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 how the endpoints related to the Liveness + Identity Verification + Behavior Alert capabilities work when used together.

These are three synchronous capabilities (Liveness + Identity Verification + Behavior Alert), meaning that the entire integration occurs using a single endpoint.

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, you must have an API Key configured with the Liveness + Identity Verification + Behavior Alert capabilities, 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;

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

CreateProcess

---

Create Process

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

post

/processes/v1

Header parameters

Authorizationstringrequired

Valid access token.

APIKEYstringrequired

Valid APIKEY with the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score enabled.

Body

useCasestringrequired

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

imageBase64stringrequired

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

Example: /9j/4AAQSkZJR...

subjectobjectrequired

User information.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.id.uat.unico.app/processes/v1' \
  --header 'Authorization: text' \
  --header 'APIKEY: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "useCase": "Onboarding",
    "subsidiaryId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "imageBase64": "/9j/4AAQSkZJR...",
    "subject": {
      "code": "12345678909",
      "name": "Luke Skywalker",
      "email": "[e-mail]",
      "phone": "551972557070"
    }
  }'

200

400

500

200

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

Process successfully created.

Important:

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

• The Identity Verification and Behavior Alert capabilities are completely independent. To implement your business rules, make sure to analyze what each return means.

• 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 life proof, not even passive validation.

• 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:

• For this use case, there is no need to Query the Process Result, as the response is synchronous.

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

• For more information on the scenarios you might receive in the response, refer to the Response Scenarios section.

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

GetProcess

---

Get Process

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

get

/processes/v1/{processId}

Path parameters

processIdstringrequired

Process ID.

Header parameters

Authorizationstringrequired

Valid access token.

APIKEYstringrequired

Valid APIKEY with the capabilities Liveness + Identity Verification + Behavior Alert + Risk Score enabled.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.id.uat.unico.app/processes/v1/{processId}' \
  --header 'Authorization: text' \
  --header 'APIKEY: text'

200

400

403

404

410

500

200

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

Process information successfully retrieved.

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.