Skip to main content

​
Resumo

Após um cliente completar sua verificação KYC, você pode consultar os resultados para verificar o status, dados extraídos e detalhes de decisão.
Embora você possa consultar esta API, recomendamos fortemente usar webhooks para receber notificações em tempo real quando a verificação for concluída.

​
Obter Validação por ID

GET https://api.gu1.ai/api/kyc/validations/{id}

​
Exemplo

const validationId = '550e8400-e29b-41d4-a716-446655440000';

const response = await fetch(
  `https://api.gu1.ai/api/kyc/validations/${validationId}`,
  {
    headers: {
      'Authorization': 'Bearer SUA_API_KEY'
    }
  }
);

const validation = await response.json();

console.log('Status:', validation.status);
console.log('Verificado:', validation.status === 'approved');

if (validation.status === 'approved') {
  console.log('Dados verificados:', validation.extractedData);
}

​
Obter Validação Atual para Entidade

GET https://api.gu1.ai/api/kyc/entities/{entityId}/current

​
Obter Status KYC da Entidade

GET https://api.gu1.ai/api/kyc/entities/{entityId}/status

​
Resposta

{
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "hasKyc": true,
  "isVerified": true,
  "currentValidation": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "approved",
    "verifiedAt": "2025-01-15T11:00:00Z"
  },
  "lastVerifiedAt": "2025-01-15T11:00:00Z",
  "needsReverification": false
}

​
Valores de Status

  • pending - Aguardando cliente iniciar
  • in_progress - Cliente completando verificação
  • approved - Verificação bem-sucedida
  • rejected - Verificação falhou
  • expired - Sessão expirou
  • abandoned - Cliente não completou

​
Padrões de Integração Comuns

​
Padrão 1: Verificar Antes de Permitir Ação

async function requererVerificacao(entityId) {
  const status = await fetch(
    `https://api.gu1.ai/api/kyc/entities/${entityId}/status`,
    { headers: { 'Authorization': 'Bearer SUA_API_KEY' } }
  ).then(r => r.json());

  if (!status.isVerified) {
    throw new Error('Cliente deve completar verificação de identidade');
  }

  return true;
}

​
Melhores Práticas

Em vez de verificar repetidamente o status, use webhooks para receber notificações em tempo real.
Armazene o status de verificação no seu banco de dados e atualize-o via webhooks.
As verificações podem expirar. Verifique needsReverification e solicite aos clientes reverificar quando necessário.

​
Próximos Passos

Criar Validação KYC

Iniciar nova sessão de verificação

Integração Webhook

Obter notificações em tempo real