CreateProcess

In this section, you will find how to create a process in by Client through 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.

---

CreateProcess

Endpoint to create a new identity verification process by Client.

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

Header parameters

Body

application/json

subject*object

useCase*string

Use case of the operation.

Example: "Onboarding"

imageBase64*string

Encrypted generated by the SDK or base64.

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

Response

200400500

Process created successfully (YES from Identity Verification).

Body

application/json

idstring

Process ID.

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

statusinteger

Process status.

Example: 3

unicoIdobject

Request

JavaScriptCurlPython

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

200400500

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

The parameters above represent the most common usage of the API but may change depending on the capabilities you are using. Check the subsections of this section for the possibilities of capabilities and their differences.

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 Client API does not reject photos (meaning there is no drop). The existing returns are from the Identity Verification capability and will always be: yes, no, or inconclusive. Thus, cases of poor quality in image capture, proof of life, or non-ownership will result in an inconclusive return. The return is "yes" when it is possible to identify a live person who is the actual holder of the CPF.

---

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.