Ato

Business Registries

Introduction The Business Registries API is built on HTTP. The API is RESTful. It has predictable resource URIs. The API is documented in OpenAPI format. In…

Government & public#openapi#financial

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Introduction

The Business Registries API is built on HTTP. The API is RESTful. It has predictable resource URIs.

The API is documented in OpenAPI format.
In addition to the standard OpenAPI syntax we use a few
vendor extensions .

Overview

The following sections describe the resources that make up the Business Registries REST API.

Current Version

By default, all requests to https://api.abr.ato.gov.au receive the v1 version of the REST API. We encourage you to explicitly request this version via the Accept header.

Accept: application/vnd.abr-ato.v1+json

Schema

All API access is over HTTPS, and accessed from https://api.abr.ato.gov.au. All data is sent and received as JSON. Blank fields are included.

All dates use the ISO 8601 format:

YYYY-MM-DD

For example: 2017-07-01 (the 1st of July 2017)

All timestamps use the ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

For example: 2017-07-01T11:05:06+10:00

Timezones

Some requests allow for specifying timestamps or generate timestamps with time zone information. We apply the following rules, in order of priority, to determine timezone information for API calls.

Explicitly provide an ISO 8601 timestamp with timezone information

For API calls that allow for a timestamp to be specified, we use that exact timestamp.

For example: 2017-07-01T11:05:06+10:00

Pagination

Information about pagination is provided in the Link header.

For example:

Link: ; rel="next",
; rel="last"

rel="next" states that the next page is page=2. This makes sense, since by default, all paginated queries start at page 1. rel="last" provides some more information, stating that the last page of results is on page 34. Accordingly, we have 33 more pages of information that we can consume.

Parameters

Many API methods take optional parameters:

GET /individuals/1234/addresses/?addressType='Mailing'

In this example, the '1234' value is provided for the :partyId parameter in the path while :addressType is passed in the query string.
For POST, PATCH, PUT, and DELETE requests, parameters not included in the URL should be encoded as JSON with a Content-Type of 'application/json'.

Metadata

The API provides metadata services that you can use to discover information about the classifcation schemes and values used by the Registry.

For example:

GET /classifications/roles

Sample response:

[
{
"id": "123e4567-e89b-12d3-a456-426655440001",
"role": "Director",
"roleDescription": "An individual responsible for managing a company's ...",
"relationship": "Directorship",
"reciprocalRole": "Company",
"reciprocalRoleDescription": "An incorporated legal entity."
},
{
...
}
]

Root Endpoint

You can issue a GET request to the root endpoint (also known as the service root) to get all the endpoint categories that the REST API supports:

curl https://api.abr.ato.gov.au

Authentication

The Business Registries API supports API Key authentication.

When you sign up for an account, you are given your first API key. You can generate additional API keys, and delete
API keys (as you may need to rotate your keys in the future). You authenticate to the Business Registries API by
providing your secret key in the request header.

Note: Some requests will return 404 Not Found, instead of 403 Permission Denied. This is to prevent the
accidental leakage of information to unauthorised users.

Endpoints 74

Individuals

  • GETRetrieve a list of individuals/individuals?dateOfBirth=string&placeOfBirth=stringRetrieve a list of individuals
  • POSTCreate an individual/individualsCreate an individual
  • GETRetrieve an individual/individuals/:partyIdRetrieve an individual with the specified identifier
  • PUTUpdate an individual/individuals/:partyIdUpdate an individual
  • DELETEDelete an individual/individuals/:partyIdDelete an individual with the specified identifier

Individuals Roles

  • GETRetrieve a list of roles/individuals/:partyId/roles
  • POSTCreate a role/individuals/:partyId/rolesCreate a role
  • GETRetrieve a role/individuals/:partyId/roles/:roleIdRetrieve a role
  • PUTUpdate a role/individuals/:partyId/roles/:roleIdUpdate a role
  • DELETEDelete a role/individuals/:partyId/roles/:roleIdDelete a role

Individuals Addresses

  • GETRetrieve a list of addresses/individuals/:partyId/addresses
  • POSTCreate an address/individuals/:partyId/addressesCreate an address
  • GETRetrieve an address/individuals/:partyId/addresses/:addressIdRetrieve an address
  • PUTUpdate an address/individuals/:partyId/addresses/:addressIdUpdate an address
  • DELETEDelete an address/individuals/:partyId/addresses/:addressIdDelete an address

Individuals Electronic Addresses

  • GETRetrieve a list of electronic addresses/individuals/:partyId/electronic-addresses
  • POSTCreate an electronic address/individuals/:partyId/electronic-addressesCreate an electronic address
  • GETRetrieve an electronic address/individuals/:partyId/electronic-addresses/:addressIdRetrieve an electronic address
  • PUTUpdate an electronic address/individuals/:partyId/electronic-addresses/:addressIdUpdate an electronic address
  • DELETEDelete an electronic address/individuals/:partyId/electronic-addresses/:addressIdDelete an electronic address

Individuals Business Names

  • GETRetrieve a list of business names/individuals/:partyId/business-names
  • POSTCreate a business name/individuals/:partyId/business-namesCreate a business name
  • GETRetrieve a business name/individuals/:partyId/business-names/:productIdRetrieve a business name
  • PUTUpdate a business name/individuals/:partyId/business-names/:productIdUpdate a business name
  • DELETEDelete a business name/individuals/:partyId/business-names/:productIdDelete a business name

Individuals Licenses

  • GETRetrieve a list of licenses/individuals/:partyId/licenses
  • POSTCreate a license/individuals/:partyId/licensesCreate a license
  • GETRetrieve a license/individuals/:partyId/licenses/:productIdRetrieve a license
  • PUTUpdate a license/individuals/:partyId/licenses/:productIdUpdate a license
  • DELETEDelete a license/individuals/:partyId/licenses/:productIdDelete a license

Organisations

  • GETRetrieve a list of organisations/organisations?registeredIdentifier=string&identifier=stringRetrieve a list of organisations
  • POSTCreate an organisation/organisationsCreate an organisation
  • GETRetrieve an organisation/organisations/:partyIdRetrieve an organisation with the specified identifier
  • PUTUpdate an organisation/organisations/:partyIdUpdate an organisation
  • DELETEDelete an organisation/organisations/:partyIdDelete an organisation with the specified identifier

Organisations Roles

  • GETRetrieve a list of roles/organisations/:partyId/roles
  • POSTCreate a role/organisations/:partyId/rolesCreate a role
  • GETRetrieve a role/organisations/:partyId/roles/:roleIdRetrieve a role
  • PUTUpdate a role/organisations/:partyId/roles/:roleIdUpdate a role
  • DELETEDelete a role/organisations/:partyId/roles/:roleIdDelete a role

Organisations Addresses

  • GETRetrieve a list of addresses/organisations/:partyId/addresses
  • POSTCreate an address/organisations/:partyId/addressesCreate an address
  • GETRetrieve an address/organisations/:partyId/addresses/:addressIdRetrieve an address
  • PUTUpdate an address/organisations/:partyId/addresses/:addressIdUpdate an address
  • DELETEDelete an address/organisations/:partyId/addresses/:addressIdDelete an address

Organisations Electronic Addresses

  • GETRetrieve a list of electronic addresses/organisations/:partyId/electronic-addresses
  • POSTCreate an electronic address/organisations/:partyId/electronic-addressesCreate an electronic address
  • GETRetrieve an electronic address/organisations/:partyId/electronic-addresses/:addressIdRetrieve an electronic address
  • PUTUpdate an electronic address/organisations/:partyId/electronic-addresses/:addressIdUpdate an electronic address
  • DELETEDelete an electronic address/organisations/:partyId/electronic-addresses/:addressIdDelete an electronic address

Organisations Business Names

  • GETRetrieve a list of business names/organisations/:partyId/business-names
  • POSTCreate a business name/organisations/:partyId/business-namesCreate a business name
  • GETRetrieve a business name/organisations/:partyId/business-names/:productIdRetrieve a business name
  • PUTUpdate a business name/organisations/:partyId/business-names/:productIdUpdate a business name
  • DELETEDelete a business name/organisations/:partyId/business-names/:productIdDelete a business name

Organisations Licenses

  • GETRetrieve a list of licenses/organisations/:partyId/licenses
  • POSTCreate a license/organisations/:partyId/licensesCreate a license
  • GETRetrieve a license/organisations/:partyId/licenses/:productIdRetrieve a license
  • PUTUpdate a license/organisations/:partyId/licenses/:productIdUpdate a license
  • DELETEDelete a license/organisations/:partyId/licenses/:productIdDelete a license

Business Names

  • GETRetrieve a list of business names/business-namesRetrieve a list of business names

Licenses

  • GETRetrieve a list of licenses/licensesRetrieve a list of licenses

Business Name Lifecycle States

  • GETRetrieve a list of business name lifecycle states/classifications/business-name-lifecycle-states

Name Directions

  • GETRetrieve a list of name directions/classifications/name-directions

Name Prefixes

  • GETRetrieve a list of name prefixes/classifications/name-prefixes

Name Types

  • GETRetrieve a list of name types/classifications/name-types

Address Types

  • GETRetrieve a list of address types/classifications/address-types

Electronic Address Types

  • GETRetrieve a list of electronic address types/classifications/electronic-address-types

Genders

  • GETRetrieve a list of genders/classifications/genders

Legal Entity Types

  • GETRetrieve a list of legal entity types/classifications/legal-entity-types

License Lifecycle States

  • GETRetrieve a list of license lifecycle states/classifications/license-lifecycle-states

License Types

  • GETRetrieve a list of license types/classifications/license-types

Registered Identifier Types

  • GETRetrieve a list of registered identifier types/classifications/registered-identifier-types

Roles

  • GETRetrieve a list of roles/classifications/roles

API details

Authentication
None declared in the description
Operations
74 operations on 38 pathsGET 38PUT 12POST 12DELETE 12
Main resources
Individuals 5Individuals Addresses 5Individuals Business Names 5Individuals Electronic Addresses 5Individuals Licenses 5Individuals Roles 5Organisations 5Organisations Addresses 5Organisations Business Names 5Organisations Electronic Addresses 5
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.0.6
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Business Registries in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Business Registries collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Retrieve a list of individuals” (GET /individuals?dateOfBirth=string&placeOfBirth=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Business Registries?

Introduction The Business Registries API is built on HTTP. The API is RESTful. It has predictable resource URIs. The API is documented in OpenAPI format. In… It is listed under Government & public and has 74 endpoints.

Who publishes the Business Registries?

It is listed from Ato's public API description (an OpenAPI document), not published by Ato on Swastik Codes. Anyone who controls ato.gov.au can claim the profile by adding a DNS TXT record.

How do I authenticate with the Business Registries?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Business Registries have?

74 operations on 38 paths (38 GET, 12 PUT, 12 POST, 12 DELETE). The largest groups are Individuals, Individuals Addresses, Individuals Business Names, Individuals Electronic Addresses.

Is forking the Business Registries free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.