Versions Compared

Key

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

...

  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 either via a callback, see below, or polled by issuing HTTP GET requests to https.
  4. A HTTP GET request to https://api.thecomplianceworkbook.com/api/documents/{documentId} . Please can then provide the summary details of the document. 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.
  5. A value of Pending indicates further processing is ongoing.
  6. A value of Completed indicates all processing is complete.

Document Details

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.

...