Yoti Sign Component

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

Component key: yoti-sign

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

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.

Important Your API Key must 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 authorised 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	Notes
API Key password / Required apiKey	The Yoti API Key
Environment string / Required baseUrl	The environment to use for the Yoti Sign API

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

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Envelope ID string / Required envelopeId		The ID of the envelope	envelope-id

Example Payload for Archive Envelope

{
  "data": {}
}

Create Embedded Envelope

Create an envelope for Yoti Sign | key: createEmbeddedEnvelope

Input	Default	Notes	Example
Autotagging string 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 code branding		The branding to be used for the envelope
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Emails code emails		The emails to be used for the envelope
Envelope Name string / Required envelopName		The name of the envelope	Envelope name
Files data / Required Value List file		The files to be used for the envelope
PDF File Name string / Required Value List fileName		The name of the file to be used for the envelope	example.pdf
Notification Destination string notificationDestination		The destination for the notifications	https://example.com/callback
Notifications Subscriptions string Value List notificationsSubscriptions		The notifications subscriptions to be used for the envelope
Parent Redirect URLs code parent_redirect_urls		The parent redirect URLs to be used for the envelope
Recipients code / Required recipients		The recipients to send the envelope to

Example Payload for Create Embedded Envelope

{
  "data": {
    "envelope_id": "uuid",
    "recipients": [
      {
        "token": "uuid",
        "email": "email1@email.com"
      }
    ]
  }
}

Create Envelope

Create an envelope for Yoti Sign | key: createEnvelope

Input	Default	Notes	Example
Autotagging string 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 code branding		The branding to be used for the envelope
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Emails code emails		The emails to be used for the envelope
Envelope Name string / Required envelopName		The name of the envelope	Envelope name
Files data / Required Value List file		The files to be used for the envelope
PDF File Name string / Required Value List fileName		The name of the file to be used for the envelope	example.pdf
Has Envelope OTPs string has_envelope_otps		Boolean, to determine if the envelope access requires OTP verification
Notification Destination string notificationDestination		The destination for the notifications	https://example.com/callback
Notifications Subscriptions string Value List notificationsSubscriptions		The notifications subscriptions to be used for the envelope
Parent Redirect URLs code parent_redirect_urls		The parent redirect URLs to be used for the envelope
Recipients code / Required recipients		The recipients to send the envelope to

Example Payload for Create Envelope

{
  "data": {
    "envelope_id": "<envelopeId>"
  }
}

Edit Recipient

Change the recipient of your envelope. | key: editRecipient

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Envelope ID string / Required envelopeId		The ID of the envelope	envelope-id
Recipient ID string / Required recipientId		The ID of the recipient	recipient-id
Recipient Info code / Required recipientInfo		The recipient info to be modified

Example Payload for Edit Recipient

{
  "data": {}
}

Envelope Status

Get the status of a single envelope | key: getEnvelopeStatus

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Envelope ID string / Required envelopeId		The ID of the envelope	envelope-id

Example Payload for Envelope Status

{
  "data": {
    "status": "COMPLETED/ARCHIVED/ACTIVE/ERRORED"
  }
}

Find Envelopes

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

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Envelope IDs string / Required Value List envelopeIds		The IDs of the envelopes

Example Payload for Find Envelopes

{
  "data": {
    "envelopes": [
      {
        "envelope_id": "string",
        "envelope": "string",
        "status": "string",
        "created_at": "string"
      }
    ]
  }
}

Get Documents

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

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Envelope ID string / Required envelopeId		The ID of the envelope	envelope-id

Example Payload for Get Documents

{
  "data": {
    "type": "Buffer",
    "data": [
      109,
      101,
      100,
      105,
      97
    ]
  }
}

Get Envelope

Get Envelope details based on Envelope ID | key: getEnvelope

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Envelope ID string / Required envelopeId		The ID of the envelope	envelope-id

Example Payload for Get Envelope

{
  "data": {
    "envelope_id": "<envelopeId>",
    "status": "ACTIVE",
    "details": {
      "recipients": [
        {
          "id": "uuid",
          "sign_status": "UNSIGNED",
          "name": "name1",
          "email": "email1@email.com",
          "auth_type": "sign-auth",
          "role": "Signee"
        }
      ]
    }
  }
}

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

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Media ID string / Required mediaId		The ID of the media	media-id
Recipient ID string / Required recipientId		The ID of the recipient	recipient-id

Example Payload for Get IDV session media

{
  "data": {
    "type": "Buffer",
    "data": [
      109,
      101,
      100,
      105,
      97
    ]
  }
}

Get IDV Session Result

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

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Recipient ID string / Required recipientId		The ID of the recipient	recipient-id

Example Payload for Get IDV Session Result

{
  "data": {
    "session_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "client_session_token_ttl": 599,
    "user_tracking_id": "string",
    "biometric_consent": "2022-12-01T15:23:28.894Z",
    "state": "ONGOING",
    "client_session_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "resources": {
      "id_documents": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "source": {
            "type": "END_USER"
          },
          "document_type": "string",
          "issuing_country": "string",
          "pages": [
            {
              "capture_method": "CAMERA",
              "media": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "IMAGE",
                "created": "2021-06-11T11:39:24Z",
                "last_updated": "2021-06-11T11:39:24Z"
              },
              "frames": [
                {
                  "media": {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "type": "IMAGE",
                    "created": "2021-06-11T11:39:24Z",
                    "last_updated": "2021-06-11T11:39:24Z"
                  }
                }
              ]
            }
          ],
          "document_fields": {
            "media": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "IMAGE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z"
            }
          },
          "document_id_photo": {
            "media": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "IMAGE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z"
            }
          },
          "tasks": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "state": "DONE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z",
              "generated_media": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "type": "IMAGE"
                }
              ],
              "generated_checks": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "type": "ID_DOCUMENT_TEXT_DATA_CHECK"
                }
              ],
              "type": "ID_DOCUMENT_TEXT_DATA_EXTRACTION"
            }
          ]
        }
      ],
      "supplementary_documents": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "source": {
            "type": "END_USER"
          },
          "document_type": "string",
          "issuing_country": "string",
          "file": {
            "media": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "IMAGE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z"
            }
          },
          "pages": [
            {
              "capture_method": "CAMERA",
              "media": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "IMAGE",
                "created": "2021-06-11T11:39:24Z",
                "last_updated": "2021-06-11T11:39:24Z"
              },
              "frames": [
                {
                  "media": {
                    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "type": "IMAGE",
                    "created": "2021-06-11T11:39:24Z",
                    "last_updated": "2021-06-11T11:39:24Z"
                  }
                }
              ]
            }
          ],
          "document_fields": {
            "media": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "IMAGE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z"
            }
          },
          "tasks": [
            {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "state": "DONE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z",
              "generated_media": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "type": "IMAGE"
                }
              ],
              "generated_checks": [
                {
                  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                  "type": "ID_DOCUMENT_TEXT_DATA_CHECK"
                }
              ],
              "type": "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_EXTRACTION"
            }
          ]
        }
      ],
      "liveness_capture": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "source": {
            "type": "END_USER"
          },
          "liveness_type": "ZOOM",
          "facemap": {
            "media": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "IMAGE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z"
            }
          },
          "frames": [
            {
              "media": {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "type": "IMAGE",
                "created": "2021-06-11T11:39:24Z",
                "last_updated": "2021-06-11T11:39:24Z"
              }
            }
          ],
          "tasks": []
        }
      ],
      "face_capture": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "source": {
            "type": "END_USER"
          },
          "image": {
            "media": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "type": "IMAGE",
              "created": "2021-06-11T11:39:24Z",
              "last_updated": "2021-06-11T11:39:24Z"
            }
          },
          "tasks": []
        }
      ]
    },
    "checks": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "ID_DOCUMENT_AUTHENTICITY",
        "state": "CREATED",
        "resources_used": [
          "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        ],
        "generated_media": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "type": "IMAGE"
          }
        ],
        "report": {
          "recommendation": {
            "value": "APPROVE"
          },
          "breakdown": [
            {
              "sub_check": "string",
              "result": "PASS",
              "details": []
            }
          ]
        },
        "created": "2021-06-11T11:39:24Z",
        "last_updated": "2021-06-11T11:39:24Z"
      }
    ]
  }
}

List Envelopes

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

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Fetch All boolean fetchAll	false	Boolean to determine if all records should be fetched
Key Value Params string Key Value List keyValueParams		Key value pairs to be used as query parameters	key1=value1
Limit string limit		The amount of envelopes to return	50
Offset string offset		The files to be used for the envelope	0

Example Payload for List Envelopes

{
  "data": {
    "findEnvelopesResponse": {
      "envelopes": [
        {
          "envelope_id": "string",
          "envelope": "string",
          "status": "string",
          "created_at": "string"
        }
      ]
    },
    "total": 123
  }
}

Send Reminder

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

Input	Default	Notes	Example
Connection connection / Required connection			A connection used for Yoti Sign
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
Envelope ID string / Required envelopeId		The ID of the envelope	envelope-id
Recipient ID string / Required recipientId		The ID of the recipient	recipient-id

Example Payload for Send Reminder

{
  "data": {
    "recipient_id": "uuid"
  }
}

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

Description​

Connections​

API Key Connection​

Actions​

Archive Envelope​

Create Embedded Envelope​

Create Envelope​

Edit Recipient​

Envelope Status​

Find Envelopes​

Get Documents​

Get Envelope​

Get IDV session media​

Get IDV Session Result​

List Envelopes​

Send Reminder​

Description

Connections

API Key Connection

Actions

Archive Envelope

Create Embedded Envelope

Create Envelope

Edit Recipient

Envelope Status

Find Envelopes

Get Documents

Get Envelope

Get IDV session media

Get IDV Session Result

List Envelopes

Send Reminder