The Australian Business Register (ABR) is a government database containing key information about businesses and organisations operating in Australia. Award Force can integrate with the ABR to:
- Verify Australian Business Numbers (ABNs)
- Retrieve business information automatically
- Populate entry form fields with verified data while entrants complete their submission
This helps ensure the accuracy of business details submitted by entrants.
Enable API updates during entry editing
Before configuring the integration, allow API updates to entry form fields.
- In the Manage workspace, go to Settings > Entries > Form settings
- Open the 'Advanced' tab
- Enable Allow API updates to submission fields whilst a user is editing the submission
- Click Save
Configure the ABR integration
- In the Manage workspace, go to Settings > Integrations > Marketplace
- Select Australian Business Register
- Click Configure
- Edit the integration name if required
- Click Next
- Review the information provided and click Next
- Select your entry form from the Local resources list
- Under 'External resource', choose Australian Business Register
- Click Next
- Click Add to Entry Resource Map
- Select your Award Force form and the Australian Business Register resource
- Click Next
- Click Add to Field Map
- Pair the Award Force fields with the corresponding ABR fields
- Click Finish
Configure the webhook
After the integration is created, configure the webhook to trigger ABN verification.
- In the Manage workspace, go to Settings > Integrations > Webhooks
- Open the Marketplace webhook
- Select your entry form from the Resource drop-down
- Choose the ABN field used in the field mapping
- Click Save
Once configured, the integration will automatically verify an ABN when it is entered in the form. If the ABN is valid, the integration will populate the mapped fields with information from the ABR. If the ABN is invalid, the entrant will see a validation message.
Mappable fields
The following ABR fields can be mapped to fields in your entry form.
- Is Current
- Replaced From
- Entity Status Code
- Entity Status Effective From
- Entity Status Effective To
- ASIC Number
- Entity Type Code
- GST Effective From
- GST Effective To
- Main Name
- Main Name Effective From
- Main Trading Name
- Trading Name Effective From
- Business Address State
- Business Address Postcode
- Business Address Effective From
- Business Address Effective To
- Record Last Updated
- Register Last Updated
- Datetime Retrieved
- Usage Statement
- Entity Description
Good to know
- The ABR integration verifies Australian Business Numbers (ABNs) in real time. If an ABN is valid, mapped fields are automatically populated with business data. If an ABN is invalid, the entrant will see a validation error message.
- ABR data fields can be set as read-only or hidden if they do not need to be visible to entrants.
- The integration relies on a webhook trigger tied to the ABN field.
- API updates must be enabled in form settings for the integration to update fields while the entrant is editing the form.