Cancelar processo de Biometria

Este artigo explica como cancelar um processo de biometria em aberto através da REST API do Unico Check.

Como usar?

Faça uma requisição POST para o endpoint /processes/{processoId}/cancel

Com o token de acesso válido, faça uma requisição para o endpoint (POST/processes/{processoId}/cancel).

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso

• PATH PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
processoId	String	Mandatório	Numero do processo

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo os seguintes parâmetros:

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

Os parâmetros de retorno são:

Nome	Tipo	Descrição
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.

Erro na Requisição

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
    "Error": {
        "code": "40004",
        "description": "Descrição do erro"
    }
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.