Passer au contenu principal
GET
curl
Cet endpoint renvoie les chiffres affichés dans le tableau de bord d’analyse de la Business Console. Il possède deux formats de réponse : Chaque widget contient un kind et un title ; les autres champs dépendent du type. Envoyez scope sans widget_keys une fois pour lire available_widget_keys, puis ne demandez que les widgets dont vous avez besoin.
Seule une clé API à accès complet peut appeler cet endpoint. Une clé à accès limité reçoit un 403 quel que soit l’accès qu’elle possède, et il en va de même pour une clé appartenant à une autre application. Voir Clés API.

Liens connexes

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

organization_id
string<uuid>
requis

UUID de l'organisation.

application_id
string<uuid>
requis

UUID de l'application. Doit être l'application à laquelle appartient la clé API : une clé utilisée sur toute autre application reçoit une erreur 403.

Paramètres de requête

start_date
string<date>

Premier jour de la plage, YYYY-MM-DD, inclus (UTC). À envoyer avec end_date : si l'un des deux est manquant, les deux sont ignorés et la plage s'étend de 30 jours avant aujourd'hui jusqu'à aujourd'hui.

Exemple:

"2026-10-01"

end_date
string<date>

Dernier jour de la plage, YYYY-MM-DD, inclus (UTC). Une date future équivaut à aujourd'hui. La plage ne peut pas dépasser 730 jours.

Exemple:

"2026-10-15"

scope
enum<string>

Onglet du tableau de bord pour lequel renvoyer les widgets (insensible à la casse). Omettez-le, ainsi que widget_keys, pour obtenir le récapitulatif KYC. Envoyer uniquement widget_keys implique kyc. home accepte tout widget KYC, KYB ou de transaction et utilise par défaut la disposition d'accueil enregistrée de l'application.

Options disponibles:
home,
kyc,
kyb,
transactions
widget_keys
string

Clés de widgets séparées par des virgules, renvoyées dans cet ordre. Les clés non acceptées par le périmètre sont ignorées ; s'il n'en reste aucune, vous obtenez les valeurs par défaut du périmètre. KYC : kyc_sessions_volume, kyc_warning_insights, kyc_id_locations, kyc_ip_locations, kyc_workflow_funnel, kyc_average_verification_time, kyc_conversion_rate, kyc_conversion_by_country, kyc_resubmission_insights, kyc_original_status_distribution, kyc_database_validation_coverage, kyc_database_validation_latency, kyc_demographics, kyc_device_details. KYB : kyb_sessions_volume, kyb_workflow_funnel, kyb_average_verification_time, kyb_ip_locations, kyb_business_country_distribution, kyb_warning_insights, kyb_conversion_rate, kyb_conversion_by_country, kyb_industry_breakdown, kyb_resubmission_insights, kyb_original_status_distribution, kyb_registry_coverage, kyb_registry_data_completeness, kyb_device_details. Transactions : tx_count_total, tx_count_daily, tx_volume_total_preferred_currency, tx_volume_daily_preferred_currency, tx_average_amount, tx_average_amount_daily, tx_transaction_category_breakdown, tx_action_type_breakdown, tx_status_volume_trend, tx_user_ip_or_country_distribution, tx_tag_breakdown, tx_top_rules_triggered, tx_team_member_performance, tx_score_histogram.

Exemple:

"tx_count_total,tx_count_daily"

workflow_ids
string

Identifiants de workflow séparés par des virgules. Limite le récapitulatif KYC ainsi que les widgets KYC et KYB à ces workflows. Les valeurs qui ne sont pas des UUID sont ignorées ; si aucune n'est valide, le filtre est abandonné. Le récapitulatif accepte également workflow_id.

Exemple:

"33333333-4444-5555-6666-777777777777"

versions
string

Numéros de version de workflow séparés par des virgules. S'applique uniquement en combinaison avec workflow_ids ; les valeurs qui ne sont pas des nombres entiers sont ignorées. version est accepté comme alias.

Exemple:

"3,4"

branch_path_ids
string

Identifiants de chemins de branche séparés par des virgules. S'applique uniquement avec workflow_ids, et seulement aux chiffres KYC. Les chiffres sont actuellement enregistrés uniquement pour default (tous les chemins combinés), toute autre valeur renvoie donc des chiffres vides. branch_path_id est accepté en alias.

Exemple:

"default"

tag
string

Widgets de transactions uniquement : UUID ou noms de tags séparés par des virgules.

transaction_type
string

Widgets de transactions uniquement : catégories de transaction séparées par des virgules.

Exemple:

"finance"

action_type
string

Widgets de transactions uniquement : types d'actions séparés par des virgules (insensible à la casse).

Exemple:

"withdrawal"

Réponse

Le récapitulatif KYC, ou les widgets demandés lorsque scope ou widget_keys est envoyé.

Résumé de la vérification d'identité (KYC) de l'utilisateur, renvoyé lorsque ni scope ni widget_keys ne sont envoyés.

data_points
object[]
requis

Un point par jour, du premier jour avec des sessions dans l'intervalle jusqu'à end_date. Toujours quotidien, quelle que soit la valeur de grouping_mode.

request_breakdown
object
requis

Totaux de statuts pour la période. La répartition de la période précédente contient au moins les champs requis.

previous_data_points
object[]
requis

Points quotidiens pour la période de même durée précédant immédiatement start_date.

previous_request_breakdown
object
requis

Totaux de statuts pour la période. La répartition de la période précédente contient au moins les champs requis.

conversion_rate
number | null
requis

total_approved / (total_approved + total_declined + total_in_review) x 100, une décimale. null lorsque rien n'est terminé.

location_stats
object
requis
demographic_stats
object
requis
device_details
object
requis

Les cinq premiers de chaque catégorie, avec les sessions les plus nombreuses en premier.

workflow_funnel_stats
object
requis

Indexé par ID de workflow. total correspond aux sessions démarrées sur ce workflow ; steps compte les sessions ayant atteint chaque étape (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Atteindre une étape ne signifie pas la valider.

verification_time_stats
object
requis

Temps actif passé par les utilisateurs à se vérifier, sans compter les périodes d'inactivité. Objet vide en l'absence de données.

resubmission_stats
object
requis
warning_stats
object
requis

Indexé par fonctionnalité (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE et les fonctionnalités KYB). total correspond aux sessions ayant atteint la fonctionnalité ; risks compte les sessions par code et niveau d'avertissement.

original_status_stats
object
requis

Le verdict automatique du workflow, avant toute modification par un réviseur.

grouping_mode
enum<string>
requis

Manière dont les listes *_time_series sont regroupées : day jusqu'à 14 jours, week jusqu'à 90, month au-delà. Mesuré à partir du premier jour comportant des sessions dans la plage.

Options disponibles:
day,
week,
month
demographic_time_series
object[]
requis
device_time_series
object[]
requis
verification_time_time_series
object[]
requis
resubmission_time_series
object[]
requis
original_status_time_series
object[]
requis
Dernière modification le 7 novembre 2026