GetProcess

In this section, you will find instructions on how to retrieve the result of a process in by Client using the REST API

---

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.

---

GetProcess

Endpoint to retrieve the result of a verification identity process by Client.

GEThttps://api.id.uat.unico.app/processes/v1/client/v1/process/{processId}

Path parameters

processId*string

Process ID.

Header parameters

Response

200400403404410500

Process information retrieved successfully.

Body

application/json

idstring

Process ID.

Example: "2b034568-dfaf-463f-94fb-18ed93c312e8"

statusinteger

Process status.

Example: 3

unicoIdobject

Identity verification result.

livenessinteger

Liveness test result, where: '1' is LIVE and '2' is NOT LIVE.

Example: 1

scoreinteger

Risk score result.

Example: 50

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/client/v1/process/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "APIKEY": "text"
    },
});
const data = await response.json();

Response

200400403404410500

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "score": 50
}

---

To implement your business rules, always validate the final statuses of the processes (3, 4, 5). To validate the response from IDCloud capabilities, only consider status = 3 for your decision-making. For more information on the possible statuses, see the Parameters Specification section.

The parameters above represent the most common usage of the API but may change depending on the capabilities you are using.

In the v2 endpoint (/processes/v2/{id}), we also return additional user information, as shown in the example below:

"processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Nome da pessoa",
      "personDocument": "Número do documento da pessoa",
      "personImage": "URL assinada da imagem da pessoa",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

---

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.