HomepageAuthentication

Liveness + Validation (1:1) + Behavior Alert

In this section, you will find the specifics of creating a process that includes Liveness + 1:1 Validation + Behavior Alert as capabilities.

Introduction

In this section, you will find detailed documentation on the operation of the endpoint related to the capabilities Liveness + 1:1 Validation + Behavior Alert, used together.

These are three synchronous capabilities, meaning the entire integration takes place using a single endpoint.

The capabilities of the Unico IDCloud platform via by Client are managed through API Keys - used as a parameter in the request header - which define the scope of access. As a prerequisite, it is necessary to have an API Key configured with the Liveness + 1:1 Validation + Behavior Alert 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:

CreateProcess

Create Process

post

Endpoint to create a new process for liveness + 1:1 validation + behavior alert in the by Client.

Header parameters
AuthorizationstringRequired

Access-token válido.

APIKEYstringRequired

Valid APIKEY with the capabilities Liveness + 1:1 Validation + Behavior Alert.

Body
referenceProcessIdstringRequired

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

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

Use case of the operation.

Example: Onboarding
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: 35d734c4-7fbb-4b2f-a1dc-7e1575514819
imageBase64stringRequired

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

Example: /9j/4AAQSkZJR...
Responses
200
Process created successfully (User authenticated).
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: 275

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker",
    "email": "[email protected]",
    "phone": "551972557070"
  },
  "referenceProcessId": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "useCase": "Onboarding",
  "subsidiaryId": "35d734c4-7fbb-4b2f-a1dc-7e1575514819",
  "imageBase64": "/9j/4AAQSkZJR..."
}
{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "identityFraudsters": {
    "result": "yes"
  },
  "biometryToken": {
    "result": "true"
  },
  "liveness": 1
}

Important:

  • To use the liveness capability, it is essential to use our SDKs:

    • It is possible to use the Validation (1:1) capability without liveness. In this use case, we will not return the liveness parameter in the API response. In this scenario, there is no validation of the liveness, not even passive.

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

PreviousLiveness + Identity Verification + Behavior Alert + Risk ScoreNextDocument Capture and Reuse

Last updated

Was this helpful?