Consultar um processoGET

Consulte um processo pelo id que o Human Plugin retornou na criação.

Markdown

GET /v1/processes/{id}

id é o UUID da resposta de criação. Não há header de autenticação nem escopo por cliente: qualquer chamador que consiga alcançar o Human Plugin pode consultar qualquer um dos seus processos.

curl http://human-plugin.internal:8080/v1/processes/b063041c-7529-4e70-a2b4-c71c00f19801

Quando o resultado chega

• Um processo pendente (PROCESS_STATE_CREATED) é verificado a cada consulta e respondido com o resultado assim que houver um.
• Um processo finalizado ou com falha é definitivo e é respondido como está.
• Uma criação que foi interrompida é respondida como falha cerca de 70 segundos depois de iniciada.

A consulta é a única forma de um processo pendente avançar: não há job em segundo plano, e o retorno ao seu callbackUri não atualiza o Human Plugin.

Resposta

200 OK com o mesmo formato de uma criação: id, state e data.

Uma Journey pendente:

{ "id": "b063041c-7529-4e70-a2b4-c71c00f19801", "state": "PROCESS_STATE_CREATED", "data": {} }

Processos finalizados e com falha

Um processo finalizado retorna o resultado em data: quem é a pessoa, em humanToken, e a inteligência da pessoa, em ndocs, além de liveness quando o fluxo a verifica. Uma revalidação retorna humanTokenMatch no lugar de humanToken. Cada campo é descrito em O resultado em data. Um processo com falha retorna PROCESS_STATE_FAILED com data vazio.

Um processo finalizado:

{
  "id": "b063041c-7529-4e70-a2b4-c71c00f19801",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanToken": { "value": "6d3d71…", "status": "validated" },
    "liveness": { "value": "live", "status": "validated" },
    "ndocs": {
      "distinctClientsCount": 2,
      "transactionsCount": 3,
      "firstSeen": "2026-09-08",
      "lastSeen": "2026-11-03",
      "credentials": [
        { "type": "DUI_TYPE_NG_BVN", "countryCode": "NGA", "distinctCredentialCount": 1 }
      ]
    }
  }
}

Uma revalidação finalizada, em que ndocs descreve a pessoa que você confirmou:

{
  "id": "7f2c9a10-3d4e-4b5f-8a61-0c9e2d7b4a35",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanTokenMatch": "true",
    "liveness": { "value": "live", "status": "validated" },
    "ndocs": {
      "distinctClientsCount": 2,
      "transactionsCount": 4,
      "firstSeen": "2026-09-08",
      "lastSeen": "2026-11-04",
      "credentials": [
        { "type": "DUI_TYPE_NG_BVN", "countryCode": "NGA", "distinctCredentialCount": 1 }
      ]
    }
  }
}

Um processo com falha:

{ "id": "c41e8b27-95d0-4a8f-b3e6-2f7a1d9c0e58", "state": "PROCESS_STATE_FAILED", "data": {} }

O token e o link da Journey são retornados somente pela criação. Guarde-os a partir dessa resposta.

Erros

Status	message	Significado
404	PROCESS_NOT_FOUND	O id não é um UUID ou é desconhecido
502	UPSTREAM_UNAVAILABLE	O processo está pendente e não foi possível verificar seu resultado. Tente novamente mais tarde
503	DATABASE_UNAVAILABLE	O banco de dados falhou. Tente novamente mais tarde

As consultas podem ser repetidas com segurança.

Próximo passo

Consultar a selfie