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


CreateProcess


Create Process

post

Endpoint to create a new isolated Liveness process via by Client.

Header parameters
AuthorizationstringRequired

Valid access token.

APIKEYstringRequired

Valid APIKEY with the Liveness capability enabled.

Body
subsidiaryIdstringOptional

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.

Example: /9j/4AAQSkZJR...
Responses
200
Process successfully created (User alive).
application/json
post
POST /processes/v1 HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker",
    "email": "[email protected]",
    "phone": "551972557070"
  },
  "subsidiaryId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
  "imageBase64": "/9j/4AAQSkZJR..."
}
{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "liveness": 1
}

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.

Last updated

Was this helpful?