Quickstart

Add Australian register data to your app, script, or AI workflow. Start with an available ABN lookup. PPSR preview and explicit-confirmation mechanics are implemented but not currently customer-accessible; preview requests fail closed without returning a price or dispatching a register search. Paid PPSR searches and pricing are not currently available through Hoist.

1. Get access

Use a Hoist API key (prefixed ha_live_) for REST API and CLI calls. MCP hosts get a scoped token through OAuth consent — no key to paste.

terminal

export HOIST_API_KEY=ha_live_xxxxxxxxxxxxxxxxxxxxxxxx

2. Choose the interface

Interface	Best fit	Start here
REST API	Products, backend jobs, workflow automation	REST API
CLI	Terminal checks, CI, local agents	CLI
MCP	AI hosts that need user-approved tool access	MCP

3. Run an ABN lookup

curl

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

Use this direct ABN route when an agent needs entity identity and ABN status. It does not return GST status. For GST evidence, call POST /v1/verify-counterparty with an ABN and a token carrying both abn:lookup and gst:status.

4. Understand the unavailable PPSR contracts

The API contract documents organisation and serial-number subject shapes, but it is not a runnable customer workflow today. Preview requests fail closed with 503, return no price, and do not hit the register.

Preview and explicit-confirmation mechanics are implemented but not currently customer-accessible. Use AFSA direct if you need a paid PPSR search today.

5. Connect an AI client

Use the MCP endpoint in your AI host:

MCPhttps://mcp.assets.hoistai.com/mcp

Then approve the scopes in the browser window the host opens.

6. Use the CLI

terminal

hoist health --base-url https://api.assets.hoistai.com
hoist abn lookup 11695718659 --json

The CLI uses the same API key as the REST API with --token or HOIST_API_KEY.