9. Audience Enhancement¶
Contents
The purpose of these methods are to return a range of data insights/variables relating to an address, DPID or MALID. The full list of insights/variables can be found here. For more details on Audience Enhancement, click here
9.1. Variable Configuration¶
Note
It is important that the variables to be appended for the Audience Enhancement API service is configured from the Marketing Portal by Equifax prior to triggering any transactions. Otherwise, only a selected set of address identifiers will be returned in the response.
The Audience Enhancement functions allow a user to provide an address related input and receive Equifax Insights (or Variables) to understand and engage with audiences more effectively. Leveraging Equifax’s Insights Library, Audience Enhancement offers a rich pool of insights with precise, current information across over 50 dimensions. Given that the Audience 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 Enhancement Configuration tab in the Marketing Portal by Equifax. To access the Enhancement Configuration tab, select API Configuration from the menu as shown below.
9.2. Enhance by Address¶
9.2.1. API URL Endpoint and URL Format¶
https://services.inivio.com.au/enhance/address?query_string
where the query string is composed of a series of field-value pairs field1=value1&field2=value2&field3=value3
9.2.2. Authentication¶
Basic Authentication over HTTPS
9.2.3. Query String Fields and Values¶
| Query String Parameter | Values | Notes |
|---|---|---|
| value | Address in full or part of it | Mandatory |
| coordinates | Longitute and Latitude coordinates for the address | Optional field. Possible values are “true” or “false”. Default if not supplied is false |
Note
API endpoint URLs including the parameters in the query string are not case sensitive.
Warning
Requesting coordinates data may incur additional fees. Please check with your account manager or Contact Us before using coordinates.
9.2.4. Example 1¶
The example shown here demonstrates an API configured to return all Equifax Variables configured through the UI, the types of variables returned will differ depending on your configuration.
9.2.4.1. Request¶
Get the default fields and Equifax variables associated with the address value in the query string
https://services.inivio.com.au/enhance/address?value=L%2010%20100%20Arthur%20st%20north%20sydney%20nsw%202060
9.2.4.2. Response¶
<ResultOfDataEnhamcement xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Result>
<Address>
<BName/>
<FLNbr>10</FLNbr>
<FLType>L</FLType>
<FUNbr/>
<FUType/>
<HNbr1>100</HNbr1>
<HNbr1S/>
<HNbr2/>
<HNbr2S/>
<LocName1>NORTH SYDNEY</LocName1>
<LocName2/>
<LOTNbr/>
<PDNbr/>
<PDNbrP/>
<PDNbrS/>
<PDType/>
<PostCode>2060</PostCode>
<State>NSW</State>
<StName>ARTHUR</StName>
<StType>ST</StType>
<StTypeS/>
<GeoCoderErrorsAndWarnings xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:string/>
</GeoCoderErrorsAndWarnings>
</Address>
<InivioVariables>
<IMPVariable>
<Code>MALID</Code>
<Name>MALID</Name>
<Value>24771525</Value>
</IMPVariable>
<IMPVariable>
<Code>DPID</Code>
<Name>DPID</Name>
<Value>58748411</Value>
</IMPVariable>
<IMPVariable>
<Code>PrimaryDPID</Code>
<Name>Primary DPID</Name>
<Value>95960134</Value>
</IMPVariable>
<IMPVariable>
<Code>X_Coord</Code>
<Name>Longitude</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>Y_Coord</Code>
<Name>Latitude</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>MB_CODE_2011</Code>
<Name>Meshblock</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA1_2011</Code>
<Name>Statistical Area Level1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA2_11</Code>
<Name>Statistical Area Level2</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA3_11</Code>
<Name>Statistical Area Level3</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA4_11</Code>
<Name>Statistical Area Level4</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DIDensityHH</Code>
<Name>Density Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHIncome</Code>
<Name>Household Income</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PVIndState</Code>
<Name>PropertyValue Index State HH Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PVIndLGA</Code>
<Name>PropertyValue Index LGA HH Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHComp</Code>
<Name>Household Composition</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHGroup</Code>
<Name>Household Composition Group</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LORBand</Code>
<Name>Length of Residency</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DwellingType</Code>
<Name>Dwelling Type</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DispIncome10</Code>
<Name>Disposable Income 10</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>EIUnemploymentrateDecile</Code>
<Name>Unemployment Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RIRentrateDecile</Code>
<Name>Neighbourhood Rental Rate</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskMCT</Code>
<Name>GeoRisk (HH Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskBandMB</Code>
<Name>GeoRisk (Meshblock Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskBandSA1</Code>
<Name>GeoRisk (SA1 Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSGroupMB</Code>
<Name>LandScape Group MB Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSSegmentMB</Code>
<Name>LandScape Segment MB Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSGroup</Code>
<Name>LandScape Group SA1 Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSSegment</Code>
<Name>LandScape Segment SA1 Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand3MB</Code>
<Name>Prophesy - Personal Loan 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand12MB</Code>
<Name>Prophesy - Personal Loan 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand3MB</Code>
<Name>Prophesy - Mortgage 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand12MB</Code>
<Name>Prophesy - Mortgage 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand3MB</Code>
<Name>Prophesy - Credit Card 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand12MB</Code>
<Name>Prophesy - Credit Card 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand3SA1</Code>
<Name>Prophesy - Personal Loan 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand12SA1</Code>
<Name>Prophesy - Personal Loan 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand3SA1</Code>
<Name>Prophesy - Mortgage 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand12SA1</Code>
<Name>Prophesy - Mortgage 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand3SA1</Code>
<Name>Prophesy - Credit Card 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand12SA1</Code>
<Name>Prophesy - Credit Card 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>MetroRural</Code>
<Name>Metro/Rural Flag</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSChildrenDecile</Code>
<Name>Census Factor Score Children Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSDisengagedDecile</Code>
<Name>Census Factor Score Disengaged Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSEthnicityDecile</Code>
<Name>Census Factor Score Ethnicity Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSFamilyDecile</Code>
<Name>Census Factor Score Family Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSRetiredDecile</Code>
<Name>Census Factor Score Retired Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSStudentDecile</Code>
<Name>Census Factor Score Student Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSWealthDecile</Code>
<Name>Census Factor Score Wealth Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSWelfareDecile</Code>
<Name>Census Factor Score Welfare Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>OTInd</Code>
<Name>Owner/Tenant Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
</InivioVariables>
</Result>
</ResultOfDataEnhamcement>
9.2.5. Example 2¶
The example shown here demonstrates an API configured to return all Equifax Variables configured through the UI, the types of variables returned will differ depending on your configuration. In addition, this example utilises the coordinates option and returns the response in JSON format.
9.2.5.1. Request¶
In this request, Accept field in the HTTP header is set to JSON
Accept:application/json
https://services.inivio.com.au/enhance/address?value=L%2010%20100%20Arthur%20st%20north%20sydney%20nsw%202060&coordinates=true
9.2.5.2. Response¶
{
"Result": {
"Address": {
"BName": "",
"FLNbr": "10",
"FLType": "L",
"FUNbr": "",
"FUType": "",
"HNbr1": "100",
"HNbr1S": "",
"HNbr2": "",
"HNbr2S": "",
"LocName1": "NORTH SYDNEY",
"LocName2": "",
"LOTNbr": "",
"PDNbr": "",
"PDNbrP": "",
"PDNbrS": "",
"PDType": "",
"PostCode": "2060",
"State": "NSW",
"StName": "ARTHUR",
"StType": "ST",
"StTypeS": "",
"GeoCoderErrorsAndWarnings": [
""
]
},
"InivioVariables": [
{
"Code": "MALID",
"Name": "MALID",
"Value": "24771525"
},
{
"Code": "DPID",
"Name": "DPID",
"Value": "58748411"
},
{
"Code": "PrimaryDPID",
"Name": "Primary DPID",
"Value": "95960134"
},
{
"Code": "X_Coord",
"Name": "Longitude",
"Value": "151.2095"
},
{
"Code": "Y_Coord",
"Name": "Latitude",
"Value": "-33.83984"
},
{
"Code": "MB_CODE_2011",
"Name": "Meshblock",
"Value": null
},
{
"Code": "SA1_2011",
"Name": "Statistical Area Level1",
"Value": null
},
{
"Code": "SA2_11",
"Name": "Statistical Area Level2",
"Value": null
},
{
"Code": "SA3_11",
"Name": "Statistical Area Level3",
"Value": null
},
{
"Code": "SA4_11",
"Name": "Statistical Area Level4",
"Value": null
},
{
"Code": "DIDensityHH",
"Name": "Density Indicator",
"Value": null
},
{
"Code": "HHIncome",
"Name": "Household Income",
"Value": null
},
{
"Code": "PVIndState",
"Name": "PropertyValue Index State HH Level",
"Value": null
},
{
"Code": "PVIndLGA",
"Name": "PropertyValue Index LGA HH Level",
"Value": null
},
{
"Code": "HHComp",
"Name": "Household Composition",
"Value": null
},
{
"Code": "HHGroup",
"Name": "Household Composition Group",
"Value": null
},
{
"Code": "LORBand",
"Name": "Length of Residency",
"Value": null
},
{
"Code": "DwellingType",
"Name": "Dwelling Type",
"Value": null
},
{
"Code": "DispIncome10",
"Name": "Disposable Income 10",
"Value": null
},
{
"Code": "EIUnemploymentrateDecile",
"Name": "Unemployment Indicator",
"Value": null
},
{
"Code": "RIRentrateDecile",
"Name": "Neighbourhood Rental Rate",
"Value": null
},
{
"Code": "GeoRiskMCT",
"Name": "GeoRisk (HH Level)",
"Value": null
},
{
"Code": "GeoRiskBandMB",
"Name": "GeoRisk (Meshblock Level)",
"Value": null
},
{
"Code": "GeoRiskBandSA1",
"Name": "GeoRisk (SA1 Level)",
"Value": null
},
{
"Code": "LSGroupMB",
"Name": "LandScape Group MB Level",
"Value": null
},
{
"Code": "LSSegmentMB",
"Name": "LandScape Segment MB Level",
"Value": null
},
{
"Code": "LSGroup",
"Name": "LandScape Group SA1 Level",
"Value": null
},
{
"Code": "LSSegment",
"Name": "LandScape Segment SA1 Level",
"Value": null
},
{
"Code": "LCDemand3MB",
"Name": "Prophesy - Personal Loan 3Months MB",
"Value": null
},
{
"Code": "LCDemand12MB",
"Name": "Prophesy - Personal Loan 12Months MB",
"Value": null
},
{
"Code": "RMDemand3MB",
"Name": "Prophesy - Mortgage 3Months MB",
"Value": null
},
{
"Code": "RMDemand12MB",
"Name": "Prophesy - Mortgage 12Months MB",
"Value": null
},
{
"Code": "CCDemand3MB",
"Name": "Prophesy - Credit Card 3Months MB",
"Value": null
},
{
"Code": "CCDemand12MB",
"Name": "Prophesy - Credit Card 12Months MB",
"Value": null
},
{
"Code": "LCDemand3SA1",
"Name": "Prophesy - Personal Loan 3Months SA1",
"Value": null
},
{
"Code": "LCDemand12SA1",
"Name": "Prophesy - Personal Loan 12Months SA1",
"Value": null
},
{
"Code": "RMDemand3SA1",
"Name": "Prophesy - Mortgage 3Months SA1",
"Value": null
},
{
"Code": "RMDemand12SA1",
"Name": "Prophesy - Mortgage 12Months SA1",
"Value": null
},
{
"Code": "CCDemand3SA1",
"Name": "Prophesy - Credit Card 3Months SA1",
"Value": null
},
{
"Code": "CCDemand12SA1",
"Name": "Prophesy - Credit Card 12Months SA1",
"Value": null
},
{
"Code": "MetroRural",
"Name": "Metro\/Rural Flag",
"Value": null
},
{
"Code": "CFSChildrenDecile",
"Name": "Census Factor Score Children Decile",
"Value": null
},
{
"Code": "CFSDisengagedDecile",
"Name": "Census Factor Score Disengaged Decile",
"Value": null
},
{
"Code": "CFSEthnicityDecile",
"Name": "Census Factor Score Ethnicity Decile",
"Value": null
},
{
"Code": "CFSFamilyDecile",
"Name": "Census Factor Score Family Decile",
"Value": null
},
{
"Code": "CFSRetiredDecile",
"Name": "Census Factor Score Retired Decile",
"Value": null
},
{
"Code": "CFSStudentDecile",
"Name": "Census Factor Score Student Decile",
"Value": null
},
{
"Code": "CFSWealthDecile",
"Name": "Census Factor Score Wealth Decile",
"Value": null
},
{
"Code": "CFSWelfareDecile",
"Name": "Census Factor Score Welfare Decile",
"Value": null
},
{
"Code": "OTInd",
"Name": "Owner\/Tenant Indicator",
"Value": null
}
]
}
}
9.3. Enhance by DPID¶
Returns a list of Equifax variables given a DPID. Enhance by DPID will not be able to return X and Y coordinates.
9.3.1. API URL Endpoint and URL Format¶
https://services.inivio.com.au/enhance/address/bydpid?query_string
where the query string is composed of a series of field-value pairs field1=value1&field2=value2&field3=value3
9.3.2. Authentication¶
Basic Authentication over HTTPS
9.3.3. Query String Fields and Values¶
| Query String Field/Parameter | Values | Type |
|---|---|---|
| value | A DPID | Mandatory Field |
9.3.4. Response Format¶
XML, JSON depends on “Accept” field in the HTTP header.
Example – Setting ‘Accept’ field in the HTTP header
Accept:application/json
9.3.5. Example¶
The example shown here demonstrates an API configured to return all Equifax Variables configured through the UI, the types of variables returned will differ depending on your configuration.
9.3.5.1. Request¶
https://services.inivio.com.au/enhance/address/bydpid?value=58748411
9.3.5.2. Response¶
<ResultOfDataEnhamcement xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Result>
<InivioVariables>
<IMPVariable>
<Code>MALID</Code>
<Name>MALID</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DPID</Code>
<Name>DPID</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PrimaryDPID</Code>
<Name>Primary DPID</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>X_Coord</Code>
<Name>Longitude</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>Y_Coord</Code>
<Name>Latitude</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>MB_CODE_2011</Code>
<Name>Meshblock</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA1_2011</Code>
<Name>Statistical Area Level1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA2_11</Code>
<Name>Statistical Area Level2</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA3_11</Code>
<Name>Statistical Area Level3</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA4_11</Code>
<Name>Statistical Area Level4</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DIDensityHH</Code>
<Name>Density Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHIncome</Code>
<Name>Household Income</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PVIndState</Code>
<Name>PropertyValue Index State HH Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PVIndLGA</Code>
<Name>PropertyValue Index LGA HH Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHComp</Code>
<Name>Household Composition</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHGroup</Code>
<Name>Household Composition Group</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LORBand</Code>
<Name>Length of Residency</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DwellingType</Code>
<Name>Dwelling Type</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DispIncome10</Code>
<Name>Disposable Income 10</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>EIUnemploymentrateDecile</Code>
<Name>Unemployment Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RIRentrateDecile</Code>
<Name>Neighbourhood Rental Rate</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskMCT</Code>
<Name>GeoRisk (HH Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskBandMB</Code>
<Name>GeoRisk (Meshblock Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskBandSA1</Code>
<Name>GeoRisk (SA1 Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSGroupMB</Code>
<Name>LandScape Group MB Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSSegmentMB</Code>
<Name>LandScape Segment MB Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSGroup</Code>
<Name>LandScape Group SA1 Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSSegment</Code>
<Name>LandScape Segment SA1 Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand3MB</Code>
<Name>Prophesy - Personal Loan 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand12MB</Code>
<Name>Prophesy - Personal Loan 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand3MB</Code>
<Name>Prophesy - Mortgage 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand12MB</Code>
<Name>Prophesy - Mortgage 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand3MB</Code>
<Name>Prophesy - Credit Card 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand12MB</Code>
<Name>Prophesy - Credit Card 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand3SA1</Code>
<Name>Prophesy - Personal Loan 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand12SA1</Code>
<Name>Prophesy - Personal Loan 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand3SA1</Code>
<Name>Prophesy - Mortgage 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand12SA1</Code>
<Name>Prophesy - Mortgage 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand3SA1</Code>
<Name>Prophesy - Credit Card 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand12SA1</Code>
<Name>Prophesy - Credit Card 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>MetroRural</Code>
<Name>Metro/Rural Flag</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSChildrenDecile</Code>
<Name>Census Factor Score Children Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSDisengagedDecile</Code>
<Name>Census Factor Score Disengaged Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSEthnicityDecile</Code>
<Name>Census Factor Score Ethnicity Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSFamilyDecile</Code>
<Name>Census Factor Score Family Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSRetiredDecile</Code>
<Name>Census Factor Score Retired Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSStudentDecile</Code>
<Name>Census Factor Score Student Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSWealthDecile</Code>
<Name>Census Factor Score Wealth Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSWelfareDecile</Code>
<Name>Census Factor Score Welfare Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>OTInd</Code>
<Name>Owner/Tenant Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
</InivioVariables>
</Result>
</ResultOfDataEnhamcement>
9.4. Enhance by MALID¶
Returns a list of Equifax variables given a MALID. Enhance by MALID will not be able to return X and Y coordinates.
9.4.1. API URL Endpoint and URL Format¶
https://services.inivio.com.au/enhance/address/bymalid?query_string where the query string is composed of a series of field-value pairs field1=value1&field2=value2&field3=value3
9.4.2. Authentication¶
Basic Authentication over HTTPS
9.4.3. Query String Fields and Values¶
| Query String Field/Parameter | Values | Type |
|---|---|---|
| value | A MALID | Mandatory Field |
9.4.4. Example¶
The example shown here demonstrates an API configured to return all Equifax Variables configured through the UI, the types of variables returned will differ depending on your configuration.
9.4.4.1. Request¶
https://services.inivio.com.au/enhance/address/bymalid?value=24771525
9.4.5. Response Format¶
XML, JSON depends on “Accept” field in the HTTP header.
Example – Setting ‘Accept’ field in the HTTP header
Accept:application/json
9.4.5.1. Response¶
<ResultOfDataEnhamcement xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Result>
<InivioVariables>
<IMPVariable>
<Code>MALID</Code>
<Name>MALID</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DPID</Code>
<Name>DPID</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PrimaryDPID</Code>
<Name>Primary DPID</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>X_Coord</Code>
<Name>Longitude</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>Y_Coord</Code>
<Name>Latitude</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>MB_CODE_2011</Code>
<Name>Meshblock</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA1_2011</Code>
<Name>Statistical Area Level1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA2_11</Code>
<Name>Statistical Area Level2</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA3_11</Code>
<Name>Statistical Area Level3</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>SA4_11</Code>
<Name>Statistical Area Level4</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DIDensityHH</Code>
<Name>Density Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHIncome</Code>
<Name>Household Income</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PVIndState</Code>
<Name>PropertyValue Index State HH Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>PVIndLGA</Code>
<Name>PropertyValue Index LGA HH Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHComp</Code>
<Name>Household Composition</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>HHGroup</Code>
<Name>Household Composition Group</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LORBand</Code>
<Name>Length of Residency</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DwellingType</Code>
<Name>Dwelling Type</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>DispIncome10</Code>
<Name>Disposable Income 10</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>EIUnemploymentrateDecile</Code>
<Name>Unemployment Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RIRentrateDecile</Code>
<Name>Neighbourhood Rental Rate</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskMCT</Code>
<Name>GeoRisk (HH Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskBandMB</Code>
<Name>GeoRisk (Meshblock Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>GeoRiskBandSA1</Code>
<Name>GeoRisk (SA1 Level)</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSGroupMB</Code>
<Name>LandScape Group MB Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSSegmentMB</Code>
<Name>LandScape Segment MB Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSGroup</Code>
<Name>LandScape Group SA1 Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LSSegment</Code>
<Name>LandScape Segment SA1 Level</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand3MB</Code>
<Name>Prophesy - Personal Loan 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand12MB</Code>
<Name>Prophesy - Personal Loan 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand3MB</Code>
<Name>Prophesy - Mortgage 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand12MB</Code>
<Name>Prophesy - Mortgage 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand3MB</Code>
<Name>Prophesy - Credit Card 3Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand12MB</Code>
<Name>Prophesy - Credit Card 12Months MB</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand3SA1</Code>
<Name>Prophesy - Personal Loan 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>LCDemand12SA1</Code>
<Name>Prophesy - Personal Loan 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand3SA1</Code>
<Name>Prophesy - Mortgage 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>RMDemand12SA1</Code>
<Name>Prophesy - Mortgage 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand3SA1</Code>
<Name>Prophesy - Credit Card 3Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CCDemand12SA1</Code>
<Name>Prophesy - Credit Card 12Months SA1</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>MetroRural</Code>
<Name>Metro/Rural Flag</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSChildrenDecile</Code>
<Name>Census Factor Score Children Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSDisengagedDecile</Code>
<Name>Census Factor Score Disengaged Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSEthnicityDecile</Code>
<Name>Census Factor Score Ethnicity Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSFamilyDecile</Code>
<Name>Census Factor Score Family Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSRetiredDecile</Code>
<Name>Census Factor Score Retired Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSStudentDecile</Code>
<Name>Census Factor Score Student Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSWealthDecile</Code>
<Name>Census Factor Score Wealth Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>CFSWelfareDecile</Code>
<Name>Census Factor Score Welfare Decile</Name>
<Value i:nil="true"/>
</IMPVariable>
<IMPVariable>
<Code>OTInd</Code>
<Name>Owner/Tenant Indicator</Name>
<Value i:nil="true"/>
</IMPVariable>
</InivioVariables>
</Result>
</ResultOfDataEnhamcement>