Skip to main content
GET
http://api.gu1.ai
/
api
/
kyc
/
id-verification
/
verifications
Obter ID Verification (Listagem, Uma, Imagens)
curl --request GET \
  --url http://api.gu1.ai/api/kyc/id-verification/verifications \
  --header 'Authorization: Bearer <token>'

​
Resumo

Cada envio via POST ID Verification é armazenado para auditoria. Você pode:
  1. Listar verificações (com filtros opcionais: entityId, withoutEntity, status, paginação).
  2. Obter uma verificação por ID (o mesmo UUID que verificationId na resposta do POST).
  3. Obter as imagens armazenadas (frente/verso do documento) quando a verificação tiver caminhos de armazenamento.
Todos os endpoints estão limitados à sua organização. Nas respostas não é mencionado nenhum provedor externo.

​
1. Listar verificações

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

​
Parâmetros de query

ParâmetroTipoDescrição
entityIdstring (UUID)Opcional. Filtrar por entidade pessoa.
withoutEntitybooleanSe true, apenas verificações sem entidade associada.
statusstringOpcional. approved | declined | failed.
limitnumberMáximo de itens (padrão 50, máx. 100).
offsetnumberDeslocamento para paginação.

​
Resposta (200 OK)

{
  "verifications": [
    {
      "id": "uuid",
      "organizationId": "uuid",
      "entityId": "uuid | null",
      "status": "approved",
      "requestId": "string | null",
      "vendorData": "string | null",
      "errorMessage": "string | null",
      "warnings": ["string"],
      "extractedData": { },
      "createdAt": "ISO8601",
      "documentFrontStoragePath": "string | null",
      "documentBackStoragePath": "string | null",
      "storageProvider": "s3 | local | null"
    }
  ],
  "pagination": { "limit", "offset", "total" }
}

​
2. Obter uma verificação

GET https://api.gu1.ai/api/kyc/id-verification/verifications/:id
Retorna um registro de auditoria por ID. Use o verificationId da resposta do POST ou da listagem.

​
Parâmetros de path

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

​
Resposta (200 OK)

Mesmo formato de um item da listagem. 404 se não existir ou não pertencer à sua organização.

​
3. Obter imagens do documento armazenadas

Quando a verificação tem documentFrontStoragePath ou documentBackStoragePath, você pode obter os bytes da imagem: 
GET https://api.gu1.ai/api/kyc/id-verification/verifications/:id/document-front-image
GET https://api.gu1.ai/api/kyc/id-verification/verifications/:id/document-back-image

​
Parâmetros de path

​
id
string
required
UUID da verificação.

​
Resposta

  • 200: Corpo da imagem (ex. Content-Type: image/jpeg).
  • 404: Verificação não encontrada ou essa imagem não foi armazenada.

​
Headers

Em todas as solicitações: 
Authorization: Bearer SUA_API_KEY
Inclua X-Organization-Id se sua conta for limitada por organização.

​
Erros

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

​
Exemplo

const response = await fetch(
  'https://api.gu1.ai/api/kyc/id-verification/verifications?limit=20',
  { headers: { 'Authorization': 'Bearer SUA_API_KEY' } }
);
const { verifications, pagination } = await response.json();

​
Próximos passos

ID Verification (POST)

Enviar frente/verso e obter validação

Face Match

Comparar documento e selfie