Skip to main content

Visão Geral

Nossa solução hospedada é uma página segura e totalmente personalizável de KYC e verificação de identidade que permite verificar seus clientes rapidamente sem código. A página de onboarding hospedada é a maneira mais rápida de começar com a verificação KYC.
Design Mobile-Responsive: A página hospedada é totalmente responsiva e otimizada para todos os dispositivos (desktop, tablet e mobile). Seus usuários terão uma experiência de verificação perfeita independentemente do dispositivo que usarem.

Como Funciona

Parâmetros de Personalização

Você pode personalizar a página de onboarding usando estes parâmetros:

Personalização de Marca e Visual

domain
string
A página web pode ser hospedada em seu próprio domínio
lang
string
default:"en"
O idioma padrão da página. Valores suportados: en, es, pt
icon
string
O ícone da página (favicon)
O logo principal exibido na página

Personalização de Cores

Todos os parâmetros de cor aceitam códigos hexadecimais (ex., #6366f1):
headersColor
string
Código hex para a cor dos cabeçalhos
paragraphsColor
string
Código hex para a cor dos parágrafos
supportTextsColor
string
Código hex para a cor dos textos de suporte
backgroundColor
string
Código hex para a cor de fundo
pillsColor
string
Código hex para a cor das pílulas
progressBarColor
string
Código hex para a cor da barra de progresso
primaryButtonColor
string
Código hex para a cor do botão primário
secondaryButtonColor
string
Código hex para a cor do botão secundário
selectorColor
string
Código hex para a cor do seletor
primaryButtonTextColor
string
Código hex para a cor do texto do botão primário
secondaryButtonTextColor
string
Código hex para a cor do texto do botão secundário
borderRadius
number
Raio da borda web. Número entre 0 e 50

Configuração de Regras de Validação

Você pode personalizar as regras de validação usando estes parâmetros:

Verificação de Idade

Exclude By Age
number
Rejeita automaticamente todas as sessões realizadas por usuários menores de certa idade. Número entre 1 e 100

Captura de Documentos

Capture Method
string
Selecione os métodos permitidos para as imagens:
  • Camera - Apenas captura com câmera
  • Upload - Apenas upload de arquivos
  • Both - Permitir ambos os métodos

Detecção de Duplicados

Duplicated users
string
Quando um usuário tem documentos previamente aprovados da mesma aplicação, você pode definir uma regra automática:
  • Approve - Aprovar automaticamente
  • Review - Enviar para revisão manual
  • Decline - Rejeitar automaticamente

Regras de Validação de Documentos

QR / barcode
string
Se um código de barras ou QR era esperado no documento mas não pôde ser lido, você pode definir uma regra automática:
  • Approve - Aprovar automaticamente
  • Review - Enviar para revisão manual
  • Decline - Rejeitar automaticamente
MRZ not valid
string
Quando uma Zona de Leitura Mecânica (MRZ) é esperada no documento mas não pode ser lida:
  • Approve - Aprovar automaticamente
  • Review - Enviar para revisão manual
  • Decline - Rejeitar automaticamente
Expiration date
string
Quando a data de validade do documento é esperada mas não pode ser lida ou está em formato inválido:
  • Approve - Aprovar automaticamente
  • Review - Enviar para revisão manual
  • Decline - Rejeitar automaticamente
Invalid validation
string
Este problema surge quando não conseguimos validar uma data, detectar um número de documento ou reconhecer com precisão o documento:
  • Review - Enviar para revisão manual
  • Decline - Rejeitar automaticamente
Invalid document liveness
string
Este problema surge quando não conseguimos validar a vivacidade do documento:
  • Approve - Aprovar automaticamente
  • Review - Enviar para revisão manual
  • Decline - Rejeitar automaticamente
Address not processed
string
Este problema surge quando o endereço no documento não pôde ser encontrado ou geolocalizado, provavelmente devido a um endereço inválido ou ausente:
  • Approve - Aprovar automaticamente
  • Review - Enviar para revisão manual
  • Decline - Rejeitar automaticamente
Estes parâmetros de validação devem ser comunicados à equipe da Gu1 através do seu canal de suporte dedicado. Se você precisar fazer alterações ou modificações a estes parâmetros, por favor envie uma solicitação através do seu canal de suporte dedicado do cliente. No futuro, estes parâmetros serão editáveis no painel da Gu1.

Como Obter a URL da Página de Onboarding?

1

Criar uma entidade pessoa

Crie uma entidade do tipo pessoa na Gu1 pela API de Entidades (nome, taxId, countryCode).Aprenda como criar uma entidade →
2

Criar uma validação KYC

Crie uma sessão de validação KYC para essa entidade com POST /api/kyc/validations usando o ID da entidade e integrationCode (ex.: global_gueno_validation_kyc).Aprenda como criar uma validação →
3

Obter o providerSessionUrl

Recupere o providerSessionUrl da resposta da validação. É a URL da página hospedada que você compartilha com seu cliente.
4

Compartilhar com seu cliente

Compartilhe o providerSessionUrl com seu cliente por e-mail, SMS ou incorporado em sua aplicação.

Exemplo de Implementação

// 1. Criar uma entidade pessoa (API de Entidades)
const entityRes = await fetch('https://api.gu1.ai/api/entities', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer SUA_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    type: 'person',
    name: 'João Silva',
    taxId: '12345678900',
    countryCode: 'BR',
    entityData: { person: { email: 'joao@exemplo.com' } }
  })
});
const entityData = await entityRes.json();
const entityId = entityData.entity?.id ?? entityData.id;

// 2. Criar uma sessão de validação KYC
const validationRes = 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,
    integrationCode: 'global_gueno_validation_kyc'
  })
});
const validationData = await validationRes.json();

// 3. Obter a URL da página hospedada (providerSessionUrl)
const hostedPageUrl = validationData.providerSessionUrl;
console.log('Compartilhe esta URL com seu cliente:', hostedPageUrl);

// 4. Compartilhar com o cliente (por e-mail, SMS, etc.)
await sendEmail({
  to: 'joao@exemplo.com',
  subject: 'Complete sua Verificação de Identidade',
  body: `Por favor complete sua verificação aqui: ${hostedPageUrl}`
});

Melhores Práticas

Configure o esquema de cores, logo e idioma para combinar com a identidade da sua marca. Isso cria uma experiência perfeita para seus usuários.
Configure as regras de validação com base em seus requisitos de conformidade e tolerância ao risco. Regras mais rigorosas fornecem melhor segurança, mas podem resultar em mais revisões manuais.
Use webhooks para receber notificações em tempo real quando a verificação for concluída. Isso permite que você atualize imediatamente o acesso do usuário em seu sistema.
Expiração de Sessões: As sessões normalmente expiram após 7 dias. Se a sessão de um usuário expirar, crie uma nova validação para gerar uma URL nova.Melhores Práticas de Segurança:
  • Nunca exponha o providerSessionUrl publicamente (não compartilhe em fóruns públicos, URLs públicas, etc.)
  • Sempre gere URLs do lado do servidor - nunca exponha as chaves de API no código do lado do cliente
  • Use HTTPS ao compartilhar URLs através de seus próprios sistemas
  • Implemente autenticação adequada antes de gerar sessões para usuários
  • Considere implementar rate limiting na criação de sessões para prevenir abuso
  • Armazene os IDs de validação em seu banco de dados vinculados a registros de usuários para trilhas de auditoria

Próximos Passos

Criar Entidade

Aprenda como criar uma entidade de pessoa

Criar Validação

Crie uma sessão de validação KYC

Integração de Webhooks

Receba atualizações de status em tempo real

Integração de Cliente

Incorpore em sua aplicação móvel ou web