> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API de comprovante de endereço com contas de consumo

> A Didit verifica endereços residenciais com extração por IA de contas de consumo, extratos bancários e documentos oficiais. $0.20 por chamada.

A verificação de comprovante de endereço (PoA) da Didit permite confirmar o endereço residencial de um usuário por meio de documentos oficiais. O recurso simplifica o processo de verificação de endereço e permite que os usuários capturem ou enviem documentos que comprovem o endereço.

Prompt de integração do comprovante de endereço
        Copy prompt to clipboard



      
      

\<pre>

\````# Goal
Integrate Didit Proof of Address (utility bill, bank statement, government letter OCR + cross-checks) into your app. Pick ONE mode.

\# Mode A — Session-based
Use this when the user uploads the document in a hosted Didit flow.

1\. Add the PROOF_OF_ADDRESS feature to the workflow (Business Console or POST /v3/workflows/). Configure: poa_languages_allowed, poa_document_age_months, and the per-risk actions (poa_issuer_not_identified_action, poa_name_mismatch_action, poa_address_mismatch_action, poa_document_expired_action, poa_language_not_allowed_action).
2\. Create a session — POST /v3/session/ with { workflow_id, vendor_data, callback }. See /sessions-api/create-session.
3\. Open session.url for the user (or mount the Web/Mobile SDK).
4\. Fetch the decision — GET /v3/session/{sessionId}/decision/ or subscribe to session.status.updated.

Decision surface: `poa_verifications[]` array on the decision payload.

\# Mode B — Standalone API (server-to-server)
Use when you already have the document and want a one-shot check decoupled from a hosted flow.

POST https://verification.didit.me/v3/poa/
multipart/form-data — x-api-key: YOUR_API_KEY

Latency: OCR typically takes 5–15s (up to ~30s for multi-page PDFs). Use a client timeout of **at least 45s**. Max upload 15 MB (PDF, JPG, PNG, TIFF, WebP). Encrypted PDFs require `document_password` or you get HTTP 400 with `code: "encrypted_pdf"`.

curl example:
\```bash
curl -X POST 'https://verification.didit.me/v3/poa/' \
-H "x-api-key: $DIDIT_API_KEY" \
-F "document=@./utility-bill.pdf" \
-F "expected_address=Av. Monseñor Tavella 3396, Salta" \
-F "expected_country=ARG" \
-F "expected_first_name=Sophia" \
-F "expected_last_name=Martinez" \
-F "poa_languages_allowed=en,es" \
-F "vendor_data=user-1234"
\```
Returns: { request_id, poa: { status, parsed_address, document_type, issuer, issue_date, language, document_metadata: { overlay_manipulation }, warnings: [...] } }.

\# Status enum (per poa_verifications[].status / poa.status)
"Not Started" | "In Progress" | "Approved" | "In Review" | "Declined" | "Abandoned" | "Kyc Expired"

\# Warnings (LogWarningChoices.PROOF_OF_ADDRESS)
warnings[] risk codes include:
ISSUER_NOT_IDENTIFIED, LANGUAGE_NOT_ALLOWED, DOCUMENT_EXPIRED, DOCUMENT_TOO_OLD, NAME_MISMATCH, ADDRESS_MISMATCH, COUNTRY_MISMATCH, OVERLAY_MANIPULATION_DETECTED, UNREADABLE_DOCUMENT.
Full catalogue: /core-technology/proof-of-address/warnings-proof-of-address.

\# Failure modes to handle
\- HTTP 400 with `code: "encrypted_pdf"` — the PDF is password-protected (or the password is wrong); supply the right `document_password` or a decrypted copy.
\- HTTP 400 with `code: "document_unreadable"` — the file is corrupt or cannot be opened; ask the user for a different file. Branch on `code`, not on the message text.
\- HTTP 403 — out of credits.
\- Client timeout — bump to 45s+ before retrying.
\- status="Declined" with NAME_MISMATCH / ADDRESS_MISMATCH — the extracted fields don't match expected_*; do not approve.
\- OVERLAY_MANIPULATION_DETECTED — PDF forensics caught edits; reject.

\# See also
\- Canonical schema: /reference/data-models#proof-of-address
\- Per-feature report: /core-technology/proof-of-address/report-proof-of-address
\- Risk catalogue: /core-technology/proof-of-address/warnings-proof-of-address
\- Full integration playbook: /integration/integration-prompt````

\</pre>



      
      

Paste into

A lição da Academy sobre como ler o resultado de uma verificação chega à verificação de comprovante de endereço aos 7:20.[Comprovante de endereço — Didit Academy](https://www.youtube.com/embed/7htTWCWsl60?start=440\&rel=0\&playsinline=1)## Como funcionaA verificação de comprovante de endereço da Didit oferece uma solução robusta para verificar o endereço residencial de um usuário por meio de documentação oficial. Nossa solução combina IA avançada, visão computacional e verificações de segurança abrangentes para entregar uma verificação de endereço rápida e confiável em escala.**1. Captura inteligente do documento**Os usuários podem verificar o endereço por meio de:| Método | Descrição |
| - | - |
| **Captura automática** | Nossa IA detecta automaticamente o posicionamento ideal do documento e o captura de forma automática no momento certo |
| **Opção de envio** | Os usuários podem enviar documentos existentes em vários formatos (PDF, JPG, PNG) |
| **Suporte a várias páginas** | Lida sem problemas com documentos de várias páginas, como extratos bancários |**2. Extração e verificação avançadas de dados**Recursos de processamento poderosos:- OCR de alta precisão para extrair as informações de endereço
- Classificação inteligente de documentos para identificar os tipos de documento
- Correspondência de nomes com documentos de identidade para verificação cruzada
- Extração da data de emissão e validação conforme os requisitos configurados
- Correspondência de formato e de padrões em todos os campos de endereço**3. Validação abrangente**Nosso sistema baseado em IA executa verificações extensas:| Verificação | Descrição |
| - | - |
| **Autenticidade do documento** | Verificação da legitimidade do documento |
| **Detecção de adulteração** | Análise de integridade da imagem para detectar manipulação |
| **Padronização do endereço** | Formatação e normalização dos campos de endereço |
| **Geocodificação** | Fornecimento das coordenadas de localização a partir do endereço extraído |
| **Detecção de idioma** | Identificação e validação do idioma do documento |**4. Entrega fluida dos resultados**Acesse os resultados da verificação por vários canais:- Atualizações do painel em tempo real
- Notificações instantâneas por webhook
- Integração por API RESTful
- Relatórios completos com informações detalhadas da sessão de verificação## Requisitos do documentoPara garantir uma verificação de endereço bem-sucedida, os documentos devem atender a estes critérios:#### Tipos de documento aceitosA tabela a seguir lista os tipos de documento aceitos e seus respectivos subtipos. Todos os documentos devem ter sido emitidos nos últimos 3 meses, salvo indicação em contrário.| Tipo de documento | Subtipos |
| - | - |
| **Conta de consumo** | Conta de luz, conta de água, conta de gás, conta de internet, conta de telefone, conta de TV a cabo, conta de TV por satélite, conta de coleta de lixo, conta de esgoto, conta de aquecimento, conta combinada de serviços, conta de serviços municipais |
| **Extrato bancário** | Extrato de conta, extrato de cartão de crédito, carta do banco confirmando o endereço, extrato de financiamento imobiliário, extrato de empréstimo, extrato de conta poupança, extrato de conta corrente, extrato de conta de investimento, extrato de conta empresarial, extrato de cooperativa de crédito, extrato de cartão de débito, extrato de linha de crédito |
| **Documento emitido pelo governo** | Avaliação de impostos, título de eleitor, documento de identidade, certidão de residência, carta/notificação do governo, carta de censo, certidão de registro individual, cobrança de imposto sobre propriedade, registro de veículo, extrato da previdência social, carta de seguro-desemprego, carta de benefício por incapacidade, extrato de aposentadoria, intimação judicial, convocação para júri, alvará municipal, documento de imigração |
| **Outro comprovante de endereço** | Contrato de locação, contrato de aluguel, carta do empregador confirmando o endereço, apólice de seguro, carta de matrícula escolar, declaração notarial de endereço, carta de advogado confirmando o endereço, extrato de financiamento estudantil, documento judicial confirmando o endereço, apólice de seguro residencial do proprietário, apólice de seguro residencial do locatário, apólice de seguro de automóvel, extrato de plano de saúde, conta médica, conta hospitalar, conta de serviço por assinatura, extrato de mensalidade de academia, carta da administradora do imóvel, extrato de associação de proprietários, histórico acadêmico universitário, comprovante de matrícula universitária, holerite, declaração de vínculo empregatício, extrato de conta de previdência, extrato de conta de corretora |#### Disponibilidade por paísPor padrão, o comprovante de endereço é compatível com os mesmos países e territórios da verificação de identidade, incluindo as Ilhas Turks e Caicos (`TCA`) e Tuvalu (`TUV`). Todos os países compatíveis oferecem as quatro categorias de documento listadas acima. Você pode restringir essa cobertura padrão nas configurações de comprovante de endereço do seu fluxo.> [!NOTE]
>
> Se um fluxo existente não mostrar um país recém-compatível, abra as configurações de comprovante de endereço dele e salve-as novamente para atualizar a configuração de países permitidos do fluxo.![Tipos de documento aceitos como comprovante de endereço na Didit - contas de consumo, extratos bancários e documentos do governo](https://mintcdn.com/didit-0f962782/z6T2GHM4Zh-iSj-K/images/proof-of-address-id-table.png?fit=max\&auto=format\&n=z6T2GHM4Zh-iSj-K\&q=85\&s=b065b2bb6f64408442b49d89ab16cb46)#### Requisitos gerais- Documento válido, dentro de 90 dias da data de emissão
- Fisicamente íntegro (sem danos, arranhões ou manchas)
- Informações de endereço completas e claramente visíveis
- Nome e logotipo do emissor do documento visíveis
- O nome no documento deve corresponder à identidade verificada do usuário
- Diferente do documento de identidade (não pode ser o mesmo documento usado na verificação de identidade)#### Requisitos da imagem- Documento original capturado em tempo real ou escaneado em alta qualidade
- Formatos compatíveis: JPG, JPEG, PNG, TIFF, PDF
- Tamanho máximo do arquivo: 15MB
- Imagem totalmente colorida, com todos os cantos visíveis
- Sem edição ou manipulação digital
- Todas as páginas incluídas em documentos de várias páginas


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.