# 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 extensions</a>. # 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](https://en.wikipedia.org/wiki/ISO_8601) format:
//api.abr.ato.gov.au/74 endpoints available
/licensesRetrieve a list of licenses
/individualsRetrieve a list of individuals
/individualsCreate an individual
/organisationsRetrieve a list of organisations
/organisationsCreate an organisation
/business-namesRetrieve a list of business names
/classifications/rolesRetrieve a list of roles
/individuals/{partyId}Retrieve an individual
/individuals/{partyId}Update an individual
/individuals/{partyId}Delete an individual
/classifications/gendersRetrieve a list of genders
/organisations/{partyId}Retrieve an organisation
/organisations/{partyId}Update an organisation
/organisations/{partyId}Delete an organisation
/classifications/name-typesRetrieve a list of name types
/individuals/{partyId}/rolesRetrieve a list of roles
/individuals/{partyId}/rolesCreate a role
/classifications/address-typesRetrieve a list of address types
/classifications/license-typesRetrieve a list of license types
/classifications/name-prefixesRetrieve a list of name prefixes
/organisations/{partyId}/rolesRetrieve a list of roles
/organisations/{partyId}/rolesCreate a role
/individuals/{partyId}/licensesRetrieve a list of licenses
/individuals/{partyId}/licensesCreate a license
/classifications/name-directionsRetrieve a list of name directions
/individuals/{partyId}/addressesRetrieve a list of addresses
/individuals/{partyId}/addressesCreate an address
/organisations/{partyId}/licensesRetrieve a list of licenses
/organisations/{partyId}/licensesCreate a license
/organisations/{partyId}/addressesRetrieve a list of addresses
/organisations/{partyId}/addressesCreate an address
/classifications/legal-entity-typesRetrieve a list of legal entity types
/individuals/{partyId}/business-namesRetrieve a list of business names
/individuals/{partyId}/business-namesCreate a business name
/individuals/{partyId}/roles/{roleId}Retrieve a role
/individuals/{partyId}/roles/{roleId}Update a role
/individuals/{partyId}/roles/{roleId}Delete a role
/organisations/{partyId}/business-namesRetrieve a list of business names
/organisations/{partyId}/business-namesCreate a business name
/organisations/{partyId}/roles/{roleId}Retrieve a role
/organisations/{partyId}/roles/{roleId}Update a role
/organisations/{partyId}/roles/{roleId}Delete a role
/classifications/electronic-address-typesRetrieve a list of electronic address types
/classifications/license-lifecycle-statesRetrieve a list of license lifecycle states
/individuals/{partyId}/electronic-addressesRetrieve a list of electronic addresses
/individuals/{partyId}/electronic-addressesCreate an electronic address
/individuals/{partyId}/licenses/{productId}Retrieve a license
/individuals/{partyId}/licenses/{productId}Update a license
/individuals/{partyId}/licenses/{productId}Delete a license
/classifications/registered-identifier-typesRetrieve a list of registered identifier types
/individuals/{partyId}/addresses/{addressId}Retrieve an address
/individuals/{partyId}/addresses/{addressId}Update an address
/individuals/{partyId}/addresses/{addressId}Delete an address
/organisations/{partyId}/electronic-addressesRetrieve a list of electronic addresses
/organisations/{partyId}/electronic-addressesCreate an electronic address
/organisations/{partyId}/licenses/{productId}Retrieve a license
/organisations/{partyId}/licenses/{productId}Update a license
/organisations/{partyId}/licenses/{productId}Delete a license
/organisations/{partyId}/addresses/{addressId}Retrieve an address
/organisations/{partyId}/addresses/{addressId}Update an address
/organisations/{partyId}/addresses/{addressId}Delete an address
/classifications/business-name-lifecycle-statesRetrieve a list of business name lifecycle states
/individuals/{partyId}/business-names/{productId}Retrieve a business name
/individuals/{partyId}/business-names/{productId}Update a business name
/individuals/{partyId}/business-names/{productId}Delete a business name
/organisations/{partyId}/business-names/{productId}Retrieve a business name
/organisations/{partyId}/business-names/{productId}Update a business name
/organisations/{partyId}/business-names/{productId}Delete a business name
/individuals/{partyId}/electronic-addresses/{addressId}Retrieve an electronic address
/individuals/{partyId}/electronic-addresses/{addressId}Update an electronic address
/individuals/{partyId}/electronic-addresses/{addressId}Delete an electronic address
/organisations/{partyId}/electronic-addresses/{addressId}Retrieve an electronic address
/organisations/{partyId}/electronic-addresses/{addressId}Update an electronic address
/organisations/{partyId}/electronic-addresses/{addressId}Delete an electronic address
# 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 extensions</a>. # 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](https://en.wikipedia.org/wiki/ISO_8601) format:
//api.abr.ato.gov.au/74 endpoints available
/licensesRetrieve a list of licenses
/individualsRetrieve a list of individuals
/individualsCreate an individual
/organisationsRetrieve a list of organisations
/organisationsCreate an organisation
/business-namesRetrieve a list of business names
/classifications/rolesRetrieve a list of roles
/individuals/{partyId}Retrieve an individual
/individuals/{partyId}Update an individual
/individuals/{partyId}Delete an individual
/classifications/gendersRetrieve a list of genders
/organisations/{partyId}Retrieve an organisation
/organisations/{partyId}Update an organisation
/organisations/{partyId}Delete an organisation
/classifications/name-typesRetrieve a list of name types
/individuals/{partyId}/rolesRetrieve a list of roles
/individuals/{partyId}/rolesCreate a role
/classifications/address-typesRetrieve a list of address types
/classifications/license-typesRetrieve a list of license types
/classifications/name-prefixesRetrieve a list of name prefixes
/organisations/{partyId}/rolesRetrieve a list of roles
/organisations/{partyId}/rolesCreate a role
/individuals/{partyId}/licensesRetrieve a list of licenses
/individuals/{partyId}/licensesCreate a license
/classifications/name-directionsRetrieve a list of name directions
/individuals/{partyId}/addressesRetrieve a list of addresses
/individuals/{partyId}/addressesCreate an address
/organisations/{partyId}/licensesRetrieve a list of licenses
/organisations/{partyId}/licensesCreate a license
/organisations/{partyId}/addressesRetrieve a list of addresses
/organisations/{partyId}/addressesCreate an address
/classifications/legal-entity-typesRetrieve a list of legal entity types
/individuals/{partyId}/business-namesRetrieve a list of business names
/individuals/{partyId}/business-namesCreate a business name
/individuals/{partyId}/roles/{roleId}Retrieve a role
/individuals/{partyId}/roles/{roleId}Update a role
/individuals/{partyId}/roles/{roleId}Delete a role
/organisations/{partyId}/business-namesRetrieve a list of business names
/organisations/{partyId}/business-namesCreate a business name
/organisations/{partyId}/roles/{roleId}Retrieve a role
/organisations/{partyId}/roles/{roleId}Update a role
/organisations/{partyId}/roles/{roleId}Delete a role
/classifications/electronic-address-typesRetrieve a list of electronic address types
/classifications/license-lifecycle-statesRetrieve a list of license lifecycle states
/individuals/{partyId}/electronic-addressesRetrieve a list of electronic addresses
/individuals/{partyId}/electronic-addressesCreate an electronic address
/individuals/{partyId}/licenses/{productId}Retrieve a license
/individuals/{partyId}/licenses/{productId}Update a license
/individuals/{partyId}/licenses/{productId}Delete a license
/classifications/registered-identifier-typesRetrieve a list of registered identifier types
/individuals/{partyId}/addresses/{addressId}Retrieve an address
/individuals/{partyId}/addresses/{addressId}Update an address
/individuals/{partyId}/addresses/{addressId}Delete an address
/organisations/{partyId}/electronic-addressesRetrieve a list of electronic addresses
/organisations/{partyId}/electronic-addressesCreate an electronic address
/organisations/{partyId}/licenses/{productId}Retrieve a license
/organisations/{partyId}/licenses/{productId}Update a license
/organisations/{partyId}/licenses/{productId}Delete a license
/organisations/{partyId}/addresses/{addressId}Retrieve an address
/organisations/{partyId}/addresses/{addressId}Update an address
/organisations/{partyId}/addresses/{addressId}Delete an address
/classifications/business-name-lifecycle-statesRetrieve a list of business name lifecycle states
/individuals/{partyId}/business-names/{productId}Retrieve a business name
/individuals/{partyId}/business-names/{productId}Update a business name
/individuals/{partyId}/business-names/{productId}Delete a business name
/organisations/{partyId}/business-names/{productId}Retrieve a business name
/organisations/{partyId}/business-names/{productId}Update a business name
/organisations/{partyId}/business-names/{productId}Delete a business name
/individuals/{partyId}/electronic-addresses/{addressId}Retrieve an electronic address
/individuals/{partyId}/electronic-addresses/{addressId}Update an electronic address
/individuals/{partyId}/electronic-addresses/{addressId}Delete an electronic address
/organisations/{partyId}/electronic-addresses/{addressId}Retrieve an electronic address
/organisations/{partyId}/electronic-addresses/{addressId}Update an electronic address
/organisations/{partyId}/electronic-addresses/{addressId}Delete an electronic address