1 de 1

Identity Verification

In this section, you will find the specifics of creating a process that has Identity Verification as a capability, along with its complements

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.

During the process creation, the required fields are subject.code, subject.name, and imageBase64.
In the process response, the responses from the capabilities may arrive at different times, since IDCloud has both synchronous and asynchronous capabilities. Therefore, you should implement the GetProcess method depending on the combination of these capabilities.

The Identity Verification capability can be combined with other capabilities, such as Risk Score or Fraud Profile Detection. For more information on the possible responses, refer to the sections on Response Scenarios and Parameter Specifications.

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.

Identity Verification

In this section, you will find the specifics of creating a process that has Identity Verification as a capability, along with its complements

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 identity verification process by Client.

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

Header parameters

Authorization*string

Valid access-token.

APIKEY*string

Valid APIKEY with the capabilities you will use.

Body

subject*object

code*string

User's CPF.

Example: "12345678909"

name*string

User's name.

Example: "Luke Skywalker"

emailstring

User's email.

Example: "luke@unico.io"

phonestring

User's phone.

Example: "551972557070"

useCase*string

Use case of the operation.

Example: "Onboarding"

imageBase64*string

Encrypted generated by the SDK or base64.

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

Response

Process created successfully (INCONCLUSIVE from Identity Verification).

Body

idstring

Process ID.

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

statusinteger

Process status.

Example: 2

unicoIdobject

resultstring

Result of the identity verification.

Example: "inconclusive"

Request

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

Response

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 2,
  "unicoId": {
    "result": "inconclusive"
  }
}

During the process creation, the required fields are subject.code, subject.name, and imageBase64.
In the process response, the responses from the capabilities may arrive at different times, since IDCloud has both synchronous and asynchronous capabilities. Therefore, you should implement the GetProcess method depending on the combination of these capabilities.

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 identity verification process by Client.

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

Header parameters

Authorization*string

Valid access-token.

APIKEY*string

Valid APIKEY with the capabilities you will use.

Body

subject*object

code*string

User's CPF.

Example: "12345678909"

name*string

User's name.

Example: "Luke Skywalker"

emailstring

User's email.

Example: "luke@unico.io"

phonestring

User's phone.

Example: "551972557070"

useCase*string

Use case of the operation.

Example: "Onboarding"

imageBase64*string

Encrypted generated by the SDK or base64.

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

Response

Process created successfully (INCONCLUSIVE from Identity Verification).

Body

idstring

Process ID.

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

statusinteger

Process status.

Example: 2

unicoIdobject

resultstring

Result of the identity verification.

Example: "inconclusive"

Request

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

Response

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 2,
  "unicoId": {
    "result": "inconclusive"
  }
}