Create envelope

An envelope serves as a container for all Yoti Sign transactions. When you create an envelope the following elements are configurable:

• File
• Name
• Email
• Reminders
• Envelope one time password
• Recipients including tags, auto-tagging and witnesses.
• Notifications
• Branding (only available with embedded flow)

Yoti offers two types of envelope flows:

1. Yoti envelope - Yoti will handle the flow.
2. Embedded envelope - The envelope will be rendered directly in the browser, commonly via an iFrame.

Important Authentication is important. Please ensure that any user signing through the embedded version are authenticated. You can do this by validating the email address or doing an IDV check on the user. More information is provided in the next section.

Headers explained

The following elements are needed in the header:

Body explained

Each subpart should declare its appropriate Content-Type:

There must be at least 1 file and a maximum of 20. When sending multiple documents, they will be received in the order sent.

Hint If you have access to the Yoti Sign portal you can retrieve a template with example JSON. See Templates.