Yoti Sign Connector

[#1]

Note on third‑party tools

We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.

Yoti Sign is a digital identity and e-signature solution that allows users to verify their identity and sign documents electronically and securely.

Connections

API Key Connection

The connection to the Yoti API

Before you start
Request your API keys, please notify Yoti Client Support and specify if you want to use sandbox or production.
Get your API Keys here

Yoti Sign uses an HTTP authentication scheme called ‘bearer authentication’. This involves security tokens called ‘bearer tokens’. They are the predominant type of access token used with OAuth 2.0. A resource should interpret a bearer token as "Give the bearer of this token access". The client must send this token in the Authorization header when making requests to protected resources.

It is important that your API Key remains strictly confidential. It must be stored securely. We advise that you never commit any code containing your API Key, and never share it beyond the authorized party.

If you believe your API key has been compromised, please contact Yoti Client Support as soon as possible. This can be done through your account manager or via our support channel by emailing clientsupport@yoti.com.

Input	Comments	Default
Environment	The environment to use for the Yoti Sign API
API Key	The Yoti API Key

Actions

Archive Envelope

Archiving an envelope stops all other signers from signing and leaves the envelope in the state it was archived in.

Input	Comments	Default
Connection
Envelope ID	The ID of the envelope
Debug Request	Enabling this flag will log out the current request.	false

Create Embedded Envelope

Create an envelope for Yoti Sign

Input	Comments	Default
Connection
Files	The files to be used for the envelope
PDF File Name	The name of the file to be used for the envelope
Recipients	The recipients to send the envelope to	[ { "name": "User 1", "email": "user1@gtest.com", "role": "Signee", "auth_type": "no-auth", "sign_group": 1, "tags": [ { "page_number": 1, "x": 0.1, "y": 0.1, "type": "signature", "optional": false, "file_name": "myfile.pdf" } ], "event_notifications": [ "signer_invitation", "signer_invitation_sms", "envelope_completion" ], "rules": [ { "action": "show", "conditions": [ { "trigger_tag_name": "sign-here", "criteria": "has_value" } ], "affected_tag_names": [ "signee-name" ] } ], "witness": { "tags": [] } } ]
Envelope Name	The name of the envelope
Emails	The emails to be used for the envelope	{ "invitation": { "body": { "message": "Please sign this document" } }, "reminders": { "frequency": 1 } }
Notification Destination	The destination for the notifications
Notifications Subscriptions	The notifications subscriptions to be used for the envelope
Branding	The branding to be used for the envelope	{ "logo_options": { "logo_choice": "brand_powered_by_yoti", "logo_base64": "base64-encoded-PNG-image" }, "primary_color": "#000", "primary_color_hover": "#c0c0c0", "on_primary_color": "#fff", "secondary_color": "#00ffff", "secondary_color_hover": "#d2691e" }
Parent Redirect URLs	The parent redirect URLs to be used for the envelope	{ "success": "https://someurl.com/success", "failure": "https://someurl.com/failure" }
Autotagging	Auto-tagging is an optional property and is used to automatically place fields in documents which have been set up for Auto-tagging. This is an extension of templates.
Debug Request	Enabling this flag will log out the current request.	false

Create Envelope

Create an envelope for Yoti Sign

Input	Comments	Default
Connection
Files	The files to be used for the envelope
PDF File Name	The name of the file to be used for the envelope
Envelope Name	The name of the envelope
Recipients	The recipients to send the envelope to	[ { "name": "User 1", "email": "user1@gtest.com", "role": "Signee", "auth_type": "no-auth", "sign_group": 1, "tags": [ { "page_number": 1, "x": 0.1, "y": 0.1, "type": "signature", "optional": false, "file_name": "myfile.pdf" } ], "event_notifications": [ "signer_invitation", "signer_invitation_sms", "envelope_completion" ], "rules": [ { "action": "show", "conditions": [ { "trigger_tag_name": "sign-here", "criteria": "has_value" } ], "affected_tag_names": [ "signee-name" ] } ], "witness": { "tags": [] } } ]
Has Envelope OTPs	Boolean, to determine if the envelope access requires OTP verification
Emails	The emails to be used for the envelope	{ "invitation": { "body": { "message": "Please sign this document" } }, "reminders": { "frequency": 1 } }
Notification Destination	The destination for the notifications
Notifications Subscriptions	The notifications subscriptions to be used for the envelope
Branding	The branding to be used for the envelope	{ "logo_options": { "logo_choice": "brand_powered_by_yoti", "logo_base64": "base64-encoded-PNG-image" }, "primary_color": "#000", "primary_color_hover": "#c0c0c0", "on_primary_color": "#fff", "secondary_color": "#00ffff", "secondary_color_hover": "#d2691e" }
Parent Redirect URLs	The parent redirect URLs to be used for the envelope	{ "success": "https://someurl.com/success", "failure": "https://someurl.com/failure" }
Autotagging	Auto-tagging is an optional property and is used to automatically place fields in documents which have been set up for Auto-tagging. This is an extension of templates.
Debug Request	Enabling this flag will log out the current request.	false

Edit Recipient

Change the recipient of your envelope.

Input	Comments	Default
Connection
Envelope ID	The ID of the envelope
Recipient ID	The ID of the recipient
Recipient Info	The recipient info to be modified	{ "name": "foobar", "email": "test@example.com", "iso_country_code": "US", "mobile_number": "2136210002" }
Debug Request	Enabling this flag will log out the current request.	false

Envelope Status

Get the status of a single envelope

Input	Comments	Default
Connection
Envelope ID	The ID of the envelope
Debug Request	Enabling this flag will log out the current request.	false

Find Envelopes

This allows you to find the envelope details for specified envelopes.

Input	Comments	Default
Connection
Envelope IDs	The IDs of the envelopes
Debug Request	Enabling this flag will log out the current request.	false

Get Documents

Get Documents from a specific envelope based on Envelope ID

Input	Comments	Default
Connection
Envelope ID	The ID of the envelope
Debug Request	Enabling this flag will log out the current request.	false

Get Envelope

Get Envelope details based on Envelope ID

Input	Comments	Default
Connection
Envelope ID	The ID of the envelope
Debug Request	Enabling this flag will log out the current request.	false

Get IDV session media

This action will allow you to obtain the individual media generated in the identity verification session submitted in signing e.g the image of a document.

Input	Comments	Default
Connection
Recipient ID	The ID of the recipient
Media ID	The ID of the media
Debug Request	Enabling this flag will log out the current request.	false

Get IDV Session Result

This will return the result of the Identity verification session in JSON format

Input	Comments	Default
Connection
Recipient ID	The ID of the recipient
Debug Request	Enabling this flag will log out the current request.	false

List Envelopes

List Envelopes based on the search criteria. If no search criteria is provided, it will return all envelopes.

Input	Comments	Default
Connection
Fetch All	Boolean to determine if all records should be fetched	false
Offset	The files to be used for the envelope
Limit	The amount of envelopes to return
Key Value Params	Key value pairs to be used as query parameters
Debug Request	Enabling this flag will log out the current request.	false

Send Reminder

Send a reminder to a recipient to sign the envelope.

Input	Comments	Default
Connection
Envelope ID	The ID of the envelope
Recipient ID	The ID of the recipient
Debug Request	Enabling this flag will log out the current request.	false