Audit Document by ID

GET

https://api.staple.io/v2/audit/documents/:docId

GET

/v2/audit/documents/:docId

$ curl https://api.staple.io/v2/audit/documents/docId \
>      -H "x-api-key: <apiKey>"

200Audit Document by ID

1 {
2   "auditDocument": {
3     "completedAt": null,
4     "completedBy": null,
5     "docId": 1,
6     "docName": "documents_tKp8QET3l1TGnz3-szG100OGK7seaqDrNO27_0.jpg",
7     "docOriginalURL": "https://staple-new-product-staging.s3.ap-southeast-1.amazonaws.com/originals/4fe8b35280a24f508c0f254a049cfadf.jpg?AWSAccessKeyId=AKIATO6YT43IVPW557NL&Expires=1669274133&Signature=b4Rnw%2BQha0eLXZlmPyTyy2vkzKM%3D&response-content-disposition=inline%3B%20filename%3D%22originals%2F4fe8b35280a24f508c0f254a049cfadf.jpg%22&response-content-type=image%2Fjpeg",
8     "docProcessedURLs": [
9       "https://staple-new-product-staging.s3.ap-southeast-1.amazonaws.com/documents/4fe8b35280a24f508c0f254a049cfadf/0.jpg?AWSAccessKeyId=AKIATO6YT43IVPW557NL&Expires=1669274133&Signature=HZNpBSAf23tZTP5EosWAOYY%2FbEI%3D&response-content-disposition=inline%3B%20filename%3D%22documents%2F4fe8b35280a24f508c0f254a049cfadf%2F0.jpg%22&response-content-type=image%2Fjpeg"
10     ],
11     "duplicateIds": [],
12     "error": null,
13     "exportIds": [],
14     "exportedAt": null,
15     "exportedBy": null,
16     "failedExportReason": null,
17     "modelType": "INVOICE",
18     "queueId": 1,
19     "rejectedAt": null,
20     "rejectedBy": null,
21     "rejectedReason": null,
22     "status": "RECEIVED",
23     "timeToComplete": null,
24     "uploadedAt": 1669107237724,
25     "uploadedBy": "developer@gmail.com"
26   }
27 }

Returns the full audit trail of a document: who uploaded, completed, exported, or rejected it and when, the time taken to complete, scanning errors, export and duplicate IDs, and any rejection or failed-export reasons. Use this for compliance reviews or to troubleshoot a document’s processing history.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

docIdstringRequired

Authentication

Path parameters

Response