ComplyTraq APIs are seamlessly integrated with the ComplyTraq web interface (ComplyTraq.com).  Inspections may be requested and viewed using both the API and web interface interchangeably. The workflow for using the APIs are summarized below:

Step 1: Login (required prior to all API calls)

All ComplyTraq APIs require an initial call to the Login API to authenticate the user.

This API will return an authentication token, which should be submitted in the request of all subsequent API calls made until the token expires.

Following the Login step, API users may choose to submit any of the following API calls:

•     Submit Request
•     Check Report Status
•     Retrieve Report
•     Retrieve Status List

Step 2: Submit Request

Use this API call following the Login to submit a new request for an inspection and/or credentialing report.

Step 3: Check Report Status

This API is NOT a required call to complete an inspection request, but is an optional call that may be used to check the status of any previously requested report submitted.

This can be used to check the status of reports submitted originally via API or via web interface.

Step 4: Retrieve Report

Once a report reaches a “Completed” status, all information from the report and photo images may be retrieved using this API call.

Optional API: Retrieve Status List

Call this API for a list of all possible Statuses that may be associated with an inspection. This API is for informational purposes only and not part of the inspection workflow.