GetProcess - IDCheck flow
This article explains how to get the result of a process in the idCheck flow through the REST API.
How to use it?
Make a GET request for the endpoint:
- UAT: https://api.cadastro.uat.unico.app/client/v1/process/{id}
- Production: https://api.cadastro.unico.app/client/v1/process/{id}
With a valid access token, make a request to the endpoint passing the {id} parameter, which must be the same as the one generated during process creation (CreateProcess).
Parameters:
- PATH PARAMETERS
Name | Type | Mandatory/Optional | Description |
---|---|---|---|
id | String | Mandatory | Process number |
Request executed successfully
If the request was successful, the return response is a 200 OK
and a JSON containing the following parameters:
{
"process": {
"id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
"flow": "idcheck",
"company": {
"code": "unico",
"friendlyName": "Acesso QA Digital",
"logoUrl": "https://unico.io/wp-content/themes/theme_unico/img/logo/unico-color.svg"
},
"callbackUri": ""/path/to/callback-url/",
"userRedirectUrl": "https://cadastro.dev.unico.app/process/53060f52-f146-4c12-a234-5bb5031f6f5b",
"state": "PROCESS_STATE_FINISHED",
"result": "PROCESS_RESULT_OK",
"person": {
"duiType": "DUI_TYPE_BR_CPF",
"duiValue": "73689290074",
"friendlyName": "John Doe",
},
"purpose": "creditprocess",
"authenticationInfo": {
"authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
"scoreEngineResult": {
"scoreEnabled": "SCORE_ENABLED_TRUE",
"score": 50
},
"authenticationId": "",
"livenessResult": "LIVENESS_RESULT_UNSPECIFIED"
},
"capacities": [
"PROCESS_CAPACITY_IDUNICO",
"PROCESS_CAPACITY_IDCHECK",
"PROCESS_CAPACITY_IDDOCS",
"PROCESS_CAPACITY_IDSIGN",
"PROCESS_CAPACITY_IDLIVE"
],
"createdAt": "2023-10-05T18:28:58.537985Z"
"finishedAt": "2023-08-09T15:15:25.417105Z"
}
}
Parameter | Description |
---|---|
id | The process identifier. |
flow | Defines the journey that was created. id : Identity validation flow with facial biometrics. idcheck : Identity validation flow with facial biometrics with score in the case of inclusion. iddocs : Identity validation flow with document capture and reuse (RG or CNH). idsign : Identity validation flow with electronic signature.iddocssign : Identity validation flow, capture/reuse of documents (RG or CNH) and electronic signature. |
callbackUri | Defines where the user will be redirected at the end of the process. More details in Request Parameters. |
company.code | Flags the company code in the Unico ecosystem. |
company.friendlyName | Flags the customer name displayed in the user journey. |
company.logoUrl | Flags the customer logo displayed in the user journey. |
userRedirectUrl | URL where you should redirect the user to complete the journey |
state | Indicates the current state of the process, as it is of the type: PROCESS_STATE_CREATED : Process created and not yet finished by the user. PROCESS_STATE_FINISHED : Process completed by the user successfully. PROCESS_STATE_FAILED : Process created or terminated with error. |
result | Indicates the result of the user journey process, which may be of the type: PROCESS_RESULT_OK : Process completed successfully. PROCESS_RESULT_WARNING : Process ended with alert. PROCESS_RESULT_ERROR : Process ended with some type of error. PROCESS_RESULT_UNSPECIFIED : It is returned when the client uses the IDUnico alone. Process ended with unspecified result. |
person.personDuiType | Defines the user identifier type. DUI_TYPE_BR_CPF : For CPF as identifier. |
person.personDuiValue | Sets the value of the user identifier specified in the personDuiType field. |
person.friendlyName | Sets the user name, for example, John Doe . |
authenticationInfo.authenticationResult | Result of identity validation using ID. AUTHENTICATION_RESULT_UNSPECIFIED : Waiting for the authentication process to return. AUTHENTICATION_RESULT_INCONCLUSIVE : Inconclusive authentication result. AUTHENTICATION_RESULT_POSITIVE : Positive authentication result. |
authenticationInfo.authenticationResult. scoreEngineResult.scoreEnabled | Indicates whether the process has Check enabled in case the ID is inconclusive. SCORE_ENABLED_TRUE : Enabled. SCORE_ENABLED_FALSE : Disabled. |
authenticationInfo.authenticationResult. scoreEngineResult.score | Indicates the result of the Check score. 0 : If disabled. -100 to 100 : score result. |
authenticationInfo.livenessResult | Indicates the enumerated with the liveness result. LIVENESS_RESULT_UNSPECIFIED : Unexpected return. LIVENESS_RESULT_NOT_LIVE : The user did not pass the proof of life check LIVENESS_RESULT_LIVE : The user's proof of life was checked. |
authenticationInfo.authenticationId | id of the IDCloud process that generated the user authentication of the By Unico process. |
capacities | Unico capabilities used in processes: PROCESS_CAPACITY_IDUNICO : with identity validation with facial biometrics. PROCESS_CAPACITY_IDCHECK : with identity validation with facial biometrics and score in the case of inclusion.PROCESS_CAPACITY_IDDOCS : with identity validation with capture and reuse of documents (RG or CNH).PROCESS_CAPACITY_IDSIGN : with identity validation with electronic signature.PROCESS_CAPACITY_IDLIVE : with identity validation and proof of life. |
createdAt | Indicates the moment the process was created. |
finishedAt | Indicates the moment at which the process was completed by the user. |
services
ParameterReturns data from journeys that use Docs/Sign. In the IDCheck flow, this parameter is returned empty (services []
), so there is no need to deal with it.
Request error
For information on the errors returned, see the list available in the article Response Errors.
Any concerns?
Missing something or still need help? If you are already a customer or partner, you can contact us through the Help Center.