11. Commercial Enhancement

11.1. Introduction

Note

It is important that the variables to be appended for the Commercial Enhancement API service is configured from the Marketing Portal by Equifax prior to triggering any transactions. Otherwise, only a selected set of entity identifiers will be returned in the response.

The Commercial Enhancement functions allow a user to provide an ABN or ACN as input and receive Equifax Insights (or Variables) to understand the insights around the entities more effectively. Leveraging Equifax’s Insights Library, Commercial Enhancement offers a rich pool of insights with precise, current information across over 20 dimensions. Given that the Commercial Enhancement functions are able to return a large number of variables, it is necessary for the API user to predefine the required variables for output. Once the variables are selected and saved, the same list of variables will be returned for the particular user account triggering the endpoints.

The user can configure and learn more about each variable from the Commercial Enhancement Configuration tab in the Marketing Portal by Equifax. To access the Commercial Enhancement Configuration tab, select API Configuration from the menu as shown below.

resources/images/api_commercial_config.png

11.2. Endpoint

https://services.inivio.com.au/enhance/commercial/entity?query_string

where the query string is composed of a series of field-value pairs field1=value1&field2=value2&field3=value3. see Request Parameters for details.

11.3. Authentication

Basic Authentication over HTTPS

See Connecting to APIs for more details.

11.4. Request Parameters

Query format.

https://base_url/enhance/commercial/entity?acn={acn}&abn={abn}&as={outputmsgformat}
Query String Parameter Description Mandatory/Optional
acn Australian Company Number Optional.See Note.
abn Australian Business Number Optional.See Note.

Note

acn:
If the abn has been provided, acn is an optional field. Australian Company Number of the company for which data is to be retrieved upon.
abn:
If the acn has been provided, abn is an optional field. Australian Business Number of the company or business for which data is to be retrieved upon.

One of these two input fields will be mandatory per request. If both fields are available in one request, API will use the ACN.

Note

API endpoint URLs including the parameters in the query string are not case sensitive.

11.5. Response Parameters

Parameter Description / Notes
ACN Australian Company Number. All ACNs are associated at the Entity level. See Note.
ABN Australian Business Number. All ABNs are associated at the Entity level. See Note.
ABNStartDate See Note.
ABNLastUpdateDate Date that the ABN was last updated. See Note.
ABNStatus ABN Status. See Note.
ABNStatusStartDate See Note.
EntityName See Note.
ACNStatus See Note.
LastASICRefreshDateTime See Note.
ROPostcode Registered office post code. See Note.
ROState Registered office state. See Note.
EntityANZSICDivision See Note.
EntityANZSICCode See Note.
BusinessAddress See Note.
AddressType See Note.
DM1FullName See Note.
DM2FullName See Note.
FNDemandIndex See Note.
GSTRegistered See Note.
NewBusinessFlag See Note.
NoOfDirector See Note.
EntityNoOfEmployee See Note.
PhoneAtAddress See Note.
PhoneISSuppressed See Note.
PRS_Band See Note.
EntityRevenue See Note.
TimeInBusinessIndicator See Note.
EntityTypeCategory See Note.
Errors Any errors experienced in validation.

Note

ACN:
ACN is a 9 digit number. It is an unique identifier for a company registered under the Commonwealth Corporations Act 2001. The purpose of the ACN is to ensure adequate identification of companies when transacting business.
ABN:

ABN is a 11 digit number. The ABN is used to

  • Register for GST and claim GST credits.
  • Register for PAYG withholding.
  • Deal with investment bodies.
  • Apply to the ATO for endorsement as a deductible gift recipient or tax concession charity.
  • Interact with other government departments, agencies and authorities.
  • Interact with the ATO on other taxes, such as FBT.
ABNStartDate:
The effective start date of the ABN returned in format DD/MM/YYYY.
ABNLastUpdateDate:
The date that the ABN was last updated from the Australian Business Register (ABR) returned in format DD/MM/YYYY.
ABNStatus:

The status of the ABN. Values returned can be one of either

  • Active - An ABN with a status of ‘active’ means that the registration is current.

  • Cancelled - An ABN with a status of ‘cancelled’ means that the ABN has been deactivated and is no longer current. A business would cancel their ABN if it

    • has been sold.
    • has closed down.
    • is no longer operating in Australia or making supplies connected with Australia.
    • if its business structure has changed.

  • NULL - No ABN Status because the entity does not have an ABN.

ABNStatusStartDate:
The effective start date of the current status of the ABN.
ACNStatus:
Status of the Australian Company Number - REGD/DRGD.
LastASICRefreshDateTime:
The date a business’ data was last refreshed.
EntityName:
Entity name refers to the name that appears on all official documents or legal papers. The entity name may be different from the business name. For instances where there is an ABN linked to an ACN (e.g. Private Company / Public Company), then the Entity Name is the ACN Company name (from ASIC). For instances where there is no ABN to ACN relationship (e.g. Sole Trader) then the Entity Name will be the name registered under the ABN.
ROPostcode:
The postcode of the most applicable registered office address associated to the entity.
ROState:
The state of the most applicable registered office address associated to the entity.
EntityANZSICDivision:
Nineteen broad industry divisions denoted by letters associated to the entity.ANZSIC codes can be found here
EntityANZSICCode:
The Australian and New Zealand Standard Industrial Classification (ANZSIC) code developed for use in both Australia and New Zealand for the production and analysis of industry statistics. This field contains the 2006 edition of the ANZSIC code at the class level (4 digits) associated to the entity. ANZSIC codes can be found here
BusinessAddress:
The address of the most applicable registered office associated to the entity.
AddressType:
Describes the type of address displayed.
  • CO - ASIC Company Officers Address
  • FR - Foreign Address
  • HO - Head Office
  • NTDM - No Telephone Directory Match
  • PA - Postal Address
  • PP - Principal Place of Business
  • RO - Registered Office
  • RO-NTDM - Registered Office - No Telephone Directory Match
  • SD - Service of Documents
  • SH - ASIC Shareholder Address
  • TA - Trading Address
  • UK - Unknown
DM1FullName:
Full name of the highest ranked decision maker. Could be a business owner for sole trader or Director/Secretary for a company.
DM2FullName:
Full name of the lower ranked decision maker. Could be a business owner for sole trader or Director/Secretary for a company.
FNDemandIndex:
Relative banding of entities in demand for finance.
GSTRegistered:
Identifies whether an Entity (must have an ABN) has registered for GST purposes.
NewBusinessFlag:
Is flagged based on time in business less than 1 year.This is calculated based on the difference between today’s date and ABN Start Date (for businesses) or ACN incorporated date (for companies). The output is rounded to a year.
NoOfDirector:
Provides a count on the total number of directors of a company.
EntityNoOfEmployee:
Provides an indication of the size of a business as defined by the number of individuals employed by the Entity.
PhoneAtAddress:
The Phone number of the most applicable registered office address associated to the entity.
PhoneISSuppressed:
PhoneISSuppressed represents the values "Y" & "N" due to the Do Not Call Register (DNCR). For example if a phone numberis present in DNCR, we will not be able to append the phoneAtAddress.
PRS_Band:
PRS or Portfolio Review Score is a behavioural score specifically designed to predict the probability of an adverse credit event of a commercial entity within a twelve month window.
EntityRevenue:
Provides an indication of the revenue of an entity.
TimeInBusinessIndicator:
Provides an indication of how long a business has been in operation.
EntityTypeCategory:
Describes the type of legal entity as defined by ASIC or the ABR.

11.6. Enhanced by ABN/ACN

ANZSIC codes can be found at ABS.gov.au Or you can download here

11.7. Examples

11.7.1. Example 1

This example shows a response with a parent,group and entity ANZSIC code returned. This example provides response in Json for the ACN provided in the request parameter.

11.7.1.1. Request

https://services.inivio.com.au/enhance/commercial/entity?acn=123433200

11.7.1.2. Response

{
        "EntityDetails": {
                "ACN": "123433200",
                "ABN": "11123433200",
                "ABNStartDate": "2000-03-04T00:00:00",
                "ABNLastUpdateDate": null,
                "ABNStatus": "Active",
                "ABNStatusStartDate": "2000-03-04T00:00:00",
                "EntityName": "GOOD COMPANY PTY LIMITED",
                "ROPostcode": "2113",
                "ROState": "NSW"
                "ACNStatus": "REGD" 
                "LastASICRefreshDateTime": "2018-04-23T04:00:00"                
        },
        "EntityAttributes": [
                 {
                        "Code": "AddressType",
                        "Name": "Entity Address",
                        "Value": "RO"
                },
                {
                        "Code": "BusinessAddress",
                        "Name": "Entity Address",
                        "Value": "100 ARTHUR ST SYDNEY NSW 2000"
                },                
                {
                        "Code": "EntityANZSICDivision",
                        "Name": "Entity ANZSIC Division",
                        "Value": "J"
                },
                {
                        "Code": "EntityANZSICCode",
                        "Name": "Entity ANZSIC Code",
                        "Value": "5801"
                }
                {
                        "Code": "DM1FullName",
                        "Name": "Entity Director Info",
                        "Value": "JOHN SMITH"
                },
                {
                        "Code": "DM2FullName",
                        "Name": "Entity Director Info",
                        "Value": "J SMITH"
                },
                {
                        "Code": "FNDemandIndex",
                        "Name": "Entity Financial Demand Index",
                        "Value": ""
                },
                {
                        "Code": "GSTRegistered",
                        "Name": "Entity GST Register Flag",
                        "Value": "0"
                },
                {
                        "Code": "NewBusinessFlag",
                        "Name": "Entity New Business Flag",
                        "Value": "False"
                },
                {
                        "Code": "NoOfDirector",
                        "Name": "Entity Number Of Directors",
                        "Value": "2"
                },
                {
                        "Code": "EntityNoOfEmployee",
                        "Name": "Entity Number Of Employees",
                        "Value": "2-4"
                },
                {
                        "Code": "PhoneAtAddress",
                        "Name": "Entity Phone",
                        "Value": ""
                },
                {
                        "Code": "PhoneISSuppressed",
                        "Name": "Entity Phone",
                        "Value": "N"
                },
                {
                        "Code": "PRS_Band",
                        "Name": "Entity PRS Band",
                        "Value": ""
                },
                {
                        "Code": "EntityRevenue",
                        "Name": "Entity Revenue",
                        "Value": "$200k to less than $500k"
                },
                {
                        "Code": "TimeInBusinessIndicator",
                        "Name": "Entity Time In Business",
                        "Value": "4"
                },
                {
                        "Code": "EntityTypeCategory",
                        "Name": "Entity Type Category",
                        "Value": "PrivateCo"
                },
        ],
        "Error": null
}

11.7.2. Example 2

This example returns the output in XML format. The response provides only Entity ANZSIC code.

11.7.2.1. Request

https://services.inivio.com.au/enhance/commercial/entity?acn=123410319&as=xml

11.7.2.2. Response

<CommercialEnhancement
        xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <EntityDetails>
                <ACN>123410319</ACN>
                <ABN i:nil="true"/>
                <ABNStartDate i:nil="true"/>
                <ABNLastUpdateDate i:nil="true"/>
                <ABNStatus i:nil="true"/>
                <ABNStatusStartDate i:nil="true"/>
                <EntityName>WATER FORD TESTING CO LTD</EntityName>
                <ROPostcode i:nil="true"/>
                <ROState i:nil="true"/>
                <ACNStatus i:nil="true"/>
                <LastASICRefreshDateTime>2018-04-23T04:00:00</LastASICRefreshDateTime>                
        </EntityDetails>
        <EntityAttributes>
                <EntityAttribute>
                        <Code>AddressType</Code>
                        <Name>Entity Address</Name>
                        <Value>RO</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>BusinessAddress</Code>
                        <Name>Entity Address</Name>
                        <Value>100 ARTHUR ST SYDNEY NSW 2000</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>EntityANZSICCode</Code>
                        <Name>Entity ANZSIC Code</Name>
                        <Value>0919</Value>
                </EntityAttribute>                
                <EntityAttribute>
                        <Code>EntityANZSICDivision</Code>
                        <Name>Entity ANZSIC Division</Name>
                        <Value>B</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>DM1FullName</Code>
                        <Name>Entity Director Info</Name>
                        <Value>JOHN SMITH</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>DM2FullName</Code>
                        <Name>Entity Director Info</Name>
                        <Value>J SMITH</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>FNDemandIndex</Code>
                        <Name>Entity Financial Demand Index</Name>
                        </Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>GSTRegistered</Code>
                        <Name>Entity GST Register Flag</Name>
                        <Value>0</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>NewBusinessFlag</Code>
                        <Name>Entity New Business Flag</Name>
                        <Value>False</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>NoOfDirector</Code>
                        <Name>Entity Number Of Directors</Name>
                        <Value>2</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>EntityNoOfEmployee</Code>
                        <Name>Entity Number Of Employees</Name>
                        <Value>1-4</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>PhoneAtAddress</Code>
                        <Name>Entity Phone</Name>
                        </Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>PhoneISSuppressed</Code>
                        <Name>Entity Phone</Name>
                        <Value>N</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>PRS_Band</Code>
                        <Name>Entity PRS Band</Name>
                        </Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>EntityRevenue</Code>
                        <Name>Entity Revenue</Name>
                        <Value>$200k to less than $500k</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>TimeInBusinessIndicator</Code>
                        <Name>Entity Time In Business</Name>
                        <Value>4</Value>
                </EntityAttribute>
                <EntityAttribute>
                        <Code>EntityTypeCategory</Code>
                        <Name>Entity Type Category</Name>
                        <Value>PrivateCo</Value>
                </EntityAttribute>
        </EntityAttributes>
        <Error i:nil="true"/>
</CommercialEnhancement>

11.7.3. Example 3

This example shows a response with error code.

11.7.3.1. Request

https://services.inivio.com.au/enhance/commercial/entity?acn=01234320

11.7.3.2. Response

{
        "Error": " ACN should contain 9 digits only."
}

11.7.4. Example 4

This example shows a response with no ANZSIC data found for the supplied ACN.

11.7.4.1. Request

https://services.inivio.com.au/enhance/commercial/entity?acn=011133111

11.7.4.2. Response

{
        "EntityAttributes": [],
        "Error": null
}