Audit Trails
Get the audit trail for a document
Returns a list of audit trail entries for a specific document.
GET /audit_trail/<document_key>
Returns a list of audit_trail entries for a document.
Optional query string parameters:
- page_size (indicates how many records to return). 100 by default
- cursor (if you received a cursor from request
- obfuscate_contact_info (boolean). Obfuscates/masks email addresses and mobile numbers.
Properties
audit_detail is what actually happened
audit_detail_formatted includes the date (in the default timezone) and the audit_entry type.
audit_entry_type is the type of audit_trail event. See Audit entry types
date_created is date when the audit occurred. It's a number representing ticks since the epoch.
document_key is the document for which this audit_trail applies
email_address is the email address that applies to the audit trail entry.
ip_address is the ip_address from where the request originated. E.g. the user's computer or a server (in the case of email_delivery reports).
key is the audit trail entry key.
mobile_number: the mobile_number of the user for which the audit trail applies.
user_key: the user_key of the user who is performing the action.
user_name: the name of the user performing the action
Example response
{
"data": {
"audit_trail": [
{
"audit_detail": "Email has been received by [email protected] mail server",
"audit_detail_formatted": "2022-08-03 08:02:37 GMT+0000 email_tracking_info: Email has been received by [email protected] mail server 149.72.149.195",
"audit_entry_type": "email_tracking_info",
"date_created": 1659513757000.0,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "149.72.149.195",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoJ7Gl8MLDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": null,
"user_name": null
},
{
"audit_detail": "Email has been received by [email protected] mail server",
"audit_detail_formatted": "2022-08-03 08:02:30 GMT+0000 email_tracking_info: Email has been received by [email protected] mail server 167.89.84.21",
"audit_entry_type": "email_tracking_info",
"date_created": 1659513750000.0,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "167.89.84.21",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoN7oyswLDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": null,
"user_name": null
},
{
"audit_detail": "Status marked as complete.",
"audit_detail_formatted": "2022-08-03 08:01:04 GMT+0000 document_completed: Status marked as complete. ",
"audit_entry_type": "document_completed",
"date_created": 1659513664428.41796875,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "",
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoL7XnccJDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": null,
"user_name": ""
},
{
"audit_detail": "[email protected] (Joe Soaps Brother) completed signing document in-person.",
"audit_detail_formatted": "2022-08-03 08:00:59 GMT+0000 user_signed_in_person: [email protected] (Joe Soaps Brother) completed signing document in-person. 102.65.62.25",
"audit_entry_type": "user_signed_in_person",
"date_created": 1659513659275.6040039062,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "102.65.62.25",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoN7ooOEIDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKD-mdWjCwyiAQdzYW5kYm94",
"user_name": "Joe Soaps Brother"
},
{
"audit_detail": "[email protected] (Joe Soaps Brother) entered correct verification OTP and confirmed they signed the document in each other's presence.",
"audit_detail_formatted": "2022-08-03 08:00:58 GMT+0000 entered_correct_otp: [email protected] (Joe Soaps Brother) entered correct verification OTP and confirmed they signed the document in each other's presence. 102.65.62.25",
"audit_entry_type": "entered_correct_otp",
"date_created": 1659513658600.3662109375,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "102.65.62.25",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoO6t1MAKDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKD-mdWjCwyiAQdzYW5kYm94",
"user_name": "Joe Soaps Brother"
},
{
"audit_detail": "Message delivered to +27123456789",
"audit_detail_formatted": "2022-08-03 08:00:37 GMT+0000 whatsapp_delivered: Message delivered to +27123456789 ",
"audit_entry_type": "whatsapp_delivered",
"date_created": 1659513637508.8000488281,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "",
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoP7LoYQIDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": null,
"user_name": ""
},
{
"audit_detail": "Message delivered to +27123456789",
"audit_detail_formatted": "2022-08-03 08:00:32 GMT+0000 whatsapp_delivered: Message delivered to +27123456789 ",
"audit_entry_type": "whatsapp_delivered",
"date_created": 1659513632395.66796875,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "",
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoJ6kyr8LDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": null,
"user_name": ""
},
{
"audit_detail": "OTP sent to: [email protected] (Joe Soaps Brother)",
"audit_detail_formatted": "2022-08-03 08:00:22 GMT+0000 whatsapp_sent: OTP sent to: [email protected] (Joe Soaps Brother) ",
"audit_entry_type": "whatsapp_sent",
"date_created": 1659513622737.9501953125,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoJ7Gl4MIDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKD-mdWjCwyiAQdzYW5kYm94",
"user_name": "Joe Soaps Brother"
},
{
"audit_detail": "OTP sent to: +27123456789 (Joe Soaps Brother)",
"audit_detail_formatted": "2022-08-03 07:59:24 GMT+0000 sms_sent: OTP sent to: +27123456789 (Joe Soaps Brother) ",
"audit_entry_type": "sms_sent",
"date_created": 1659513564446.04296875,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": null,
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoL71jLwLDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKD-mdWjCwyiAQdzYW5kYm94",
"user_name": "Joe Soaps Brother"
},
{
"audit_detail": "OTP sent to: +27123456789 (Joe Soaps Brother)",
"audit_detail_formatted": "2022-08-03 07:58:13 GMT+0000 sms_sent: OTP sent to: +27123456789 (Joe Soaps Brother) ",
"audit_entry_type": "sms_sent",
"date_created": 1659513493751.9599609375,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": null,
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoL7truQJDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKD-mdWjCwyiAQdzYW5kYm94",
"user_name": "Joe Soaps Brother"
},
{
"audit_detail": "[email protected] ([email protected]) opened document via in-person signing link.",
"audit_detail_formatted": "2022-08-03 07:58:12 GMT+0000 document_opened_via_in_person_signing_link: [email protected] ([email protected]) opened document via in-person signing link. 102.65.62.25",
"audit_entry_type": "document_opened_via_in_person_signing_link",
"date_created": 1659513492858.3200683594,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "102.65.62.25",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoO6vxqEIDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKD-mdWjCwyiAQdzYW5kYm94",
"user_name": "[email protected]"
},
{
"audit_detail": "[email protected] ([email protected]) clicked document link",
"audit_detail_formatted": "2022-08-03 07:58:12 GMT+0000 log: [email protected] ([email protected]) clicked document link 102.65.62.25",
"audit_entry_type": "log",
"date_created": 1659513492734.5969238281,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "102.65.62.25",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoL73q80IDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKD-mdWjCwyiAQdzYW5kYm94",
"user_name": "[email protected]"
},
{
"audit_detail": "[email protected] requested in-person signing link for [email protected] (Joe Soaps Brother)",
"audit_detail_formatted": "2022-08-03 07:58:11 GMT+0000 in_person_signing_link_generated: [email protected] requested in-person signing link for [email protected] (Joe Soaps Brother) 102.65.62.25",
"audit_entry_type": "in_person_signing_link_generated",
"date_created": 1659513491629.6430664062,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "102.65.62.25",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoP7LoZgKDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKDSi-r-CwyiAQdzYW5kYm94",
"user_name": "Joe Soap"
},
{
"audit_detail": "Signature request sent to: [email protected] (Joe Soaps Brother) via SMS",
"audit_detail_formatted": "2022-08-03 07:53:20 GMT+0000 signature_request_sent: Signature request sent to: [email protected] (Joe Soaps Brother) via SMS ",
"audit_entry_type": "signature_request_sent",
"date_created": 1659513200173.419921875,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoP7LobAIDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKDui-WVCAyiAQdzYW5kYm94",
"user_name": "Joe Soaps Brother"
},
{
"audit_detail": "[email protected] (Joe Soap) completed signing document",
"audit_detail_formatted": "2022-08-03 07:53:14 GMT+0000 user_signed: [email protected] (Joe Soap) completed signing document 102.65.62.25",
"audit_entry_type": "user_signed",
"date_created": 1659513194513.0329589844,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "102.65.62.25",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoJ7EveILDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKDSi-r-CwyiAQdzYW5kYm94",
"user_name": "Joe Soap"
},
{
"audit_detail": "Signature request sent to: [email protected] (Joe Soap) via SMS",
"audit_detail_formatted": "2022-08-03 07:52:36 GMT+0000 signature_request_sent: Signature request sent to: [email protected] (Joe Soap) via SMS ",
"audit_entry_type": "signature_request_sent",
"date_created": 1659513156523.8608398438,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoL73q_kKDKIBB3NhbmRib3g",
"mobile_number": "+27123456789",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKDSi-r-CwyiAQdzYW5kYm94",
"user_name": "Joe Soap"
},
{
"audit_detail": "[email protected] (Joe Soap) changed the status to:awaiting_signatures via api",
"audit_detail_formatted": "2022-08-03 07:51:34 GMT+0000 document_status_changed_to_awaiting_signatures: [email protected] (Joe Soap) changed the status to:awaiting_signatures via api 0.1.0.2",
"audit_entry_type": "document_status_changed_to_awaiting_signatures",
"date_created": 1659513094841.6330566406,
"document_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXInCxIIRG9jdW1lbnQiGUkwb2hnV0FiaGhQS3dTMTgyNjJiMDI5NTkMogEHc2FuZGJveA",
"email_address": "[email protected]",
"ip_address": "0.1.0.2",
"key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXJACxIKQXVkaXRUcmFpbCIZSTBvaGdXQWJoaFBLd1MxODI2MmIwMjk1OQwLEgpBdWRpdFRyYWlsGICAoL7s7LULDKIBB3NhbmRib3g",
"mobile_number": "",
"user_key": "ahFzfnRoZW1hc3NpdmUtbGl2ZXIRCxIEVXNlchiAgKDSi-r-CwyiAQdzYW5kYm94",
"user_name": "Joe Soap"
}
]
},
"status": {
"status_code": 200
}
}
Updated almost 2 years ago