Software providers and developers: API documentation and support
How the BCNSW eCert API works
This overview describes system-level behaviour only. See the technical documentation for implementation details.
The BCNSW eCert API allows connected third party business software to submit Certificate of Compliance for Electrical Work (CCEW) data to the BCNSW eCert portal.
When a licensed electrician submits CCEW information through connected business software:
- The business software sends the CCEW data to the BCNSW eCert portal through the API.
- The BCNSW eCert API validates the data.
- If the submission is accepted, the CCEW is created and stored in the BCNSW eCert portal.
- The organisation receives a receipt for the submission.
- Certificate notifications are sent to the relevant parties.
- The electrician can access the official certificate through their BCNSW eCert portal account.
Storage of certificates and records
The BCNSW eCert portal is the system of record for all CCEWs, regardless of how the data is submitted.
Supported submission methods
There are two ways to submit CCEW data through the API.
Instant submission
Use instant submission when connected business software is submitting one certificate at a time.
Key characteristics:
- One certificate per request.
- Returns a response for each submission.
- Returns a receipt and certificate reference number when successful.
Batch submission
Use batch submission when connected business software is submitting multiple certificates in one request.
Key characteristics:
- Multiple certificates per request.
- Processed after the request is received.
- Returns a receipt after submission.
- Does not return certificate reference numbers at the time of submission.
How validation works
Validation occurs in:
- your organisation's system before submission
- the API when data is received
- the BCNSW eCert portal during processing.
These checks help make sure the submitted data is complete and can be processed.
For detailed validation rules, error codes and troubleshooting steps, refer to the technical documentation.
Common developer questions
Access and authentication
Access is authenticated using client credentials including:
- client ID
- client secret
- IP address controls
Encrypted API credentials are issued at two stages:
Test environment
Issued after access to the test environment is granted.
Production environment
Issued after access to the production environment is granted.
Data checks and validation
Submissions are validated through a combination of:
- Data and format validation within the API
- External verification services, including licence validation, business registry checks (ABN/ACN), and address validation.
The submission is rejected and an error response is returned, see Error management for more details.
Error management
Errors are communicated in different ways depending on the submission type.
Instant (synchronous) submissions
Errors are returned through HTTP status codes, such as 400 series codes for validation or authentication issues, and 500 series codes for system errors.
Error details are included in the response.
Batched (asynchronous) submissions
Errors are provided in a CSV error report sent by email at scheduled intervals.
All error responses include a code, message and reference identifier.
- Review the returned error details and any error report provided.
- Correct any identified issues in the submission.
- Resubmit the request.
For ongoing issues, you can contact bcnswecert@customerservice.nsw.gov.au.
If you experience an issue with the API, report it by contacting bcnswecert@customerservice.nsw.gov.au
Please include:
- a description of the issue
- the request payload (where possible)
- the response or error message received
- the date and time of the request
We will review reported issues and respond where further information is required.
Due to the self-service nature of the API, individual status updates are not provided for all issues.
Where relevant, updates may be shared directly or reflected in API documentation.
Using the technical documentation
The technical documentation supports the development and testing of your API integration.
It includes information about:
- API endpoints and payload structures
- field definitions and format requirements
- validation rules
- response and error handling
- post submission processing
- testing and environment setup.
Download the BCNSW eCert API technical documentation
The technical documentation is version controlled and maintained separately. Check that you are using the latest version before building or testing your integration.
Request an accessible format of this publication.