API Home

This API is a work in progress.

• The Comply API is built on REST

• All responses are returned as JSON and therefore have headers with Content-Type: application/json

• There are three categories of API endpoints:

  1. Public actions (not requiring any authentication)

  2. Private endpoints for reading data from an existing Comply account
     This is the majority of the API in its present state.

  3. Endpoints for creating and setting up a Comply account
     Only Comply accounts may be created and configured using the API. These accounts are restricted to one single-family home.