Skip to content
Banking/open banking

ato.gov.au

Business Registries sandbox and mock API

# Introduction The Business Registries API is built on HTTP. The API is RESTful. It has predictable resource URIs. The API is documented in <a target="_blank" href="https://github.com/OAI/OpenAPI-Specification">OpenAPI</a> format. In addition to the standard OpenAPI syntax we use a few <a target="_blank" href="https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md">vendor ext Writes persist, data moves on a schedule and every change can fire a signed webhook.

Operations
74
Collections
-
Event types
-
example request
curl https://your-ato-gov-au.slurry.io/business-names \
  -H "Authorization: Bearer slurry_sim_..."

Your simulation gets its own hostname, key and IP allow-list. Built from API version 0.0.6.

What gets simulated

Collections, relationships and state machines are worked out from the spec when you start the simulation.

  • State. Creates, updates and deletes persist and show up in later reads.
  • Behaviour. Records move through their states on a schedule you control, and you can fast-forward up to 30 days.
  • Webhooks. Every change emits a signed, retried event.
  • Failure. Per-endpoint errors, latency and chaos rules, on demand.

Operations

First 12 of 74.

  • GET/business-names
  • GET/classifications/address-types
  • GET/classifications/business-name-lifecycle-states
  • GET/classifications/electronic-address-types
  • GET/classifications/genders
  • GET/classifications/legal-entity-types
  • GET/classifications/license-lifecycle-states
  • GET/classifications/license-types
  • GET/classifications/name-directions
  • GET/classifications/name-prefixes
  • GET/classifications/name-types
  • GET/classifications/registered-identifier-types