Passer au contenu principal
GET
cURL

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 chemin

settings_uuid
string<uuid>
requis

UUID par version du workflow (la valeur uuid renvoyée par l'endpoint de liste). Chaque version d'un workflow possède son propre settings_uuid.

Réponse

Configuration complète du workflow. Le format correspond à la sérialisation brute de VerificationSettings (~190 champs : chaque activation de fonctionnalité, seuil, action sur avertissement, configuration des documents autorisés, le workflow_graph, la politique de nouvelle tentative, les callbacks et les tarifs). L'exemple ci-dessous est abrégé. Remarques : features est une chaîne reliée par " + " (par ex. "OCR + LIVENESS"), les prix sont des nombres JSON, et is_editable est à true uniquement pour les versions draft.

Les champs ci-dessous sont typés ; l'objet contient également toutes les autres colonnes de la configuration du workflow (activation des fonctionnalités, seuils, actions d'avertissement, documents autorisés, rappels) sous forme de propriétés supplémentaires. Les champs qui ne s'appliquent pas au workflow_type sont null.

uuid
string<uuid>

Identifiant par version (settings_uuid). Chaque version d'un workflow possède le sien.

workflow_id
string<uuid>

Identifiant stable partagé par toutes les versions du workflow. Les sessions créées avec celui-ci utilisent la dernière version publiée.

workflow_label
string

Nom d'affichage du workflow.

workflow_type
enum<string> | null

Modèle de workflow. null pour les workflows sous forme de graphe créés sans modèle.

Options disponibles:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

Indique s'il s'agit du workflow par défaut de l'application.

is_archived
boolean

Les workflows archivés ne peuvent pas démarrer de nouvelles sessions.

version
integer

Numéro de version au sein du workflow.

status
enum<string>

Les versions de brouillon sont modifiables ; les versions publiées sont immuables et utilisées pour les nouvelles sessions.

Options disponibles:
draft,
published
published_at
string<date-time> | null

Date et heure auxquelles cette version a été publiée. null pour les brouillons.

is_simple_workflow
boolean

true lorsque le workflow ne comporte aucun workflow_graph personnalisé.

is_editable
boolean

true uniquement pour les versions draft.

workflow_url
string<uri>

URL publique qui démarre une session avec ce workflow.

workflow_graph
object | null

Structure en graphe du workflow (nœuds et arêtes). null pour les workflows simples.

features
string

Fonctionnalités activées jointes par " + ", par exemple "OCR + LIVENESS".

total_price
number | null

Prix par session ; pour les workflows de graphe, le parcours le plus cher.

min_price
number | null

Prix du parcours le moins cher dans le workflow.

max_price
number | null

Prix du parcours le plus cher dans le workflow.

special_add_on_prices
object | null

Prix des modules complémentaires spécifiques à l'organisation, ou null si aucun n'est défini.

max_retry_attempts
integer

Réessais autorisés après une vérification refusée.

retry_window_days
integer | null

Nombre de jours pendant lesquels les nouvelles tentatives sont autorisées.

session_expiration_time
integer

Secondes avant l'expiration d'une session inachevée.

questionnaire
object | null

Le questionnaire associé au workflow, ou null.

kyb_role_settings
object[]

Paramètres de vérification par rôle pour les personnes clés KYB.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

Quels niveaux de Signature électronique peuvent signer actuellement. Vérifiez-le avant de définir signature_level. Renvoyé sur les workflows kyc, kyb et de graphe.

is_bank_verification_enabled
boolean

Indique si un workflow KYC ou KYB simple exécute la vérification bancaire. Elle s'exécute après les étapes de contact (et la vérification de localisation) et avant la validation en base de données, le filtrage AML et l'analyse IP. La vérification bancaire n'est pas encore disponible pour tous : son activation est refusée partout où elle n'est pas activée.

bank_verification_config
object

Paramètres de vérification bancaire d'un workflow simple, avec les mêmes clés qu'un nœud BANK_VERIFICATION (par exemple bank_countries et bank_method_order). Les clés inconnues sont ignorées. Chaque clé est optionnelle et une clé absente conserve sa valeur par défaut, {} désigne donc toutes les valeurs par défaut. Voir Paramètres de vérification bancaire.

Exemple:
is_geolocation_enabled
boolean

Indique si un workflow KYC simple exécute la vérification de localisation. Elle s'exécute après les étapes de contact et avant la vérification bancaire et la validation en base de données. Les workflows d'entreprise (KYB) ne peuvent pas l'exécuter.

geolocation_config
object

Paramètres de vérification de localisation d'un workflow simple, avec les mêmes clés qu'un nœud GEOLOCATION (par exemple is_geolocation_geofencing_enabled et geolocation_max_attempts). Les clés inconnues sont ignorées. Chaque clé est facultative et une clé absente conserve sa valeur par défaut, {} correspond donc à toutes les valeurs par défaut.

Exemple:
Dernière modification le 7 novembre 2026