Skip to main content

Get Process - IDUnico + IDCheck

Esse método obtem o resultado da transação biométrica no IDUnico + IDCheck.

Como usar?

Faça uma requisição GET para o endpoint /processes/v1/{id}

Com o token de acesso válido, faça uma requisição para o endpoint (GET/processes/v1/{id}). O parâmetro {id} deve ser o mesmo que foi gerado durante a criação da transação.

Parametros:

  • HEADER PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
APIKEYStringMandatórioAPI key
AuthorizationStringMandatórioToken de acesso
  • PATH PARAMETERS
NomeTipoMandatorio/OpcionalDescrição
processoIdStringMandatórioNumero 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:

  • Processo finalizado, unicoId = “inconclusive” e liveness = “not live”.
{
"id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
"status": 3,
"unicoId": {
"result": "inconclusive"
},
"liveness": 1,
"score": 42
}

Os parâmetros de retorno são:

NomeTipoDescrição
idstringIndica o ID do processo criado com o envio da foto.
statusintegerIndica o status do processo, usado para indicar se está concluído ou não. Para mais informações, veja Status do Processo.
unicoId.resultstringIndica a autenticidade do CPF. Os valores podem ser Yes ou Inconclusive
livenessintegerIndica se é uma foto ao vivo ou não. Para mais informações, veja Liveness.
scoreintegerIndica a probabilidade de a pessoa da foto ser o titular do CPF. Para mais informações, veja Score de Autenticação.
Importante
  • Quando a requisição GET for para um processo com status 5 (erro), o status code de retorno é 410 (Gone) ao invés de 200 (Success).

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.