Get Process - IDUnico + IDCheck

This method obtains the result of the biometric transaction in IDUnico + IDCheck.

How to use it?

Make a GET request to the /processes/v1/{id} endpoint

With a valid Access token, make a request to the endpoint (GET/processes/v1/{id}). The {id} parameter must be the same as the one generated when the transaction was created.

Parameters:

• HEADER PARAMETERS

Name	Type	Mandatory/Optional	Description
APIKEY	String	Mandatory	API key
Authorization	String	Mandatory	Access token

• PATH PARAMETERS

Name	Type	Mandatory/Optional	Description
processoId	String	Mandatory	Process number

Successful request

If the request was executed successfully, the return response is a JSON containing the following parameters:

• *Process finished, unicoId = "inconclusive" and liveness = "not live".

{
    "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
    "status": 3,
    "unicoId": {
        "result": "inconclusive"
    },
    "liveness": 1,
    "score": 42
}

The return parameters are:

Name	Type	Description
id	string	Indicates the process ID created by sending the photo.
status	integer	Indicates the status of the process, used to indicate whether it is complete or not. For more information, see Process Status.
unicoId.result	string	Indicates the authenticity of the CPF. Values can be Yes or Inconclusive.
liveness	integer	Indicates whether it's a live photo or not. For more information, see Liveness.
score	integer	Indicates the probability that the person in the photo is the CPF holder. For more information, see Authentication Score.

Important

• When the GET request goes to a process with status 5 (error), the return status code is 410 (Gone) instead of 200 (Success).

Request error

If an error occurs, the return response is a JSON containing the error code and description:

{
    "Error": {
        "code": "40004",
        "description": "Error description"
    }
}

For more 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.