API Reference
The GetEDGE API is a RESTful web service. It exposes company registration, agent services, registry and document production functions and can be used for a variety of purposes, from building up company registration websites, to designing advance company management software. The GetEDGE API is platform independent and it can be used in virtually any kind of environment.
-
Obtaining a token
After you have successfully registered on our website, access your account area and click on the API setting page. Enter your domain name as the token name and hit the Create button. A modal window will appear with your 60 characters long API key. Please copy and securely store the key as this is the only time when you will see it. You may revoke the token at any time from your API settings.
API setting page
API key modal
-
Using a token
When you make any API calls, you should use your API key to authenticate and identify yourself. You do this by attaching a custom header
X-Auth-Edge
to your API call.PHPcurl_setopt($curl, CURLOPT_HTTPHEADER, ['X-Auth-Edge: your-generate-api-key-here']);
Pythoncustom_headers={"X-Auth-Edge" : "your-generate-api-key-here"}
JavahttpReq.addHeader("X-Auth-Edge", "your-generate-api-key-here");
C#http.SetRequestHeader("X-Auth-Edge","your-generate-api-key-here");
C++request.headers().add(L"X-Auth-Edge", L"your-generate-api-key-here");
Rubyrequest["X-Auth-Edge"] = "your-generate-api-key-here"
Example workflow
Our API suite can be used by accountants, lawyers, business consultants and any other professional, to process consume ASIC webservices. You have below an example workflow for getting raw company data with our API. With this workflow you will get the addresses, office holders, share structure and shareholders, etc.
1. Lodge a RA71 form to /api/v1/ra71
Once you successfully send the request to us, you will get in return a
request-id
. Store it along with your form identifier defined when building the
RA71 form. Check Agent Services menu for the RA71 form structure, details and requirements.
2. Check the status of the form at /api/v1/checkStatus
Check the status of the request every 5 minutes.
Check Core Services menu for the checkStatus API call details. Possible outcomes:
a) validation failed
go to step 3 to get the validation erros from the log, amend and resubmit
b) validation ok
the form is accepted by ASIC and you can go to step 3 to get the company details
3. Retrieve raw details with /api/v1/checkLog
Use this endpoint to get raw details of a request id. You can use it to retrieve validation errors or raw company data. Check Core Services menu for the checkLog API call details.
-
Form 201 - Application for registration as an Australian company
Endpoint: /api/v1/201
Methods: POST
Description: Create a 201 form application for company registration for Application for registration as an Australian company. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved, an RA55 Company Registration Advice will be returned.
Version: 8.00
Form 201 API docs -
Form 201 Documents - Company Documents
Endpoint: /api/v1/201/docs/{request-id}
Methods: GET
Description: Request for the company documents. An API call to this endpoint will return a ZIP file with the company documents (form 201, constitution, minutes, registers, etc.) in DOCX and PDF formats.
Version: 3.00
-
Form 201 Certificate - Registration Certificate
Endpoint: /api/v1/201/{request-id}
Methods: GET
Description: Request for the company certificate. An API call to this endpoint will return a PDF file with the company registration certificate.
Version: 1.00
-
Form 201 - Company Name Search
Endpoint: /api/v1/checkName
Methods: POST
Description: An API call to this endpoint with thecompany_name
parameter, will return availability of a company name.
Version: 1.00
-
Form 205A - Notification of resolution-change of name
Endpoint: /api/v1/205a
Methods: POST
Description: Create a 205A form application for notification of resolution-change of name for an Australian company. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved, an RC05 Advice will be returned.
Version: 2.00
Form 205A API docs -
Form 205A Certificate - Name Change Certificate
Endpoint: /api/v1/205a/{request-id}
Methods: GET
Description: Request for the company name change certificate. An API call to this endpoint will return a PDF file with the company name change certificate.
Version: 1.00
-
Form 205A - Company Name Search
Endpoint: /api/v1/checkName
Methods: POST
Description: An API call to this endpoint with thecompany_name
parameter, will return availability of a company name.
Version: 1.00
-
Business Name - Application for registration (instant)
Endpoint: /api/v2/business-names
Methods: POST
Description: Create a form application for business name registration for sole-traders, companies or trusts. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved for processing, an ASICpaymentUrl
link will be returned.
Version: 2.00
Business Name registration API docs -
Business Name - Application for registration (invoice)
Endpoint: /api/v1/business-names
Methods: POST
Description: Create a form application for business name registration for sole-traders and companies. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved for processing, an ASICdocument_number
and anurl
field with the ASIC confirmation will be returned.
Version: 1.01
Business Name registration API docs -
Business Name - Application for renewal
Endpoint: /api/v1/business-names-renewal
Methods: POST
Description: Create a form application for business name renewal. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved for processing, an ASICdocument_number
and anurl
field with the ASIC confirmation will be returned.
Version: 1.01
Business Name renewal API docs -
Business Name - Name Search
Endpoint: /api/v1/checkName
Methods: POST
Description: An API call to this endpoint with thebusiness_name
parameter, will return availability of a business name.
Version: 1.00
-
Form 484 - Change to company details
Endpoint: /api/v1/484
Methods: POST
Description: Create a 361 form application for Change to company details. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved, an successful validation report will be returned together with the ASIC document number.
Version: 2.00
Form 484 API docs
-
361 - Registered agent ceasing to act for a company
Endpoint: /api/v1/361
Methods: POST
Description: Create a 361 form application for Registered agent ceasing to act for a company. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved, an successful validation report will be returned together with the ASIC document number.
Version: 6.00
Form 361 API docs -
Form 362 - Appointment or cessation of a registered agent by a company
Endpoint: /api/v1/362
Methods: POST
Description: Create a 362 form application for Appointment or cessation of a registered agent by a company. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved, an successful validation report will be returned together with the ASIC document number.
Version: 1.00
Form 362 API docs -
Form RA63 - Request Company Debt Report for a specified company
Endpoint: /api/v1/ra63
Methods: POST
Description: Create a RA63 form application for Request Company Debt Report for a specified company. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved, an RA64 Company Debt Report for a specified company advice will be returned with the current company status in a structured data format.
Version: 1.00
Form RA63 API docs -
Form RA71 - Request for statement of company details
Endpoint: /api/v1/ra71
Methods: POST
Description: Create a RA71 form application for Request for statement of company details. An API call to this endpoint will return a JSON response with the requst ID. If the application has been approved, an RA72 Data Download report will be returned with the current details in PDF and/or structured data formats.
Version: 3.00
Form RA71 API docs
-
Status - Check request's status
Endpoint: /api/v1/checkStatus/{request-id}
Methods: GET
Description: Request for the status updates on a specific request ID. An API call to this endpoint will return a JSON response with the status details of the request ID. To be used when interrogating the status of a lodged form.
Version: 1.00
Possible statuses
new
- we received the request (continue polling every 5 minutes)
transmission ok
- ASIC received the request (continue polling every 5 minutes)
validation ok
- ASIC accepted the form (you also have a document number)
validation failed
- ASIC rejected the request use checkLog for the errors (stop polling every 5 minutes)
retry 00x
- ASIC communication error (continue polling every 5 minutes)
-
Log - Check request's log entries
Endpoint: /api/v1/checkLog/{request-id}
Methods: GET
Description: Request for the log entries on a specific request ID. An API call to this endpoint will return a JSON response with the log details of the request ID. To be used when checking the validation errors of a submitted form or to get raw data.
Version: 1.00
-
List Files - Check company's retrieved documents
Endpoint: /api/v1/checkList/{acn}
Methods: GET
Description: Request for the company's retrieved documents from ASIC for a specific company. An API call to this endpoint will return a JSON response with the list of all existing documents. To be used after an RA71 API call.
Version: 1.00
-
Get File - Download individual file
Endpoint: /api/v1/pdf/{document-id}
Methods: GET
Description: Request for an existing company document previously retrieved from ASIC. An API call to this endpoint will return a PDF response with the requested file.
Version: 1.00