REST API

Use the REST API when your app, agent backend, or workflow needs Australian data directly. Send a bearer token. Get JSON back.

Base URL

BASEhttps://api.assets.hoistai.com/v1

The version is in the path. New optional fields may be added to v1. Breaking changes use a new version.

Authentication

Every API request except GET /v1/_health needs a Hoist API key (prefixed ha_live_) sent as a bearer credential.

Authorization header

Authorization: Bearer $HOIST_API_KEY

Treat the API key like a password. Keep it server-side. Do not paste it into browser code, public repos, screenshots, prompts, or analytics payloads.

Common endpoints

Endpoint	What it does	Auth
GET /v1/_health	Checks whether the API is responding.	None
GET /v1/abn/{abn}	Looks up an Australian Business Number.	Bearer token
POST /v1/ppsr/preview	Previews a PPSR search before a paid run.	Bearer token
POST /v1/ppsr/search	Runs a PPSR organisation or serial-number search.	Bearer token
GET /v1/receipts/due-diligence	Reads records for completed checks.	Bearer token

ABN lookup

curl

curl https://api.assets.hoistai.com/v1/abn/11695718659 \
  -H "Authorization: Bearer $HOIST_API_KEY"

Use this when your agent needs to verify a business identity or GST status before it answers.

PPSR preview

curl

curl https://api.assets.hoistai.com/v1/ppsr/preview \
  -H "Authorization: Bearer $HOIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject_kind":"organisation","acn":"123456789"}'

Preview before running a paid PPSR search. Show the cost and subject back to the human before charging them.

PPSR search

curl

curl https://api.assets.hoistai.com/v1/ppsr/search \
  -H "Authorization: Bearer $HOIST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subject_kind":"organisation","acn":"123456789","purpose":"counterparty check"}'

Use this when your agent needs source data, not a guess. Paid searches require account access and billing capacity.

Responses

Responses are JSON. They include source result data, timestamps, IDs, and enough context for an agent to explain what it found. Common fields to surface to the reader:

Field	What it tells you
data_mode	Whether the result came from live source traffic or a stored source snapshot, so an agent can caveat accordingly.
source / source_citation	The authoritative source checked (for example ABR, ASIC, PPSR) with a visible citation for human review.
retrieved_at	When the underlying source data was retrieved, so freshness is explicit.
confidence	A confidence signal and any mismatch or review flags.

Hoist supplies Australian source data. It does not provide legal, credit, tax, or financial advice.

OpenAPI

The machine-readable API spec remains the contract source for generated clients:

SPEChttps://hoistai.com/.well-known/openapi.json