Liveness + Identity Verification + Behavior Alert + Risk Score

In this section, you will find the specifics of creating a process that has Liveness + Identity Verification + Behavior Alert + Risk Score as a capabilities.

---

Introduction

---

In this section, you will find detailed documentation on the operation of the endpoints related to the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score, used together.

This involves two synchronous capabilities (Liveness + Identity Verification) integrated with two asynchronous capabilities (Behavior Alert + Risk Score). That is, to obtain all the responses, it will be necessary to Get the Process Result.

For this integration, it will be necessary to consume two endpoints described in this documentation, which can also be combined with the use of Webhooks.

The capabilities of the Unico IDCloud platform via by Client are managed through API Keys - used as a parameter in the request headers - which define the access scope. As a prerequisite, it is necessary to have an API Key configured with the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score, ensuring dedicated and secure access to the resource.

Talk to your project manager to obtain the API Key with this configuration.

Getting started

---

Your API requests are authenticated using an access token. Any request that does not include a valid access token will return an error.

You can learn more about generating an access token here.

Endpoints:

• UAT: https://api.id.uat.unico.app/processes/v1;

• Production: https://api.id.unico.app/processes/v1.

CreateProcess

---

Create Process

Endpoint to create a new process for Liveness + Identity Verification + Behavior Alert + Risk Score in the by Client.

POSThttps://api.id.uat.unico.app/processes/v1/

Header parameters

Body

application/json

subject*object

User information.

useCase*string

Use case of the operation.

Example: "Onboarding"

subsidiaryIdstring

The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

imageBase64*string

Encrypted file generated by the SDK or Base64 (if not using liveness).

Example: "/9j/4AAQSkZJR..."

Response

200400500

Process successfully created.

Body

application/json

idstring

Process ID.

Example: "80371b2a-3ac7-432e-866d-57fe37896ac6"

statusenum

Process status. Possible values: '1' - Processing; '4' - Canceled (e.g., timeout); '5' - Error.

Example: 1

145

unicoIdobject

Information about identity verification.

livenessenum

Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness denied.

Example: 1

12

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "APIKEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "subject": {
        "code": "12345678909",
        "name": "Luke Skywalker"
      },
      "useCase": "Onboarding",
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

200400500

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 1,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1
}

Important:

• If the response from the Identity Verification capability is unicoId = yes, this return already includes the Liveness (i.e., you will not receive the liveness parameter in the response);

• To use the Liveness capability, it is essential to use our SDKs.

• It is possible to use the Identity Verification capability without Liveness. In this use case, the liveness return will always be liveness = 1. In this scenario, there is no validation of the Liveness, not even passive validation.

• If the responses from the Identity Verification and Behavior Alert capabilities are unicoId = inconclusive + identityFraudsters = inconclusive, there will be orchestration with the Risk Score capability. If any of these responses is conclusive, there will be no orchestration with the Risk Score.

• If an error occurs during processing, the process will return a status = 5, as shown in the example below:

•   {
    "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
    "status": 5
    }

Tips:

• To implement your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response from the IDCloud capabilities, only consider the status = 3 for your decision-making.

GetProcess

---

Get Process

Endpoint to get the result of a Liveness + Identity Verification + Behavior Alert + Risk Score process by Client.

GEThttps://api.id.uat.unico.app/processes/v1/{processId}

Path parameters

processId*string

Process ID.

Header parameters

Response

200400403404410500

Process information successfully retrieved.

Body

application/json

idstring

Process ID.

Example: "2b034568-dfaf-463f-94fb-18ed93c312e8"

statusenum

Process status. Possible values: '1' - In progress; '2' - Divergence (occurs when the risk score identifies a divergence for this face and is yet to conclude verification); '3' - Completed; '4' - Canceled (e.g., timeout); '5' - Error.

Example: 3

12345

unicoIdobject

Identity verification details.

livenessenum

Liveness result. Possible values: '1' - Liveness approved; '2' - Liveness rejected.

Example: 1

12

identityFraudstersobject

Behavior Alert details.

scoreinteger

Risk score result.

Example: 50

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "APIKEY": "text"
    },
});
const data = await response.json();

Response

200400403404410500

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "score": 50
}

In the v2 endpoint (/processes/v2/{id}), we also return some additional user information, as shown in the example below:

"processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Nome da pessoa",
      "personDocument": "Número do documento da pessoa",
      "personImage": "URL assinada da imagem da pessoa",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

Attention:

• When the GET request is for a process with status = 5 (error), the return status code will be 410 (Gone) instead of 200 (Success);

• There may be cases of a drop in orchestration with the Risk Score capability. In this scenario, the process will have the combination: {status = 3, unicoId = inconclusive, liveness = 1, identityFraudsters = inconclusive, and NO score in the API response}. Learn more in the "Response Scenarios" section;

• If you query a process that is in status = 2, implement polling until you get a status = 3, or implement Unico’s Webhook to know when to query the result.

Tips:

• To implement your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response from the IDCloud capabilities, only consider status = 3 for your decision-making;

• To improve the performance of your operation, you can use our Webhooks and only query the result of processes that are in the finalized statuses;

• For more information about the scenarios you may receive in the response, refer to the "Response Scenarios" section;

• For more information about possible errors for this endpoint, refer to the "Errors" section.

---

Still need help?​

Didn't find something or still need help? If you're already a client or partner, you can reach out through our Help Center.