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/verify-counterparty	Builds source-attributed business verification evidence, including GST status when returned by ABR.	Bearer token with abn:lookup and gst:status
POST /v1/ppsr/preview	Documents the PPSR preview contract; current requests fail closed with 503, no price, and no register dispatch.	Bearer token
POST /v1/ppsr/search	Future PPSR request contract only; current calls fail closed and paid PPSR searches are unavailable through Hoist.	Bearer token does not unlock access
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 route for entity identity and ABN status. The response contains ok, abn, entityName, entityType, status, abnRegisteredDate, acn, state, postcode, sourceUrl, and data_mode. It does not return GST status.

GST status through counterparty verification

Request GST evidence through the counterparty-verification route:

curl

curl https://api.assets.hoistai.com/v1/verify-counterparty \
  -H "Authorization: Bearer $HOIST_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"abn":"11695718659"}'

This route requires both abn:lookup and gst:status. It returns an Evidence Card; GST evidence appears in card.source_checks when ABR returns a GST record. Current ABN/GST verification is free and does not consume a metered usage cap.

PPSR preview contract (currently unavailable)

The mechanics are implemented but not currently customer-accessible. The route documents a future contract only; current requests fail closed with 503, without returning a price or hitting the register. Hoist does not publish a runnable preview command while that boundary remains in place.

Paid PPSR searches and pricing are not currently available through Hoist. Use AFSA direct if you need a paid PPSR search today.

PPSR search contract (currently unavailable)

Paid PPSR production dispatch is unavailable. Hoist does not publish a runnable search command or price while the launch-proof gate is closed. Availability will be published only after verified AFSA production access, a successful billable live search, and durable audit evidence are proved; use AFSA direct if you need a paid PPSR search today.

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 source checked (for example an available ABR or ASIC-public source) with a visible citation and any fixture/snapshot limitations for human review. No current successful row identifies PPSR as checked.
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