Liveness

In this section, you will find the specifics of creating a process that only has the Liveness capability

---

Intoduction

---

In this section, you will find detailed documentation about the functionality of the endpoint related to the "Liveness" capability, used in isolation.

This is a synchronous capability, meaning the entire integration occurs using a single endpoint.

The capabilities of the Unico IDCloud platform via Client 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 exclusively for the "Liveness" capability, 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 isolated Liveness process via by Client.

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

Header parameters

Body

application/json

subject*object

User information.

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.

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

Response

200400500

Process successfully created (User alive).

Body

application/json

idstring

Process ID.

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

statusenum

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

Example: 3

345

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"
      },
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

200400500

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

Important:

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

• If an error occurs during biometric processing, the request will return a status code = 200, and 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, 4, 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.