CancelProcess

This article explains how to cancel an open biometrics process using the Unico Check REST API.

How to use it?

Make a POST request to the /processes/{processoId}/cancel endpoint

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

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:

{
    "id": "6ab1771e-dfab-4e47-8316-2452268e5481",
    "Status": 4
}

The return parameters are:

Name	Type	Description
Id	string	Indica o ID do processo criado com o envio da foto. Ele é utilizado nos outros métodos de 'Processes'
Status	integer	Indica o status do Processo, usado para indicar se está cancelado ou não.

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.