GetProcess

Nesta seção, você encontrará como obter o resultado de um processo no by Client através da API REST

---

Antes de começar

---

Suas requisições de API são autenticadas utilizando um access-token. Qualquer requisição que não inclua um access-token válido retornará um erro.

Você pode ver mais sobre como gerar um access-token aqui.

Endpoints:

• UAT: https://api.id.uat.unico.app/processes/v1;

• Produção: https://api.id.unico.app/processes/v1.

---

GetProcess

Endpoint para buscar o resultado de um processo de verificação de identidade no by Client.

GEThttps://api.id.uat.unico.app/processes/v1/client/v1/process/{processId}

Path parameters

processId*string

ID do processo.

Header parameters

Response

200400403404410500

Informações do processo obtidas com sucesso.

Body

application/json

idstring

ID do processo.

Example: "2b034568-dfaf-463f-94fb-18ed93c312e8"

statusinteger

Status do processo.

Example: 3

unicoIdobject

Resultado do verificação de identidade.

livenessinteger

Resultado da prova de vida, onde: '1' é LIVE e '2' é NOT LIVE.

Example: 1

scoreinteger

Resultado do score de risco.

Example: 50

Request

JavaScriptCurlPython

const response = await fetch('https://api.id.uat.unico.app/processes/v1/client/v1/process/{processId}', {
    method: 'GET',
    headers: {
      "Authorization": "text",
      "APIKEY": "text"
    },
});
const data = await response.json();

Response

200400403404410500

{
  "id": "2b034568-dfaf-463f-94fb-18ed93c312e8",
  "status": 3,
  "unicoId": {
    "result": "inconclusive"
  },
  "liveness": 1,
  "score": 50
}

---

Para implementar suas regras de negócio, sempre valide os status finais dos processos (3,4,5). Para validar a reposta das capacidades IDCloud, só considere o status = 3 para sua tomada de decisão. Veja mais sobre os possíveis status na seção Especificação de parâmetros.

Para entender mais sobre as combinações de capacidades, veja também a seção Cenários de response.

No endpoint da v2 (/processes/v2/{id}), também devolvemos algumas informações adicionais do usuário, conforme exemplo abaixo:

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

Responses de erro

---

400 Bad Request

code	message	Descrição
20023	O parâmetro processId não foi informado.	Falta o parâmetro id do processo.
20002	O parâmetro APIKey não foi informado.	Falta o parâmetro APIKEY no header da requisição.
20001	O parâmetro authtoken não foi informado.	QFalta o parâmetro do token de integração no header da requisição.

404 Not Found

code	message	Descrição
50001	O processo informado não foi encontrado.	O processo não existe na base de dados.

403 Forbidden

code	message	Descrição
30017	O usuário não tem permissão para executar está ação.	Quando o access-token utilizado contém caracteres errados.
10502	O token informado está expirado.	Quando o access-token utilizado expirou.
10501	O token informado é inválido.	O token de autenticação é inválido.
10201	O AppKey informado é inválido.	O parâmetro APIKEY não foi informado ou não existe.

500 Internal Server Error

code	message	Descrição
99999	Internal failure! Try again later	Quando há algum erro interno.

---

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.