API reference

The full, interactive reference — every endpoint, parameter and schema — is generated from the API itself and always current. Try requests directly from the browser with your siq_test_ key.

Open the interactive API reference ↗

Machine-readable schema: openapi.json

Base URL & auth

https://api.statementiq.com.au
Header:  X-API-Key: siq_test_…  (sandbox)  |  siq_live_…  (production)

Endpoints at a glance

POST/v1/requests

Create a request; returns a consent link.

GET/v1/requests

List your requests (scoped to the key’s environment).

GET/v1/requests/{id}

Fetch a request’s status and details.

POST/v1/requests/{id}/invite

Send the consent link by email or SMS (production only).

GET/v1/requests/{id}/report

Fetch the finished report as JSON (also /report.html).

DELETE/v1/requests/{id}

Withdraw consent and delete the derived report.

New to the API? Start with the overview and Authentication & keys.