CreateProcess

In this section, you will find how to create a process in Unico via 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.cadastro.uat.unico.app/client/v1/process;

• Production: https://api.cadastro.unico.app/client/v1/process.

---

CreateProcess

Endpoint to create a new identity verification process in by Unico.

POSThttps://api.cadastro.uat.unico.app/client/v1/process/

Authorization

bearerAuth

Body

application/json

callbackUri*string

Defines where the user will be redirected at the end of the process. Possible values are: an HTTPS URL for web page redirection, a URL schema for redirection in native mobile applications, or no redirection (include only '/').

Example: "/"

flow*string

Flow type. Possible flows: 'idlive', 'idcheck', 'iddocs', 'idsign', 'iddocssign', 'idcheckserpro', 'idtoken'. See flow details in the 'Overview' section of this documentation.

Example: "iddocssign"

companyBranchIdstring

The ID of the branch where the process will be created. If there is only one branch associated with the service account, this parameter does not need to be included.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

bioTokenIdstring

Biometric token identification. Required for the 'idtoken' flow, and an ID from a completed process of any other identity verification flow must be used.

Example: "60837cd3-ed3c-4038-ad7c-0a85ad64b03a"

personobject

purpose*string

Process purpose. Possible values are: 'creditprocess', 'biometryonboarding', or 'carpurchase'.

Example: "creditprocess"

expiresInstring

This is the process expiration time in seconds. If this information is not provided, the default value of 7 days will be used.

Example: "3600s"

payloadarray of object

Response

200400401500

Process successfully created.

Body

application/json

processobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.cadastro.uat.unico.app/client/v1/process/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "callbackUri": "/",
      "flow": "iddocssign",
      "purpose": "creditprocess"
    }),
});
const data = await response.json();

Response

200400401500

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "companyBranchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
    "flow": "iddocssign",
    "callbackUri": "/path/to/callback-url/",
    "userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
    "state": "PROCESS_STATE_CREATED",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "73689290074",
      "friendlyName": "Luke Skywalker",
      "phone": "5511912345678",
      "email": "[e-mail]",
      "notifications": [
        {
          "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP"
        }
      ]
    },
    "purpose": "creditprocess",
    "authenticationInfo": {},
    "capacities": [
      "PROCESS_CAPACITY_IDUNICO",
      "PROCESS_CAPACITY_IDCHECK",
      "PROCESS_CAPACITY_IDDOCS"
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ"
  }
}

For detailed verification of the API parameters, please refer to the Parameters Specification 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.