6. Contact Validation: Address ¶

Contents

Contact Validation: Address

6.1. ValidateAddress ¶

ValidateAddress takes a single address line, validates it and returns it in separate address elements, potentially making small corrections, e.g. to street name or postcode. In addition, the endpoint appends selected address identifiers to assist in identifying whether the address is valid or not. This endpoint should be used post simple/complex address typeahead functions to clean and store valid data.

6.1.1. API URL Endpoint and URL Format ¶

https://services.inivio.com.au/autocomplete/address/validateaddress?query_string

The query string is composed of a series of field-value pairs

field1=value1&field2=value2&field3=value3

6.1.2. Authentication ¶

Basic Authentication over HTTPS

6.1.3. Query String Fields and Values ¶

Query String Parameter	Values	Notes
address	Address in full or part of it	Mandatory Field
as	XML or JSON	Optional field. Default is JSON
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.

6.1.4. Example 1 ¶

6.1.4.1. Request ¶

Validate the address provided in the address field

https://services.inivio.com.au/autocomplete/address/ValidateAddress?address=l+15+100+arthur+st+north+sydney+2060&as=xml

6.1.4.2. Response ¶

<GeoCodedAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <DPID>89319674</DPID>
        <MALID>43835441</MALID>
        <PDPID>95960134</PDPID>
        <DPIDAppended>YES</DPIDAppended>
        <BName/>
        <FLNbr>15</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/>
        <FullStreetNumber>100</FullStreetNumber>
        <StreetAddress1>LEVEL 15</StreetAddress1>
        <StreetAddress2>100 ARTHUR ST</StreetAddress2>
        <StreetAddress3>NORTH SYDNEY NSW 2060</StreetAddress3>
        <StreetAddress4/>
        <StreetAddress5/>
        <SuburbStatePostcode>NORTH SYDNEY NSW 2060</SuburbStatePostcode>
        <ResultInts xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a:int>21</a:int>
        </ResultInts>
        <GeoCoderErrorsAndWarnings xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <a:string>State change/correction</a:string>
        </GeoCoderErrorsAndWarnings>
</GeoCodedAddress>

6.1.5. Example 2 ¶

6.1.5.1. Request ¶

Validate the address provided in the address field:

https://services.inivio.com.au//autocomplete/address/validateAddress?address=10%20Macquarie%20street%20Sydney%20NSW%202000

6.1.5.2. Response ¶

{
  "DPID": 43384689,
  "MALID": 10126231,
  "PDPID": 43384689,
  "DPIDAppended": "YES",
  "BName": "",
  "FLNbr": "",
  "FLType": "",
  "FUNbr": "",
  "FUType": "",
  "HNbr1": "10",
  "HNbr1S": "",
  "HNbr2": "",
  "HNbr2S": "",
  "LocName1": "SYDNEY",
  "LocName2": "",
  "LOTNbr": "",
  "PDNbr": "",
  "PDNbrP": "",
  "PDNbrS": "",
  "PDType": "",
  "PostCode": "2000",
  "State": "NSW",
  "StName": "MACQUARIE",
  "StType": "ST",
  "StTypeS": "",
  "FullStreetNumber": "10",
  "StreetAddress1": "10 MACQUARIE ST",
  "StreetAddress2": "SYDNEY NSW 2000",
  "StreetAddress3": "",
  "StreetAddress4": "",
  "StreetAddress5": "",
  "SuburbStatePostcode": "SYDNEY NSW 2000",
  "ResultInts": [
        0
  ],
  "GeoCoderErrorsAndWarnings": [
        ""
  ]
}

6.1.6. Example 3 ¶

Example with the coordinates parameter populated, coordinates=true. The response will contain the X and Y coordinates.

<XCoordinate>151.209549</XCoordinate>

<YCoordinate>-33.83984</YCoordinate>

6.1.6.1. Request ¶

https://services.inivio.com.au/autocomplete/address/ValidateAddress?address=l+15+100+arthur+st+north+sydney+2060&as=xml&coordinates=true

6.1.6.2. Response ¶

<?xml version="1.0"?>
<GeoCodedAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<DPID>89319674</DPID>
<XCoordinate>151.209549</XCoordinate>
<YCoordinate>-33.83984</YCoordinate>
<MALID>43835441</MALID>
<PDPID>95960134</PDPID>
<DPIDAppended>YES</DPIDAppended>
<BName/>
<FLNbr>15</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/>
<FullStreetNumber>100</FullStreetNumber>
<StreetAddress1>LEVEL 15</StreetAddress1>
<StreetAddress2>100 ARTHUR ST</StreetAddress2>
<StreetAddress3>NORTH SYDNEY NSW 2060</StreetAddress3>
<StreetAddress4/>
<StreetAddress5/>
<SuburbStatePostcode>NORTH SYDNEY NSW 2060</SuburbStatePostcode>
<ResultInts xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:int>21</a:int>
</ResultInts>
<GeoCoderErrorsAndWarnings xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a:string>State change/correction</a:string>
</GeoCoderErrorsAndWarnings>
</GeoCodedAddress>

6.2. Address Validation Response Details ¶

Response element	Description
DPID	See Glossary
MALID	See Glossary
PDPID	See Glossary
DPIDAppended	Flag YES or NO indicating whether a DPID has been appended.
BName	Building Name
FLNbr	Floor/Level Number
FLType	Floor/Level Type
FUNbr	Flat/Unit Number
FUType	Flat/Unit Type
HNbr1	House Number 1
HNbr1S	House Number 1 Suffix
HNbr2	House Number 2
HNbr2S	House Number 2 Suffix
LocName1	Locality (Suburb) Name 1
LocName2	Locality (Suburb) Name 2 – split names e.g. VIA
LOTNbr	Lot Number
PDNbr	Postal Delivery Number
PDNbrP	Postal Delivery Number Prefix
PDNbrS	Postal Delivery Number Suffix
PDType	Postal Delivery Type
PostCode	Postcode
State	State
StName	Street Name
StType	Street Type
StTypeS	Street Type Suffix
FullStreetNumber	Full Street Number
StreetAddress1 – 5	Concatenation and breakdown of address into varying address line components.
SuburbStatePostcode	Concatenation of Suburb, State and Postcode fields
ResultInts	Result of ValidateAddress call see ErrorCodes
GeoCoderErrorsAndWarnings	Any warnings or error messages relating to the response. See AddressValidationErrorCode
XCoordinate	x coordinates of the location
YCoordinate	y coordinates of the location

6.3. Address Validation Error Codes ¶

6.3.1. Overview ¶

0 (zero) indicates that the Address Validation engine did not return an error/correction/information code. This is the only single digit code. If the return code is > 0 the return code is made up of a 2 digit error/correction/information code. These are outlined below:

Code Range	Description
10 to 69	Non critical errors or correction codes
80-99	Either ‘unable to parse errors’ or a critical error (data files not found etc.)

6.3.2. Address Validation Error Code Description ¶

Code	Description
10	Address Field(s) appear to contain non address data
13	Locality correction
20	Address not in PAF or more than 2 address elements are incorrect
21	State change/correction
22	Postcode change/correction
23	Locality correction
24	Street Name correction
25	Street Type change/correction
26	Postal delivery type number suffix or prefix missing
27	Postal delivery type number suffix or prefix added
28	Postal delivery type does not require a number, number deleted
29	Unable to find Postal delivery type or number in PAF
30	PO Box or GPO Box not found in this locality
31	Ambiguous street name match for this locality
32	Lot number/street number missing
33	Street number range incorrect
34	Ambiguous street number match
35	Unable to resolve street number and/or secondary data (unit/floor)
36	Lot number and street number ambiguity, street number used to match
37	Unable to resolve State/Post Code/Locality combination
38	Too many permissible changes required to match address
45	Matched to a Street Level DPID
46	Matched to a Locality Level DPID
48	DPID data expires in 14 days
49	DPID data has expired
50	Insufficient data to GeoCode and/or GeoURN record
51	State change/correction
52	Post Code change/correction
53	Locality correction
54	Street name correction
55	Street type change/correction
59	Unable to GeoCode and/or GeoURN this address
60	Postal Record, unable to GeoCode and/or GeoURN
80	Field Count variable cannot be 0
81	Address Field(s) do not contain data
82	Locality, Post Code and State missing or not determined
90	Critical Error: Unable to find or open Index/Data file(s)!