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} ou /processes/v2/{id}

Com o token de acesso válido, faça uma requisição para o endpoint (GET/processes/{v1/v2}/{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 - /processes/v1/{id}

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"
  }
}

Requisição com Sucesso - /processes/v2/{id}

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"
  },
  "processAdditionalInfo": {
      "transactionId": "2ed76ac5-8fd7-4477-839d-92bedd7e9fd5",
      "personName": "Nome da pessoa",
      "personDocument": "Número do documento da pessoa",
      "personImage": "URL assinada da imagem da pessoa",
      "finishedAt": "2024-10-04T18:53:17.028228"
  }
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição	Versão API
id	string	Indica o ID do processo criado com o envio da foto.	v1/v2
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.	v1/v2
unicoId.result	string	Indica a autenticidade do CPF. Os valores podem ser Yes ou Inconclusive	v1/v2
processAdditionalInfo.transactionId	string	Indica o ID da transação do processo criado	v2
processAdditionalInfo.personName	string	Indica o nome da pessoa do processo criado	v2
processAdditionalInfo.personDocument	string	Indica o documento da pessoa do processo criado	v2
processAdditionalInfo.personImage	string	Indica a imagem da pessoa do processo criado	v2
processAdditionalInfo.finishedAt	string	Indica a data e hora do término do processo criado	v2

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.