The Compliance Workbook offers an HTTP a REST API for integration with third party systems. The API enables you to submit PDF documents for processing, view the 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#/.
...
API Architecture
The API is divided into three two key areas:
- Documents -
- API routes with a URL of /documents provide interactions with documents on your account.
- The API is capable of webhook integration to provide information when document has been processed.
- Properties - API routes with a URL of /properties provide interactions with properties on your account.
...
A summary of all the documents on your account can be accessed by a HTTP GET request to /api/documents-v2. Please refer to the Documents Summary Postman request for a working example.
...
- 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.
Document Webhook
The API is capable of webhook integration to an endpoint provided by the consuming client. The webhook is triggered in response to a document being processed within TCW. This processing maybe the result of the initial import into the system, as well as user driven modifications; for example through the creation of a remedial action after the document has been assessed. The webhook issues a POST request to an endpoint with the following JSON payload:
- EventName: "DocumentCalculated"
- DocumentId: <DocumentId>
- EventDateTime: <Timestamp>
Please refer to the Document Webhook Postman request for a working example.
To get started with webhook integration, please contact our support team to provide your endpoint and secure API key.
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.
...