flowground für Geschäftskunden
Business Registries
Konnektor für

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 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](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DD For example: `2017-07-01` (the 1st of July 2017) All timestamps use the [ISO 8601](https://en.wikipedia.org/wiki/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](https://tools.ietf.org/html/rfc5988#page-6) 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.
Spezifikationen
  • Kategorie: Office
  • Anbieter: n/a
  • Genutzte API: -
  • Managed: -
  • Lizenz: Apache License 2.0
  • Programmiert mit: javascript
Preise

Sie benötigen zur produktiven Nutzung einen kostenpflichtigen Projektraum.

Preise und Editionen

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

get_business_names

Retrieve a list of business names

OnInit
./lib/actions/get_business_names.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_address_types

OnInit
./lib/actions/get_classifications_address_types.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_business_name_lifecycle_states

OnInit
./lib/actions/get_classifications_business_name_lifecycle_states.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_electronic_address_types

OnInit
./lib/actions/get_classifications_electronic_address_types.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_genders

OnInit
./lib/actions/get_classifications_genders.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_legal_entity_types

OnInit
./lib/actions/get_classifications_legal_entity_types.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_license_lifecycle_states

OnInit
./lib/actions/get_classifications_license_lifecycle_states.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_license_types

OnInit
./lib/actions/get_classifications_license_types.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_name_directions

OnInit
./lib/actions/get_classifications_name_directions.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_name_prefixes

OnInit
./lib/actions/get_classifications_name_prefixes.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_name_types

OnInit
./lib/actions/get_classifications_name_types.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_registered_identifier_types

OnInit
./lib/actions/get_classifications_registered_identifier_types.js
OnStartup
-
OnClose
-

Attributes

-

get_classifications_roles

OnInit
./lib/actions/get_classifications_roles.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals

Retrieve a list of individuals

OnInit
./lib/actions/get_individuals.js
OnStartup
-
OnClose
-

Attributes

-

post_individuals

Create an individual

OnInit
./lib/actions/post_individuals.js
OnStartup
-
OnClose
-

Attributes

-

delete_individuals__partyId_

Delete an individual with the specified identifier

OnInit
./lib/actions/delete_individuals__partyId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId_

Retrieve an individual with the specified identifier

OnInit
./lib/actions/get_individuals__partyId_.js
OnStartup
-
OnClose
-

Attributes

-

put_individuals__partyId_

Update an individual

OnInit
./lib/actions/put_individuals__partyId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__addresses

OnInit
./lib/actions/get_individuals__partyId__addresses.js
OnStartup
-
OnClose
-

Attributes

-

post_individuals__partyId__addresses

Create an address

OnInit
./lib/actions/post_individuals__partyId__addresses.js
OnStartup
-
OnClose
-

Attributes

-

delete_individuals__partyId__addresses__addressId_

Delete an address

OnInit
./lib/actions/delete_individuals__partyId__addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__addresses__addressId_

Retrieve an address

OnInit
./lib/actions/get_individuals__partyId__addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

put_individuals__partyId__addresses__addressId_

Update an address

OnInit
./lib/actions/put_individuals__partyId__addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__business_names

OnInit
./lib/actions/get_individuals__partyId__business_names.js
OnStartup
-
OnClose
-

Attributes

-

post_individuals__partyId__business_names

Create a business name

OnInit
./lib/actions/post_individuals__partyId__business_names.js
OnStartup
-
OnClose
-

Attributes

-

delete_individuals__partyId__business_names__productId_

Delete a business name

OnInit
./lib/actions/delete_individuals__partyId__business_names__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__business_names__productId_

Retrieve a business name

OnInit
./lib/actions/get_individuals__partyId__business_names__productId_.js
OnStartup
-
OnClose
-

Attributes

-

put_individuals__partyId__business_names__productId_

Update a business name

OnInit
./lib/actions/put_individuals__partyId__business_names__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__electronic_addresses

OnInit
./lib/actions/get_individuals__partyId__electronic_addresses.js
OnStartup
-
OnClose
-

Attributes

-

post_individuals__partyId__electronic_addresses

Create an electronic address

OnInit
./lib/actions/post_individuals__partyId__electronic_addresses.js
OnStartup
-
OnClose
-

Attributes

-

delete_individuals__partyId__electronic_addresses__addressId_

Delete an electronic address

OnInit
./lib/actions/delete_individuals__partyId__electronic_addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__electronic_addresses__addressId_

Retrieve an electronic address

OnInit
./lib/actions/get_individuals__partyId__electronic_addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

put_individuals__partyId__electronic_addresses__addressId_

Update an electronic address

OnInit
./lib/actions/put_individuals__partyId__electronic_addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__licenses

OnInit
./lib/actions/get_individuals__partyId__licenses.js
OnStartup
-
OnClose
-

Attributes

-

post_individuals__partyId__licenses

Create a license

OnInit
./lib/actions/post_individuals__partyId__licenses.js
OnStartup
-
OnClose
-

Attributes

-

delete_individuals__partyId__licenses__productId_

Delete a license

OnInit
./lib/actions/delete_individuals__partyId__licenses__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__licenses__productId_

Retrieve a license

OnInit
./lib/actions/get_individuals__partyId__licenses__productId_.js
OnStartup
-
OnClose
-

Attributes

-

put_individuals__partyId__licenses__productId_

Update a license

OnInit
./lib/actions/put_individuals__partyId__licenses__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__roles

OnInit
./lib/actions/get_individuals__partyId__roles.js
OnStartup
-
OnClose
-

Attributes

-

post_individuals__partyId__roles

Create a role

OnInit
./lib/actions/post_individuals__partyId__roles.js
OnStartup
-
OnClose
-

Attributes

-

delete_individuals__partyId__roles__roleId_

Delete a role

OnInit
./lib/actions/delete_individuals__partyId__roles__roleId_.js
OnStartup
-
OnClose
-

Attributes

-

get_individuals__partyId__roles__roleId_

Retrieve a role

OnInit
./lib/actions/get_individuals__partyId__roles__roleId_.js
OnStartup
-
OnClose
-

Attributes

-

put_individuals__partyId__roles__roleId_

Update a role

OnInit
./lib/actions/put_individuals__partyId__roles__roleId_.js
OnStartup
-
OnClose
-

Attributes

-

get_licenses

Retrieve a list of licenses

OnInit
./lib/actions/get_licenses.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations

Retrieve a list of organisations

OnInit
./lib/actions/get_organisations.js
OnStartup
-
OnClose
-

Attributes

-

post_organisations

Create an organisation

OnInit
./lib/actions/post_organisations.js
OnStartup
-
OnClose
-

Attributes

-

delete_organisations__partyId_

Delete an organisation with the specified identifier

OnInit
./lib/actions/delete_organisations__partyId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId_

Retrieve an organisation with the specified identifier

OnInit
./lib/actions/get_organisations__partyId_.js
OnStartup
-
OnClose
-

Attributes

-

put_organisations__partyId_

Update an organisation

OnInit
./lib/actions/put_organisations__partyId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__addresses

OnInit
./lib/actions/get_organisations__partyId__addresses.js
OnStartup
-
OnClose
-

Attributes

-

post_organisations__partyId__addresses

Create an address

OnInit
./lib/actions/post_organisations__partyId__addresses.js
OnStartup
-
OnClose
-

Attributes

-

delete_organisations__partyId__addresses__addressId_

Delete an address

OnInit
./lib/actions/delete_organisations__partyId__addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__addresses__addressId_

Retrieve an address

OnInit
./lib/actions/get_organisations__partyId__addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

put_organisations__partyId__addresses__addressId_

Update an address

OnInit
./lib/actions/put_organisations__partyId__addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__business_names

OnInit
./lib/actions/get_organisations__partyId__business_names.js
OnStartup
-
OnClose
-

Attributes

-

post_organisations__partyId__business_names

Create a business name

OnInit
./lib/actions/post_organisations__partyId__business_names.js
OnStartup
-
OnClose
-

Attributes

-

delete_organisations__partyId__business_names__productId_

Delete a business name

OnInit
./lib/actions/delete_organisations__partyId__business_names__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__business_names__productId_

Retrieve a business name

OnInit
./lib/actions/get_organisations__partyId__business_names__productId_.js
OnStartup
-
OnClose
-

Attributes

-

put_organisations__partyId__business_names__productId_

Update a business name

OnInit
./lib/actions/put_organisations__partyId__business_names__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__electronic_addresses

OnInit
./lib/actions/get_organisations__partyId__electronic_addresses.js
OnStartup
-
OnClose
-

Attributes

-

post_organisations__partyId__electronic_addresses

Create an electronic address

OnInit
./lib/actions/post_organisations__partyId__electronic_addresses.js
OnStartup
-
OnClose
-

Attributes

-

delete_organisations__partyId__electronic_addresses__addressId_

Delete an electronic address

OnInit
./lib/actions/delete_organisations__partyId__electronic_addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__electronic_addresses__addressId_

Retrieve an electronic address

OnInit
./lib/actions/get_organisations__partyId__electronic_addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

put_organisations__partyId__electronic_addresses__addressId_

Update an electronic address

OnInit
./lib/actions/put_organisations__partyId__electronic_addresses__addressId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__licenses

OnInit
./lib/actions/get_organisations__partyId__licenses.js
OnStartup
-
OnClose
-

Attributes

-

post_organisations__partyId__licenses

Create a license

OnInit
./lib/actions/post_organisations__partyId__licenses.js
OnStartup
-
OnClose
-

Attributes

-

delete_organisations__partyId__licenses__productId_

Delete a license

OnInit
./lib/actions/delete_organisations__partyId__licenses__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__licenses__productId_

Retrieve a license

OnInit
./lib/actions/get_organisations__partyId__licenses__productId_.js
OnStartup
-
OnClose
-

Attributes

-

put_organisations__partyId__licenses__productId_

Update a license

OnInit
./lib/actions/put_organisations__partyId__licenses__productId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__roles

OnInit
./lib/actions/get_organisations__partyId__roles.js
OnStartup
-
OnClose
-

Attributes

-

post_organisations__partyId__roles

Create a role

OnInit
./lib/actions/post_organisations__partyId__roles.js
OnStartup
-
OnClose
-

Attributes

-

delete_organisations__partyId__roles__roleId_

Delete a role

OnInit
./lib/actions/delete_organisations__partyId__roles__roleId_.js
OnStartup
-
OnClose
-

Attributes

-

get_organisations__partyId__roles__roleId_

Retrieve a role

OnInit
./lib/actions/get_organisations__partyId__roles__roleId_.js
OnStartup
-
OnClose
-

Attributes

-

put_organisations__partyId__roles__roleId_

Update a role

OnInit
./lib/actions/put_organisations__partyId__roles__roleId_.js
OnStartup
-
OnClose
-

Attributes

-

Keine Daten für terms vorhanden

Keine Daten für environment vorhanden