Skip to main content
yoti-sign icon

Yoti Sign Connector

SourceDeveloper DocsConnector Changelog

Description​

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

Use the Yoti Sign component to send, sign, track, and manage the signature process.

API Documentation: Yoti eSignatures,

Connections​

API Key Connection​

key: apiKey

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.

InputNotesExample
API Key

The Yoti API Key

Environment

The environment to use for the Yoti Sign API

Triggers​

New Envelopes​

Fetches Yoti Sign Envelopes created on a recurring schedule. | key: pollChangesTrigger

InputNotesExample
ConnectionA connection used for Yoti Sign

This trigger polls Yoti Sign on a configured schedule and emits envelopes that were created since the previous run. It is a convenient alternative to webhooks when a scheduled pull is preferred over an event push.

It filters server-side using the envelope search endpoint's from_date parameter, which filters and sorts by each envelope's created_at timestamp.

How It Works​

On each scheduled run, the trigger searches envelopes with from_date set to the date of the previous poll, then keeps only the envelopes whose created_at is strictly after the previous poll time. The current run time is stored as the cursor for the next run.

  • First run: the very first execution records the cursor and emits nothing, so an instance does not receive a backlog of historical envelopes on deploy.
  • Subsequent runs: only envelopes created since the last run are returned.

Returned Data​

The trigger returns the newly created envelopes under data.created. Fields shown are representative. The full response object includes additional properties.

Example Payload
{
  "data": {
    "created": [
      {
        "envelope_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "envelope": "Contract for Jane Smith",
        "status": "ACTIVE",
        "created_at": "2026-05-30T14:22:00Z"
      }
    ]
  }
}

Notes​

  • This trigger detects newly created envelopes only. The search endpoint filters by created_at, and envelope records do not expose a modification timestamp, so status changes to existing envelopes are not detected here. Use Yoti Sign's notifications/webhooks for envelope status updates.
  • The from_date filter has day granularity (YYYY-MM-DD); the trigger applies a precise client-side created_at high-water mark so envelopes are not re-emitted within the same day.

Data Sources​

Select Envelope​

Select an envelope from a list of envelopes in your Yoti Sign account. | key: selectEnvelope | type: picklist

InputNotesExample
ConnectionA connection used for Yoti Sign
Example Payload for Select Envelope⤓
Loading…

Actions​

Archive Envelope​

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

InputNotesExample
ConnectionA connection used for Yoti Sign
Envelope ID

The ID of the envelope

envelope-id
Example Payload for Archive Envelope⤓
Loading…

Create Embedded Envelope​

Create an envelope for Yoti Sign | key: createEmbeddedEnvelope

InputNotesExample
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.

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"
}
ConnectionA connection used for Yoti Sign
Emails

The emails to be used for the envelope

{
  "invitation": {
    "body": {
      "message": "Please sign this document"
    }
  },
  "reminders": {
    "frequency": 1
  }
}
Envelope Name

The name of the envelope

Envelope name
Files

The files to be used for the envelope

PDF File Name

The name of the file to be used for the envelope

example.pdf
Notification Destination

The destination for the notifications

https://example.com/callback
Notifications Subscriptions

The notifications subscriptions to be used for the envelope

Parent Redirect URLs

The parent redirect URLs to be used for the envelope

{
  "success": "https://someurl.com/success",
  "failure": "https://someurl.com/failure"
}
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": []
    }
  }
]
Example Payload for Create Embedded Envelope⤓
Loading…

Create Envelope​

Create an envelope for Yoti Sign | key: createEnvelope

InputNotesExample
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.

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"
}
ConnectionA connection used for Yoti Sign
Emails

The emails to be used for the envelope

{
  "invitation": {
    "body": {
      "message": "Please sign this document"
    }
  },
  "reminders": {
    "frequency": 1
  }
}
Envelope Name

The name of the envelope

Envelope name
Files

The files to be used for the envelope

PDF File Name

The name of the file to be used for the envelope

example.pdf
Has Envelope OTPs

Boolean, to determine if the envelope access requires OTP verification

Notification Destination

The destination for the notifications

https://example.com/callback
Notifications Subscriptions

The notifications subscriptions to be used for the envelope

Parent Redirect URLs

The parent redirect URLs to be used for the envelope

{
  "success": "https://someurl.com/success",
  "failure": "https://someurl.com/failure"
}
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": []
    }
  }
]
Example Payload for Create Envelope⤓
Loading…

Edit Recipient​

Change the recipient of your envelope. | key: editRecipient

InputNotesExample
ConnectionA connection used for Yoti Sign
Envelope ID

The ID of the envelope

envelope-id
Recipient ID

The ID of the recipient

recipient-id
Recipient Info

The recipient info to be modified

{
  "name": "foobar",
  "email": "test@example.com",
  "iso_country_code": "US",
  "mobile_number": "2136210002"
}
Example Payload for Edit Recipient⤓
Loading…

Envelope Status​

Get the status of a single envelope | key: getEnvelopeStatus

InputNotesExample
ConnectionA connection used for Yoti Sign
Envelope ID

The ID of the envelope

envelope-id
Example Payload for Envelope Status⤓
Loading…

Find Envelopes​

This allows you to find the envelope details for specified envelopes. | key: findEnvelopes

InputNotesExample
ConnectionA connection used for Yoti Sign
Envelope IDs

The IDs of the envelopes

Example Payload for Find Envelopes⤓
Loading…

Get Documents​

Get Documents from a specific envelope based on Envelope ID | key: getDocuments

InputNotesExample
ConnectionA connection used for Yoti Sign
Envelope ID

The ID of the envelope

envelope-id
Example Payload for Get Documents⤓
Loading…

Get Envelope​

Get Envelope details based on Envelope ID | key: getEnvelope

InputNotesExample
ConnectionA connection used for Yoti Sign
Envelope ID

The ID of the envelope

envelope-id
Example Payload for Get Envelope⤓
Loading…

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. | key: getIDVSessionMedia

InputNotesExample
ConnectionA connection used for Yoti Sign
Media ID

The ID of the media

media-id
Recipient ID

The ID of the recipient

recipient-id
Example Payload for Get IDV session media⤓
Loading…

Get IDV Session Result​

This will return the result of the Identity verification session in JSON format | key: getIDVSessionResult

InputNotesExample
ConnectionA connection used for Yoti Sign
Recipient ID

The ID of the recipient

recipient-id
Example Payload for Get IDV Session Result⤓
Loading…

List Envelopes​

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

InputNotesExample
ConnectionA connection used for Yoti Sign
Fetch All

Boolean to determine if all records should be fetched

false
Key Value Params

Key value pairs to be used as query parameters

key1=value1
Limit

The amount of envelopes to return

50
Offset

The files to be used for the envelope

0
Example Payload for List Envelopes⤓
Loading…

Send Reminder​

Send a reminder to a recipient to sign the envelope. | key: sendEnvelopeReminder

InputNotesExample
ConnectionA connection used for Yoti Sign
Envelope ID

The ID of the envelope

envelope-id
Recipient ID

The ID of the recipient

recipient-id
Example Payload for Send Reminder⤓
Loading…

Changelog​

2026-06-05​

Added the New Envelopes polling trigger that returns envelopes created since the last run

2026-04-30​

Updated spectral version

2026-03-13​

Removed the Debug Request input from all action inputs. Debug logging is now controlled internally and no longer appears as a configurable field in actions.

2026-03-05​

Added inline data source for envelope selection to enhance data selection capabilities