Sample event data
Document sent sample payload:
{
"event": {
"id": "afceddb1-2eed-4301-ae14-8b96a6b0393a",
"created": 1669959514,
"eventType": "Sent",
"clientId": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"environment": "Test"
},
"data": {
"object": "document",
"documentId": "26b8695f-46d0-4cd4-ba1a-c5a0d595c849",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "InProgress",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": true,
"isAuthenticationFailed": false,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "none",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 3,
"status": null,
"nameMatcher": "Strict",
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"holdForPrefill": false,
"prefillCompleted": false
}
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669959514,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document signed sample payload:
{
"event": {
"id": "7af10c39-1090-4503-9d7f-cf5c3833fb63",
"created": 1669960050,
"eventType": "Signed",
"clientId": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "26b8695f-46d0-4cd4-ba1a-c5a0d595c849",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "Completed",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "Completed",
"enableAccessCode": false,
"isAuthenticationFailed": false,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": true,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 3,
"status": "Completed",
"nameMatcher": "Strict",
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"holdForPrefill": false,
"prefillCompleted": false
}
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669959514,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document completed sample payload:
{
"event": {
"id": "e1696d96-26ee-4969-8009-ea0e01eaa7ef",
"created": 1669960054,
"eventType": "Completed",
"clientId": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "26b8695f-46d0-4cd4-ba1a-c5a0d595c849",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "Completed",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "Signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "Completed",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": true,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 3,
"status": "Completed",
"nameMatcher": "Strict",
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"holdForPrefill": false,
"prefillCompleted": false
}
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669959514,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document edited sample payload:
{
"event": {
"id": "a39ff22a-9f6a-46ef-8cd9-728f1d3eda21",
"created": 1721799885,
"eventType": "Edited",
"clientId": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "26b8695f-46d0-4cd4-ba1a-c5a0d595c849",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "InProgress",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": true,
"isAuthenticationFailed": false,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "none",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 3,
"status": null,
"nameMatcher": "Strict",
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"holdForPrefill": false,
"prefillCompleted": false
}
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669959514,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined",
"metaData": {
"documentType": "NDA",
"documentCategory": "Legal"
}
}
}
Document declined sample payload:
{
"event": {
"id": "b66d4071-6783-45db-b18e-6c9549f6f622",
"created": 1669979101,
"eventType": "Declined",
"clientId": "ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "dae60436-1be4-48eb-8bc0-555d413768b6",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "Declined",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "Declined",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": true,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": "declined"
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1667797620,
"expiryDate": 1673029799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document revoked sample payload:
{
"event": {
"id": "8cabc915-12cd-418b-a3e9-08aa36d0772b",
"created": 1669971516,
"eventType": "Revoked",
"clientId": "ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "9a1b3d63-ffd7-48ab-bbca-1bf080e4a466",
"messageTitle": "Sent from API",
"documentDescription": "This is document message sent from API",
"status": "Revoked",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": true,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669971198,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": "Revoke ",
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document reassigned sample payload:
{
"event": {
"id": "51edeff6-8c87-43af-92ca-53010b4719bb",
"created": 1669979476,
"eventType": "Reassigned",
"clientId": "ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "0eb85696-0fd3-43bb-90e3-223ae83f9785",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",,
"status": "InProgress",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": true,
"order": 1,
"signerType": "Signer",
"isReassigned": true,
"reassignMessage": "reassign",
"declineMessage": null
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1649306095,
"expiryDate": 1654453799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document expired sample payload:
{
"event": {
"id": "cbebe91a-2a50-4634-8edf-7e356fe44a1f",
"created": 1669961880,
"eventType": "Expired",
"clientId": "ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "bb617d25-bfa2-4d0a-9683-e3034682de53",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "Expired",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "Signer",
"signerRole": "",
"signerEmail": "Signer@email.com",
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669904280,
"expiryDate": 1669961880,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document viewed sample payload:
{
"event": {
"id": "2157cce1-744a-4cdd-be9c-4e2686a2a8d5",
"created": 1669960043,
"eventType": "Viewed",
"clientId": "c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "26b8695f-46d0-4cd4-ba1a-c5a0d595c849",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "InProgress",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "Signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": true,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669959514,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document authentication failed sample payload:
{
"event": {
"id": "64204310-680c-44ae-b855-d4631983d333",
"created": 1669971648,
"eventType": "AuthenticationFailed",
"clientId": "c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "81dcbca3-a61a-4fb8-9278-ed89a0cf318f",
"messageTitle": "Sent from API",
"documentDescription": "This is document message sent from API",
"status": "Needs Attention",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": true,
"isAuthenticationFailed": false,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669971575,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document delivery failed sample payload:
{
"event": {
"id": "df150cce-7bc4-4b4d-97e2-ac0fdbdaffd4",
"created": 1669980004,
"eventType": "DeliveryFailed",
"clientId": "ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "f46cc00e-c76f-4fb1-aa87-e5cfc0e0cfa7",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "InProgress",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": true,
"isViewed": false,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669979993,
"expiryDate": 1671301799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document send failed sample payload:
{
"event": {
"id": "c810d5cb-0fd2-49c5-a8d0-d91fde438df8",
"created": 1669979591,
"eventType": "SendFailed",
"clientId":"ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "48b3e68a-517f-49e7-8953-45e3494e02fe",
"messageTitle": null,
"documentDescription": null,
"status": "InProgress",
"senderDetail": null,
"signerDetails": null,
"ccDetails": null,
"onBehalfOf": null,
"createdDate": null,
"expiryDate": null,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": "Unable to find the text tag definition for @tag2.",
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document draft created sample payload:
{
"event": {
"id": "87af7846-b753-42d1-ba00-984a3e7c9ea4",
"created": 1669971190,
"eventType": "DraftCreated",
"clientId": "ad174063-61cc-4f3f-8c83-f9e82dc4afe4",,
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "9a1b3d63-ffd7-48ab-bbca-1bf080e4a466",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "Draft",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "",
"signerRole": "",
"signerEmail": "",
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669971189,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined"
}
}
Document reminder sample payload:
{
"event": {
"id": "a39ff22a-9f6a-46ef-8cd9-728f1d3eda21",
"created": 1721799885,
"eventType": "Reminder",
"clientId": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"environment": "Live"
},
"data": {
"object": "document",
"documentId": "26b8695f-46d0-4cd4-ba1a-c5a0d595c849",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "InProgress",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": true,
"isAuthenticationFailed": false,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "none",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 3,
"status": null,
"nameMatcher": "Strict",
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"holdForPrefill": false,
"prefillCompleted": false
}
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669959514,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined",
"metaData": {
"documentType": "NDA",
"documentCategory": "Legal"
}
}
}
Sender identity created sample payload:
{
"event": {
"id": "ff1e7cc1-379f-4772-9587-6fcdf23437a8",
"created": 1669980401,
"eventType": "SenderIdentityCreated",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "senderIdentity",
"id": "9eb683bb-543e-4bb4-b9e6-de78ffec4f41",
"name": "Sender Identity",
"email": "senderidentity@email.com",
"redirectUrl": "https://boldsign.com",
"status": "Pending",
"createdDate": 1669980401,
"modifiedDate": 1669980401,
"approvedDateTime": null,
"brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851"
}
}
Sender identity updated sample payload:
{
"event": {
"id": "6e540002-78a7-4881-9cf6-9f2d064ead00",
"created": 1669980263,
"eventType": "SenderIdentityUpdated",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "senderIdentity",
"id": "82f6914e-7f00-4426-b231-4d403a216739",
"name": "Sender Identity",
"email": "senderidentity@email.com",
"redirectUrl": "https://boldsign.com",
"status": "Pending",
"createdDate": 1665386903,
"modifiedDate": 1669980263,
"approvedDateTime": null,
"brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851"
}
}
Sender identity deleted sample payload:
{
"event": {
"id": "003f7d44-2dc4-493b-b57d-a11d866ed2c7",
"created": 1669980268,
"eventType": "SenderIdentityDeleted",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "senderIdentity",
"id": "82f6914e-7f00-4426-b231-4d403a216739",
"name": "Sender Identity",
"email": "senderidentity@email.com",
"redirectUrl": "https://boldsign.com",
"status": "Pending",
"createdDate": 1665386903,
"modifiedDate": 1669980268,
"approvedDateTime": null,
"brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851"
}
}
Sender identity revoked sample payload:
{
"event": {
"id": "219f6bc7-cf81-45f4-b119-d9c270820606",
"created": 1669980502,
"eventType": "SenderIdentityRevoked",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "senderIdentity",
"id": "9eb683bb-543e-4bb4-b9e6-de78ffec4f41",
"name": "Sender Identity",
"email": "senderidentity@email.com",
"redirectUrl": "https://boldsign.com",
"status": "Revoked",
"createdDate": 1669980401,
"modifiedDate": 1669980502,
"approvedDateTime": 1669980487,
"brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851"
}
}
Sender identity verified sample payload:
{
"event": {
"id": "c15fa5bf-9a00-4ce5-acf1-3af3f692ae07",
"created": 1669980488,
"eventType": "SenderIdentityVerified",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "senderIdentity",
"id": "9eb683bb-543e-4bb4-b9e6-de78ffec4f41",
"name": "Sender Identity",
"email": "senderidentity@email.com",
"redirectUrl": "https://boldsign.com",
"status": "Verified",
"createdDate": 1669980401,
"modifiedDate": 1669980487,
"approvedDateTime": 1669980487,
"brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851"
}
}
Sender identity denied sample payload:
{
"event": {
"id": "a4735c18-9e96-4ad5-aa31-6659dd63f5ce",
"created": 1669980417,
"eventType": "SenderIdentityDenied",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "senderIdentity",
"id": "9eb683bb-543e-4bb4-b9e6-de78ffec4f41",
"name": "ashwin",
"email": "sendertest24@gmail.com",
"redirectUrl": "https://boldsign.com",
"status": "Denied",
"createdDate": 1669980401,
"modifiedDate": 1669980417,
"approvedDateTime": null,
"brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851"
}
}
Template created sample payload:
{
"event": {
"id": "dbb5c557-d9b0-42b2-b4ee-362d8e944bdb",
"created": 1669961050,
"eventType": "TemplateCreated",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "template",
"templateId": "b666c1fe-9642-4fab-bc9c-9fa217d9092d",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com",
"userId": "0851018f-0be9-4017-9537-f68ea5acd5a6"
},
"ccDetails": [],
"createdDate": 1669961050,
"activityDate": null,
"activityBy": null,
"messageTitle": "API Test template",
"status": "Completed",
"signerDetails": [
{
"signerName": "Signer",
"signerRole": "role",
"signerEmail": "signer@email.com",
"enableAccessCode": false,
"enableEmailOTP": false,
"status": "NotCompleted",
"userId": null,
"order": 1,
"signerType": "Signer",
"hostEmail": "",
"hostName": "",
"hostUserId": "",
"language": "English",
"allowRoleEdit": true,
"allowRoleDelete": true
}
],
"enableSigningOrder": false,
"templateName": "Template ",
"brandId": "3d7e8acf-f1c2-4d14-a4fb-ff731673f512",
"allowMessageEditing": true,
"allowNewRoles": true,
"allowNewFiles": true,
"allowModifyFiles": true,
"enableReassign": true,
"templateDescription": "Template description",
"errorMessage": null,
"isTemplate": true,
"onBehalfOf": null
},
}
Template create failed sample payload:
{
"event": {
"id": "a6236a85-3279-41fc-b67c-2b53346b95b3",
"created": 1669980114,
"eventType": "TemplateCreateFailed",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "template",
"templateId": "dfa5c0bd-5342-4b19-afb7-d64a5f54ce39",
"senderDetail": null,
"ccDetails": [],
"createdDate": null,
"activityDate": null,
"activityBy": null,
"messageTitle": null,
"status": "InProgress",
"signerDetails": null,
"enableSigningOrder": false,
"templateName": null,
"brandId": null,
"allowMessageEditing": true,
"allowNewRoles": true,
"allowNewFiles": true,
"allowModifyFiles": true,
"enableReassign": true,
"templateDescription": null,
"errorMessage": "The page number specified in form field does not match the page count in the document.",
"isTemplate": false,
"onBehalfOf": null
}
}
Template draft created sample payload:
{
"event": {
"id": "46cff0e1-fd1a-4c16-bff3-a7adb7aa8c6a",
"created": 1670303367,
"eventType": "TemplateDraftCreated",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "template",
"templateId": "e60f5bdf-daf0-453c-b3f9-32f7d2512e35",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com",
"userId": "0851018f-0be9-4017-9537-f68ea5acd5a6"
},
"ccDetails": [],
"createdDate": 1670303367,
"activityDate": null,
"activityBy": null,
"messageTitle": "Test Template",
"status": "Draft",
"signerDetails": [
{
"signerName": "",
"signerRole": "Role",
"signerEmail": "",
"enableAccessCode": false,
"enableEmailOTP": false,
"status": "NotCompleted",
"userId": null,
"order": 1,
"signerType": "Signer",
"hostEmail": "",
"hostName": "",
"hostUserId": "",
"language": "English",
"allowRoleEdit": true,
"allowRoleDelete": true
}
],
"enableSigningOrder": false,
"templateName": "sample template",
"brandId": "3d7e8acf-f1c2-4d14-a4fb-ff731673f512",
"allowMessageEditing": true,
"allowNewRoles": true,
"allowNewFiles": true,
"allowModifyFiles": true,
"enableReassign": true,
"templateDescription": "",
"errorMessage": null,
"isTemplate": true,
"onBehalfOf": null
}
}
Template send failed sample payload:
{
"event": {
"id": "581a4d5d-3ff0-4285-84e1-9d32eeae35e0",
"created": 1721805547,
"eventType": "TemplateSendFailed",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "template",
"templateId": "e60f5bdf-daf0-453c-b3f9-32f7d2512e35",
"allowNewFiles": null,
"allowModifyFiles": null,
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com",
"userId": "0851018f-0be9-4017-9537-f68ea5acd5a6"
},
"ccDetails": [],
"createdDate": null,
"activityDate": null,
"activityBy": null,
"messageTitle": null,
"status": "Draft",
"signerDetails": null,
"enableSigningOrder": false,
"templateName": null,
"templateDescription": null,
"errorMessage": "SignerName or SignerEmail is missing in roles",
"isTemplate": true,
"BrandId": null,
"onBehalfOf": null,
"labels": null,
"templateLabels": null
}
}
Identity Verification Initiated sample payload:
{
"event": {
"id": "f24b90eb-664b-46da-93c9-d2c345ferb615",
"created": 1717675200,
"eventType": "IdentityVerificationInitiated",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "identityVerification",
"documentId": "3f255c2d-fb72-4abe-7yt5-e4e48780fe74",
"messageTitle": "Template Send Document",
"documentDescription": "",
"status": "InProgress",
"senderDetail": {
"name": "Michael",
"emailAddress": "michael@cubeflakes.com"
},
"signerDetail": {
"signerName": "Clara",
"signerRole": "Tester",
"signerEmail": "clara@cubeflakes.com",
"phoneNumber": null,
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"lastActivityDate": null,
"authenticationType": "IdVerification",
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 1,
"status": "InProgress",
"nameMatcher": "Lenient",
"requireLiveCapture": false,
"requireMatchingSelfie": false,
"holdForPrefill": false,
"prefillCompleted": false
},
"allowFieldConfiguration": false,
"lastReminderSentOn": null
}
}
}
Identity Verification Succeeded sample payload:
{
"event": {
"id": "096dbaf2-5aef-404a-92e4-ayt6u72e3efe",
"created": 1717676211,
"eventType": "IdentityVerificationSucceeded",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "identityVerification",
"documentId": "3f255c2d-fb72-4abe-7yt5-e4e48780fe74",
"messageTitle": "Template Send Document",
"documentDescription": "",
"status": "InProgress",
"senderDetail": {
"name": "Michale",
"emailAddress": "michael@cubeflakes.com"
},
"signerDetail": {
"signerName": "Clara",
"signerRole": "Tester",
"signerEmail": "clara@cubeflakes.com",
"phoneNumber": null,
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": null,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"lastActivityDate": null,
"authenticationType": "IdVerification",
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 1,
"status": "Completed",
"nameMatcher": "Lenient",
"requireLiveCapture": false,
"requireMatchingSelfie": false,
"holdForPrefill": false,
"prefillCompleted": false
},
"allowFieldConfiguration": false,
"lastReminderSentOn": null
}
}
}
Identity Verification Failed sample payload
{
"event": {
"id": "36458d8b-516b-45de-bfa4-58yure0d8240",
"created": 1720524793,
"eventType": "IdentityVerificationFailed",
"clientId": null,
"environment": "Live"
},
"data": {
"object": "identityVerification",
"documentId": "ec0456ta-dde6-4f9d-9cc9-63rtadb1ab7d",
"messageTitle": "Template Send Document",
"documentDescription": "API send document",
"status": "InProgress",
"senderDetail": {
"name": "Antony",
"emailAddress": "sender@email.com"
},
"signerDetail": {
"signerName": "Hanky",
"signerRole": "Developer",
"signerEmail": "signer@email.com",
"phoneNumber": null,
"status": "NotCompleted",
"enableAccessCode": false,
"isAuthenticationFailed": true,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 2,
"signerType": "Signer",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"lastActivityDate": 1720524789,
"authenticationType": "IdVerification",
"idVerification": {
"type": "UntilSignCompleted",
"maximumRetryCount": 1,
"status": "Failed",
"nameMatcher": "Lenient",
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"holdForPrefill": false,
"prefillCompleted": false
},
"allowFieldConfiguration": true,
"lastReminderSentOn": null
}
}
}
Document edited sample payload:
{
"event": {
"id": "afceddb1-2eed-4301-ae14-8b96a6b0393a",
"created": 1669959514,
"eventType": "Edited",
"clientId": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"environment": "Test"
},
"data": {
"object": "document",
"documentId": "26b8695f-46d0-4cd4-ba1a-c5a0d595c849",
"messageTitle": "API Test Document",
"documentDescription": "This is document message sent from API",
"status": "InProgress",
"senderDetail": {
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails": [
{
"signerName": "signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status": "NotCompleted",
"enableAccessCode": true,
"isAuthenticationFailed": false,
"enableEmailOTP": false,
"isDeliveryFailed": false,
"isViewed": false,
"order": 1,
"signerType": "none",
"isReassigned": false,
"reassignMessage": null,
"declineMessage": null,
"idVerification": {
"type": "EveryAccess",
"maximumRetryCount": 3,
"status": null,
"nameMatcher": "Strict",
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"holdForPrefill": false,
"prefillCompleted": false
}
}
],
"ccDetails": [],
"onBehalfOf": null,
"createdDate": 1669959514,
"expiryDate": 1675189799,
"enableSigningOrder": false,
"disableEmails": false,
"revokeMessage": null,
"errorMessage": null,
"labels": ["documentLabel"],
"templateLabels": ["templateLabel"],
"brandId":"d6cfd0ce-b98d-4026-9f36-a40f91c8f2c8",
"documentDownloadOption": "Combined",
"metaData": {
"documentType": "NDA",
"documentCategory": "Legal"
}
}
}