> ## 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 de utilizadores: IDs, comprovativos e anexos

> Documentos de identidade e comprovativos de morada dos utilizadores Didit: o que é recolhido, como obter e carregar na consola.



Prompt de documentos do utilizador
        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

Cada documento que um utilizador carrega durante a verificação fica associado de forma permanente à sua entidade User. Esta página explica o que é recolhido, como obter esses documentos e como carregar documentos adicionais manualmente.## O que a Didit recolhe| Tipo de documento | Quando é recolhido | Campos extraídos |
| - | - | - |
| **Documento de identificação oficial** (passaporte, bilhete de identidade, carta de condução, título de residência) | Passo de [verificação de identidade](https://docs.didit.me/pt/core-technology/id-verification/overview.md) | Nome, data de nascimento, número do documento, país emissor, data de validade, MRZ quando existe |
| **Selfie / fotogramas de prova de vida** | Passo de [prova de vida](https://docs.didit.me/pt/core-technology/liveness/overview.md) | Maior recorte facial, pontuação de prova de vida passiva |
| **Comprovativo de morada (POA)** | Passo de [POA](https://docs.didit.me/pt/core-technology/proof-of-address/overview.md) | Nome, morada, entidade emissora, data do documento |
| **Leitura do chip NFC** | Passo de [verificação NFC](https://docs.didit.me/pt/core-technology/nfc-verification/overview.md) | Dados do chip, cadeia de certificados ICAO, correspondência com OCR |
| **Documentos adicionais** | Pedido do analista ou passos personalizados do fluxo | OCR quando aplicável, caso contrário armazenados tal como estão |A [lista de tipos de documentos suportados](https://docs.didit.me/pt/core-technology/id-verification/supported-documents-id-verification.md) abrange a matriz completa de país × documento (14,000+ documentos em 220+ países).## Obter documentosOs documentos estão associados à **sessão** que os recolheu, e não diretamente ao utilizador. Para listar todos os documentos de um utilizador:**1. Listar as sessões do utilizador**```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. Obter a decisão de cada sessão**Cada decisão de sessão inclui URLs para os documentos recolhidos.```bash theme={null}
curl https://verification.didit.me/v3/session/{session_id}/decision/ \
  -H "x-api-key: YOUR_API_KEY"
```Analise os campos `id_verification.document_images`, `proof_of_address.document_images` e `liveness.images` na resposta.**3. Utilizar URLs assinados**Os URLs das imagens na resposta são URLs assinados de curta duração. Guarde-os em cache no cliente enquanto forem necessários, ou volte a obter a decisão quando expirarem.## Gerar um relatório em PDFPara uma exportação legível de tudo o que foi recolhido para uma sessão, incluindo todos os documentos, utilize:**`GET /v3/session/{session_id}/generate-pdf/`**Devolve um PDF com os detalhes da sessão, os resultados das funcionalidades e as imagens dos documentos incorporadas. Útil para auditorias de conformidade, anexos de SAR e submissões regulamentares.## Carregar documentos a partir da consolaOs operadores de conformidade podem carregar documentos adicionais associados a um utilizador ou a uma sessão ativa:1. Aceda a *Users → \[user] → Documents → Upload document*.
2. Escolha um tipo de documento (ID, POA, personalizado).
3. Carregue um ficheiro; o OCR é executado automaticamente para os tipos suportados.
4. O documento fica associado à sessão mais recente (ou pode criar uma sessão de correção).> [!NOTE]
>
> A interface de carregamento de documentos existe apenas na consola: não há nenhum endpoint de API público para associar documentos diretamente a um utilizador. Utilize as sessões como ponto de entrada para toda a recolha de documentos.## Validação cruzada de documentosQuando uma sessão recolhe vários tipos de documentos, a Didit faz a validação cruzada entre eles:- **ID ↔ Prova de vida** — a face no documento de identificação corresponde à selfie de prova de vida.
- **ID ↔ POA** — o nome no comprovativo de morada corresponde ao nome extraído do documento de identificação.
- **ID ↔ NFC** — os dados MRZ / visuais correspondem aos dados do chip NFC.As inconsistências são apresentadas como avisos na decisão da sessão e podem ser configuradas para acionar uma revisão manual.## Monitorização de documentos e reverificaçãoPara casos de utilização que exigem validade contínua dos documentos (por exemplo, documentos de identificação expirados):- **A validade do documento** é registada em todos os documentos de identificação verificados. Consulte a decisão da sessão para obter o campo `expiration_date`.
- **Monitorização de documentos** — ativada por predefinição e automática: não é necessário ativar nada. Quando a data de validade do documento de identificação passa, uma sessão `"Approved"` passa para `"Kyc Expired"`, o resultado da verificação de identidade recebe um aviso `DOCUMENT_EXPIRED` e é disparado um webhook `status.updated`. Não é enviado nenhum aviso antes de a data passar.
- **Desativar** — defina o **Expiration mode** como **Allow expired** para esse país e tipo de documento nas [definições de verificação de identidade](https://docs.didit.me/pt/core-technology/id-verification/overview.md). **Reject expired**, a predefinição, é o modo que monitoriza. Um documento aceite com **Allow expired** nunca é monitorizado.
- **Reverificação** — inicie uma nova sessão com o mesmo `vendor_data` para atualizar os documentos.## Geolocalização do documentoA verificação de [geolocalização do documento de identificação](https://docs.didit.me/pt/core-technology/id-verification/document-geolocation-id-verification.md) compara a localização IP de quem submete com o país emissor do documento de identificação. Os resultados ficam associados à decisão da sessão.## Privacidade e conservação- Todos os documentos são cifrados em repouso.
- O acesso às imagens é feito através de URLs assinados de curta duração.
- A conservação segue a política de [conservação de dados](https://docs.didit.me/pt/console/data-retention.md) da aplicação.
- Os utilizadores têm o direito de pedir a eliminação; a eliminação remove as imagens, os dados extraídos por OCR e os dados NFC.## Próximos passos> [card] [Verificação de identidade](https://docs.didit.me/pt/core-technology/id-verification/overview.md)
>
> Como funcionam a captura do documento de identificação e o OCR.> [card] [Comprovativo de morada](https://docs.didit.me/pt/core-technology/proof-of-address/overview.md)
>
> Recolha de comprovativos de morada.> [card] [Decisão da sessão](https://docs.didit.me/pt/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.