Saltar al contingut principal
GET
cURL

Visió general

Retorna un únic PDF amb tot l’historial de verificació d’una entitat d’usuari, identificada per vendor_data. És el mateix document que produeix la Console amb User detail → Actions → Download PDF, de manera que els equips de compliment poden automatitzar les exportacions en lloc de fer clic una vegada per cada usuari. L’informe conté:
  • Una portada amb el resum del perfil (nom, data de naixement, estats emissors, correus electrònics i telèfons aprovats), l’estat més recent de cada funcionalitat, els comptadors de sessions i un índex de les sessions incloses.
  • Un informe complet de sessió per cada sessió inclosa, en ordre cronològic (de la més antiga a la més recent). Cadascun és el mateix informe que retorna Generar PDF per a aquesta sessió individualment.

Sessions elegibles i límit

Només s’inclouen les sessions de verificació d’usuaris (KYC) en estat Approved, Declined, In Review o Kyc Expired. Les sessions en qualsevol altre estat (Not Started, In Progress, Abandoned, Expired, …) s’ometen. L’informe es limita a les 20 sessions reportables més recents. Quan un usuari en té més, s’inclouen les 20 més noves i la portada indica quantes sessions més antigues s’han deixat fora. Fes servir Llistar sessions amb un filtre per vendor_data quan necessitis la llista completa en JSON.

Resposta

El cos de la resposta és el PDF en si (application/pdf), no un contenidor JSON ni una URL de descàrrega. La capçalera Content-Disposition és attachment; filename=user_<didit_internal_id>.pdf, on didit_internal_id és l’identificador estable de Didit de l’usuari.

Marca blanca

Quan la personalització de marca blanca està activada a la teva aplicació, la portada i cada informe de sessió mostren el teu logotip i l’URL de la política de privacitat en lloc de la marca de Didit, exactament igual que l’endpoint per sessió. Configura-ho a Console → Customization.

Memòria cau i latència

No es guarda res a la memòria cau: cada crida torna a generar l’informe amb les dades actuals, de manera que un informe sol·licitat després d’una revisió manual reflecteix la decisió del revisor. Dues crides poden produir fitxers amb bytes diferents; arxiva el fitxer descarregat quan necessitis una còpia immutable. La generació és síncrona i descarrega cada imatge emmagatzemada de cada sessió inclosa, de manera que un usuari amb moltes sessions amb molt contingut multimèdia pot trigar desenes de segons. Fes servir un temps de lectura generós al client (es recomanen 120 s) i transmet el cos de la resposta al disc. La generació s’atura en arribar a un límit de temps del servidor, en lloc de continuar fins que el client es rendeixi: si s’arriba a aquest límit, l’informe igualment retorna un PDF vàlid amb les sessions més recents i la portada indica quantes se n’han omès.

Barra final

La ruta canònica acaba amb una barra final (…/generate-pdf/). Una sol·licitud sense la barra final es serveix directament amb la mateixa resposta: no hi ha cap redirecció 301, de manera que cap client no ha de seguir redireccions i curl no necessita -L. Fes servir l’URL amb la barra final, tal com als exemples; és la forma que mostren l’especificació OpenAPI i els teus registres.

Errors

Exemples

Permisos

Qualsevol clau d’API activa de l’aplicació pot cridar aquest endpoint. Les claus d’API de Didit tenen abast d’aplicació, no de rol: els rols i permisos de la Console (read:users i la resta) decideixen què pot fer una persona a la Console, i no s’avaluen per al trànsit de la Management API. Una clau només pot exportar usuaris de la seva pròpia aplicació.

Relacionat

Autoritzacions

x-api-key
string
header
requerit

La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.

Paràmetres de ruta

vendor_data
string
requerit

El teu identificador únic per a l'usuari — una cadena de text lliure (NO un UUID). És el mateix valor que vas passar com a vendor_data quan vas crear les sessions de l'usuari, que coincideix exactament com s'ha enviat. Codifica'l com a URL; un valor que contingui / no es pot adreçar mitjançant aquesta ruta.

Resposta

El document PDF renderitzat, retornat directament com a binari application/pdf: no hi ha cap contenidor JSON ni cap redirecció d'URL de descàrrega. El cos comença amb els bytes màgics %PDF. Guarda'l en un fitxer .pdf o transmet-lo directament a qui fa la crida.

The response is of type file.

Darrera modificació el 7 de novembre del 2026