Onboarding
Below you'll find the endpoint for Onboarding by Cilent with all capabilities enabled, but you can also use the capabilities individually (except for Serpro's similarity score and risk score, which depend on the use of Identity Verification). Discuss with your project manager which capabilities to enable for your operation.
Endpoint to create a new Onboarding process in by Client
Valid access-token.
Valid APIKEY with the capabilities for Onboarding use.
Operation's use case.
OnboardingThe ID of the branch where the process will be created. If there is only one branch associated with the service account, there is no need to pass this parameter. If there is a separation of processes by branch, you will receive the branch IDs from the Unico team.
35d734c4-7fbb-4b2f-a1dc-7e1575514819Encrypted file generated by the SDK or base64 (if not using Liveness Detection).
/9j/4AAQSkZJR...Process created successfully.
Bad Request.
Forbidden.
Internal Server Error.
POST /processes/v1 HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Content-Type: application/json
Accept: */*
Content-Length: 215
{
"subject": {
"code": "12345678909",
"name": "Luke Skywalker",
"email": "[email protected]",
"phone": "551972557070"
},
"useCase": "Onboarding",
"subsidiaryId": "35d734c4-7fbb-4b2f-a1dc-7e1575514819",
"imageBase64": "/9j/4AAQSkZJR..."
}{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 1,
"unicoId": {
"result": "inconclusive"
},
"identityFraudsters": {
"result": "inconclusive"
},
"government": {
"serpro": 50
},
"liveness": 1
}Important:
If the response from the Identity Verification capability is
unicoId = yes/no, this response already includes the Liveness (meaning you will not receive thelivenessparameter in the response).If the response from the Identity Verification capability is
unicoId = inconclusive, there will be orchestration with the Risk Score capability.To use the Liveness capability, it is essential to use our SDKs:
It is possible to use the Identity Verification capability without Liveness. In this use case, the liveness return will always be
liveness = 1. In this scenario, there is no validation of the life proof, not even passive validation.
If an error occurs during processing, the process will return a
status = 5, as shown in the example below:{ "id": "80371b2a-3ac7-432e-866d-57fe37896ac6", "status": 5 }
Tips:
To implement your business rules, always validate the final statuses of the processes (
3,5). To validate the response from the IDCloud capabilities, only considerstatus = 3for your decision-making.
Errors
20900
O base64 informado não é válido.
The base64 parameter is invalid. Possible causes: It's not an image or it's an injection attempt.
20807
A imagem precisa estar no padrão HD ou possuir uma resolução superior a 640 x 480.
The resolution of the uploaded image is too low.
20507
O parâmetro subject.code é inválido.
Non-standard or non-existent CPF.
20506
O base64 informado é muito grande. O tamanho máximo suportado é até 800kb.
When the e-mail address provided is not vThe image is too large. The image can be compressed to JPEG92 without loss of quality.
20505
O base64 informado não é suportado. Os formatos aceitos são png, jpeg e webp.
When the phone number entered is not validBase64 invalid. Possible causes: not a valid image or invalid prefix.
20009
O parâmetro imagebase64 não foi informado.
The imagebase64 parameter, which contains the person's selfie, is missing.
20006
O parâmetro subject.name não foi informado.
The subject.name parameter, which contains the person's name, is missing.
20005
O parâmetro subject.code não foi informado.
The subject.code parameter, which contains the person's cpf, is missing.
20004
O parâmetro subject não foi informado.
The subject parameter, which contains the person's data (cpf, name), is missing.
20003
The request body is missing or invalid.
Null or invalid payload.
20002
O parâmetro APIKey não foi informado.
The APIKEY parameter is missing from the request header.
20001
O parâmetro authtoken não foi informado
The integration token parameter is missing from the request header.
10508
The JWT with the captured face has already been used.
The jwt can only be used once.
10507
The JWT with the captured face is expired.
JWT expired. The .jwt must be sent within 10 minutes.
10506
The bundle is invalid.
Invalid bundle. APIKEY uses a security method and this request does not meet the security requirements (SDK).
30017
Jwt header is an invalid JSON.
When the access-token used contains wrong characters.
10502
O token informado está expirado.
When the access-token used has expired
10501
O token informado é inválido.
The authentication token is invalid.
10201
O AppKey informado é inválido.
The APIKEY parameter has not been entered or does not exist.
99999
Internal failure! Try again later
When there is an internal error.
Endpoint to fetch the result of an Onboarding process in by Client (specific for when there is orchestration with the Risk Score)
Process ID.
Valid access-token.
Valid APIKEY with the capabilities for Onboarding use.
Process information obtained successfully.
Bad Request.
Forbidden.
Not Found.
Gone.
Internal Server Error.
GET /processes/v1/{processId} HTTP/1.1
Host: api.id.uat.unico.app
Authorization: text
APIKEY: text
Accept: */*
{
"id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
"status": 3,
"unicoId": {
"result": "inconclusive"
},
"identityFraudsters": {
"result": "inconclusive"
},
"score": 90,
"government": {
"serpro": 50
},
"liveness": 1
}Attention:
When making a GET request for a process with
status = 5(error), the return status code will be410 (Gone)instead of200 (Success).There may be cases of drops during orchestration with the Risk Score capability. In this scenario, the process will have the following combination: {
status = 3,unicoId = inconclusive,liveness = 1,identityFraudsters = inconclusive/yesand NO score in the API response}. Learn more in the Response Scenarios section.If you query a process with
status = 2, implement polling until you receivestatus = 3or implement Unico's Webhook to know when to get the result.
Tips:
When implementing your business rules, always validate the final statuses of the processes (
3,4,5). To validate the response of IDCloud capabilities, only considerstatus = 3for your decision-making process.To improve the performance of your operation, you can use our Webhooks and only query the results of processes that have a finalized status.
Errors
20023
O parâmetro processId não foi informado.
The process id parameter is missing.
20002
O parâmetro APIKey não foi informado.
The APIKEY parameter is missing from the request header.
20001
O parâmetro authtoken não foi informado.
The integration token parameter is missing from the request header.
50001
O processo informado não foi encontrado.
The process does not exist in the database.
30017
O usuário não tem permissão para executar está ação.
When the access-token used contains wrong characters.
10502
O token informado está expirado.
When the access-token used has expired.
10501
O token informado é inválido.
The authentication token is invalid.
10201
O AppKey informado é inválido.
The APIKEY parameter has not been entered or does not exist.
{
"id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
"status": 5
}99999
Internal failure! Try again later
When there is an internal error.
Last updated
Was this helpful?