Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To get started with the API, you must have a valid Username and API Key, as well as having your IP address on our white list. If you do not have one or either of these, or your IP address has not been white listed, please raise a support desk ticket.

API Architecture

The API is divided into two key areas:

...

  1. 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.
  2. A Document Id is returned from this HTTP request.
  3. The status of this document is received via a callback.
  4. A HTTP GET request to https://api.thecomplianceworkbook.com/api/documents/{documentId} can then provide the summary details of the document. Please refer to the Document Details Postman request for full details of the parameters.

...

To get started with webhook integration, please raise a support desk ticket to provide your endpoint and secure API key.

...