Integrate with the Australian Business Register

The Australian Business Register (ABR) is a government database that stores key information about businesses and organisations operating in Australia. They maintain a database which can be integrated with Good Grants so you can verify Australian Business Numbers (ABNs) or fetch business data in real-time while your applicants are completing the application form.

Configure the integration

  1. In the Manage workspace, navigate to Forms
  2. Click on the ellipsis (three dots) associated with your form and go to Form settings
  3. Open the 'Advanced' tab and select the Allow API updates to submission fields whilst a user is editing the submission checkbox
     
  4. Next, go to Settings > Integrations > Marketplace and click the Australian Business Register
  5. In the popup that appears, click the Configure button
     
  6. If desired, customise the name of the integration in the 'Initial Configuration' and click Next
  7. The 'How it works' tab initiates background processes and provides basic information on how the integration works--after reading hit Next
  8. In the 'Resources' tab, choose your desired form(s) from the Local Resources list
  9. Under the 'External resource' heading, choose the Australian Business Register
  10. Click Next
  11. In the 'Resource Mapping' step, click Add to Application Resource Map
  12. Select your Good Grants form and the Australian Business Register from their respective drop-downs before clicking Next
  13. From the 'Field Mapping' tab, click Add to Field Map and begin pairing your fields between Good Grants (the Local field) and the Australian Business Number (the External field)--to view the list of fields available from the Australian Business Register see the Mappable fields section below

    Tip: if the information provided by the Australian Business Register needn't be visible to applicants, the Good Grants fields can be marked as read only or hidden entirely from applicants.
  14. Once you've finished mapping fields click the Finish button
  15. Next, navigate to Settings > Integrations > Webhooks and open the Marketplace webhook
  16. Select your application form from the Resource dropdown and the ABN field you selected in the field mapping in the previous step
  17. Click Save

That's it! Now when a user types in an ABN the integration will automatically verify it with the Australian Business Register. If the value is valid it will return any other information about the charity you want to include in the application. If the number is invalid it will display a message letting the applicant know.

Mappable fields 

  • 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

 

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more