Skip to main content
GET
/
api
/
kyc
/
face-match
/
verifications
/
{id}
Obter verificação Face Match
curl --request GET \
  --url http://api.gu1.ai/api/kyc/face-match/verifications/{id} \
  --header 'Authorization: Bearer <token>'

​
Resumo

Retorna uma verificação de Face Match pelo seu id (o mesmo UUID retornado como verificationId na resposta do POST Face Match ou no endpoint de listagem). Use para consultar o detalhe de uma verificação passada (auditoria, suporte ou telas de detalhe). Pontos principais:
  • Scoped à sua organização; retorna 404 se o ID não existir ou pertencer a outra organização.
  • Mesmos campos de cada item da listagem: id, entityId, status, match, score, threshold, createdAt e caminhos de imagens opcionais.
Para baixar os bytes do documento e do selfie armazenados, use Obter imagens Face Match (/document-image e /selfie-image).

​
Solicitação

​
Endpoint

GET https://api.gu1.ai/api/kyc/face-match/verifications/:id

​
Parâmetros de path

​
id
string
required
UUID da verificação Face Match (o mesmo que verificationId do POST ou da listagem).

​
Headers

{
  "Authorization": "Bearer YOUR_API_KEY"
}
Inclua X-Organization-Id se sua conta for scoped por organização.

​
Resposta

​
Sucesso (200 OK)

Objeto único de verificação:
CampoTipoDescrição
idstringUUID da verificação.
organizationIdstringOrganização que possui o registro.
entityIdstring | nullID da entidade pessoa se enviado na solicitação.
statusstringapproved | declined | in_review | failed.
matchbooleanSe as faces foram consideradas coincidentes.
scorenumber | nullPontuação de similaridade 0–100 (null quando status é failed).
requestIdstring | nullID interno da solicitação (suporte).
vendorDatastring | nullReferência do cliente na solicitação.
errorMessagestring | nullMensagem de erro quando status é failed.
triggeredByUserIdstring | nullUsuário que chamou a API.
createdAtstringTimestamp ISO.
documentStoragePathstring | nullCaminho de armazenamento da imagem do documento (auditoria).
selfieStoragePathstring | nullCaminho de armazenamento da selfie (auditoria).
storageProviderstring | nulls3 ou local.
thresholdnumber | nullLimiar de pontuação usado nesta verificação (configuração da org naquele momento).

​
Respostas de erro

CódigoHTTPDescrição
NOT_FOUND404O ID da verificação não existe ou pertence a outra organização.
UNAUTHORIZED401API key ou contexto de organização ausente ou inválido.

​
Exemplo

const id = 'a1b2c3d4-e5f6-7890-abcd-ef1234567890';
const response = await fetch(`https://api.gu1.ai/api/kyc/face-match/verifications/${id}`, {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' },
});
const verification = await response.json();

​
Próximos passos

Face Match (POST)

Verificar documento + selfie em uma chamada

Listar validações

Listar validações KYC por entidade