The Compliance Workbook offers an HTTP API for integration with third party systems. The API enables you to submit PDF documents for processing, view the compliance details of submitted documents, as well as browse a list of the properties on your account. You can view the Swagger page for the API at https://api.thecomplianceworkbook.com/swagger/ui/index#/.
...
To assist with the below use cases, we have created a Postman collection. Please set your Username, Password and Document Id variables in the collection to use the sample requests.
...
- PDF document submitted to the API. Documents can be submitted for processing by issuing a HTTP POST request to https://api.thecomplianceworkbook.com/api/documents. Please refer to Document Creation Postman request for full details of the parameters.
- A Document Id is returned from this HTTP request.
- The status of this document is received either via a callback, see below, or polled by issuing HTTP GET requests to https://api.thecomplianceworkbook.com/api/documents/{documentId}. Please refer to the Document Details Postman request for full details of the parameters.
- The Status property of a response from /api/documents/{documentId} will indicate whether the document has been successfully processed.
- A value of Pending indicates further processing is ongoing.
- A value of Completed indicates all processing is complete.
...
A summary of all the documents on your account can be accessed by a HTTP GET request to /api/documents. Please refer to the Documents Summary Postman request for a working example.
The Document Id returned from the HTTP POST to /api/documents can be used to retrieve various data sets extracted from your PDF
- Summary of the document.
- Compliance and associated compliance calculations.
- Data fields extracted from the PDF.
- Tags attached to the document, for example the name of the engineer who carried out the work.
Properties
Data about properties on your account can be accessed by HTTP GET requests to /api/properties/{propertyId}. Please refer to the Properties Summary Postman request for a working example.
...