Audit Logs (GET /v2.0/envelopes/{envelopeId}/audit_logs)
Get the audit logs of a signed envelope.
Request Parameters
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {access_token} |
| app_auth_type | jsign-oauth2 |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| envelopeId | GUID | Yes | Envelope ID |
Response Parameters
Response Body Message Field
| Field | Value |
|---|---|
| message | The returned audit log(s) |
Response Body Data Fields
| Field | Always preset | Description |
|---|---|---|
| envelope_id | Yes | Envelope ID |
| create_date | Yes | Envelope created date |
| created_by | Yes | Envelope creator's name |
| signature_type[] | Yes | Available signatures for an envelope |
| documents[] | Yes | JSON object of document |
| documents[].name | Yes | Document name with extension |
| documents[].audit_event_logs[] | Yes | Audit logs array |
| documents[].audit_event_logs[].activity | Yes | Activity type |
| documents[].audit_event_logs[].activity_enum | Yes | Activity name |
| documents[].audit_event_logs[].time_stamp_utc | Yes | Activity time |
| documents[].audit_event_logs[].transaction_hash | Yes | Blockchain transaction hash |
| documents[].audit_event_logs[].action_by | Yes | Name of the user who performed the action |
| documents[].audit_event_logs[].block_number | Yes | Blockchain blocknumber |
| documents[].audit_event_logs[].wallet_address | Yes | Wallet address |
| documents[].audit_event_logs[].final_block_hash | Yes | Final block hash |
| documents[].audit_event_logs[].contract_address | Yes | Smart Contract Address |
Sample Success Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/225de81a-c71a-417c-a8be-603868acb491/audit_logs' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"message": "",
"data": {
"envelope_id": "dcf144b6-19d0-45b0-9dda-bbe0e4ca6269",
"created_date": "2022-03-22T10:31:44Z",
"created_by": "John Doe",
"signature_type": [
"ESignature"
],
"documents": [
{
"name": "sample1.pdf",
"audit_event_logs": [
{
"activity": "Document Creation",
"activity_enum": "Created",
"time_stamp_utc": "2022-03-22T10:31:44Z",
"transaction_hash": "0xc84a754296d6153997679734548d7fd8595151073c1a7d0aad40d0e398930c84",
"action_by": "Neil Smith",
"block_number": 116366,
"wallet_address": "0x7b39dE5d9763854Bccd23c49495ad9184238492c"
},
{
"activity": "Document Signed",
"activity_enum": "Signed",
"time_stamp_utc": "2022-03-22T10:43:32Z",
"transaction_hash": "0x24d9ea07a52a84f1442edc21a1e0cf7970fab5e8b90f12c31a4b1257dded0c61",
"action_by": "Andrew Garfield",
"block_number": 116370,
"wallet_address": "0x8469c43940A43292F0173555Af37828A47106D81"
"final_block_hash": "0x582aeedbb40a98fe32e5db601fd351d012dce1cb5103871b81e0ca54bd071e35",
"contract_address": "0x52DfB5973C6A7b914A532687Fab1c433EB16d633"
}
]
},
{
"name": "sample2.pdf",
"audit_event_logs": [
{
"activity": "Document Creation",
"activity_enum": "Created",
"time_stamp_utc": "2022-03-22T10:31:44Z",
"transaction_hash": "0xc84a754296d6153997679734548d7fd8595151073c1a7d0aad40d0e398930c84",
"action_by": "Neil Smith",
"block_number": 116366,
"wallet_address": "0x7b39dE5d9763854Bccd23c49495ad9184238492c"
},
{
"activity": "Document Signed",
"activity_enum": "Signed",
"time_stamp_utc": "2022-03-22T10:43:32Z",
"transaction_hash": "0x24d9ea07a52a84f1442edc21a1e0cf7970fab5e8b90f12c31a4b1257dded0c61",
"action_by": "Jon Smith",
"block_number": 116370,
"wallet_address": "0x8469c43940A43292F0173555Af37828A47106D81",
"final_block_hash": "0x582aeedbb40a98fe32e5db601fd351d012dce1cb5103871b81e0ca54bd071e35",
"contract_address": "0x52DfB5973C6A7b914A532687Fab1c433EB16d633",
}
]
}
]
}
}
Sample Error Response
REQUEST:
curl --location --request GET '/api/v2.0/envelopes/cdeb23d5-3201-43d9-8638-d381f50b1500/audit_logs' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9' \
--header 'app_auth_type: jsign-oauth2'
RESPONSE:
{
"errors": [
{
"error_code": "ENVELOPE_SIGNING_NOT_COMPLETED", "
developer_message": "Envelope signing process is not completed. Only signed envelopes have audit logs."
}
]
}
Note: View the full list of applicable error code for this method here.