1 de 1

Liveness

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

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.

When creating the process, only the subject.code and imageBase64 parameters are mandatory;
In the process response, only the id, status, and liveness (result of Liveness) parameters are returned.

For this use case, there is no need to perform the GetProcess call, as the response is synchronous.

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.

Liveness

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

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

Endpoint to create a new liveness process by Client.

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

Header parameters

Authorization*string

Valid access-token.

APIKEY*string

Valid APIKEY with liveness capability.

Body

subject*object

code*string

User's CPF.

Example: "12345678909"

name*string

User's name.

Example: "Luke Skywalker"

imageBase64*string

Encrypted generated by the SDK.

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

Response

Process created successfully (User alive).

Body

idstring

Process ID.

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

statusinteger

Process status.

Example: 3

livenessinteger

Result of the liveness.

Example: 1

Request

Response

When creating the process, only the subject.code and imageBase64 parameters are mandatory;
In the process response, only the id, status, and liveness (result of Liveness) parameters are returned.

For this use case, there is no need to perform the GetProcess call, as the response is synchronous.

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.

CreateProcess

Endpoint to create a new liveness process by Client.

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

Header parameters

Authorization*string

Valid access-token.

APIKEY*string

Valid APIKEY with liveness capability.

Body

subject*object

code*string

User's CPF.

Example: "12345678909"

name*string

User's name.

Example: "Luke Skywalker"

imageBase64*string

Encrypted generated by the SDK.

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

Response

Process created successfully (User alive).

Body

idstring

Process ID.

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

statusinteger

Process status.

Example: 3

livenessinteger

Result of the liveness.

Example: 1

Request

Response

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();