The Red Flag Alert API follows the JSON API (http://jsonapi.org) format and uses the REST architectural style with JSON throughout.
All responses will be returned as JSON, with the requested data being returned in the '
data' key of the response.
When performing a search, pagination links will be available as per the JSONAPI standard in a field called '
links', with '
next' and '
last' links allowing navigation.
JSON API has been properly registered with the IANA. Its media type designation is
In addition to the standard JSON response, companies can be requested formatted as PDF documents. In order to request this, change the 'Accept' header of your request to 'application/pdf'. Currently, this is only supported by the company/ endpoint.
The PDF document will also include any extra resources requested in the '
?include=' GET parameter and therefore can be used to construct a full company report by appending '
?include=all' to the URL (See 'Including Additional Resources').
To assist developers, a browsable API is available enabling the viewing and navigation of records in the browser. This can be accessed by visiting the corresponding URL in a browser; the API will detect that a browser is being used and displays records accordingly. A username and password will be requested; this is simply the API key and secret.