> ## 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 liste des sessions : filtrer les sessions KYC et KYB
> Listez les sessions Didit via GET /v3/sessions/, filtrables par type, statut, workflow et fournisseur. API KYC et KYB, tarification à l'usage.
Invite pour lister les sessions
Copier le prompt dans le presse-papiers
\
\`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.`
\
Coller dans
## Filtre par type de sessionUtilisez le paramètre de requête `session_kind` pour choisir le type de sessions à renvoyer :| Valeur | Renvoie |
| - | - |
| `user` (par défaut) | Uniquement les sessions de Vérification des utilisateurs (KYC). **Comportement rétrocompatible** : omettez `session_kind` pour obtenir ce comportement. |
| `business` | Uniquement les sessions de Vérification d'entreprise (KYB). |
| `all` | Les sessions de Vérification des utilisateurs et de Vérification d'entreprise, concaténées. |Chaque ligne de la réponse inclut `session_kind: "user" | "business"`, afin que votre client puisse traiter la structure de chaque ligne selon son type.## Filtres communsCes filtres s'appliquent aux deux types (les filtres réservés aux utilisateurs sont ignorés lorsque `session_kind=business`, et inversement) :| Paramètre de requête | Description |
| - | - |
| `session_kind` | `user`, `business` ou `all`. Valeur par défaut : `user`. |
| `vendor_data` | Correspondance exacte avec votre identifiant. |
| `status` | Un ou plusieurs statuts, séparés par des virgules, écrits exactement tels que l'API les renvoie : `Approved`, `Declined`, `In Review`, etc. (voir [Statuts de vérification](https://docs.didit.me/fr/integration/verification-statuses.md)). |
| `workflow_id` | Filtre par workflow utilisé. |
| `country` | Filtre par code pays (KYC : `issuing_states`, KYB : `country_code`). |
| `date_from`, `date_to` | Fenêtre de date de création (ISO 8601). |
| `tags` | Identifiants de tags séparés par des virgules. Renvoie les sessions portant l'un d'entre eux. |
| `decided_from`, `decided_to` | Dates et heures ISO 8601. Renvoie les sessions dont le statut a changé pour la dernière fois dans cette fenêtre (borne inférieure incluse, borne supérieure exclue). Elles utilisent l'heure du dernier changement de statut, et non l'heure de création. |
| `search` | Une référence complète telle qu'affichée, comme `S-0001` ou `B-0001`, ne correspond qu'à ce numéro de session et à ce type, sans tenir compte des zéros initiaux ni de la casse. Toute autre saisie recherche dans les champs existants : nom, contact, document, numéro d'immatriculation et `vendor_data`. |## Exemples> [tab] Lister les sessions de Vérification des utilisateurs (KYC) (par défaut)
>
> ```bash theme={null}
> curl -G https://verification.didit.me/v3/sessions/ \
> -H "x-api-key: YOUR_API_KEY" \
> --data-urlencode "vendor_data=user-42"
> ```
>
> **Réponse (tronquée) :**
>
> ```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] Lister les sessions de Vérification d'entreprise (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"
> ```
>
> **Réponse (tronquée) :**
>
> ```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] Lister les deux types
>
> ```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"
> ```
>
> Renvoie les lignes de Vérification des utilisateurs et de Vérification d'entreprise dans un seul tableau `results`. Les clients doivent traiter chaque ligne selon sa valeur `session_kind`.
>
> > [!NOTE]
> >
> > Le mode `all` concatène les résultats au lieu de les entrelacer selon l'horodatage. Pour les parcours volumineux de données mixtes, appelez chaque type séparément et fusionnez les résultats côté client.## Les structures de lignes diffèrent selon le typeLes lignes de Vérification des utilisateurs (KYC) incluent : `portrait_image`, `document_type`, `full_name`, `country` (État émetteur), `phone_number`, `email_address`, ainsi que quelques champs de revue : `assignee` (le réviseur de la Console auquel la session est attribuée, ou `null`), `waiting_since` et `sla_due_at` (renseignés uniquement lorsque la session est `In Review`), `top_warnings` (les avertissements les plus importants, chacun avec `risk`, `feature`, `log_type` et `short_description`) et `warnings_count`.Les lignes de Vérification d'entreprise (KYB) incluent : `workflow_type`, `workflow_label`, `company_name`, `registration_number`, `country` (pays de constitution).Les deux types contiennent : `session_id`, `session_kind`, `session_number`, `status`, `vendor_data`, `created_at`.Consultez la [vue d'ensemble des sessions](https://docs.didit.me/fr/sessions-api/overview.md) pour la matrice complète des fonctionnalités.## PaginationLa pagination utilise `limit` (par défaut `50`) et `offset` (par défaut `0`), avec les URL absolues `next` et `previous` dans la réponse. Les deux paramètres acceptent des valeurs allant jusqu'à `1000000` ; une valeur supérieure renvoie `400`.`count` est exact jusqu'à `100` et reste à `100` au-delà. Ne l'utilisez donc pas comme total. Continuez à appeler l'URL `next` jusqu'à ce qu'elle soit `null`. Avec `session_kind=all`, `count` correspond à la somme des deux types, chacun étant plafonné à `100`.## Liens connexes- [Vue d'ensemble des sessions](https://docs.didit.me/fr/sessions-api/overview.md)
- [Récupérer une session](https://docs.didit.me/fr/sessions-api/retrieve-session.md) : décision complète pour une seule ligne
- [Vue d'ensemble des entreprises](https://docs.didit.me/fr/entities/businesses/overview.md) : l'entité Business agrégée à travers les sessions
- [Vue d'ensemble des utilisateurs](https://docs.didit.me/fr/entities/users/overview.md) : l'entité User agrégée à travers les sessions
## OpenAPI
````yaml fr/openapi-25.json GET /v3/sessions/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: API de vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/sessions/:
get:
tags:
- Sessions
summary: >-
Lister les sessions de vérification (KYC et/ou KYB) avec filtres et
pagination
description: "Renvoie une liste paginée de sessions de vérification pour l'application identifiée par votre clé API, les plus récentes en premier (`session_number` décroissant).\n\n**URL canonique\_:** la route est `/v3/sessions/` (slash final). Les requêtes vers `/v3/sessions` sans le slash reçoivent une redirection `301` vers l'URL avec slash en conservant la chaîne de requête\_; la plupart des clients HTTP la suivent de manière transparente sur GET.\n\n**Quand utiliser cet endpoint par rapport aux webhooks.** Utilisez cet endpoint pour les tableaux de bord, la recherche dans le back-office, le rapprochement et les exports par lot. Ne l'interrogez pas en boucle pour suivre la progression de vérifications individuelles - configurez plutôt des [webhooks](/fr/integration/webhooks), qui envoient des événements `status.updated` dès qu'une session change. Pour obtenir le résultat complet d'une session, appelez `GET /v3/session/{sessionId}/decision/`.\n\n**Sessions KYC et KYB.** `session_kind` sélectionne les types répertoriés\_:\n- `user` (par défaut) - sessions de Vérification des utilisateurs (KYC) uniquement. Comportement rétrocompatible.\n- `business` - sessions de Vérification d'entreprise (KYB) uniquement. Les lignes ont une structure différente et plus compacte (voir le schéma de réponse).\n- `all` - les deux types dans une seule réponse\_: la page KYC et la page KYB pour les mêmes valeurs de `limit`/`offset` sont concaténées dans `results` (les lignes KYC en premier), de sorte qu'une page peut contenir jusqu'à `2 x limit` lignes. `count` est la somme des deux types et `next`/`previous` reflètent la pagination côté KYC. Pour une pagination stricte de données mixtes, appelez `user` et `business` séparément.\n\nChaque ligne comporte un discriminateur `session_kind` (`\"user\"` ou `\"business\"`).\n\n**Pagination.** Limit/offset standard\_: `limit` (50 par défaut) et `offset` (0 par défaut), avec des URL de pages prêtes à l'emploi dans `next`/`previous`. Pour les lignes KYC, `count` est exact. Pour les lignes KYB, `count` est calculé avec un balayage borné et est plafonné à 100 - lorsqu'il y a plus de 100 correspondances, il reste à 100\_; itérez donc à l'aide de `next` (ou en vérifiant si une page complète a été renvoyée) plutôt qu'en calculant le nombre total de pages à partir de `count`.\n\n**Sémantique des filtres.** Tous les filtres se combinent avec ET et s'appliquent aux lignes KYC. Lorsque `session_kind` vaut `business` ou `all`, le côté KYB prend en compte les paramètres partagés `vendor_data`, `status`, `workflow_id`, `country` (code pays du registre des sociétés), `date_from`, `date_to`, `search` (nom de l'entreprise, numéro d'immatriculation - saisissez les numéros d'immatriculation sans séparateurs, par exemple `DPC001` et non `DPC-001` - vendor_data, numéro de session ou UUID de session), `warning` et `organization_name`\_; les autres filtres réservés au KYC sont ignorés pour les lignes KYB. Les paramètres séparés par des virgules (`status`, `country`, `document_type`, `region`, `workflow_id`, `document_name`, `warning`, `organization_name`, `session_type`) correspondent à l'une quelconque des valeurs listées (OU au sein du paramètre). `vendor_data` est une correspondance exacte - utilisez `search` pour une correspondance partielle. Les valeurs inconnues dans les filtres de liste ne renvoient simplement aucune ligne (aucune erreur)\_; les valeurs typées mal formées (`date_from`, `date_to`, `didit_internal_id`, `api_service`, `session_kind`) renvoient `400` avec un objet d'erreur par champ.\n\n**Recherche.** `search` s'adapte à la saisie\_: un UUID complet recherche `session_id`\_; les chiffres (avec `+ - . space` facultatifs) correspondent au préfixe du numéro de session, aux numéros de document et aux numéros personnels, au préfixe de numéro de téléphone ou à `vendor_data`\_; les valeurs contenant `@` correspondent aux préfixes d'e-mail\_; tout autre texte correspond aux noms (insensible aux accents) et à `vendor_data`.\n\nAucune limite de débit fixe par endpoint n'est appliquée, mais évitez d'interroger la liste trop fréquemment et appuyez-vous sur les webhooks pour les mises à jour en temps réel."
operationId: get_v3_sessions
parameters:
- name: session_kind
in: query
required: false
description: >-
Quel type de sessions lister : `user` (KYC uniquement, par défaut),
`business` (KYB uniquement) ou `all` (les deux, concaténées - voir
la description pour la sémantique de pagination fusionnée). La
correspondance est insensible à la casse (`BUSINESS` fonctionne) ;
toute valeur autre qu'une variante de casse de
`user`/`business`/`all` renvoie `400`.
schema:
type: string
enum:
- user
- business
- all
default: user
example: all
- name: limit
in: query
required: false
description: >-
Nombre maximal de lignes par page (par type lorsque
`session_kind=all`). Vaut par défaut 50.
schema:
type: integer
default: 50
minimum: 1
maximum: 1000000
example: 20
- name: offset
in: query
required: false
description: >-
Nombre de lignes à ignorer avant la première ligne retournée. La
valeur par défaut est 0. Privilégiez l'utilisation des URL
`next`/`previous` de la réponse.
schema:
type: integer
maximum: 1000000
minimum: 0
default: 0
example: 20
- name: status
in: query
required: false
description: >-
Liste séparée par des virgules des statuts de session à inclure, par
exemple `Approved,In Review`. Les valeurs sont sensibles à la casse
; voir [Statuts de
vérification](/fr/integration/verification-statuses). Les valeurs
inconnues ne correspondent à aucun élément.
schema:
type: string
example: Approved,In Review
- name: vendor_data
in: query
required: false
description: >-
Filtre par correspondance exacte sur le `vendor_data` que vous avez
envoyé lors de la création de la session (votre propre identifiant
d'utilisateur/d'entreprise). Pour les correspondances partielles,
utilisez plutôt `search`.
schema:
type: string
example: your-user-id-123
- name: search
in: query
required: false
description: "Une référence affichée complète telle que `S-0001` (utilisateur) ou `B-0001` (entreprise) correspond uniquement à ce numéro et à ce type de session\_; les zéros de tête et la casse des lettres n'affectent pas la correspondance. Recherche intelligente en texte libre. Un UUID complet correspond à `session_id`\_; une saisie numérique correspond à un préfixe de numéro de session, aux numéros de document/personnels, à un préfixe de téléphone ou à `vendor_data`\_; une saisie contenant `@` correspond aux préfixes d'e-mail\_; les autres textes correspondent aux noms (insensible aux accents) et à `vendor_data`. Le texte libre contenant des chiffres correspond en plus aux champs de recherche de numéros de document/personnels et aux préfixes de numéros de session."
schema:
type: string
example: jane doe
- name: workflow_id
in: query
required: false
description: >-
UUID de workflow séparés par des virgules (retrouvez-les sur la page
Workflows de la console). Les UUID mal formés dans la liste sont
ignorés ; si aucun n'est valide, le résultat est vide.
schema:
type: string
example: 9f9b1234-aaaa-bbbb-cccc-1234567890ab
- name: date_from
in: query
required: false
description: >-
Uniquement les sessions créées à partir de cette date (UTC) incluse,
au format `YYYY-MM-DD`. Les dates mal formées renvoient `400`.
schema:
type: string
format: date
example: '2026-06-01'
- name: date_to
in: query
required: false
description: >-
Uniquement les sessions créées jusqu'à cette date (UTC) incluse, au
format `YYYY-MM-DD`. Pour les lignes KYC, la journée entière est
incluse ; pour les lignes KYB, la comparaison est `created_at <=
date_to` (minuit), utilisez donc la date du jour suivant pour
inclure une journée complète de sessions KYB.
schema:
type: string
format: date
example: '2026-06-30'
- name: tags
in: query
required: false
schema:
type: string
description: >-
Identifiants de tags séparés par des virgules (`tags` de votre
application). Renvoie les sessions portant l'un d'entre eux. Les
identifiants qui ne sont pas des UUID valides sont ignorés, et si
aucun n'est valide, la liste est vide.
- name: decided_from
in: query
required: false
schema:
type: string
format: date-time
description: >-
Date et heure ISO 8601. Renvoie les sessions dont le statut a changé
pour la dernière fois à cette date ou après celle-ci. Filtre sur
l'heure du dernier changement de statut, et non sur l'heure de
création.
- name: decided_to
in: query
required: false
schema:
type: string
format: date-time
description: >-
Date et heure ISO 8601. Renvoie les sessions dont le statut a changé
pour la dernière fois avant cette date. À combiner avec
`decided_from` pour obtenir une période semi-ouverte.
- name: country
in: query
required: false
description: >-
Filtre de pays séparés par des virgules. Pour les lignes KYC : codes
ISO 3166-1 alpha-3 de l'État de délivrance du document d'identité
(par ex. `ESP,USA`), qui peuvent différer de la nationalité. Pour
les lignes KYB : code du pays de l'entreprise enregistrée.
schema:
type: string
example: ESP,USA
- name: document_type
in: query
required: false
description: >-
Codes des types de documents d'identité vérifiés au cours de la
session, séparés par des virgules (lignes KYC uniquement) : `P`
(passeport), `ID` (carte d'identité), `DL` (permis de conduire),
`RP` (titre de séjour), `SSC` (carte de sécurité sociale), `HIC`
(carte d'assurance maladie), `WP` (permis de travail), `TC` (carte
fiscale), `VISA`, `PSC` (carte de service public), `BC` (acte de
naissance), `OTHER`. Notez que le champ de réponse `document_type`
contient le nom d'affichage, et non le code.
schema:
type: string
example: P,ID
- name: document_name
in: query
required: false
description: >-
Noms exacts des documents ; plusieurs noms peuvent être transmis
séparés par des virgules, mais la valeur n'est scindée sur les
virgules que lorsqu'elle contient plus d'un séparateur ` - ` (un nom
unique contenant une virgule est mis en correspondance dans son
intégralité). Les noms sont tels que reconnus par la vérification de
documents (recto ou verso), par ex. `Spain - Id Card (2021)`. Lignes
KYC uniquement.
schema:
type: string
example: Spain - Id Card (2021)
- name: region
in: query
required: false
description: >-
Valeurs de région/État du document séparées par des virgules (pour
les documents délivrés par région, comme les permis de conduire
américains). Lignes KYC uniquement.
schema:
type: string
example: CA,TX
- name: didit_internal_id
in: query
required: false
description: >-
Filtrer par identifiant d'utilisateur interne Didit (le champ de
réponse `didit_internal_id`) pour lister toutes les sessions d'un
utilisateur vérifié. Doit être un UUID valide ; les valeurs
malformées renvoient `400`. Lignes KYC uniquement.
schema:
type: string
format: uuid
example: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147
- name: session_type
in: query
required: false
description: >-
Canaux de création de session séparés par des virgules : `API`,
`HOSTED`, `MIGRATED`. La valeur spéciale `ALL` (ou l'omission du
paramètre) désactive le filtre. Lignes KYC uniquement.
schema:
type: string
example: HOSTED
- name: api_service
in: query
required: false
description: >-
Filtrer les sessions d'API autonomes par service. Les valeurs non
valides renvoient `400`. Lignes KYC uniquement.
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: >-
Recherche de nom insensible aux accents parmi les données filtrées
d'AML et de validation en base de données. Combinée avec
`api_service=AML` ou `api_service=DATABASE_VALIDATION`, la recherche
est limitée aux données filtrées de cette fonctionnalité. Lignes KYC
uniquement.
schema:
type: string
example: Jane Doe
- name: warning
in: query
required: false
description: >-
Codes de risque d'avertissement séparés par des virgules ; renvoie
les sessions ayant déclenché l'un d'entre eux (par ex.
`POSSIBLE_FRAUD`). Les codes de risque sont répertoriés par
fonctionnalité dans la [documentation des
avertissements](/fr/integration/webhooks). S'applique aux lignes KYC
et, avec les codes d'avertissement d'entreprise, aux lignes KYB.
schema:
type: string
example: POSSIBLE_FRAUD
- name: status_initialized_as_in_review
in: query
required: false
description: >-
Lorsque la valeur est `true`, seules les sessions dont la décision a
initialement abouti à `In Review` (utile pour auditer le volume
d'examens manuels). Lignes KYC uniquement.
schema:
type: boolean
example: true
- name: is_kyc_to_be_reviewed
in: query
required: false
description: >-
`true` renvoie les sessions dont la vérification du document est
marquée pour examen manuel ; `false` renvoie les sessions dont la
vérification du document n'est explicitement pas marquée. Omettre
pour désactiver. Lignes KYC uniquement.
schema:
type: boolean
example: true
- name: euuid
in: query
required: false
description: >-
Filtrer par l'euuid de l'utilisateur final (UUID assigné à
l'utilisateur en cours de vérification, utilisé par les liens
profonds de la Console). Doit être un UUID valide ; les valeurs
incorrectes renvoient une erreur de champ 400. Lignes KYC
uniquement.
schema:
type: string
format: uuid
example: 0f8fad5b-d9cb-469f-a165-70867728950e
- name: organization_name
in: query
required: false
description: >-
Noms d'organisations séparés par des virgules. Destiné à la console
; avec une clé API (déjà limitée à une seule application), il ne
correspond qu'au nom de votre propre organisation.
schema:
type: string
example: Acme Inc
responses:
'200':
description: >-
Liste paginée de sessions. Les éléments de `results` sont des lignes
KYC, des lignes KYB, ou les deux selon `session_kind` ;
différenciez-les grâce au champ `session_kind` de chaque ligne.
content:
application/json:
schema:
type: object
required:
- count
- next
- previous
- results
properties:
count:
type: integer
description: >-
Nombre de sessions correspondant aux filtres : exact
jusqu'à 100 et plafonné à 100 au-delà, ne l'utilisez donc
pas comme un total. Utilisez `next` pour savoir si
d'autres pages existent. Pour `session_kind=all`, il
s'agit de la somme des deux types, chacun plafonné à 100.
example: 2
next:
type: string
format: uri
nullable: true
description: >-
URL absolue de la page suivante, ou `null` sur la dernière
page.
example: >-
https://verification.didit.me/v3/sessions/?limit=20&offset=20
previous:
type: string
format: uri
nullable: true
description: >-
URL absolue de la page précédente, ou `null` sur la
première page.
example: null
results:
type: array
description: >-
Lignes de session, les plus récentes en premier. Avec
`session_kind=all`, les lignes KYC apparaissent en
premier, puis les lignes 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 - une session terminée et une session non
démarrée
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 - ligne KYC suivie d'une ligne 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: >-
Redirection vers l'URL canonique avec barre oblique finale. Renvoyée
lorsque le chemin de la requête est `/v3/sessions` (sans barre
oblique finale) ; l'en-tête `Location` pointe vers `/v3/sessions/`
en conservant la chaîne de requête. Les clients GET la suivent
généralement de manière automatique.
'400':
description: >-
Paramètre de requête non valide. Le corps est un objet indexé par le
paramètre en cause.
content:
application/json:
examples:
Invalid session_kind:
summary: session_kind n'est pas l'un de user/business/all
value:
session_kind: Must be "user", "business", or "all".
Invalid date:
summary: date_from/date_to mal formés
value:
date_from:
- Enter a valid date.
Invalid didit_internal_id:
summary: didit_internal_id n'est pas un UUID
value:
didit_internal_id:
- Enter a valid UUID.
Invalid api_service:
summary: api_service ne fait pas partie des choix autorisés
value:
api_service:
- >-
Select a valid choice. FOO is not one of the available
choices.
'403':
description: >-
Clé API manquante, malformée ou révoquée. Une clé manquante renvoie
`403` ; une clé incorrecte, révoquée ou expirée renvoie `401`.
**Application supprimée :** pendant quelques minutes après la
suppression d'une application, une requête effectuée avec l'une de
ses clés API peut répondre `{"detail": "This application was
deleted.", "code": "application_deleted"}`. Ne réessayez pas :
l'application et ses clés API n'existent plus. Après ces quelques
minutes, la clé est refusée comme toute autre clé invalide.
content:
application/json:
schema:
type: object
properties:
detail:
type: string
example: You do not have permission to perform this action.
code:
type: string
description: >-
Raison lisible par machine, présente uniquement lors de
certains échecs. `application_deleted` : la clé API
appartient à une application qui a été supprimée.
example: application_deleted
required:
- detail
examples:
Forbidden:
summary: x-api-key manquant ou invalide
value:
detail: You do not have permission to perform this action.
ApplicationDeleted:
summary: Clé API d'une application supprimée
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: >-
Ligne de résumé pour une session de Vérification des utilisateurs (KYC).
Les champs d'identité (`full_name`, `country`, `document_type`,
`portrait_image`, champs de contact) sont renseignés progressivement à
mesure que l'utilisateur franchit les étapes de vérification, et sont
`null` jusqu'à la fin de l'étape correspondante. Les champs restreints
par la configuration response-attributes du workflow sont également
renvoyés avec la valeur `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: >-
Identifiant unique de la session de vérification. Utilisez-le avec
`GET /v3/session/{sessionId}/decision/` pour récupérer l'intégralité
du payload de décision.
example: 5b3720ed-d429-42ef-b67f-37ea805f48ee
session_kind:
type: string
enum:
- user
description: >-
Discriminant de ligne. Vaut toujours `"user"` pour les lignes KYC ;
les lignes de Vérification d'entreprise (KYB) ont `"business"` et
une structure différente.
example: user
session_number:
type: integer
description: >-
Numéro séquentiel lisible par l'humain de la session au sein de
votre application. Également pris en compte par le paramètre
`search`.
example: 720
session_url:
type: string
nullable: true
description: >-
URL de vérification hébergée que l'utilisateur final ouvre pour
effectuer le parcours. `null` lorsque la session n'a pas d'URL
hébergée.
example: https://verify.didit.me/session/CuXoBYCYVO5Y
portrait_image:
type: string
nullable: true
description: >-
URL temporaire (pré-signée) du meilleur portrait disponible : la
photo de la puce NFC si disponible, sinon le portrait de la pièce
d'identité, sinon l'image de référence de détection du vivant.
`null` tant qu'aucun d'entre eux n'existe. Téléchargez-la rapidement
; le lien expire.
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: >-
Type lisible par l'utilisateur de la pièce d'identité vérifiée.
`null` avant la fin de la vérification du document, et également
`null` après celle-ci lorsque le code vérifié n'a pas de
correspondance d'affichage (`SSC`, `WP`, `VISA`, `PSC`, `BC`,
`OTHER`). Remarque : le paramètre de requête `document_type` filtre
par codes courts (`P`, `ID`, `DL`, `RP`, ...), et non par ces
valeurs d'affichage.
example: Passport
full_name:
type: string
nullable: true
description: >-
Meilleur nom complet disponible pour la session, résolu dans l'ordre
: OCR du document d'identité, données soumises au filtrage AML,
données soumises à la validation en base de données, justificatif de
domicile, puis les informations attendues fournies lors de la
création de la session. `null` lorsqu'aucun n'est encore disponible.
example: Jane Marie Doe
country:
type: string
nullable: true
description: >-
Pays ISO 3166-1 alpha-3 associé à la session, résolu dans l'ordre
suivant : pays de délivrance du document d'identité, pays de
délivrance de la validation en base de données, pays de délivrance
du justificatif de domicile, informations attendues, puis pays du
téléphone vérifié. Peut différer de la nationalité.
example: ESP
status:
type: string
enum:
- Not Started
- In Progress
- Approved
- Declined
- In Review
- Expired
- Abandoned
- Kyc Expired
- Resubmitted
- Awaiting User
description: >-
Statut global de la session. Consultez la page [Statuts de
vérification](/fr/integration/verification-statuses) pour le cycle
de vie.
example: Approved
vendor_data:
type: string
nullable: true
description: >-
Votre propre identifiant pour l'utilisateur final, renvoyé
exactement tel qu'il a été transmis lors de la création de la
session.
example: your-user-id-123
didit_internal_id:
type: string
format: uuid
nullable: true
description: "Identifiant interne Didit pour le profil d'utilisateur vérifié derrière cette session. Stable à travers plusieurs sessions du même utilisateur\_; filtrable via le paramètre de requête `didit_internal_id`."
example: d9e78474-6c8d-4f2a-bb90-6f5c2f3a1147
created_at:
type: string
format: date-time
description: Horodatage UTC de la création de la session.
example: '2026-06-09T12:26:54.328364Z'
features:
type: array
description: >-
Statut par fonctionnalité pour chaque étape de vérification
configurée dans le workflow de la session, dans l'ordre du workflow.
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: Identifiant de la fonctionnalité de vérification.
example: ID_VERIFICATION
status:
type: string
enum:
- Not Finished
- Approved
- Declined
- In Review
- Resub Requested
description: >-
Statut de cette fonctionnalité. `Not Finished` jusqu'à ce que
l'étape soit terminée.
example: Approved
phone_number:
type: object
nullable: true
description: >-
Téléphone associé à la session : le téléphone vérifié lorsque la
vérification du téléphone a été effectuée, sinon le téléphone de
contact fourni lors de la création de la session. `null`
lorsqu'aucun des deux n'existe.
required:
- number
- is_verified
properties:
number:
type: string
description: Numéro de téléphone au format E.164.
example: '+14155552671'
is_verified:
type: boolean
description: >-
`true` uniquement lorsque la fonctionnalité de vérification du
téléphone a approuvé ce numéro.
example: true
email_address:
type: object
nullable: true
description: >-
E-mail associé à la session : l'e-mail vérifié lorsque la
vérification de l'e-mail a été exécutée, sinon l'e-mail de contact
fourni lors de la création de la session. `null` si aucun des deux
n'existe.
required:
- email
- is_verified
properties:
email:
type: string
format: email
example: jane@example.com
is_verified:
type: boolean
description: >-
`true` uniquement lorsque la fonctionnalité de vérification de
l'e-mail a approuvé cette adresse.
example: true
additional_details:
type: object
nullable: true
description: >-
Données supplémentaires compactes par fonctionnalité. Seules les
fonctionnalités ayant produit des données apparaissent comme clés ;
`null` lorsqu'aucune fonctionnalité n'a produit de données
supplémentaires. Les champs exclus par la configuration des
attributs de réponse du workflow sont omis.
properties:
aml:
type: object
description: Présent lorsque le filtrage AML a été exécuté.
properties:
total_hits:
type: integer
description: Nombre de correspondances au filtrage AML.
example: 0
entity_type:
type: string
description: Type d'entité filtrée.
example: person
is_adverse_media_fetched:
type: boolean
example: false
screened_data:
type: object
description: >-
Sous-ensemble des données ayant fait l'objet d'un filtrage.
Seules les clés non vides sont incluses.
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: Présent lorsque la validation en base de données a été exécutée.
properties:
validation_type:
type: string
example: DOCUMENT_VALIDATION
match_type:
type: string
example: FULL_MATCH
identification_number:
type: string
description: >-
Numéro fiscal, personnel ou de document ayant été validé
(premier disponible).
example: 12345678Z
poa:
type: object
description: Présent lorsque le justificatif de domicile a été exécuté.
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: Présent lorsqu'une vérification du vivant a été exécutée.
properties:
method:
type: string
example: PASSIVE
score:
type: number
description: >-
Score de confiance de détection du vivant, arrondi à 2
décimales.
example: 0.98
face_match:
type: object
description: Présent lorsque la correspondance faciale a été exécutée.
properties:
score:
type: number
description: >-
Score de similarité de la correspondance faciale, arrondi à
2 décimales.
example: 0.95
source_image:
type: string
description: URL temporaire (pré-signée) de l'image du visage source.
example: https:///faces/source.jpg?X-Amz-Expires=3600&...
target_image:
type: string
description: URL temporaire (pré-signée) de l'image du visage cible.
example: https:///faces/target.jpg?X-Amz-Expires=3600&...
phone_verification:
type: object
description: Présent lorsque la vérification du téléphone a été exécutée.
properties:
country_code:
type: string
description: Pays ISO 3166-1 alpha-2 du numéro de téléphone.
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: Présent lorsque la vérification de l'e-mail a été exécutée.
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: >-
Le réviseur de la Console auquel la session est assignée, ou `null`
si personne ne la détient.
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: >-
Moment où la session a commencé à attendre un examen. `null` sauf si
la session est `In Review`.
sla_due_at:
type: string
format: date-time
nullable: true
description: >-
Date d'échéance de l'examen, d'après la date limite d'examen définie
pour votre application dans la Console. `null` sauf si la session
est `In Review` et qu'une date limite est définie.
top_warnings:
type: array
description: >-
Jusqu'à quelques-uns des avertissements les plus importants de la
session, pour une vue de triage rapide. La liste complète se trouve
dans la décision.
items:
type: object
properties:
risk:
type: string
description: Code d'avertissement, par exemple `FACE_MATCH_LOW_SIMILARITY`.
feature:
type: string
description: La fonctionnalité qui l'a déclenché.
log_type:
type: string
nullable: true
description: '`error` ou `warning` ; `null` pour une entrée héritée.'
short_description:
type: string
warnings_count:
type: integer
description: Nombre d'avertissements sur la session.
BusinessSessionListItem:
title: 'KYB session row (session_kind: business)'
type: object
description: >-
Ligne de résumé pour une session de Vérification d'entreprise (KYB).
Renvoyée uniquement lorsque `session_kind` est défini sur `business` ou
`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: Identifiant unique de la session de vérification d'entreprise.
example: 8a1f63c2-1b9e-4f3a-9c41-2f6a1f0b7d52
session_kind:
type: string
enum:
- business
description: >-
Discriminant de ligne. Vaut toujours `"business"` pour les lignes
KYB.
example: business
session_number:
type: integer
description: >-
Numéro séquentiel lisible par l'humain de la session d'entreprise au
sein de votre application. Numéroté indépendamment des sessions KYC.
example: 42
status:
type: string
enum:
- Not Started
- In Progress
- Approved
- Declined
- In Review
- Expired
- Abandoned
- Kyc Expired
- Resubmitted
- Awaiting User
description: >-
Statut global de la session. Consultez la page [Statuts de
vérification](/fr/integration/verification-statuses).
example: Approved
vendor_data:
type: string
nullable: true
description: >-
Votre propre identifiant pour l'entreprise, renvoyé exactement tel
qu'il a été transmis lors de la création de la session.
example: your-company-id-77
created_at:
type: string
format: date-time
description: Horodatage UTC de la création de la session.
example: '2026-06-08T09:14:02.118450Z'
workflow_id:
type: string
format: uuid
nullable: true
description: Identifiant du workflow avec lequel cette session a été créée.
example: 9f9b1234-aaaa-bbbb-cccc-1234567890ab
workflow_type:
type: string
nullable: true
description: Type de workflow. `kyb` pour les workflows d'entreprise.
example: kyb
workflow_label:
type: string
nullable: true
description: Nom d'affichage du workflow.
example: Standard KYB
company_name:
type: string
nullable: true
description: >-
Nom de l'entreprise en cours de vérification, issu de l'entreprise
du registre liée à la session. `null` jusqu'à ce qu'une entreprise
soit sélectionnée.
example: Acme Holdings S.L.
registration_number:
type: string
nullable: true
description: >-
Numéro d'immatriculation de l'entreprise provenant de l'entreprise
du registre des sociétés liée à la session.
example: B12345678
country:
type: string
nullable: true
description: Code pays de l'entreprise du registre liée à la session.
example: ES
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
La clé API de votre application, issue de Développeurs -> Clés API dans
la Business Console. La clé principale dispose d'un accès complet. Une
clé nommée peut être restreinte : aucun, lecture ou écriture par
ressource, limitée à certains workflows ou aux sessions approuvées, à
une liste d'adresses IP et à une date d'expiration. 401 signifie que la
clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
une route de session signifie que la session est hors des workflows ou
des statuts de la clé. Une clé sans accès aux médias reçoit les URL
d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
aux sessions reçoit les liens et tokens de session à null. Voir
https://docs.didit.me/console/api-keys.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.