Onboarding

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

application/json

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

idstringOptional

Process ID.

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

statusinteger · enumOptional

Process status. Possible values: '3' - Completed; '5' - Error.

Example: 3Possible values:

400

Invalid payload.

application/json

500

Unexpected error (Internal error or parameter issue).

application/json

post

/processes/v1

HTTPcURLJavaScriptPython

POST /processes/v1 HTTP/1.1
Host: api.id.uat.unico.app
APIKEY: text
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "subject": {
    "code": "HEWW580907HGRSHL05",
    "name": "Luke Skywalker",
    "email": "[email protected]",
    "phone": "525512345678"
  },
  "useCase": "Onboarding",
  "subsidiaryId": "60837cd3-ed3c-4038-ad7c-0a85ad64b03a",
  "imageBase64": "/9j/4AAQSkZJR..."
}

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

The answer approved is not activate by default. If you wan't implement this rule, align with the responsible for your project in Unico.

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:

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

Error Responses

Click on the side to see more

400 Bad Request

401 Unauthorized

403 Forbidden

500 Internal Server Error