Passer au contenu principal
POST
Python
Un aperçu ne modifie pas la session et n’envoie pas d’e-mail. Après avoir examiné la réponse, confirmez avec Mettre à jour le statut de la session en transmettant le preview_token renvoyé comme email_preview_token. Le reçu expire au bout de 15 minutes. Un reçu modifié ou expiré renvoie 409 avant que la session ne soit modifiée et qu’un e-mail ne soit envoyé. Générez un nouvel aperçu après un conflit. Les intégrations API existantes peuvent omettre le reçu : la console le fournit lors de la confirmation d’un aperçu. L’expéditeur et l’image de marque suivent votre configuration de marque blanche. Le contenu du message provient du modèle de vérification traduit : les objets, les corps de message et les URL d’action personnalisés ne sont pas acceptés comme entrées de modèle.

Qui reçoit l’e-mail

email_address est facultatif. Sans ce champ, l’e-mail est envoyé à l’adresse de la personne : celle qu’elle a vérifiée lors d’une étape de vérification de l’e-mail du parcours, sinon celle indiquée dans contact_details lors de la création de la session. Une adresse transmise dans email_address prévaut. recipient_source indique l’adresse applicable :

Si l’e-mail est envoyé

will_be_sent vaut true lorsque la confirmation de la nouvelle soumission avec send_email: true envoie l’e-mail. Lorsqu’il vaut false, not_sent_reason en indique la raison :

Confirmer la nouvelle soumission

Appelez Mettre à jour le statut de la session avec ces champs : La valeur language de la réponse correspond à la langue de rédaction de l’e-mail : l’anglais est utilisé lorsque la langue demandée n’est pas proposée.

Nouvelles soumissions répétées sans action de la personne

Lorsque chaque étape à soumettre à nouveau s’exécute sans la personne (AML, Validation en base de données ou Analyse IP), une session ne peut être soumise à nouveau pour elle qu’une fois toutes les 30 secondes. Pendant cette fenêtre, l’aperçu renvoie 429, comme le ferait Mettre à jour le statut de la session, avec le délai d’attente dans l’en-tête Retry-After.

Voir aussi

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

sessionId
string<uuid>
requis

UUID de la session de vérification à mettre à jour. Accepte les identifiants de session d'utilisateur (KYC) et d'entreprise (KYB) — le service résout l'identifiant pour les deux types de session.

Exemple:

"11111111-2222-3333-4444-555555555555"

Corps

application/json
nodes_to_resubmit
object[]

Étapes à prévisualiser, en utilisant les mêmes règles de validation, de sélection et d'ordonnancement du workflow qu'une nouvelle soumission. Omettez ce paramètre pour sélectionner automatiquement les tentatives enregistrées nécessitant une nouvelle soumission.

email_address
string<email>

Optionnel. Envoie l'e-mail à cette adresse au lieu de celle de la personne. Sans cela, le destinataire est l'adresse vérifiée par la personne dans le workflow, sinon celle indiquée dans contact_details. Aucun e-mail n'est envoyé par cet appel.

Exemple:

"user@example.com"

email_language
string
défaut:en

Langue de l'e-mail de notification. Accepte n'importe quelle chaîne au niveau du schéma ; les codes non pris en charge basculent silencieusement sur l'anglais (en).

Exemple:

"en"

Réponse

Prévisualisation uniquement. La session reste inchangée et aucun e-mail n'est envoyé.

recipient
string
requis

L'adresse à laquelle l'e-mail est envoyé. Une chaîne vide lorsqu'aucune adresse n'est connue pour la personne : aucun e-mail ne peut alors être envoyé et preview_token est également vide. Transmettez-la en tant que email_address lors de la confirmation.

Exemple:

"person@example.com"

recipient_source
enum<string>
requis

Provenance de recipient. request : l'email_address transmise. email_verification : l'adresse vérifiée par la personne lors d'une étape de vérification de l'e-mail du flux. contact_details : l'adresse fournie dans contact_details lors de la création de la session. Une chaîne vide lorsqu'il n'y a pas d'adresse.

Options disponibles:
email_verification,
contact_details,
request,
Exemple:

"email_verification"

sender
string
requis

L'en-tête From avec lequel l'e-mail est envoyé.

Exemple:

"Example App <no-reply@mail.example.com>"

sender_name
string
requis

La partie nom d'affichage de sender.

Exemple:

"Example App"

sender_email
string<email>
requis

La partie adresse de sender.

Exemple:

"no-reply@mail.example.com"

sender_kind
enum<string>
requis

customer : l'e-mail est envoyé depuis le domaine d'expéditeur vérifié de votre application (marque blanche). didit : il est envoyé depuis le propre expéditeur de Didit.

Options disponibles:
customer,
didit
Exemple:

"customer"

subject
string
requis

La ligne d'objet exactement telle qu'elle est envoyée.

Exemple:

"Action Required: Complete your verification in Example App"

html
string
requis

Le HTML de l'e-mail exactement tel qu'il est envoyé, avec son logo intégré sous forme de data URL. Affichez-le dans un cadre sandboxé, jamais directement dans le DOM de votre application.

Exemple:

"<!DOCTYPE html><html><body>...</body></html>"

text
string
requis

Le texte brut de l'e-mail, tel qu'il apparaît dans le fil Messages de la personne, pour un aperçu compact (le HTML reste l'e-mail que la personne reçoit).

Exemple:

"Almost there\n\nSome steps need to be completed again.\nHere’s what to fix:\n\nhttps://verify.didit.me/session/abc123"

language
string
requis

La langue dans laquelle l'e-mail est rédigé. Anglais (en) lorsque le email_language demandé n'est pas proposé.

Exemple:

"en"

will_be_sent
boolean
requis

Indique si la confirmation de la modification avec send_email: true envoie cet e-mail. false lorsque not_sent_reason est défini.

Exemple:

true

not_sent_reason
enum<string> | null
requis

Raison pour laquelle la confirmation n'enverrait aucun e-mail, ou null lorsqu'il sera envoyé. no_user_action : chaque étape sélectionnée s'exécute sans intervention de la personne, la nouvelle soumission se termine donc d'elle-même et aucun e-mail n'est envoyé. no_recipient : aucune adresse n'est connue pour la personne et vous n'en avez transmis aucune. sandbox : une session sandbox dont le destinataire n'a pas activé la réception d'e-mails en sandbox, l'envoi est donc seulement simulé.

Options disponibles:
no_user_action,
no_recipient,
sandbox,
null
Exemple:

null

nodes_to_resubmit
object[]
requis
requires_user_action
boolean
requis

Indique si au moins un contrôle sélectionné nécessite une interaction de l'utilisateur. Cela ne présage pas du résultat final du workflow.

preview_token
string
requis

Récépissé signé pour cet e-mail exact, valide pendant 15 minutes. Transmettez-le en tant que email_preview_token à Mettre à jour le statut de la session. Une chaîne vide lorsqu'il n'y a aucun destinataire.

Exemple:

"eyJkaWdlc3QiOiI0ZjJhIn0:1uExAm:Pl3x4mpleS1gnatureValue000000000000000"

Dernière modification le 7 novembre 2026