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

Documentation Index

Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
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).
Para baixar os bytes da frente/verso armazenados, use Obter imagens ID Verification. Todos os endpoints estão limitados à sua organização. Cada item da listagem/detalhe usa a mesma forma de extractedData do POST (ver campos de extractedData), incluindo extraFields para chaves não promovidas.

​
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": "c3d4e5f6-a7b8-9012-cdef-345678901234",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "entityId": "223e4567-e89b-12d3-a456-426614174001",
      "status": "declined",
      "requestId": "4e2bf9fb-d75b-4b26-9362-e51436cfe1eb",
      "vendorData": "my-ref-001",
      "errorMessage": null,
      "warnings": ["DOCUMENT_EXPIRED", "POSSIBLE_DUPLICATED_USER"],
      "extractedData": {
        "providerStatus": "Declined",
        "fullName": "Breno Henrique Ferreira Silva",
        "firstName": "Breno Henrique",
        "lastName": "Ferreira Silva",
        "firstSurname": "Ferreira",
        "secondSurname": "Silva",
        "documentNumber": "08585626509",
        "personalNumber": "2156732124SSPBA",
        "documentType": "Driver's License",
        "taxNumber": "10584158599",
        "dateOfBirth": "2004-08-29",
        "age": 21,
        "expirationDate": "2025-03-07",
        "dateOfIssue": "2024-03-08",
        "firstIssueDate": "2024-03-08",
        "nationality": "BRA",
        "gender": "U",
        "placeOfBirth": "Barreiras/Ba",
        "maritalStatus": "UNKNOWN",
        "issuingState": "BRA",
        "issuingStateName": "Brazil",
        "warningMeta": {
          "duplicatedSessionId": "a4bfeef8-6d6e-4e9b-8fcb-44950912b2b4",
          "duplicatedSessionNumber": 2834,
          "duplicatedApiService": "ID_VERIFICATION"
        },
        "frontImageQualityScore": {
          "overall_score": 98.2,
          "focus_score": 100,
          "brightness_score": 94,
          "is_document_fully_visible": true
        },
        "backImageQualityScore": { "overall_score": 97.1, "focus_score": 100 },
        "extraFields": { "license_category": "AB", "restrictions": "01" },
        "mrz": {
          "line1": "IDBRA085856265<<<<<<<<<<<<<<<",
          "line2": "0408299M2503077BRA<<<<<<<<<<<6",
          "line3": "SILVA<<BRENO<HENRIQUE<FERREIRA"
        },
        "parsedAddress": {},
        "barcodes": []
      },
      "createdAt": "2026-05-26T14:32:10.123Z",
      "documentFrontStoragePath": "org/.../front.jpg",
      "documentBackStoragePath": "org/.../back.jpg",
      "storageProvider": "s3"
    }
  ],
  "pagination": { "limit": 20, "offset": 0, "total": 1 }
}

​
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 (com extractedData completo). 404 se não existir ou não pertencer à sua organização.

​
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