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-signDescription
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.
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
Output Example Payload
{
"data": {}
}
Create Embedded Envelope
Create an envelope for Yoti Sign | key: createEmbeddedEnvelope
Output Example Payload
{
"data": {
"envelope_id": "uuid",
"recipients": [
{
"token": "uuid",
"email": "email1@email.com"
}
]
}
}
Create Envelope
Create an envelope for Yoti Sign | key: createEnvelope
Output Example Payload
{
"data": {
"envelope_id": "<envelopeId>"
}
}
Edit Recipient
Change the recipient of your envelope. | key: editRecipient
Output Example Payload
{
"data": {}
}
Envelope Status
Get the status of a single envelope | key: getEnvelopeStatus
Output Example Payload
{
"data": {
"status": "COMPLETED/ARCHIVED/ACTIVE/ERRORED"
}
}
Find Envelopes
This allows you to find the envelope details for specified envelopes. | key: findEnvelopes
Output Example Payload
{
"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
Output Example Payload
{
"data": {
"type": "Buffer",
"data": [
109,
101,
100,
105,
97
]
}
}
Get Envelope
Get Envelope details based on Envelope ID | key: getEnvelope
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "ID_DOCUMENT_TEXT_DATA_CHECK",
"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"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "LIVENESS",
"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"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "ID_DOCUMENT_FACE_MATCH",
"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"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "ID_DOCUMENT_COMPARISON",
"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"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "THIRD_PARTY_IDENTITY",
"state": "CREATED",
"resources_used": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"generated_media": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE"
}
],
"generated_profile": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"report": {
"recommendation": {
"value": "APPROVE"
},
"breakdown": [
{
"sub_check": "string",
"result": "PASS",
"details": []
}
]
},
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "WATCHLIST_SCREENING",
"state": "CREATED",
"resources_used": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"generated_media": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE"
}
],
"generated_profile": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"report": {
"recommendation": {
"value": "APPROVE"
},
"breakdown": [
{
"sub_check": "string",
"result": "PASS",
"details": []
}
],
"watchlist_summary": {
"total_hits": 0,
"search_config": {
"categories": [
"ADVERSE-MEDIA"
]
},
"raw_results": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"associated_country_codes": [
"GBR",
"USA"
]
}
},
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "WATCHLIST_ADVANCED_CA",
"state": "CREATED",
"resources_used": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"generated_media": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE"
}
],
"generated_profile": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"report": {
"recommendation": {
"value": "APPROVE"
},
"breakdown": [
{
"sub_check": "string",
"result": "PASS",
"details": []
}
],
"watchlist_summary": {
"total_hits": 0,
"search_config": {
"categories": [
"ADVERSE-MEDIA"
]
},
"raw_results": {
"media": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "IMAGE",
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
}
},
"associated_country_codes": [
"GBR",
"USA"
]
}
},
"created": "2021-06-11T11:39:24Z",
"last_updated": "2021-06-11T11:39:24Z"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"type": "SUPPLEMENTARY_DOCUMENT_TEXT_DATA_CHECK",
"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
Output Example Payload
{
"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
Output Example Payload
{
"data": {
"recipient_id": "uuid"
}
}