GetProcess

This article explains how to obtain information from an open biometrics process via the Unico Check REST API.

How to use it?

Make a GET request to the /processes/{processoId} endpoint

With a valid Access token, make a request to the endpoint (GET/processes/{processoId}).

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:

{
    "HasBiometry": true,
    "Id": "11111111-1111-1111-1111-111111111111",
    "Liveness": 0,
    "Score": 95,
    "Status": 3,
    "OCRCode": 0,
    "FaceMatch": 0
}

The return parameters are:

Name	Type	Description
HasBiometry	boolean	Indica se o processo possui uma foto biometricamente válida ou não (se possui um rosto ou não).
Id	string	Indica o ID do processo criado com o envio da foto. Ele é utilizado nos outros métodos de 'Processes'
Liveness	integer	Indica o status do liveness, indica se é uma foto de foto ou não. 0 - Desligado // 1 - Foto OK // 2 - Foto de Foto
Score	integer	Indica o score de autenticação daquele CPF / Foto. Ver a sessão de Score para entender melhor sobre
Status	integer	Indica o status do Processo, usado para indicar se está concluído ou não.
OCRCode	integer	Indica o status do OCRCode, procura no documento informado um determinado CPF. 0 - Desligado // 1 - Ok // 2 - Não Ok
FaceMatch	integer	Indica o status do FaceMatch, verifica se a foto no documento é a mesma pessoa da foto informada. 0 - Desligado // 1 - Ok // 2 - Não Ok

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.