CreateProcess

In this section, you will find how to create a process in Unico via the REST API

---

Introduction

---

In this section, you will find detailed documentation on how the Process Creation endpoint works in by Unico. Note that to utilize the capabilities of the IDCloud platform in this integration method, you only need to change the value of the "flow" parameter when creating the process. Unico will handle the orchestration of all the desired capabilities.

Learn more about using capabilities in by Unico in the Overview section.

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;

• Produção: https://api.cadastro.unico.app/client/v1/process.

---

Create Process

Endpoint to create a new process at 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: A URL (e.g., https://developers.unico.io/callback), a Schema URL for redirection in native mobile applications (e.g., br.com.meupacote.app://callback - the callback must be registered in your mobile app), or no redirection (just include '/').

Example: "/"

flow*enum

Flow type. See flow details in the 'Overview' section of this documentation.

Example: "iddocssign"

idliveididlivetrustidtrustidcheckiddocsidsigniddocssignidchecktrustidchecktrustdocsidchecktrustsignidchecktrustdocssignidcheckserprocreditoconsignadoidcheckserprodocssignidtokenidtokensignidtokentrust

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 is not required. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.

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

bioTokenIdstring

Biometric token identification. Mandatory for the "idtoken" flow and must use an ID from a completed process of any other identity verification flow.

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

personobject

User information.

purpose*enum

Purpose of the process.

Example: "creditprocess"

creditprocessbiometryonboardingcarpurchase

expiresInstring

Expiration time of the process in seconds from its creation. The value must be in the format "10080s", with "s" at the end. If not provided, the default value of 7 days will be used.

Example: "3600s"

contextualizationobject

Contextual information about the process. These fields are presented in the user journey, improving conversion by contextualizing the reason for biometric capture.

payloadarray of object

Array containing document information. All items in the array become mandatory if using any flow with electronic signature.

Response

200400401500

Process successfully created.

Body

application/json

processobject

Information about the Unico process.

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": {
      "authenticationResult": "AUTHENTICATION_RESULT_UNSPECIFIED",
      "authenticationId": "",
      "livenessResult": "LIVENESS_RESULT_UNSPECIFIED",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "identity_fraudsters_result": "TRUST_RESULT_UNSPECIFIED"
    },
    "capacities": [
      [
        "PROCESS_CAPACITY_IDUNICO",
        "PROCESS_CAPACITY_IDCHECK",
        "PROCESS_CAPACITY_IDDOCS"
      ]
    ],
    "expiresAt": "2023-10-09T15:15:25.417105Z",
    "token": "eyJhbGciOiJSUzI1[...]d_jhQ",
    "companyData": {
      "branchId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
      "countryCode": "BRA"
    }
  }
}

Processes must be created exclusively through backend-to-backend communication, due to our CORS policy, which prevents processes from being created through frontend-to-backend communication.

Tips:

• For more information about the scenarios you may receive in the response, refer to the Response Scenarios 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.