Onboarding

In this section, you will find how to create a Onboarding process in the by Client Integration

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.

Base URL:

  • Sandbox: https://api.id.uat.unico.app;

  • Production: https://api.id.unico.app.

Create Process

post

Endpoint to create a new Onboarding process in by Client integration.

Header parameters
APIKEYstringRequired

A valid APIKEY.

AuthorizationstringRequired

A valid access-token.

Body
useCasestringOptional

Use case of the operation.

Example: Onboarding
subsidiaryIdstringOptional

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
imageBase64stringRequired

User's selfie in base64.

Example: /9j/4AAQSkZJR...
Responses
200

Process successfully created.

application/json
post
/processes/v1

You can use your country's unique identifier. For example: CPF (Brazilian), CURP (Mexican), NIK (Indonesian), NIN (Nigerian), etc.

Important:

  • If status = 3, consider the response from the idCloud.result parameter;

  • If an error occurs in the biometrics process, the request will return a status code = 200 and the process will have a status = 5, as in the following example:

Error Responses

PreviousAPI ReferenceNextAdditional Resouces

Last updated