API Keys

Mint an API key (first-party, JWT-authenticated)

Creates a new API key for the logged-in web user. The plaintext key is returned exactly once and is never recoverable afterwards. This endpoint is authenticated by the first-party web session (JWT bearer token), NOT by an API key. On authentication failure it returns the standard error envelope (401 unauthorized if the token is missing, 401 invalid_token if it is invalid or expired), with a request_id.

post/api/v1/keys

Request

  • Base URL: https://api.reconcileiq.com
  • URL: https://api.reconcileiq.com/api/v1/keys
  • Auth: HTTP bearer

Request body

namestring required
scopesScope[] required

Unique list of scopes. Duplicates are rejected.

allow_overageboolean

When true, this key is permitted to incur overage charges (still also requires the request and the subscription to allow overage).

organisation_idsinteger[]

Restrict this key to these IQ Books organisations. Omit for every organisation you belong to. Naming one is how a practice gives an agent a single client: the key cannot see or touch any other set of books. Organisations you are not a member of are refused with 422.

Response

Key created. key is shown only here.

idinteger required
namestring required
prefixstring required

12-char lookup handle (also the middle segment of the key).

scopesScope[] required
allow_overageboolean required
keystring required

Full plaintext key, format iqk_<prefix>_<secret>. Shown ONCE.

Changes

No recorded changes to this operation across all 1 revision of this API.