Authentication

Learn how to authorise requests to use the Single Invoice API.

Requirements

  • All requests must use HTTPS.
  • All requests must have an "apikey" header.
  • The majority of the requests will require a valid API key (the exceptions are methods like Register and Login which have their own separate requirements).

API key types:
Account Keys

Application Keys

  • Coverage Key
  • Claim Key
  • ICE Key

Headers

Required headers to make any request:

Key

Value

Description

apikey

YOURAPIKEY

The API key for the relevant method being used.

🚧

Keys are not interchangeable

A coverage key is only valid for use on coverage methods in that specific environment and cannot be used for other request types.