> ## 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 per llistar sessions: filtra KYC i KYB > Llista sessions de verificació de Didit amb GET /v3/sessions/ i filtres per tipus, estat i flux. API KYC i KYB unificada, preu per ús. Indicació per llistar sessions Copia el prompt al porta-retalls \

\`List Didit verification sessions for your application with filters and pagination.

Endpoint:
GET https://verification.didit.me/v3/sessions

Authentication:
Use the x-api-key header with your Didit API key. The key must hold read:sessions.

Query parameters:
\- session_kind ("user" | "business" | "all", default "user") — chooses which kind to list. "user" returns only KYC sessions (backward-compatible default). "business" returns only KYB. "all" concatenates both (KYB rows are appended; not interleaved by timestamp).
\- vendor_data (string) — exact match on your stable identifier.
\- didit_internal_id (UUID) — matches vendor_user_id.
\- status (one or more, comma-separated) — Approved, Declined, In Review, In Progress, Not Started, Expired, Abandoned, Kyc Expired, Resubmitted, Awaiting User.
\- workflow_id (one or more UUIDs, comma-separated).
\- country (one or more ISO-3 codes, comma-separated) — issuing-state for KYC, country_code for KYB.
\- region (one or more, comma-separated).
\- document_type (one or more, comma-separated).
\- date_from, date_to (ISO 8601 date) — inclusive on created_at.
\- search (string) - a complete displayed reference such as S-0001 (user) or B-0001 (business) matches only that session number and kind, ignoring leading zeros and letter case.
Other input searches the existing name, contact, document, registration-number and vendor_data fields.
\- tags (comma-separated tag ids) — sessions that carry any of them.
\- decided_from, decided_to (ISO 8601 datetimes) — sessions whose status last changed at or after / before the value.
\- limit (int, default 50), offset (int, default 0) — limit/offset pagination. Both accept values up to 1000000; larger values return 400.

Per-kind filters (silently ignored on the other kind): is_kyc_to_be_reviewed, status_initialized_as_in_review, session_type, api_service, screened_full_name, document_name, warning.

curl example:
curl -G https://verification.didit.me/v3/sessions/ \
-H "x-api-key: " \
\--data-urlencode "session_kind=all" \
\--data-urlencode "status=Approved,In Review" \
\--data-urlencode "date_from=2026-01-01" \
\--data-urlencode "limit=50"

Response envelope:
\{
"count": ,   // exact up to 100, capped at 100 beyond that: paginate with next
"next": "",
"previous": "",
"results": [ ...rows ]
}

Every row has:
\- session_id (UUID), session_kind ("user" | "business"), session_number, status, vendor_data, created_at.

KYC row extras: portrait_image, document_type, full_name, country (issuing state), phone_number, email_address, features, didit_internal_id, assignee, waiting_since, sla_due_at, top_warnings, warnings_count.

KYB row extras: workflow_type, workflow_label, company_name, registration_number, country (incorporation).

Each row is a LIGHT projection. For the full feature payload of a row, call GET /v3/session/{session_id}/decision/ — see /sessions-api/retrieve-session.

Failure modes:
\- 401 — invalid API key.
\- 403 — { "detail": "You do not have permission to perform this action." } when the key lacks read:sessions.
\- 400 — malformed UUIDs in filters are silently dropped (no error); malformed ISO dates return { "date_from": ["..."] }.

Common patterns:
\- Build a dashboard: paginate with limit + offset, sort newest-first (server orders by -session_number within each kind).
\- Find pending review queue: status=In Review.
\- Find a specific entity's sessions: vendor_data=.
\- Refresh ongoing AML hits: filter by workflow_id of your AML workflow.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Enganxa a ## Filtre de tipus de sessióFes servir el paràmetre de consulta `session_kind` per triar quin tipus de sessions es retornen:| Valor | Retorna | | - | - | | `user` (predeterminat) | Només sessions de Verificació d'usuaris (KYC). **Comportament compatible amb versions anteriors**: omet `session_kind` per obtenir-lo. | | `business` | Només sessions de Verificació d'empreses (KYB). | | `all` | Sessions de Verificació d'usuaris i de Verificació d'empreses, concatenades. |Cada fila de la resposta inclou `session_kind: "user" | "business"` perquè el client pugui seleccionar l'estructura adequada per a cada fila.## Filtres comunsAquests filtres s'apliquen als dos tipus (els filtres només per a usuaris s'ignoren quan `session_kind=business`, i a la inversa):| Paràmetre de consulta | Descripció | | - | - | | `session_kind` | `user`, `business` o `all`. Predeterminat `user`. | | `vendor_data` | Coincidència exacta amb el teu identificador. | | `status` | Un o diversos estats, separats per comes, escrits exactament com els retorna l'API: `Approved`, `Declined`, `In Review`, etc. (vegeu [Estats de verificació](https://docs.didit.me/ca/integration/verification-statuses.md)). | | `workflow_id` | Filtra pel flux de treball utilitzat. | | `country` | Filtre per codi de país (usuari: `issuing_states`, empresa: `country_code`). | | `date_from`, `date_to` | Finestra de data de creació (ISO 8601). | | `tags` | Identificadors d'etiqueta separats per comes. Retorna les sessions que en tenen alguna. | | `decided_from`, `decided_to` | Dates i hores ISO 8601. Retorna les sessions l'estat de les quals va canviar per última vegada dins d'aquesta finestra (inici inclòs, fi exclòs). Fan servir l'hora de l'últim canvi d'estat, no l'hora de creació. | | `search` | Una referència completa tal com es mostra, com `S-0001` o `B-0001`, coincideix només amb aquell número de sessió i tipus, i ignora els zeros inicials i les majúscules i minúscules. Qualsevol altra entrada fa una cerca en els camps existents de nom, contacte, document, número de registre i `vendor_data`. |## Exemples> [tab] Llista les sessions de Verificació d'usuaris (KYC) (predeterminat) > > ```bash theme={null} > curl -G https://verification.didit.me/v3/sessions/ \ > -H "x-api-key: YOUR_API_KEY" \ > --data-urlencode "vendor_data=user-42" > ``` > > **Resposta (truncada):** > > ```json theme={null} > { > "count": 3, > "next": null, > "previous": null, > "results": [ > { > "session_id": "...", > "session_kind": "user", > "session_number": 1024, > "session_url": "...", > "portrait_image": "...", > "document_type": "Passport", > "full_name": "John Doe", > "country": "GBR", > "status": "Approved", > "vendor_data": "user-42", > "didit_internal_id": "...", > "created_at": "2026-04-10T09:00:00Z", > "features": "ID_VERIFICATION,LIVENESS,FACE_MATCH,AML", > "phone_number": "+14155550123", > "email_address": "jane@example.com", > "additional_details": null > } > ] > } > ```> [tab] Llista les sessions de Verificació d'empreses (KYB) > > ```bash theme={null} > curl -G https://verification.didit.me/v3/sessions/ \ > -H "x-api-key: YOUR_API_KEY" \ > --data-urlencode "session_kind=business" \ > --data-urlencode "status=Approved" > ``` > > **Resposta (truncada):** > > ```json theme={null} > { > "count": 1, > "next": null, > "previous": null, > "results": [ > { > "session_id": "...", > "session_kind": "business", > "session_number": 89, > "status": "Approved", > "vendor_data": "biz-acme-001", > "created_at": "2026-04-01T09:00:00Z", > "workflow_id": "wf_kyb_standard", > "workflow_type": "business", > "workflow_label": "Standard KYB", > "company_name": "Acme Corporation Limited", > "registration_number": "12345678", > "country": "GBR" > } > ] > } > ```> [tab] Llista els dos tipus > > ```bash theme={null} > curl -G https://verification.didit.me/v3/sessions/ \ > -H "x-api-key: YOUR_API_KEY" \ > --data-urlencode "session_kind=all" \ > --data-urlencode "date_from=2026-04-01T00:00:00Z" > ``` > > Retorna les files de Verificació d'usuaris i de Verificació d'empreses en una única llista `results`. Els consumidors han de seleccionar l'estructura adequada per a cada fila segons `session_kind`. > > > [!NOTE] > > > > El mode `all` concatena els resultats en lloc d'intercalar-los per marca de temps. Per a recorreguts mixtos d'alt volum, fes una crida per separat a cada tipus i fusiona els resultats al client.## Les estructures de les files varien segons el tipusLes files de Verificació d'usuaris (KYC) inclouen: `portrait_image`, `document_type`, `full_name`, `country` (estat emissor), `phone_number`, `email_address`, i alguns camps de revisió: `assignee` (el revisor de la Console que té la sessió, o `null`), `waiting_since` i `sla_due_at` (només s'estableixen mentre la sessió està `In Review`), `top_warnings` (les advertències més importants, cadascuna amb `risk`, `feature`, `log_type` i `short_description`) i `warnings_count`.Les files de Verificació d'empreses (KYB) inclouen: `workflow_type`, `workflow_label`, `company_name`, `registration_number`, `country` (país de constitució).Totes dues inclouen: `session_id`, `session_kind`, `session_number`, `status`, `vendor_data`, `created_at`.Consulta la [visió general de sessions](https://docs.didit.me/ca/sessions-api/overview.md) per veure la matriu de funcionalitats completa.## PaginacióLa paginació utilitza `limit` (predeterminat `50`) i `offset` (predeterminat `0`), amb URL absolutes `next` i `previous` a la resposta. Tots dos paràmetres accepten valors fins a `1000000`; un valor més gran retorna `400`.`count` és exacte fins a `100` i es queda en `100` a partir d'aquí, així que no l'utilitzis com a total. Continua sol·licitant la URL `next` fins que sigui `null`. Amb `session_kind=all`, `count` és la suma dels dos tipus, cadascun limitat a `100`.## Relacionat- [Visió general de sessions](https://docs.didit.me/ca/sessions-api/overview.md) - [Recuperar sessió](https://docs.didit.me/ca/sessions-api/retrieve-session.md) — decisió completa per a una sola fila - [Visió general d'empreses](https://docs.didit.me/ca/entities/businesses/overview.md) — l'entitat empresa agregada a partir de les sessions - [Visió general d'usuaris](https://docs.didit.me/ca/entities/users/overview.md) — l'entitat usuari agregada a partir de les sessions ## OpenAPI ````yaml ca/openapi-25.json GET /v3/sessions/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/sessions/: get: tags: - Sessions summary: Llista sessions de verificació (KYC i/o KYB) amb filtres i paginació description: >- Retorna una llista paginada de sessions de verificació per a l'aplicació identificada per la teva clau d'API, de més recents a més antigues (`session_number` descendent). **URL canònica:** la ruta és `/v3/sessions/` (amb barra final). Les sol·licituds a `/v3/sessions` sense la barra reben una redirecció `301` cap a la URL amb barra conservant la cadena de consulta; la majoria de clients HTTP la segueixen de manera transparent en GET. **Quan utilitzar aquest endpoint vs webhooks.** Fes servir aquest endpoint per a taulers, cerques de gestió interna, conciliació i exportacions per lots. No facis sondejos periòdics per seguir el progrés de verificacions individuals: en lloc d'això, configura [webhooks](/ca/integration/webhooks), que envien esdeveniments `status.updated` en el moment en què canvia una sessió. Per obtenir el resultat complet d'una sessió, crida `GET /v3/session/{sessionId}/decision/`. **Sessions de KYC i KYB.** `session_kind` selecciona quins tipus es llisten: - `user` (per defecte): només sessions de Verificació d'usuaris (KYC). Comportament compatible amb versions anteriors. - `business`: només sessions de Verificació d'empreses (KYB). Les files tenen una estructura diferent i més reduïda (consulta l'esquema de resposta). - `all`: ambdós tipus en una sola resposta: la pàgina de KYC i la pàgina de KYB per als mateixos `limit`/`offset` es concatenen a `results` (primer les files de KYC), de manera que una pàgina pot contenir fins a `2 x limit` files. `count` és la suma d'ambdós tipus i `next`/`previous` reflecteixen la paginació del costat de KYC. Per a una paginació estricta de dades mixtes, crida `user` i `business` per separat. Cada fila inclou un discriminador `session_kind` (`"user"` o `"business"`). **Paginació.** Limit/offset estàndard: `limit` (per defecte 50) i `offset` (per defecte 0), amb URL de pàgina preparades a `next`/`previous`. Per a les files de KYC, `count` és exacte. Per a les files de KYB, `count` es calcula amb un escaneig acotat i està limitat a 100; quan hi ha més de 100 coincidències es queda a 100, de manera que cal iterar fent servir `next` (o comprovant si s'ha retornat una pàgina sencera) en lloc de calcular el total de pàgines a partir de `count`. **Semàntica dels filtres.** Tots els filtres es combinen amb AND i s'apliquen a les files de KYC. Quan `session_kind` és `business` o `all`, la part de KYB respecta els paràmetres compartits `vendor_data`, `status`, `workflow_id`, `country` (codi de país del registre de l'empresa), `date_from`, `date_to`, `search` (nom de l'empresa, número de registre —introdueix els números de registre sense separadors, p. ex. `DPC001` i no `DPC-001`—, vendor_data, número de sessió o UUID de sessió), `warning` i `organization_name`; la resta de filtres exclusius de KYC s'ignoren per a les files de KYB. Els paràmetres separats per comes (`status`, `country`, `document_type`, `region`, `workflow_id`, `document_name`, `warning`, `organization_name`, `session_type`) coincideixen amb qualsevol dels valors indicats (OR dins del paràmetre). `vendor_data` és una coincidència exacta; fes servir `search` per a coincidències parcials. Els valors desconeguts als filtres de llista simplement no retornen cap fila (sense error); els valors amb tipus mal formats (`date_from`, `date_to`, `didit_internal_id`, `api_service`, `session_kind`) retornen `400` amb un objecte d'error per camp. **Cerca.** `search` s'adapta a l'entrada: un UUID complet cerca per `session_id`; els dígits (amb `+ - . space` opcionals) coincideixen amb el prefix del número de sessió, números de document/personals, prefix de número de telèfon o `vendor_data`; els valors que contenen `@` coincideixen amb prefixos de correu electrònic; qualsevol altre text coincideix amb noms (sense distinció d'accents) i `vendor_data`. No s'aplica cap límit de freqüència fix per endpoint, però mantén els sondejos de llistes poc freqüents i fes servir webhooks per a les actualitzacions en temps real. operationId: get_v3_sessions parameters: - name: session_kind in: query required: false description: >- Quin tipus de sessions s'han de llistar: `user` (només KYC, per defecte), `business` (només KYB) o `all` (ambdues, concatenades; consulta la descripció per a la semàntica de paginació combinada). No distingeix entre majúscules i minúscules (`BUSINESS` funciona); qualsevol valor que no sigui una variant de majúscules/minúscules de `user`/`business`/`all` retorna `400`. schema: type: string enum: - user - business - all default: user example: all - name: limit in: query required: false description: >- Nombre màxim de files per pàgina (per tipus quan `session_kind=all`). Per defecte és 50. schema: type: integer default: 50 minimum: 1 maximum: 1000000 example: 20 - name: offset in: query required: false description: >- Nombre de files que cal ometre abans de la primera fila retornada. Per defecte és 0. És preferible seguir els URL `next`/`previous` de la resposta. schema: type: integer maximum: 1000000 minimum: 0 default: 0 example: 20 - name: status in: query required: false description: >- Llista separada per comes dels estats de sessió que cal incloure, p. ex. `Approved,In Review`. Els valors distingeixen entre majúscules i minúscules; consulta [Estats de verificació](/ca/integration/verification-statuses). Els valors desconeguts no coincideixen amb res. schema: type: string example: Approved,In Review - name: vendor_data in: query required: false description: >- Filtre de coincidència exacta sobre el `vendor_data` que vas enviar en crear la sessió (el teu propi identificador d'usuari/empresa). Per a coincidències parcials, utilitza `search` en el seu lloc. schema: type: string example: your-user-id-123 - name: search in: query required: false description: >- Una referència mostrada completa com ara `S-0001` (usuari) o `B-0001` (empresa) només coincideix amb aquest número i tipus de sessió; els zeros inicials i les majúscules o minúscules no afecten la coincidència. Cerca intel·ligent de text lliure. Un UUID complet coincideix amb `session_id`; una entrada numèrica coincideix amb el prefix del número de sessió, números de document/personals, prefix de telèfon o `vendor_data`; una entrada que conté `@` coincideix amb prefixos de correu electrònic; la resta de text coincideix amb noms (sense distingir accents) i `vendor_data`. El text lliure que conté dígits coincideix addicionalment amb camps de cerca de número de document/personal i prefixos de número de sessió. schema: type: string example: jane doe - name: workflow_id in: query required: false description: >- UUID de flux de treball separats per comes (troba'ls a la pàgina de Fluxos de treball a la Console). Els UUID amb format incorrecte a la llista s'ignoren; si cap no és vàlid, el resultat és buit. schema: type: string example: 9f9b1234-aaaa-bbbb-cccc-1234567890ab - name: date_from in: query required: false description: >- Només sessions creades en o després d'aquesta data (UTC), format `YYYY-MM-DD`. Les dates amb format incorrecte retornen `400`. schema: type: string format: date example: '2026-06-01' - name: date_to in: query required: false description: >- Només sessions creades fins a aquesta data (UTC), format `YYYY-MM-DD`. Per a files de KYC s'inclou el dia sencer; per a files de KYB la comparació és `created_at <= date_to` (mitjanit), així que utilitza la data de l'endemà per incloure un dia complet de sessions de KYB. schema: type: string format: date example: '2026-06-30' - name: tags in: query required: false schema: type: string description: >- Identificadors d'etiquetes separats per comes (`tags` de la teva aplicació). Retorna les sessions que en continguin qualsevol. Els identificadors que no siguin UUID vàlids s'ignoren, i quan cap no és vàlid la llista és buida. - name: decided_from in: query required: false schema: type: string format: date-time description: >- Data i hora ISO 8601. Retorna les sessions l'estat de les quals ha canviat per darrera vegada en aquest moment o després. Filtra per l'hora de l'últim canvi d'estat, no per l'hora de creació. - name: decided_to in: query required: false schema: type: string format: date-time description: >- Data i hora ISO 8601. Retorna les sessions l'estat de les quals ha canviat per darrera vegada abans d'aquest moment. Combina-ho amb `decided_from` per a una finestra semioberta. - name: country in: query required: false description: >- Filtre de països separat per comes. Per a files de KYC: codis ISO 3166-1 alfa-3 de l'estat emissor del document d'identitat (p. ex. `ESP,USA`), que poden diferir de la nacionalitat. Per a files de KYB: el codi de país de l'empresa al registre. schema: type: string example: ESP,USA - name: document_type in: query required: false description: >- Codis de tipus de document d'identitat verificats a la sessió separats per comes (només files de KYC): `P` (passaport), `ID` (document d'identitat), `DL` (permís de conduir), `RP` (permís de residència), `SSC` (targeta de la Seguretat Social), `HIC` (targeta d'assegurança mèdica), `WP` (permís de treball), `TC` (targeta fiscal), `VISA`, `PSC` (targeta de serveis públics), `BC` (certificat de naixement), `OTHER`. Tingues en compte que el camp de resposta `document_type` conté el nom visible, no el codi. schema: type: string example: P,ID - name: document_name in: query required: false description: >- Noms exactes de documents; es poden passar diversos noms separats per comes, però el valor només es divideix per comes quan conté més d'un separador ` - ` (un nom sol amb una coma integrada es fa coincidir sencer). Els noms són tal com els reconeix la verificació de documents (anvers o revers), p. ex. `Spain - Id Card (2021)`. Només files de KYC. schema: type: string example: Spain - Id Card (2021) - name: region in: query required: false description: >- Valors de regió/estat del document separats per comes (per a documents emesos per regió, com ara els permisos de conduir dels EUA). Només files de KYC. schema: type: string example: CA,TX - name: didit_internal_id in: query required: false description: >- Filtra per l'identificador intern d'usuari de Didit (el camp de resposta `didit_internal_id`) per llistar totes les sessions d'un usuari verificat. Ha de ser un UUID vàlid; els valors mal formats retornen `400`. Només files de KYC. schema: type: string format: uuid example: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147 - name: session_type in: query required: false description: >- Canals de creació de sessions separats per comes: `API`, `HOSTED`, `MIGRATED`. El valor especial `ALL` (o ometre el paràmetre) desactiva el filtre. Només per a files de KYC. schema: type: string example: HOSTED - name: api_service in: query required: false description: >- Filtra les sessions d'API independents per servei. Els valors no vàlids retornen `400`. Només files de KYC. schema: type: string enum: - ID_VERIFICATION - FACE_MATCH - AGE_ESTIMATION - FACE_SEARCH - POA - AML - KYB_REGISTRY - PASSIVE_LIVENESS - DATABASE_VALIDATION - PHONE_VERIFICATION - EMAIL_VERIFICATION example: AML - name: screened_full_name in: query required: false description: >- Cerca de noms insensible als accents dins de les dades cribrades d'AML i de validació en bases de dades. Quan es combina amb `api_service=AML` o `api_service=DATABASE_VALIDATION`, la cerca es restringeix a les dades cribrades d'aquesta funcionalitat. Només files de KYC. schema: type: string example: Jane Doe - name: warning in: query required: false description: >- Codis de risc d'advertència separats per comes; retorna les sessions que n'hagin generat algun (p. ex. `POSSIBLE_FRAUD`). Els codis de risc s'enumeren per funcionalitat a la [documentació d'advertències](/ca/integration/webhooks). S'aplica a files de KYC i, amb codis d'advertència d'empresa, a files de KYB. schema: type: string example: POSSIBLE_FRAUD - name: status_initialized_as_in_review in: query required: false description: >- Quan és `true`, només les sessions la decisió de les quals hagi quedat inicialment a `In Review` (útil per auditar el volum de revisió manual). Només files de KYC. schema: type: boolean example: true - name: is_kyc_to_be_reviewed in: query required: false description: >- `true` retorna sessions la verificació de documents de les quals s'ha marcat per a revisió manual; `false` retorna sessions amb la verificació de documents no marcada explícitament. Omet-ho per desactivar-ho. Només files de KYC. schema: type: boolean example: true - name: euuid in: query required: false description: >- Filtra per l'euuid de l'usuari final (UUID assignat a l'usuari que es verifica, utilitzat pels enllaços profunds de la Console). Ha de ser un UUID vàlid; els valors malformats retornen un error de camp 400. Només files de KYC. schema: type: string format: uuid example: 0f8fad5b-d9cb-469f-a165-70867728950e - name: organization_name in: query required: false description: >- Noms d'organització separats per comes. Orientat a la consola; amb una clau d'API (ja restringida a una aplicació), només coincideix amb el nom de la teva pròpia organització. schema: type: string example: Acme Inc responses: '200': description: >- Llista de sessions paginada. Els elements de `results` són files de KYC, files de KYB o ambdues segons `session_kind`; distingeix-los mitjançant el camp `session_kind` de cada fila. content: application/json: schema: type: object required: - count - next - previous - results properties: count: type: integer description: >- Nombre de sessions que coincideixen amb els filtres: exacte fins a 100 i limitat a 100 a partir d'aquí, de manera que no l'has d'utilitzar com a total. Fes servir `next` per saber si hi ha més pàgines. Per a `session_kind=all` és la suma de tots dos tipus, cadascun limitat a 100. example: 2 next: type: string format: uri nullable: true description: >- URL absoluta de la pàgina següent, o `null` a l'última pàgina. example: >- https://verification.didit.me/v3/sessions/?limit=20&offset=20 previous: type: string format: uri nullable: true description: >- URL absoluta de la pàgina anterior, o `null` a la primera pàgina. example: null results: type: array description: >- Files de sessió, les més recents primer. Amb `session_kind=all`, les files de KYC van primer, seguides de les files de KYB. items: oneOf: - $ref: '#/components/schemas/UserSessionListItem' - $ref: '#/components/schemas/BusinessSessionListItem' discriminator: propertyName: session_kind mapping: user: '#/components/schemas/UserSessionListItem' business: '#/components/schemas/BusinessSessionListItem' examples: KYC sessions (default): summary: >- session_kind=user: una sessió completada i una altra de no iniciada value: count: 2 next: null previous: null results: - session_id: 5b3720ed-d429-42ef-b67f-37ea805f48ee session_kind: user session_number: 720 session_url: https://verify.didit.me/session/CuXoBYCYVO5Y portrait_image: >- https:///portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=... document_type: Passport full_name: Jane Marie Doe country: ESP status: Approved vendor_data: your-user-id-123 didit_internal_id: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147 created_at: '2026-06-09T12:26:54.328364Z' features: - feature: ID_VERIFICATION status: Approved - feature: LIVENESS status: Approved - feature: FACE_MATCH status: Approved - feature: AML status: Approved - feature: IP_ANALYSIS status: Approved phone_number: number: '+14155552671' is_verified: true email_address: email: jane@example.com is_verified: true additional_details: aml: total_hits: 0 entity_type: person is_adverse_media_fetched: false liveness: method: PASSIVE score: 0.98 face_match: score: 0.95 - session_id: 038ad62f-5ebd-46c2-afe9-4b2956bf687f session_kind: user session_number: 719 session_url: https://verify.didit.me/session/7RGKiO6ioGH6 portrait_image: null document_type: null full_name: null country: null status: Not Started vendor_data: your-user-id-124 didit_internal_id: eb4e679d-ca4b-461f-9685-687bac29ebdb created_at: '2026-06-09T08:02:23.343053Z' features: - feature: ID_VERIFICATION status: Not Finished - feature: LIVENESS status: Not Finished - feature: FACE_MATCH status: Not Finished - feature: AML status: Not Finished - feature: IP_ANALYSIS status: Not Finished phone_number: null email_address: null additional_details: null Mixed KYC + KYB (session_kind=all): summary: 'session_kind=all: fila de KYC seguida d''una fila de KYB' value: count: 2 next: null previous: null results: - session_id: 5b3720ed-d429-42ef-b67f-37ea805f48ee session_kind: user session_number: 720 session_url: https://verify.didit.me/session/CuXoBYCYVO5Y portrait_image: null document_type: Identity Card full_name: Jane Marie Doe country: ESP status: In Review vendor_data: your-user-id-123 didit_internal_id: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147 created_at: '2026-06-09T12:26:54.328364Z' features: - feature: ID_VERIFICATION status: In Review - feature: LIVENESS status: Approved phone_number: null email_address: null additional_details: liveness: method: PASSIVE score: 0.98 - session_id: 8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52 session_kind: business session_number: 42 status: Approved vendor_data: your-company-id-77 created_at: '2026-06-08T09:14:02.118450Z' workflow_id: 9f9b1234-aaaa-bbbb-cccc-1234567890ab workflow_type: kyb workflow_label: Standard KYB company_name: Acme Holdings S.L. registration_number: B12345678 country: ES '301': description: >- Redirigeix a l'URL canònic amb barra final. Es retorna quan el camí de la sol·licitud és `/v3/sessions` (sense barra final); la capçalera `Location` apunta a `/v3/sessions/` conservant la cadena de consulta. Els clients GET normalment la segueixen automàticament. '400': description: >- Paràmetre de consulta no vàlid. El cos és un objecte indexat pel paràmetre causant. content: application/json: examples: Invalid session_kind: summary: session_kind no és cap dels valors user/business/all value: session_kind: Must be "user", "business", or "all". Invalid date: summary: date_from/date_to amb format incorrecte value: date_from: - Enter a valid date. Invalid didit_internal_id: summary: didit_internal_id no és un UUID value: didit_internal_id: - Enter a valid UUID. Invalid api_service: summary: api_service no es troba entre les opcions permeses value: api_service: - >- Select a valid choice. FOO is not one of the available choices. '403': description: >- Clau d'API absent, mal formada o revocada. Una clau absent retorna `403`; una clau incorrecta, revocada o caducada retorna `401`. **Aplicació suprimida:** durant uns minuts després de suprimir una aplicació, una sol·licitud feta amb una de les seves claus d'API pot respondre `{"detail": "This application was deleted.", "code": "application_deleted"}`. No reintentis: l'aplicació i les seves claus d'API ja no existeixen. Després d'aquests minuts, la clau es rebutja com qualsevol altra clau no vàlida. content: application/json: schema: type: object properties: detail: type: string example: You do not have permission to perform this action. code: type: string description: >- Motiu llegible per màquina, present només en algunes fallades. `application_deleted`: la clau d'API pertany a una aplicació que s'ha suprimit. example: application_deleted required: - detail examples: Forbidden: summary: Falta l'x-api-key o no és vàlid value: detail: You do not have permission to perform this action. ApplicationDeleted: summary: Clau d'API d'una aplicació suprimida value: detail: This application was deleted. code: application_deleted security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -s 'https://verification.didit.me/v3/sessions/?status=Approved,In%20Review&date_from=2026-06-01&limit=20' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.sessions.list(): print(item) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.sessions.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.sessions().list()) { System.out.println(item); } - lang: php label: PHP source: |- sessions->list() as $item) { print_r($item); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.sessions.list.auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.Sessions.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: UserSessionListItem: title: 'KYC session row (session_kind: user)' type: object description: >- Fila de resum per a una sessió de Verificació d'usuaris (KYC). Els camps d'identitat (`full_name`, `country`, `document_type`, `portrait_image`, camps de contacte) s'emplenen progressivament a mesura que l'usuari completa els passos de verificació, i són `null` fins que finalitza el pas corresponent. Els camps restringits per la configuració dels atributs de resposta del flux de treball també es retornen com a `null`. required: - session_id - session_kind - session_number - session_url - portrait_image - document_type - full_name - country - status - vendor_data - didit_internal_id - created_at - features - phone_number - email_address - additional_details properties: session_id: type: string format: uuid description: >- Identificador únic de la sessió de verificació. Utilitza'l amb `GET /v3/session/{sessionId}/decision/` per obtenir el payload complet de la decisió. example: 5b3720ed-d429-42ef-b67f-37ea805f48ee session_kind: type: string enum: - user description: >- Discriminador de fila. Sempre `"user"` per a files de KYC; les files de Verificació d'empreses (KYB) tenen `"business"` i una estructura diferent. example: user session_number: type: integer description: >- Número seqüencial fàcil de llegir de la sessió dins de la teva aplicació. També coincideix amb el paràmetre `search`. example: 720 session_url: type: string nullable: true description: >- URL de verificació allotjada que l'usuari final obre per completar el flux. `null` quan la sessió no té cap URL allotjada. example: https://verify.didit.me/session/CuXoBYCYVO5Y portrait_image: type: string nullable: true description: >- URL temporal (presignada) del millor retrat disponible: la foto del xip NFC si està disponible; en cas contrari, el retrat del document d'identitat; si no, la imatge de referència de la prova de vida. `null` fins que n'existeixi alguna. Descarrega-la de seguida; l'enllaç caduca. example: >- https:///portraits/5b3720ed.jpg?X-Amz-Expires=3600&X-Amz-Signature=... document_type: type: string nullable: true enum: - Passport - Identity Card - Driver's License - Residence Permit - Health Insurance Card - Tax Card description: >- Tipus de document d'identitat verificat llegible per a humans. `null` abans que es completi la verificació del document, i també `null` després de completar-se quan el codi verificat no té correspondència de visualització (`SSC`, `WP`, `VISA`, `PSC`, `BC`, `OTHER`). Nota: el paràmetre de consulta `document_type` filtra per codis curts (`P`, `ID`, `DL`, `RP`, ...), no per aquests valors de visualització. example: Passport full_name: type: string nullable: true description: >- Millor nom complet disponible per a la sessió, resolt per ordre: OCR del document d'identitat, dades sotmeses a cribratge AML, dades sotmeses a validació en bases de dades, comprovant de domicili, i després els detalls esperats proporcionats durant la creació de la sessió. `null` quan encara no n'hi ha cap de disponible. example: Jane Marie Doe country: type: string nullable: true description: >- País ISO 3166-1 alpha-3 associat a la sessió, resolt per aquest ordre: estat emissor del document d'identitat, estat emissor de la validació en bases de dades, estat emissor del comprovant de domicili, dades esperades i, finalment, país del telèfon verificat. Pot ser diferent de la nacionalitat. example: ESP status: type: string enum: - Not Started - In Progress - Approved - Declined - In Review - Expired - Abandoned - Kyc Expired - Resubmitted - Awaiting User description: >- Estat global de la sessió. Consulta la pàgina [Estats de verificació](/ca/integration/verification-statuses) per al cicle de vida. example: Approved vendor_data: type: string nullable: true description: >- El teu propi identificador per a l'usuari final, retornat exactament com es va enviar en crear la sessió. example: your-user-id-123 didit_internal_id: type: string format: uuid nullable: true description: >- Identificador intern de Didit per al perfil d'usuari verificat darrere d'aquesta sessió. Estable al llarg de múltiples sessions del mateix usuari; es pot filtrar mitjançant el paràmetre de consulta `didit_internal_id`. example: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147 created_at: type: string format: date-time description: Marca de temps UTC en què es va crear la sessió. example: '2026-06-09T12:26:54.328364Z' features: type: array description: >- Estat de cada funcionalitat per a cada pas de verificació configurat al flux de treball de la sessió, en l'ordre del flux de treball. items: type: object required: - feature - status properties: feature: type: string enum: - ID_VERIFICATION - NFC - LIVENESS - FACE_MATCH - POA - QUESTIONNAIRE - EMAIL_VERIFICATION - PHONE - AML - IP_ANALYSIS - AGE_ESTIMATION - DATABASE_VALIDATION - GEOLOCATION description: Identificador de la funcionalitat de verificació. example: ID_VERIFICATION status: type: string enum: - Not Finished - Approved - Declined - In Review - Resub Requested description: >- Estat d'aquesta funcionalitat. `Not Finished` fins que es completi el pas. example: Approved phone_number: type: object nullable: true description: >- Telèfon associat a la sessió: el telèfon verificat quan s'ha executat la verificació de telèfon, o altrament el telèfon de contacte proporcionat durant la creació de la sessió. `null` quan no existeix cap dels dos. required: - number - is_verified properties: number: type: string description: Número de telèfon en format E.164. example: '+14155552671' is_verified: type: boolean description: >- `true` només quan la funcionalitat de verificació de telèfon ha aprovat aquest número. example: true email_address: type: object nullable: true description: >- Correu electrònic associat a la sessió: el correu electrònic verificat si s'ha executat la verificació de correu electrònic; en cas contrari, el correu electrònic de contacte proporcionat en crear la sessió. `null` quan no existeix cap dels dos. required: - email - is_verified properties: email: type: string format: email example: jane@example.com is_verified: type: boolean description: >- `true` només quan la funcionalitat de verificació de correu electrònic ha aprovat aquesta adreça. example: true additional_details: type: object nullable: true description: >- Dades addicionals compactes per funcionalitat. Com a claus només apareixen les funcionalitats que han generat dades; `null` quan cap funcionalitat no ha generat dades addicionals. Els camps exclosos per la configuració d'atributs de resposta del flux de treball s'ometen. properties: aml: type: object description: Present quan s'ha executat el cribratge AML. properties: total_hits: type: integer description: Nombre de coincidències del cribratge AML. example: 0 entity_type: type: string description: Tipus d'entitat sotmesa a cribratge. example: person is_adverse_media_fetched: type: boolean example: false screened_data: type: object description: >- Subconjunt de les dades sotmeses a cribratge. Només s'inclouen les claus no buides. properties: nationality: type: string example: ESP document_number: type: string example: XX1234567 date_of_birth: type: string example: '1990-05-21' database_validation: type: object description: Present quan s'ha executat la validació en bases de dades. properties: validation_type: type: string example: DOCUMENT_VALIDATION match_type: type: string example: FULL_MATCH identification_number: type: string description: >- Número fiscal, personal o de document que s'ha validat (el primer disponible). example: 12345678Z poa: type: object description: >- Present quan s'ha dut a terme la verificació del comprovant de domicili. properties: document_type: type: string example: UTILITY_BILL issuer: type: string example: Energy Co address: type: string example: Calle Mayor 1, 28013 Madrid name_on_document: type: string example: Jane Marie Doe liveness: type: object description: Present quan s'ha executat una comprovació de prova de vida. properties: method: type: string example: PASSIVE score: type: number description: >- Puntuació de confiança de la prova de vida, arrodonida a 2 decimals. example: 0.98 face_match: type: object description: Present quan s'ha executat la coincidència facial. properties: score: type: number description: >- Puntuació de similitud de la coincidència facial, arrodonida a 2 decimals. example: 0.95 source_image: type: string description: URL temporal (presignada) de la imatge facial d'origen. example: https:///faces/source.jpg?X-Amz-Expires=3600&... target_image: type: string description: URL temporal (presignada) de la imatge facial de destinació. example: https:///faces/target.jpg?X-Amz-Expires=3600&... phone_verification: type: object description: Present quan s'ha executat la verificació de telèfon. properties: country_code: type: string description: País ISO 3166-1 alpha-2 del número de telèfon. example: US is_temporary: type: boolean example: false is_ported: type: boolean example: false is_blocked: type: boolean example: false email_verification: type: object description: Present quan s'ha executat la verificació de correu electrònic. properties: is_breached: type: boolean example: false is_disposable: type: boolean example: false is_undeliverable: type: boolean example: false is_blocklisted: type: boolean example: false assignee: type: object nullable: true description: >- El revisor de la consola a qui s'ha assignat la sessió, o `null` quan ningú la té assignada. properties: email: type: string format: email assigned_at: type: string format: date-time nullable: true waiting_since: type: string format: date-time nullable: true description: >- Quan la sessió va començar a esperar la revisió. `null` tret que la sessió estigui `In Review`. sla_due_at: type: string format: date-time nullable: true description: >- Data límit de la revisió, a partir del termini de revisió establert per a la teva aplicació a la consola. `null` tret que la sessió estigui `In Review` i s'hagi establert un termini. top_warnings: type: array description: >- Fins a algunes de les advertències més importants de la sessió, per a una visualització ràpida de triatge. La llista completa es troba a la decisió. items: type: object properties: risk: type: string description: Codi d'advertència, per exemple `FACE_MATCH_LOW_SIMILARITY`. feature: type: string description: La funcionalitat que l'ha generada. log_type: type: string nullable: true description: '`error` o `warning`; `null` per a una entrada antiga.' short_description: type: string warnings_count: type: integer description: Nombre d'advertències a la sessió. BusinessSessionListItem: title: 'KYB session row (session_kind: business)' type: object description: >- Fila de resum per a una sessió de Verificació d'empreses (KYB). Només es retorna quan `session_kind` és `business` o `all`. required: - session_id - session_kind - session_number - status - vendor_data - created_at - workflow_id - workflow_type - workflow_label - company_name - registration_number - country properties: session_id: type: string format: uuid description: Identificador únic de la sessió de verificació d'empreses. example: 8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52 session_kind: type: string enum: - business description: Discriminador de fila. Sempre `"business"` per a files de KYB. example: business session_number: type: integer description: >- Número seqüencial fàcil de llegir de la sessió d'empresa dins de la teva aplicació. Numerat independentment de les sessions de KYC. example: 42 status: type: string enum: - Not Started - In Progress - Approved - Declined - In Review - Expired - Abandoned - Kyc Expired - Resubmitted - Awaiting User description: >- Estat global de la sessió. Consulta la pàgina [Estats de verificació](/ca/integration/verification-statuses). example: Approved vendor_data: type: string nullable: true description: >- El teu propi identificador per a l'empresa, retornat exactament com es va enviar en crear la sessió. example: your-company-id-77 created_at: type: string format: date-time description: Marca de temps UTC en què es va crear la sessió. example: '2026-06-08T09:14:02.118450Z' workflow_id: type: string format: uuid nullable: true description: >- Identificador del flux de treball amb el qual s'ha creat aquesta sessió. example: 9f9b1234-aaaa-bbbb-cccc-1234567890ab workflow_type: type: string nullable: true description: Tipus de flux de treball. `kyb` per a fluxos de treball d'empreses. example: kyb workflow_label: type: string nullable: true description: Nom visible del flux de treball. example: Standard KYB company_name: type: string nullable: true description: >- Nom de l'empresa que s'està verificant, procedent de l'empresa del registre vinculada a la sessió. `null` fins que se seleccioni una empresa. example: Acme Holdings S.L. registration_number: type: string nullable: true description: >- Número de registre de l'empresa procedent de l'empresa del registre vinculada a la sessió. example: B12345678 country: type: string nullable: true description: Codi de país de l'empresa del registre vinculada a la sessió. example: ES securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.