> ## 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.

# Visão geral da API de KYC da gu1

> Visão geral da API de KYC da gu1: verifique a identidade de pessoas via API, crie validações KYC, gere links e acompanhe resultados no painel.

## O que é KYC (Conheça Seu Cliente)?

Know Your Customer (KYC) é o processo de verificação de identidade de clientes individuais antes de estabelecer um relacionamento comercial. A solução KYC da gu1 permite integrar a verificação de identidade em sua aplicação, permitindo que seus usuários finais concluam o processo de verificação de forma fluida.

## Abordagem API-First

Nossa API de KYC permite:

* **Criar validações KYC programaticamente** para seus clientes
* **Gerar URLs de verificação** para compartilhar com seus usuários
* **Receber notificações webhook em tempo real** quando a verificação for concluída
* **Consultar o status de validação** a qualquer momento

## Fluxo de Integração Típico

<Steps>
  <Step title="Criar Entidade Pessoa">
    Crie uma entidade pessoa na gu1 com as informações básicas do seu cliente
  </Step>

  <Step title="Iniciar Validação KYC">
    Chame a API para criar uma validação KYC e receba uma URL de verificação
  </Step>

  <Step title="Compartilhar URL com o Cliente">
    Envie a URL de verificação ao seu cliente por email, SMS ou integre em seu app
  </Step>

  <Step title="Cliente Completa a Verificação">
    Seu cliente segue a URL e completa o processo de verificação de identidade
  </Step>

  <Step title="Receber Notificação Webhook">
    A gu1 envia um webhook ao seu sistema quando a verificação estiver completa
  </Step>

  <Step title="Verificar Status">
    Consulte a API para obter os resultados finais de verificação e a decisão
  </Step>
</Steps>

<Info>
  **Webhooks vs Polling Manual**: Embora os webhooks forneçam notificações em tempo real, você também pode verificar manualmente o status de validação a qualquer momento usando `GET /api/kyc/validations/:id`. Isso é útil para:

  * Depuração ou testes sem infraestrutura de webhook
  * Exibir atualizações de status aos usuários em tempo real
  * Recuperar de falhas na entrega de webhook
  * Criar dashboards de administração para monitorar o status de validação
</Info>

## Recursos Principais

### KYC Completo vs Verificações Individuais

<Note>
  **Qual você deve usar?**

  * **KYC Completo** (`global_gueno_validation_kyc`): Verificação de identidade completa incluindo upload de documento, selfie, comparação facial e detecção de vida. **Recomendado para serviços financeiros, bancos e indústrias reguladas.**

  * **Verificações Individuais**: Chamadas de API separadas para verificações específicas como screening PEP, verificação de sanções ou buscas de mídia adversa. **Use quando precisar apenas de pontos de dados específicos ou já tiver documentos de identidade verificados.**
</Note>

| Recurso                    | KYC Completo                  | Verificações Individuais          |
| -------------------------- | ----------------------------- | --------------------------------- |
| **Upload de Documento**    | ✅ Incluído                    | ❌ Não incluído                    |
| **Selfie + Liveness**      | ✅ Incluído                    | ❌ Não incluído                    |
| **Comparação Facial**      | ✅ Incluído                    | ❌ Não incluído                    |
| **PEP/Sanções**            | ✅ Incluído                    | ✅ Chamada de API separada         |
| **Mídia Adversa**          | Add-on opcional               | ✅ Chamada de API separada         |
| **Experiência do Usuário** | Fluxo único para o usuário    | Sem interação do usuário          |
| **Melhor Para**            | Abertura de conta, onboarding | Monitoramento contínuo, screening |
| **Endpoint API**           | `POST /api/kyc/validations`   | `POST /entities/:id/analyze`      |

### Verificação de Identidade Abrangente (KYC Completo)

* **Validação de Documento**: Autentica documentos de identidade emitidos pelo governo
* **Verificação Biométrica**: Reconhecimento facial e detecção de vida
* **Comparação Facial**: Compara selfie com a foto do documento (veja nota de segurança abaixo)
* **Screening AML/Sanções**: Verifica contra listas de vigilância globais
* **Extração de Dados**: Extrai e verifica informações pessoais

<Warning>
  **Por Que a Comparação Facial é Crítica para Bancos e Fintech**

  A comparação facial (comparar uma selfie ao vivo com a foto em um documento de identidade) é **essencial para instituições financeiras reguladas** porque:

  1. **Previne Roubo de Identidade**: Confirma que a pessoa apresentando o documento é o proprietário legítimo, não alguém usando um documento roubado/falso
  2. **Requisito Regulatório**: A maioria dos reguladores financeiros (FinCEN, FCA, FATF) exige verificação biométrica para onboarding remoto
  3. **Prevenção de Fraude**: Detecta ataques de apresentação (segurar uma foto impressa, ataques de replay de vídeo, deepfakes)
  4. **Detecção de Vida**: Garante que uma pessoa real está presente, não uma imagem estática ou vídeo
  5. **Trilha de Auditoria**: Fornece prova verificável de identidade para investigações de conformidade

  **Quando a comparação facial é obrigatória?**

  * ✅ Bancos digitais e neobanks
  * ✅ Exchanges e carteiras de criptomoedas
  * ✅ Provedores de serviços de pagamento (PSPs)
  * ✅ Plataformas de empréstimo e financiamento peer-to-peer
  * ✅ Qualquer serviço que transmita dinheiro ou mantenha fundos de clientes

  **Quando você pode pular?**

  * ❌ Marketplaces de baixo risco (não financeiros)
  * ❌ Serviços onde você verifica identidade presencialmente
  * ❌ Monitoramento contínuo de clientes existentes (use apenas PEP/sanções)

  Se você não tiver certeza se seu caso de uso requer comparação facial, consulte sua equipe de conformidade ou assessor jurídico.
</Warning>

### Processamento Automático de Documentos

* **Tecnologia OCR**: Extrai automaticamente dados de documentos de identidade
* **Suporte Multi-idioma**: Processa documentos em mais de 100 idiomas
* **Autenticação de Documentos**: Detecta documentos falsos ou adulterados
* **Extração de Dados**: Incorpora informações verificadas ao seu sistema

### Webhooks em Tempo Real

* **Notificações Instantâneas**: Receba atualizações assim que a verificação for concluída
* **Mudanças de Status**: Notificações de aprovação, rejeição ou revisão manual
* **Entrega Segura**: Assinaturas de webhook para validação de segurança
* **Lógica de Retentativas**: Retentativas automáticas para entregas falhadas

### Pronto para Conformidade

* **Conformidade AML/CFT**: Cumpre com requisitos anti-lavagem de dinheiro
* **Conformidade GDPR**: Padrões de proteção de dados e privacidade
* **Registro de Auditoria**: Histórico completo de tentativas de verificação
* **Retenção de Dados**: Políticas de retenção configuráveis

## Casos de Uso

### Aplicações Fintech

* **Banco Digital**: Verifica usuários durante abertura de conta
* **Apps de Pagamento**: Cumpre com regulações financeiras
* **Plataformas de Empréstimo**: Verifica identidade de mutuários
* **Exchanges de Cripto**: Cumpre requisitos KYC para traders

### Marketplaces e Plataformas

* **Plataformas P2P**: Verifica compradores e vendedores
* **Economia Compartilhada**: Valida prestadores de serviços
* **Economia Gig**: Incorpora freelancers e contratados
* **Plataformas de Aluguel**: Verifica inquilinos e anfitriões

## Documentos Suportados

Nossa solução KYC aceita vários documentos de identidade de um amplo conjunto de países que a Gu1 pode habilitar para a sua organização:

* Carteiras de identidade nacional
* Passaportes
* Carteiras de motorista
* Autorizações de residência
* Documentos emitidos pelo governo

### Países que a Gu1 pode habilitar para validação KYC

A cobertura documental depende do país emissor. A Gu1 pode habilitar a validação KYC para os países abaixo (agrupados por continente). Contate a Gu1 para ativar o conjunto que corresponde aos seus mercados.

<AccordionGroup>
  <Accordion title="América do Norte, América Central e Caribe">
    Anguilla; Antigua and Barbuda; Aruba; Bahamas; Barbados; Belize; Bermuda; Bonaire, Sint Eustatius and Saba; Canada; Cayman Islands; Costa Rica; Cuba; Curaçao; Dominica; Dominican Republic; El Salvador; Greenland; Grenada; Guatemala; Haiti; Honduras; Jamaica; Mexico; Montserrat; Nicaragua; Panama; Puerto Rico; Saint Kitts and Nevis; Saint Lucia; Saint Martin (French part); Saint Vincent and the Grenadines; Sint Maarten (Dutch part); Trinidad and Tobago; Turks and Caicos Islands; United States of America; Virgin Islands (British); Virgin Islands (U.S.)
  </Accordion>

  <Accordion title="América do Sul">
    Argentina; Bolivia; Brazil; Chile; Colombia; Ecuador; Falkland Islands (Malvinas); Guyana; Paraguay; Peru; Suriname; Uruguay; Venezuela
  </Accordion>

  <Accordion title="África">
    Algeria; Angola; Benin; Botswana; Burkina Faso; Burundi; Cameroon; Cape Verde; Central African Republic; Chad; Comoros; Côte d'Ivoire; Democratic Republic of the Congo; Djibouti; Egypt; Equatorial Guinea; Eritrea; Eswatini; Ethiopia; Gabon; Ghana; Guinea; Guinea-Bissau; Kenya; Lesotho; Liberia; Libya; Madagascar; Malawi; Mali; Mauritania; Mauritius; Morocco; Mozambique; Namibia; Niger; Nigeria; Republic of the Congo; The Gambia; Rwanda; Saint Helena; Sao Tome and Principe; Senegal; Seychelles; Sierra Leone; Somalia; South Africa; South Sudan; Sudan; Tanzania; Togo; Tunisia; Uganda; Western Sahara; Zambia; Zimbabwe
  </Accordion>

  <Accordion title="Ásia">
    Abkhazia; Afghanistan; Armenia; Azerbaijan; Bahrain; Bangladesh; Bhutan; Brunei Darussalam; Cambodia; China; Christmas Island; Cocos (Keeling) Islands; Hong Kong; India; Indonesia; Iraq; Iran (Islamic Republic of); Israel; Japan; Jordan; Kazakhstan; Kuwait; Kyrgyzstan; Lao People's Democratic Republic; Lebanon; Macao; Malaysia; Maldives; Mongolia; Myanmar; Nepal; North Korea; Oman; Pakistan; Palestine; Philippines; Qatar; Russia; Saudi Arabia; Singapore; South Korea; Sri Lanka; Syrian Arab Republic; Taiwan; Tajikistan; Thailand; Timor-Leste; Turkey; Turkmenistan; United Arab Emirates; Uzbekistan; Vietnam; Yemen
  </Accordion>

  <Accordion title="Oceania">
    American Samoa; Australia; Cook Islands; Fiji; French Polynesia; Guam; Kiribati; Marshall Islands; Micronesia (Federated States of); Nauru; New Caledonia; New Zealand; Niue; Northern Mariana Islands; Palau; Papua New Guinea; Samoa; Solomon Islands; Tonga; Tuvalu; Vanuatu
  </Accordion>
</AccordionGroup>

<Note>
  A disponibilidade de tipos de documento específicos (documento de identidade, passaporte, carteira de motorista, etc.) pode variar por país. A Gu1 habilita o conjunto de países da sua organização no onboarding ou sob demanda.
</Note>

## Começando

Pronto para integrar verificação KYC em sua aplicação?

<CardGroup cols={2}>
  <Card title="Criar Validação KYC" icon="play" href="/pt/use-cases/kyc/create-validation">
    Iniciar uma nova sessão de verificação
  </Card>

  <Card title="Obter URL de Verificação" icon="link" href="/pt/use-cases/kyc/get-kyc-url">
    Obter a URL para compartilhar com usuários
  </Card>

  <Card title="Integração de Webhooks" icon="webhook" href="/pt/use-cases/kyc/webhook-integration">
    Receber notificações em tempo real
  </Card>

  <Card title="Verificar Status" icon="magnifying-glass" href="/pt/use-cases/kyc/check-status">
    Consultar resultados de verificação
  </Card>
</CardGroup>

## Resumo de Endpoints API

| Endpoint                               | Método | Descrição                               | Caso de Uso                                              |
| -------------------------------------- | ------ | --------------------------------------- | -------------------------------------------------------- |
| `/api/kyc/validations`                 | POST   | Criar uma nova validação KYC            | Iniciar processo de verificação                          |
| `/api/kyc/validations/{id}`            | GET    | Obter status e detalhes de validação    | **Polling manual** - verificar status a qualquer momento |
| `/api/kyc/entities/{entityId}/current` | GET    | Obter validação atual para uma entidade | Recuperar validação ativa                                |
| `/api/kyc/webhooks`                    | POST   | Receber notificações webhook            | **Automático** - ser notificado quando completo          |

<Tip>
  **Melhor Prática**: Use webhooks para produção para receber notificações instantâneas, mas também implemente `GET /api/kyc/validations/{id}` como fallback para:

  * Verificação de status inicial após a criação
  * Atualização iniciada pelo usuário em sua UI
  * Recuperação de falha de webhook
  * Ferramentas de administração/suporte
</Tip>

## Próximos Passos

1. [Crie sua primeira validação KYC](/pt/use-cases/kyc/create-validation)
2. [Aprenda sobre integração de webhooks](/pt/use-cases/kyc/webhook-integration)
3. [Obtenha suas credenciais API](https://app.gu1.ai/org-api-keys)
