Liveness + Validation (1:1)

In this section, you will find the specifics of creating a process that includes the 1:1 Validation capability

---

Introduction

---

In this section, you will find detailed documentation about the functionality of the endpoint related to the Liveness + 1:1 Validation capabilities, used together.

These are two synchronous capabilities, 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 with the Liveness + 1:1 Validation 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/processes/v1;

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

CreateProcess

---

Create Process

Endpoint to create a new process for Liveness + 1:1 Validation by Client.

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

Header parameters

Body

application/json

subject*object

User information.

referenceProcessId*string

Identifier of the process generated during the biometric transaction creation, whose photo will be used for comparison.

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

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 created successfully (User authenticated).

Body

application/json

idstring

Process ID.

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

authenticatedboolean

Authentication result. Possible values: 'true' - Success. The face in the transaction matches the reference process; 'false' - Failure. The face in the transaction does not match the reference process.

Example: true

livenessenum

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

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"
      },
      "referenceProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
      "imageBase64": "/9j/4AAQSkZJR..."
    }),
});
const data = await response.json();

Response

200400500

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

Important:

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

  • It is possible to use the "Validation 91:1)" 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.

Tips:

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

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