API liste des sessions : filtrer les sessions KYC et KYB

curl

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'

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

iter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

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));
}

{
  "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://<media-host>/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
    }
  ]
}

GET

sessions

curl

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'

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

iter := client.Sessions.ListAutoPaging(ctx, didit.SessionsListParams{})
for iter.Next() {
	fmt.Printf("%+v\n", iter.Current())
}
if err := iter.Err(); err != nil {
	log.Fatal(err)
}

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));
}

{
  "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://<media-host>/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
    }
  ]
}

Filtre par type de session

Utilisez 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 communs

Ces 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).
`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

Lister les sessions de Vérification des utilisateurs (KYC) (par défaut)
Lister les sessions de Vérification d'entreprise (KYB)
Lister les deux types

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) :

{
  "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
    }
  ]
}

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) :

{
  "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"
    }
  ]
}

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.

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 type

Les 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 pour la matrice complète des fonctionnalités.

Pagination

La 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
Récupérer une session : décision complète pour une seule ligne
Vue d’ensemble des entreprises : l’entité Business agrégée à travers les sessions
Vue d’ensemble des utilisateurs : l’entité User agrégée à travers les sessions

Autorisations

x-api-key

string

header

requis

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.

Paramètres de requête

session_kind

enum<string>

défaut:user

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.

Options disponibles:

user,

business,

all

limit

integer

défaut:50

Nombre maximal de lignes par page (par type lorsque session_kind=all). Vaut par défaut 50.

Plage requise: 1 <= x <= 1000000

offset

integer

défaut:0

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.

Plage requise: 0 <= x <= 1000000

status

string

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. Les valeurs inconnues ne correspondent à aucun élément.

vendor_data

string

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.

string

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.

workflow_id

string

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.

date_from

string<date>

Uniquement les sessions créées à partir de cette date (UTC) incluse, au format YYYY-MM-DD. Les dates mal formées renvoient 400.

date_to

string<date>

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.

tags

string

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.

decided_from

string<date-time>

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.

decided_to

string<date-time>

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.

country

string

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.

document_type

string

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.

document_name

string

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.

region

string

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.

didit_internal_id

string<uuid>

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.

session_type

string

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.

api_service

enum<string>

Filtrer les sessions d'API autonomes par service. Les valeurs non valides renvoient 400. Lignes KYC uniquement.

Options disponibles:

ID_VERIFICATION,

FACE_MATCH,

AGE_ESTIMATION,

FACE_SEARCH,

POA,

AML,

KYB_REGISTRY,

PASSIVE_LIVENESS,

DATABASE_VALIDATION,

PHONE_VERIFICATION,

EMAIL_VERIFICATION

screened_full_name

string

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.

warning

string

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. S'applique aux lignes KYC et, avec les codes d'avertissement d'entreprise, aux lignes KYB.

status_initialized_as_in_review

boolean

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.

is_kyc_to_be_reviewed

boolean

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.

euuid

string<uuid>

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.

organization_name

string

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.

Réponse

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.

count

integer

requis

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.

Exemple:

2

string<uri> | null

requis

URL absolue de la page suivante, ou null sur la dernière page.

Exemple:

"https://verification.didit.me/v3/sessions/?limit=20&offset=20"

string<uri> | null

requis

URL absolue de la page précédente, ou null sur la première page.

Exemple:

null

results

(KYC session row (session_kind: user) · object | KYB session row (session_kind: business) · object)[]

requis

Lignes de session, les plus récentes en premier. Avec session_kind=all, les lignes KYC apparaissent en premier, puis les lignes KYB.

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.

KYC session row (session_kind: user)
KYB session row (session_kind: business)

Show child attributes

Dernière modification le 7 novembre 2026

​Filtre par type de session

​Filtres communs

​Exemples

​Les structures de lignes diffèrent selon le type

​Pagination

​Liens connexes

Autorisations

Paramètres de requête

Réponse

Filtre par type de session

Filtres communs

Exemples

Les structures de lignes diffèrent selon le type

Pagination

Liens connexes