Liveness + Identity Verification

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

---

Introduction

---

In this section, you will find detailed documentation about the functionality of the endpoint related to the "Liveness" + "Identity Verification" capabilities, used together.

These are two synchronous capabilities, meaning the entire integration occurs using a single endpoint.

The capabilities of the Unico IDCloud platform byClient are managed through API Keys—used as a parameter in the request headers—that define the access scope. As a prerequisite, it is necessary to have an API Key configured with the "Liveness" + "Identity Verification" 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

post

Endpoint to create a new Liveness + Identity Verification process via by Client.

Parâmetros de cabeçalho

AuthorizationstringObrigatório

Valid access token.

APIKEYstringObrigatório

Valid APIKEY with Liveness + Identity Verification capabilities enabled.

Corpo

useCasestringObrigatório

Operation use case.

Example: Onboarding

subsidiaryIdstringOpcional

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

imageBase64stringObrigatório

Encrypted file generated by the SDK or base64 (if not using Liveness).

Example: /9j/4AAQSkZJR...

Respostas

post

HTTPcURLJavaScriptPython

POST /processes/v1 HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker",
    "email": "[e-mail]",
    "phone": "551972557070"
  },
  "useCase": "Onboarding",
  "subsidiaryId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
  "imageBase64": "/9j/4AAQSkZJR..."
}

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

Important:

• If the response for the "Identity Verification" capability returns unicoId = yes, this result already includes the Liveness (i.e., the liveness parameter will not be included in the response);

• To use the "Liveness" capability, it is mandatory to use our SDKs:

  • It is possible to use the "Identity Verification" capability without the "Liveness". For this use case, the liveness value will always return as liveness = 1. In this scenario, no "Liveness" validation is performed, 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 Get the Process Result, as the response is synchronous;

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

• For more details on the scenarios you might 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.