integrations.sh
← all integrations

Business Registries

OpenAPI apis-guru financial

Introduction

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

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

Overview

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

Current Version

By default, all requests to 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 . All data is sent and received as JSON. Blank fields are included.

All dates use the format:

YYYY-MM-DD

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

All timestamps use the 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 header.

For example:

Link: <https://api.abr.ato.gov.au/individuals?page=2>; rel="next",      <https://api.abr.ato.gov.au/individuals?page=34>; 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.

Homepage
https://api.apis.guru/v2/specs/ato.gov.au/0.0.6.json
Provider
ato.gov.au
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/ato.gov.au/0.0.6/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/ato.gov.au/0.0.6/openapi.yaml

Tools (76)

Extracted live via the executor SDK.

  • addressTypes.getClassificationsAddressTypes

    Retrieve a list of address types

  • businessNameLifecycleStates.getClassificationsBusinessNameLifecycleStates

    Retrieve a list of business name lifecycle states

  • businessNames.getBusinessNames

    Retrieve a list of business names

  • electronicAddressTypes.getClassificationsElectronicAddressTypes

    Retrieve a list of electronic address types

  • genders.getClassificationsGenders

    Retrieve a list of genders

  • individuals.deleteIndividualsPartyId

    Delete an individual with the specified identifier

  • individuals.getIndividuals

    Retrieve a list of individuals

  • individuals.getIndividualsPartyId

    Retrieve an individual with the specified identifier

  • individuals.postIndividuals

    Create an individual

  • individuals.putIndividualsPartyId

    Update an individual

  • individualsAddresses.deleteIndividualsPartyIdAddressesAddressId

    Delete an address

  • individualsAddresses.getIndividualsPartyIdAddresses

    Retrieve a list of addresses

  • individualsAddresses.getIndividualsPartyIdAddressesAddressId

    Retrieve an address

  • individualsAddresses.postIndividualsPartyIdAddresses

    Create an address

  • individualsAddresses.putIndividualsPartyIdAddressesAddressId

    Update an address

  • individualsBusinessNames.deleteIndividualsPartyIdBusinessNamesProductId

    Delete a business name

  • individualsBusinessNames.getIndividualsPartyIdBusinessNames

    Retrieve a list of business names

  • individualsBusinessNames.getIndividualsPartyIdBusinessNamesProductId

    Retrieve a business name

  • individualsBusinessNames.postIndividualsPartyIdBusinessNames

    Create a business name

  • individualsBusinessNames.putIndividualsPartyIdBusinessNamesProductId

    Update a business name

  • individualsElectronicAddresses.deleteIndividualsPartyIdElectronicAddressesAddressId

    Delete an electronic address

  • individualsElectronicAddresses.getIndividualsPartyIdElectronicAddresses

    Retrieve a list of electronic addresses

  • individualsElectronicAddresses.getIndividualsPartyIdElectronicAddressesAddressId

    Retrieve an electronic address

  • individualsElectronicAddresses.postIndividualsPartyIdElectronicAddresses

    Create an electronic address

  • individualsElectronicAddresses.putIndividualsPartyIdElectronicAddressesAddressId

    Update an electronic address

  • individualsLicenses.deleteIndividualsPartyIdLicensesProductId

    Delete a license

  • individualsLicenses.getIndividualsPartyIdLicenses

    Retrieve a list of licenses

  • individualsLicenses.getIndividualsPartyIdLicensesProductId

    Retrieve a license

  • individualsLicenses.postIndividualsPartyIdLicenses

    Create a license

  • individualsLicenses.putIndividualsPartyIdLicensesProductId

    Update a license

  • individualsRoles.deleteIndividualsPartyIdRolesRoleId

    Delete a role

  • individualsRoles.getIndividualsPartyIdRoles

    Retrieve a list of roles

  • individualsRoles.getIndividualsPartyIdRolesRoleId

    Retrieve a role

  • individualsRoles.postIndividualsPartyIdRoles

    Create a role

  • individualsRoles.putIndividualsPartyIdRolesRoleId

    Update a role

  • legalEntityTypes.getClassificationsLegalEntityTypes

    Retrieve a list of legal entity types

  • licenseLifecycleStates.getClassificationsLicenseLifecycleStates

    Retrieve a list of license lifecycle states

  • licenses.getLicenses

    Retrieve a list of licenses

  • licenseTypes.getClassificationsLicenseTypes

    Retrieve a list of license types

  • nameDirections.getClassificationsNameDirections

    Retrieve a list of name directions

  • namePrefixes.getClassificationsNamePrefixes

    Retrieve a list of name prefixes

  • nameTypes.getClassificationsNameTypes

    Retrieve a list of name types

  • organisations.deleteOrganisationsPartyId

    Delete an organisation with the specified identifier

  • organisations.getOrganisations

    Retrieve a list of organisations

  • organisations.getOrganisationsPartyId

    Retrieve an organisation with the specified identifier

  • organisations.postOrganisations

    Create an organisation

  • organisations.putOrganisationsPartyId

    Update an organisation

  • organisationsAddresses.deleteOrganisationsPartyIdAddressesAddressId

    Delete an address

  • organisationsAddresses.getOrganisationsPartyIdAddresses

    Retrieve a list of addresses

  • organisationsAddresses.getOrganisationsPartyIdAddressesAddressId

    Retrieve an address

  • organisationsAddresses.postOrganisationsPartyIdAddresses

    Create an address

  • organisationsAddresses.putOrganisationsPartyIdAddressesAddressId

    Update an address

  • organisationsBusinessNames.deleteOrganisationsPartyIdBusinessNamesProductId

    Delete a business name

  • organisationsBusinessNames.getOrganisationsPartyIdBusinessNames

    Retrieve a list of business names

  • organisationsBusinessNames.getOrganisationsPartyIdBusinessNamesProductId

    Retrieve a business name

  • organisationsBusinessNames.postOrganisationsPartyIdBusinessNames

    Create a business name

  • organisationsBusinessNames.putOrganisationsPartyIdBusinessNamesProductId

    Update a business name

  • organisationsElectronicAddresses.deleteOrganisationsPartyIdElectronicAddressesAddressId

    Delete an electronic address

  • organisationsElectronicAddresses.getOrganisationsPartyIdElectronicAddresses

    Retrieve a list of electronic addresses

  • organisationsElectronicAddresses.getOrganisationsPartyIdElectronicAddressesAddressId

    Retrieve an electronic address

  • organisationsElectronicAddresses.postOrganisationsPartyIdElectronicAddresses

    Create an electronic address

  • organisationsElectronicAddresses.putOrganisationsPartyIdElectronicAddressesAddressId

    Update an electronic address

  • organisationsLicenses.deleteOrganisationsPartyIdLicensesProductId

    Delete a license

  • organisationsLicenses.getOrganisationsPartyIdLicenses

    Retrieve a list of licenses

  • organisationsLicenses.getOrganisationsPartyIdLicensesProductId

    Retrieve a license

  • organisationsLicenses.postOrganisationsPartyIdLicenses

    Create a license

  • organisationsLicenses.putOrganisationsPartyIdLicensesProductId

    Update a license

  • organisationsRoles.deleteOrganisationsPartyIdRolesRoleId

    Delete a role

  • organisationsRoles.getOrganisationsPartyIdRoles

    Retrieve a list of roles

  • organisationsRoles.getOrganisationsPartyIdRolesRoleId

    Retrieve a role

  • organisationsRoles.postOrganisationsPartyIdRoles

    Create a role

  • organisationsRoles.putOrganisationsPartyIdRolesRoleId

    Update a role

  • registeredIdentifierTypes.getClassificationsRegisteredIdentifierTypes

    Retrieve a list of registered identifier types

  • roles.getClassificationsRoles

    Retrieve a list of roles

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools