Defining an ORGANISATION entity object

Creating an entity object for an ORGANISATION is not all that obvious from the raw documentation, so here is what you need as a minimum to create an entity that can be used to run business reports and queries and ultimate beneficial owner checks.

Key Entity Attributes

Using the standard entity object, we first need to set the following attribute:

entityType: ORGANISATION

Because this isn't a person, you do not need to set the name, dateOfBirth, gender fields.

You can provide addresses if you wish, although these will be populated when we retrieve the business details from ABR and ASIC.

You can also add documents to the entity object if you wish to store additional data.

the extraData KVP array is also there if you need to capture additional information. This is important for key corporate attributes and identifiers such as ABN/ACN. See below.

If you wish to add your own reference number, you can add the optional customer_reference key.

The organisationData structure is where the bulk of the organisation details can be found. The API documentation covers most of these fields in some detail, but the key one to note is the organisationData.registeredName which is the actual name of the organisation.

Setting ABN and/or ACN

Australian Company Number (ACN) and Australian Business Number (ABN) are defined as external IDs in the entity.extraData KVP array.

To do this, create a KVP of the form:

{
    "kvpKey": "ACN",    (same for ABN)
    "kvpValue": "001234567",
    "kvpType": "id.external"
}

NOTE: It is critical to ensure the kvpType is set to id.external so that this is correctly identified and indexed within the system.

Example minimal ORGANISATION entity

{
    "organisation": {
        "entityType": "ORGANISATION",
        "extraData": [
            {
                "kvpKey": "ACN",
                "kvpValue": "001234567",
                "kvpType": "id.external"
            },
            {
                "kvpKey": "ABN",
                "kvpValue": "61001234567",
                "kvpType": "id.external"
            }
        ],
        "organisationData": {
            "registeredName": "Example Corporation Ltd"
        }
    }
}

Did this page help you?