Overview
Welcome to the developer documentation for integrating the eSignatures service. The eSignatures service offers the convenience and simplicity of e-signing platforms, but with the added security of biometric verification and cryptographic signatures.
You can integrate with our eSignatures service in two ways:
Technical overview
Yoti Sign has 3 personas:- Sender, Yoti and Recipient is described below.
- Sender: These are your organisation's users, who want to send out documents to be signed. They will upload their documents, and specify who should sign them.
- Yoti: Yoti stores the documents on our servers during the signing process, and sends signing requests by email.
- Recipient: Recipient will receive signing requests by email. The email will have a link to a document where they can sign.
The diagram below describes the process and how a backend can be integrated with the Yoti architecture.
eSignatures explained
Feature list
Below describes a list of features our service offers:
| Feature | Description |
|---|---|
| Send document | Upload and send a document to be signed. |
| Tags | A tag is an array of objects used to place signature fields on a given document. |
| Auto-tagging | Dynamically tag a document by including special anchor tags inside the document itself. |
| Signing order | Mandate that a certain signee signs before/after the rest. For example, all recipients within sign group 1 will be the first to receive a document to sign. Once all recipients from sign group 1 have signed, the document will be sent to sign group 2. If no sign group is specified, a default of 1 will be assumed. |
| Yoti auth | A unique feature for our eSignatures platform is the ability to add a Yoti verification on top the signature. |
| Reminders | Send a reminder to your signers. |
| One time password | Enhance security when sending across your document you can enable OTP (one time password). |
| Witness | You can add a witness to each document in the envelope. |
| Templates | Templates are ideal for frequently sent documents. |
| Text box, check box, radio buttons and date box. | Options to add to your documents. |
| Bulk send | Send multiple envelopes and documents at one time. |
| Sandbox | Only available in the API |
| Custom branding | Only available in the API |
General concepts
Yoti Sign consists of the following concepts:
eSignatures structure
| Object | Description |
|---|---|
| Envelope | The fundamental object the components are held in. This will contain the document ID, recipient ID, auth configuration and status. |
| Recipient | The person that will receive the email and document to sign, with a level of authorisation set and signature placement (tags) |
| Documents | The documents that the recipients will receive. |
Using Yoti responsibly
We pride ourselves on how we handle our users' data. We use tech for good and enable users to securely prove their identity or age, always being transparent about what happens to their details.
- Be transparent about why you're collecting data and only use this data for those reasons.
- Only collect the information you actually need. Data minimisation is one of the main benefits of Yoti, so people don't have to provide more information than is actually necessary.
- Make sure any information you export to your own systems is stored securely. Data security is at the heart of what we do and we think it should be important to every organisation.
