Delivery mode: email for Verify Workflow Sessions

You can now delegate session link notifications to Yousign, per Applicant, by setting delivery_mode to "email" on an Applicant object. Two new fields are available on both natural_person and legal_person Applicants:

• delivery_mode: controls how the session link and result notification are delivered. Accepted values: "email" or "none" (default).
• email: the delivery address. Required when delivery_mode is "email", optional otherwise (stored for later use).

How it works:

1. Create the Applicant with delivery_mode: "email" and a valid email.
2. Call GET /v3/workflow_sessions/{workflowSessionId}/links: Yousign sends the session link by email to the Applicant and transitions the Applicant to notified (firing the existing applicant.notified webhook). The link is also returned in the API response as usual. Subsequent calls while the Applicant is already notified return the link without sending a new email.
3. When the session reaches done or blocked, Yousign sends a result notification email to the same address. No email is sent on ongoing.

When delivery_mode is "none" (the default), behavior is unchanged: the link is returned in the API response only, no email is sent, and the responsability of the notification remains on Customer side.

V1 scope: all emails are sent in English, regardless of the Applicant's locale. Locale-based email language is planned for V2.

More information in our dedicated API guide article.