Documentation
Sample Event Data
Mon, 24 January, 2022
Document sent sample payload:
{
"event": {
"id": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"created": 1614933645,
"eventType": "Sent",
"clientId": "e4ca1621-bbc7-4c9a-9e81-81d107589690",
"environment": "Test"
},
"document": {
"documentId": "b7a35af1-8524-4f8e-b370-1c470eee2b38",
"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
}
],
"ccDetails": [],
"createdDate": 1614862699,
"expiryDate": 1616158699,
"enableSigningOrder": true,
"disableEmails": true,
"revokeMessage": null
}
}
Document signed sample payload:
{
"event":{
"id":"8b314e89-e305-4cb0-ac79-b489844c47aa",
"created":1618570764,
"eventType":"Signed",
"clientId":"c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment":"Live"
},
"document":{
"documentId":"c06294ec-d43f-44a2-8068-b1e26cf4cb22",
"messageTitle":"Document from Template",
"documentDescription":"This document description",
"status":"InProgress",
"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
}
],
"ccDetails":[],
"createdDate":1618570591,
"expiryDate":1623815999,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null
}
}
Document completed sample payload:
{
"event":{
"id":"ab502e16-7491-4db9-aa71-990320fd31ca",
"created":1618570788,
"eventType":"Completed",
"clientId":"c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment":"Live"
},
"document":{
"documentId":"c06294ec-d43f-44a2-8068-b1e26cf4cb22",
"messageTitle":"Document from Template",
"documentDescription":"This document description",
"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
}
],
"ccDetails": [],
"createdDate":1618570591,
"expiryDate":1623815999,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null
}
}
Document declined sample payload:
{
"event":{
"id":"65813654-ce02-4ed7-8a5a-8119cf982362",
"created":1618836047,
"eventType":"Declined",
"clientId":"c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment":"Live"
},
"document":{
"documentId":"293adf67-f066-4648-ad73-3c26b5c95f55",
"messageTitle":"Sent from API",
"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":"None",
"isReassigned":false,
"reassignMessage":null,
"declineMessage":"Test"
}
],
"ccDetails": [],
"createdDate":1618833363,
"expiryDate":1620187199,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null,
"errorMessage":null
}
}
Document revoked sample payload:
{
"event":{
"id":"b76cf62e-9a9f-4aa4-a690-3f332061f141",
"created":1616974828,
"eventType":"Revoked",
"clientId":"ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment":"Live"
},
"document":{
"documentId":"be5dc445-cb0d-4f94-aa94-9f0c6a53179f",
"messageTitle":"sample",
"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":false,
"order":1,
"signerType":"None",
"isReassigned":false,
"reassignMessage":null,
"declineMessage":null
}
],
"ccDetails": [],
"createdDate":1616974485,
"expiryDate":1618286399,
"enableSigningOrder":true,
"disableEmails":false,
"revokeMessage":"Revoke Testing"
}
}
Document reassigned sample payload:
{
"event":{
"id":"07a7f65b-836c-41db-aacb-8ba57c4420b4",
"created":1618836274,
"eventType":"Reassigned",
"clientId":"c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment":"Live"
},
"document":{
"documentId":"4c56497b-91b7-43ba-8d7e-3fe8dbb46e3d",
"messageTitle":"Sent from API",
"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":false,
"order":1,
"signerType":"None",
"isReassigned":true,
"reassignMessage":"Test",
"declineMessage":null
}
],
"ccDetails": [],
"createdDate":1618833353,
"expiryDate":1620187199,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null,
"errorMessage":null
}
}
Document expired sample payload:
{
"event":{
"id":"3f99918f-af0a-4281-9314-803960a5b1c8",
"created":1616581355,
"eventType":"Expired",
"clientId":"ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment":"Live"
},
"document":{
"documentId":"9f472f18-3579-45f7-8dc8-5c63ea6be05e",
"messageTitle":"sample",
"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":true,
"isAuthenticationFailed":false,
"enableEmailOTP":false,
"isDeliveryFailed":false,
"isViewed":false,
"order":1,
"signerType":"None",
"isReassigned":false,
"reassignMessage":null,
"declineMessage":null
}
],
"ccDetails": [],
"createdDate":1615285354,
"expiryDate":1616581353,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null
}
}
Document viewed sample payload:
{
"event":{
"id":"cd8f7ca3-f082-44d8-be0d-7edc5b8b6896",
"created":1618836411,
"eventType":"Viewed",
"clientId":"c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment":"Live"
},
"document":{
"documentId":"4c56497b-91b7-43ba-8d7e-3fe8dbb46e3d",
"messageTitle":"Sent from API",
"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":"None",
"isReassigned":true,
"reassignMessage":"Test",
"declineMessage":null
}
],
"ccDetails": [],
"createdDate":1618833353,
"expiryDate":1620187199,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null,
"errorMessage":null
}
}
Document authentication failed sample payload:
{
"event":{
"id":"cd8f7ca3-f082-44d8-be0d-7edc5b8b6896",
"created":1618836411,
"eventType":"AuthenticationFailed",
"clientId":"c7806a57-9797-4135-b7e7-700bf6e4496f",
"environment":"Live"
},
"document":{
"documentId":"4c56497b-91b7-43ba-8d7e-3fe8dbb46e3d",
"messageTitle":"Sent from API",
"documentDescription":"This is document message sent from API",
"status":"NeedsAttention",
"senderDetail":{
"name": "Sender",
"emailAddress": "sender@email.com"
},
"signerDetails":[
{
"signerName": "Signer",
"signerRole": "",
"signerEmail": "signer@email.com",
"status":"NotCompleted",
"enableAccessCode":false,
"isAuthenticationFailed":true,
"enableEmailOTP":false,
"isDeliveryFailed":false,
"isViewed":true,
"order":1,
"signerType":"None",
"isReassigned":true,
"reassignMessage":"Test",
"declineMessage":null
}
],
"ccDetails": [],
"createdDate":1618833353,
"expiryDate":1620187199,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null,
"errorMessage":null
}
}
Document delivery failed sample payload:
{
"event":{
"id":"3f99918f-af0a-4281-9314-803960a5b1c8",
"created":1616581355,
"eventType":"DeliveryFailed",
"clientId":"ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment":"Live"
},
"document":{
"documentId":"9f472f18-3579-45f7-8dc8-5c63ea6be05e",
"messageTitle":"sample",
"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":true,
"isViewed":false,
"order":1,
"signerType":"None",
"isReassigned":false,
"reassignMessage":null,
"declineMessage":null
}
],
"ccDetails": [],
"createdDate":1615285354,
"expiryDate":1616581353,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null
}
}
Document send failed sample payload:
{
"event":{
"id":"3f99918f-af0a-4281-9314-803960a5b1c8",
"created":1616581355,
"eventType":"SendFailed",
"clientId":"ad174063-61cc-4f3f-8c83-f9e82dc4afe4",
"environment":"Live"
},
"document":{
"documentId":"9f472f18-3579-45f7-8dc8-5c63ea6be05e",
"errorMessage":"Invalid brand id",
"messageTitle":null,
"documentDescription":null,
"status":"InProgress",
"senderDetail":null,
"signerDetails":null,
"ccDetails": null,
"createdDate":null,
"expiryDate":null,
"enableSigningOrder":false,
"disableEmails":false,
"revokeMessage":null
}
}