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

# Documentos do usuário: IDs, POA e arquivos de apoio

> Documentos de identidade, comprovantes de endereço e anexos dos usuários na Didit: o que é coletado, como obter e enviar pelo console.



Prompt de documentos do usuário
        Copiar o prompt para a área de transferência



      
      

\<pre>

\````# Goal — retrieve user documents and generate compliance PDFs

Documents (ID images, MRZ data, selfies, proof-of-address scans, NFC chip reads) are attached to the **session** that captured them, not directly to the User entity. There is no public "upload document to user" API — capture flows through sessions. You can however list sessions for the user, retrieve each session's decision, and pull signed URLs to the document images.

\## Pattern — list sessions for a user, then read each decision

\```bash
\# 1) List sessions tied to the User entity
curl -G https://verification.didit.me/v3/sessions/ \
-H "x-api-key: $DIDIT_API_KEY" \
\--data-urlencode "vendor_data=user-42" \
\--data-urlencode "page_size=50"

\# 2) For each session, retrieve the full decision (V3 plural arrays)
curl https://verification.didit.me/v3/session/$SESSION_ID/decision/ \
-H "x-api-key: $DIDIT_API_KEY"
\```

\## Where documents appear in the V3 decision

Inspect these plural arrays (every per-feature result is plural in V3):

\| Array | Contains |
\|---|---|
\| `id_verifications[]` | Government ID images, OCR fields, MRZ, expiry, issuing country |
\| `liveness_checks[]` | Selfie frames, passive liveness score |
\| `nfc_verifications[]` | NFC chip data, ICAO certificate chain |
\| `proof_of_address_checks[]` | POA document images, extracted address |

Image URLs are short-lived signed URLs — cache the bytes if you need them long-term, or re-fetch the decision when they expire.

\## Generate a PDF report

For a human-readable compliance export (used for SARs, audits, regulator requests):

\```bash
curl https://verification.didit.me/v3/session/$SESSION_ID/generate-pdf/ \
-H "x-api-key: $DIDIT_API_KEY" \
-o session-report.pdf
\```

The PDF includes session details, per-feature results, and embedded document images.

\## Re-verification / new document collection

To collect fresh documents (e.g. expired ID), create a new session for the same `vendor_data` — the new session attaches to the existing User entity:

\```bash
curl -X POST https://verification.didit.me/v3/session/ \
-H "x-api-key: $DIDIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"workflow_id": "$WORKFLOW_ID", "vendor_data": "user-42"}'
\```

\## Failure modes

\- `404` — wrong `session_id` or wrong `vendor_data` casing.
\- Expired signed image URL — re-fetch the decision to get fresh URLs.
\- `403` on PDF — your API key's role lacks PDF export permission.
\- Document monitoring is on by default and sends no warning before a document expires: when the ID's expiry date passes, the Approved session moves to "Kyc Expired" — see /core-technology/id-verification/document-monitoring-id-verification.

\## Response shape

See /reference/data-models for the full per-feature schema. Each plural-array item carries its own `status`, `document_images[]`, OCR extract, and decision metadata.

\## Sources of truth

\- /sessions-api/retrieve-session — decision schema
\- /reference/data-models — V3 plural-array contract
\- /core-technology/id-verification/overview — ID capture behaviour
\- /core-technology/proof-of-address/overview — POA capture
\- /integration/integration-prompt — canonical end-to-end prompt````

\</pre>



      
      

Colar em

Todo documento que um usuário envia durante a verificação fica vinculado permanentemente à sua entidade User. Esta página explica o que é coletado, como recuperar esses dados e como enviar documentos adicionais manualmente.## O que a Didit coleta| Tipo de documento | Quando é coletado | Campos extraídos |
| - | - | - |
| **Documento de identidade oficial** (passaporte, carteira de identidade, carteira de motorista, autorização de residência) | Etapa de [Verificação de identidade](https://docs.didit.me/pt-br/core-technology/id-verification/overview.md) | Nome, data de nascimento, número do documento, país emissor, validade e MRZ, quando houver |
| **Selfie / quadros da prova de vida** | Etapa de [Prova de vida](https://docs.didit.me/pt-br/core-technology/liveness/overview.md) | Maior recorte do rosto, pontuação de prova de vida passiva |
| **Comprovante de endereço (POA)** | Etapa de [Comprovante de endereço](https://docs.didit.me/pt-br/core-technology/proof-of-address/overview.md) | Nome, endereço, emissor, data do documento |
| **Leitura do chip NFC** | Etapa de [Verificação NFC](https://docs.didit.me/pt-br/core-technology/nfc-verification/overview.md) | Dados do chip, cadeia de certificados ICAO, comparação com o OCR |
| **Documentos adicionais** | Solicitação de um analista ou etapas personalizadas do fluxo de verificação (workflow) | OCR quando aplicável; caso contrário, armazenados como estão |[Tipos de documento compatíveis](https://docs.didit.me/pt-br/core-technology/id-verification/supported-documents-id-verification.md) traz a matriz completa de país × documento (14,000+ documentos em 220+ países).## Como recuperar documentosOs documentos ficam associados à **sessão** que os coletou, e não diretamente ao usuário. Para listar todos os documentos de um usuário:**1. Liste as sessões do usuário**```bash theme={null}
curl -G https://verification.didit.me/v3/sessions/ \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "vendor_data=user-42"
```**2. Busque a decisão de cada sessão**A decisão de cada sessão inclui as URLs dos documentos coletados.```bash theme={null}
curl https://verification.didit.me/v3/session/{session_id}/decision/ \
  -H "x-api-key: YOUR_API_KEY"
```Verifique os campos `id_verification.document_images`, `proof_of_address.document_images` e `liveness.images` na resposta.**3. Use URLs assinadas**As URLs das imagens na resposta são URLs assinadas de curta duração. Armazene-as em cache no cliente enquanto estiverem em uso ou busque a decisão novamente quando expirarem.## Como gerar um relatório em PDFPara exportar, em formato legível, tudo o que foi coletado em uma sessão, incluindo todos os documentos, use:**`GET /v3/session/{session_id}/generate-pdf/`**Retorna um PDF com os detalhes da sessão, os resultados dos recursos e as imagens dos documentos incorporadas. É útil para auditorias de conformidade, anexos de SAR e protocolizações regulatórias.## Como enviar documentos pelo consoleOperadores de conformidade podem enviar documentos adicionais vinculados a um usuário ou a uma sessão ativa:1. Acesse *Users → \[usuário] → Documents → Upload document*.
2. Escolha um tipo de documento (identidade, comprovante de endereço, personalizado).
3. Envie um arquivo; o OCR é executado automaticamente para os tipos compatíveis.
4. O documento é anexado à sessão mais recente (ou você pode criar uma sessão de correção).> [!NOTE]
>
> A interface de envio de documentos existe apenas no console: não há endpoint público de API para anexar documentos diretamente a um usuário. Use as sessões como ponto de entrada para toda a captura de documentos.## Cruzamento de documentosQuando uma sessão coleta vários tipos de documento, a Didit faz o cruzamento entre eles:- **Identidade ↔ Prova de vida**: o rosto no documento de identidade corresponde à selfie da prova de vida.
- **Identidade ↔ Comprovante de endereço**: o nome no comprovante de endereço corresponde ao nome extraído do documento de identidade.
- **Identidade ↔ NFC**: os dados da MRZ e os dados visuais correspondem aos dados do chip NFC.As inconsistências aparecem como avisos na decisão da sessão e podem ser configuradas para acionar uma revisão manual.## Monitoramento de documentos e reverificaçãoPara casos de uso que exigem validade contínua dos documentos (por exemplo, documentos de identidade expirados):- **A validade do documento** é acompanhada em todo documento de identidade verificado. Consulte o campo `expiration_date` na decisão da sessão.
- **Monitoramento de documentos**: ativado por padrão e automático, sem nada para habilitar. Quando a data de validade do documento expira, uma sessão `"Approved"` muda para `"Kyc Expired"`, o resultado da verificação de identidade recebe um aviso `DOCUMENT_EXPIRED` e um webhook `status.updated` é disparado. Nenhum aviso é enviado antes de a data expirar.
- **Como desativar**: defina **Expiration mode** como **Allow expired** para aquele país e tipo de documento nas [configurações de verificação de identidade](https://docs.didit.me/pt-br/core-technology/id-verification/overview.md). **Reject expired**, o padrão, é o modo que faz o monitoramento. Um documento aceito como **Allow expired** nunca é monitorado.
- **Reverificação**: acione uma nova sessão com o mesmo `vendor_data` para atualizar os documentos.## Geolocalização de documentosA verificação de [geolocalização do documento de identidade](https://docs.didit.me/pt-br/core-technology/id-verification/document-geolocation-id-verification.md) compara a localização do endereço IP do remetente com o país emissor do documento. Os resultados são anexados à decisão da sessão.## Privacidade e retenção- Todos os documentos são criptografados em repouso.
- O acesso às imagens é feito por URLs assinadas de curta duração.
- A retenção segue a política de [retenção de dados](https://docs.didit.me/pt-br/console/data-retention.md) da aplicação.
- Os usuários têm o direito de solicitar a exclusão; a exclusão remove as imagens, os dados extraídos por OCR e os dados de NFC.## Próximos passos> [card] [Verificação de identidade](https://docs.didit.me/pt-br/core-technology/id-verification/overview.md)
>
> Como funcionam a captura do documento de identidade e o OCR.> [card] [Comprovante de endereço](https://docs.didit.me/pt-br/core-technology/proof-of-address/overview.md)
>
> Coleta de comprovantes de endereço.> [card] [Decisão da sessão](https://docs.didit.me/pt-br/sessions-api/retrieve-session.md)
>
> Referência de GET /v3/session/{id}/decision/.


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