ob体育's Application Programming Interfaces (APIs) allow developers to interact with our vast company and business name registry data and integrate it with their software, which can then be used by our customers to lodge and maintain their registrations with us.
This page provides documents and information for Digital Service Providers (DSPs) interested in building services to directly connect with the ob体育 registers.
ob体育 Application Programming Interfaces (APIs) give developers an easy way to integrate ob体育 Registry interactions (company and business name registration for example) with third party software to create web and mobile services.
DSPs should review the APIs and contact ob体育 if they would like to proceed with development. ob体育 will provide:
access to a test environment for the purposes of development,
support for technical questions about the specifications, and
testing to ensure your product is suitable.
There is no fee to use the ob体育 API鈥檚 however, use of these API鈥檚 and the services available are governed by terms and conditions.
Digital Service Access Terms and Conditions
We have updated terms and conditions that govern access to ob体育鈥檚 digital services. The define requirements and obligations to be fulfilled by ob体育 Digital Service Providers (DSPs).
A DSP is a person or organisation who allows data to be sent to and from ob体育 to submit transactions and request information searches of the ob体育 Registers.
The T鈥檚 & C鈥檚 include:
requirements to be an approved DSP,听
obligations of DSPs in relation to conduct (including marketing), use and security measures,
grounds on whch ob体育 may suspend or cancel access to ob体育 digital services, and
expectations of DSPs in managing customer interactions.
By better communicating the requirements to be a DSP and strengthening our compliance work, we hope to better inform new and current DSPs about their obligations and promote the integrity of our registers and digital services.
Business names transactions
Our business name service (also referred to as web services) offers registration, address update, cancel, and renewal transactions. It also provides access to search business name information from ob体育's register.
The APIs below will help software developers implement business name services.
For more information about our business names services, please contact [email protected]
API document
Description
Last updated
A list of error messages transmitted through the service.
21 April 2016
Outlines the information that must be included for business name registration, renewal and search transactions.
20 September 2022
Sample messages submitted through the service.
6 October 2022
Outlines the information that must be included for the streamlined business registration service transaction.
20 September 2022
Explains the common aspects and architecture of the system and how it works.
20 September 2022
Company transactions
Our company service (also referred to as EDGE) offers registration and maintenance transactions. It also provides access to search company information from ob体育's register and scheduling workflows. Our most commonly lodged forms for the Companies Register are also supported.
The APIs below will help DSPs implement company services.
For more information about our company services, please contact [email protected]
API document
Description
Last updated
Describes the requirements for searching the Companies register. This includes:
the message language used,
the organisation and format of messages which requests information from the search service, and
the organisation and format of messages which return information from the search service
2 August 2021
听
A guide to our APIs.
2 August 2021
Outlines how the service communicates with ob体育.
27 January 2016
Outlines how the service communicates with ob体育.
14 April 2003
Explains common aspects of the system.
2 August 2021
Outlines the digital signature requirements for company registration.
2 August 2021
Outlines the information that must be included for company registration transactions.
2 August 2021
Outlines the information that must be included for company maintenance transactions.
18 February 2021
Outlines the information that must be included to nominate or cease a registered and requirements for data downloads and other transactions.
7 October 2020
Outlines how ob体育 will send you messages through EDGE.
19 June 2018
Outlines the information that must be included for the streamlined business registration service transaction.
20 September 2022
Explains the common aspects and architecture of the system and how it works.
20 September 2022
Other Government Business Registrations
Third party DSPs can also build services to directly connect with the Australian Taxation Office (ATO) Business Registrations.
Web and mobile services can be developed for a range of ATO registrations including Australian Business Number Registration. Application Programming Interfaces (API's) and .
Standard Business Reporting
Standard Business Reporting (SBR) is an Australian Government initiative to reduce the reporting burden of business. SBR enables business and tax professionals to report to government directly from their financial, accounting or payroll software. ob体育 supports lodgement of financial reporting obligations via SBR.
Technical information regarding the SBR system can be obtained here:
Technical information regarding the ob体育 SBR forms can be obtained here:
APIs for Reportable Situations
The Reportable Situations API will assist licensees and their agents in submitting notifications about reportable situations with ob体育.
The API provides a machine-to-machine interface solution for high-volume organisations to submit reportable situation transactions. The API will assist licensees in lodging the 鈥樷�� transaction and in particular, replicates the 鈥榥otifying of a reportable situation鈥� pathway.
The API does not accept breach reports or updates to breach reports under the old breach reporting regime that was in place prior to October 2021 (the 鈥榩roviding an update about a breach report where the breach/likely breach occurred prior to October 2021鈥� pathway).
Development of this interface has been guided by the Design Standards for Whole of Australian Government (WoAG) Application Programming Interfaces (APIs). Refer to .
This is a RESTful API service called over HTTPS and managed on API Gateway connecting to a collection of ob体育-Internal backend services that create the reportable situation.
There is a single endpoint URI for the client to call to create a reportable situation transaction. The single API endpoint request method is POST.
JSON is the standard used for transferring听data听to and from client and server sides (Header Content-Type = application/json). Payload requests sent by entities and server responses will be made using JSON.
The API conforms to REST architecture noting the following:
Client-server separation: Clients and servers can evolve independently and are not in any way coupled together, given that the interface (Swagger Doc) is unchanged. If any changes arise, they are communicated as an updated version.
Stateless requests: Server side does not store any context that links multiple consecutive API requests.
Resource Identifiers: Use of nouns for endpoint paths. The endpoint path for this API will be /v1/createReportableSituation.
See 'Access' tab below for related documents.
Access
Before requesting access to the API, interested parties should review the following documents:
Before applying for access to the API, users should have developed their API and be ready to test. Test access is for a limited time and those not ready may not be approved.
To apply for access to the API, interested parties will need to complete the following steps:
Developed the API in accordance with .
Complete an 听and submit the form to ob体育 for review at [email protected].
Successful applicants will be provided with user credentials to the test environment and test scenarios
The applicant will be required to conduct tests on the provided test scenarios. Once the applicant is satisfied with the test results, the test results are emailed to ob体育 for review at [email protected].
ob体育 will provide successful applicants with the user credentials to the production environment of the API.
