Skip to main content
POST
http://api.gu1.ai
/
api
/
kyc
/
validations
Criar Validação KYC
curl --request POST \
  --url http://api.gu1.ai/api/kyc/validations \
  --header 'Authorization: Bearer <token>'
{
  "providerSessionUrl": "<string>",
  "status": "<string>"
}

​
Resumo

Este endpoint cria uma nova sessão de validação KYC para uma entidade pessoa. Após criar a validação, você receberá uma URL de verificação que pode compartilhar com seu cliente.

​
Pré-requisitos

Antes de criar uma validação KYC:
  1. A entidade pessoa deve existir: Crie uma entidade pessoa usando a API de Entidades
  2. Integração KYC configurada: Sua organização deve ter a integração KYC habilitada
  3. API key válida: Autentique com sua chave API

​
Solicitação

​
Endpoint

POST https://api.gu1.ai/api/kyc/validations

​
Headers

{
  "Authorization": "Bearer SUA_API_KEY",
  "Content-Type": "application/json"
}

​
Parâmetros do Body

​
entityId
string
required
O UUID da entidade pessoa a verificar
​
webhookUrl
string
URL webhook personalizada para esta validação (opcional, usa o da organização por padrão)
​
metadata
object
Metadata personalizada para anexar a esta validação (máx 10KB)

​
Resposta

​
Resposta Bem-sucedida (201 Created)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "org_abc123",
  "sessionId": "session_xyz789",
  "status": "pending",
  "provider": "kyc_provider",
  "providerSessionUrl": "https://verify.example.com/session_xyz789",
  "isCurrent": true,
  "createdAt": "2025-01-15T10:30:00Z"
}

​
Campos de Resposta

​
providerSessionUrl
string
A URL de verificação para compartilhar com seu cliente
​
status
string
Status atual: pending, in_progress, approved, rejected, expired, abandoned

​
Exemplo de Solicitação

const response = await fetch('https://api.gu1.ai/api/kyc/validations', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer SUA_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    entityId: '123e4567-e89b-12d3-a456-426614174000',
    metadata: {
      userId: 'user_12345',
      source: 'mobile_app'
    }
  })
});

const validation = await response.json();
console.log('URL de verificação:', validation.providerSessionUrl);

​
Próximos Passos

Obter URL de KYC

Aprenda como recuperar a URL

Integração Webhook

Configure notificações webhook