Get Process - IDUnico

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

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

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": 3,
  "unicoId": {
    "result": "Yes"
  }
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
id	string	Indica o ID do processo criado com o envio da foto.
status	integer	Indica o status do Processo, usado para indicar se está concluído ou não. O enumerado completo pode ser visto em Enumerados.
unicoId.result	string	Indica a autenticidade do CPF. Os valores podem ser Yes ou Inconclusive

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.