Overview
All strata schemes in NSW need to report key information online each year to NSW government on the Strata Portal. Strata Scheme Management API has been developed to enable strata managing agents to report multiple schemes in the Strata Portal and continue the next steps for reporting journey. For more information, please follow details "https://www.nsw.gov.au/housing-and-construction/strata/annual-reporting/reporting-for-multiple-schemes" here.
API overview
Report Scheme
keyboard_arrow_down
HTTP Verb - POST
Create API will only create report scheme case for SMA. This API needs to be used only for initial reporting only. i.e., Any new schemes reporting or schemes which are not yet registered in Strata Hub. For additional help and to test the API solution, the software provider should follow instructions listed here "https://www.nsw.gov.au/housing-and-construction/strata/annual-reporting/reporting-for-multiple-schemes".
Update Scheme
keyboard_arrow_down
HTTP Verb - POST
Update API will only update existing Scheme(s) in Strata Scheme Reporting (SSR) application in Strata Hub. This needs to be only used when update information is required as per legislation with in 28 days of it’s change. Please make sure, you display declaration and acknowledgement as provided by government in your software. For additional help and to test the API solution, the software provider should follow instructions listed here "https://www.nsw.gov.au/housing-and-construction/strata/annual-reporting/reporting-for-multiple-schemes".
Annual Report Scheme
keyboard_arrow_down
HTTP Verb - POST
Annual Report API will only allow reporting for subsequent report of schemes after initial reporting based on their Annual General meeting (AGM). This API should only be used after AGM meeting is done. For additional help and to test the API solution, the software provider should follow instructions listed here "https://www.nsw.gov.au/housing-and-construction/strata/annual-reporting/reporting-for-multiple-schemes".
Read Scheme
keyboard_arrow_down
HTTP Verb - GET
Read existing Scheme(s) details from Strata Hub portal. This API should only be used after at least initial (i.e. First) reporting is done in Strata Hub.
Review Report
keyboard_arrow_down
HTTP Verb - POST
This API endpoint enables users to retrieve and review the information submitted for either an initial or annual strata report creation. By accepting a valid RS (Report Scheme) or AR (Annual Report) case ID, it queries Strata Hub and returns the associated report data. The response includes all relevant details along with the applicable privacy collection notice and declaration texts, ensuring transparency and compliance with data handling requirements. We expect user review every response data provided before calling next API which is DeclareAndSubmit API. If any data is not appropriate then WithdrawReport API should be invoked. This functionality supports validation and auditing processes by providing a clear view of the reported information in a structured and secure format.
Withdraw Report
keyboard_arrow_down
HTTP Verb - POST
This endpoint allows for the withdrawal of a initiated or submitted report, provided that the associated payment has not yet been completed. Once a report is withdrawn, it's typically marked as canceled and will no longer proceed through the submission or processing workflow. This action is irreversible once a payment has been fully processed for the report.
Declare and Submit Report
keyboard_arrow_down
HTTP Verb - POST
This endpoint finalizes and officially submits a report, effectively locking the submission. Before calling this API, the user must - 1. Confirm that all provided information within the report is accurate and complete. 2. Accept the required privacy collection notice. 3. Make a formal declaration. It is critical that your client software displays the specific text for both the privacy collection notice and the declaration to the user. This required text is available in two locations - Within the response of the Review API and documented in the API's data dictionary.
Get Payment Link
keyboard_arrow_down
HTTP Verb - GET
This endpoint creates a unique payment link for a report that's already been submitted. Users will use this link to complete the payment needed to finalize the reporting process. It's important to request this link only when the user is ready to pay, as it's typically valid for just 30 minutes. However, if the user picks PayID or BPAY, the link will stay valid for longer, based on our existing business rules.
Get Report Status
keyboard_arrow_down
HTTP Verb - GET
This endpoint lets you retrieve the current processing status of a specific report within Strata Hub. While you can call it anytime to check a report's progress, it's mainly designed to confirm the report's status after payment has been finalized. The API returns the report's current state, which might include statuses like - 'InProgress' (the report is being processed), 'Pending-Payment' (awaiting payment), 'Pending-BPAYcompletion' (awaiting BPAY payment confirmation), and other relevant statuses indicating its lifecycle stage.
Documents List
keyboard_arrow_down
HTTP Verb - GET
This endpoint lets you fetch a complete list of document records. You can get documents for a specific report using its Report ID, or for an entire scheme using its Strata Plan Number. While it's mainly used for downloading financial documents like invoices and receipts, this API is built to generically and scalably support access to a wider range of historical scheme documents in the future.
Download Document
keyboard_arrow_down
HTTP Verb - GET
This endpoint lets you retrieve and download the raw binary content of a single document. To use it, you need to provide the unique DocId for the document you want. You'll typically get this ID from the response of the GetDocumentList API. When successful, this API returns the actual file content, so users can directly download the document. The response payload will be the raw binary data of the file.
Create SMA Transfer
keyboard_arrow_down
HTTP Verb - POST
This new API streamlines the process of transferring Strata Managing Agent (SMA) responsibilities for a strata scheme. It enables both the outgoing and incoming SMAs to initiate and manage transfer requests, ensuring a secure and transparent handover of duties. The API supports key operations such as validating agent credentials, capturing consent from both parties, and updating the strata scheme’s records to reflect the change in management. This facilitates smoother transitions, minimizes administrative overhead, and helps maintain compliance with regulatory requirements.
Accept SMA Transfer
keyboard_arrow_down
HTTP Verb - POST
This endpoint lets the incoming Strata Managing Agent (SMA) officially accept and finalize a scheme transfer that was started earlier. This action gives the incoming SMA full ownership and management responsibility for that specific strata scheme. Once successfully accepted, ownership of the scheme is formally moved to the incoming SMA.
Withdraw SMA Transfer
keyboard_arrow_down
HTTP Verb - POST
This endpoint lets you cancel and roll back a scheme transfer that was started earlier. You can use it before the incoming Strata Managing Agent (SMA) has officially accepted the transfer. The original initiator of the scheme transfer OR The current (outgoing) Strata Managing Agent for the scheme can withdraw it. This API provides a way to undo a transfer if it's no longer needed or if it was started by mistake.
Rate limits
The Strata Scheme Management API has specific endpoint request limitation to authorized users. API.NSW reserve the right to adjust rate limits for any given endpoint in order to improve
quality of service provided to users. Every API consumer will be limited to a number of requests based on their agreement.
Rates for API calls
| Account type |
Services |
Action |
| Free |
- 2500 calls / month
- standard APIs
|
Subscribe
|
| Premium |
- custom calls / month
- standard / custom APIs
- 24/7 email / phone support
- custom service licensing agreement
|
Contact us
|
Release notes
The table below shows date, version number and a detailed description of changes or modifications made to the Strata Scheme Management API. Expected or scheduled
changes are indicated in a green color while yellow is used to indicated completed upgrades or changes.
Recent API Changes
| Date |
Version |
Description |
| 21-Oct-2016 |
1.0 |
Product portal launched |
Security and authentication
API NSW generates API keys for APIs and enables authentication to your APIs using policies.
Credential pairs consisting of consumer key and secret are provisioned to clients and stored for future validation. These are issued as per agreement
with API NSW.
An OAuth call is required to provide the consumer with an authorisation token that would last approximately 12 hours from the time when request was made.
User would need to send this authorisation token with every subsequent request in order to get appropriate results from the API.
For more information see OAuth 2.0
