10. Customer ID

10.1. Introduction

Customer ID API will return a unique Customer ID from Veda’s database based on the request query parameters. Customer ID is an unique and persistent identifier from Equifax to establish an individual person. Customer ID API will also provide Geocoded address validation information, match confidence and compliance messages.

10.2. Endpoint

https://services.inivio.com.au/validate/customerid?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.

10.3. Authentication

Basic Authentication over HTTPS

See Connecting to APIs for more details.

10.4. Request Parameters

Query Parameters
https://base_url/validate/customerid?fname={fname}&mname={mname}&lastname={lname}&fulladdress={address}&malid={malid}&dob={dob}&driverLicence={driverLicence}&gender={gender}&lphone={lphone}&mphone={mphone}&as={outputmsgformat}
Query String Parameter Description Mandatory/Optional Notes
fname First Name Mandatory First name of the individual for which a match is to be made.
mname Middle Name Optional Middle name (if any) of the individual for which a match is to be made
lastname Last Name Mandatory Last name / surname of the individual for which a match is to be made.
fulladdress Full Address Optional (See Note) Full home address of the individual for which a match is to be made.
malid MALID Optional (See Note) See Note below.
dob Date of Birth Optional Date of birth of the individual for which a match is to be made.
driverLicense Drivers Licence Optional Driver licence number of the individual for which a match is to be made
gender Gender Optional Gender of the individual for which a match is to be made. See Note below for supported values.
lphone Landline Phone Number Optional Home phone number of the individual for which a match is to be made. See Note.
mphone Mobile Phone Number Optional Mobile phone number of the individual for which a match is to be made. See Note.
as Ouput format Optional Data format in the response body. Default is JSON. See Note below

Note

fulladdress and malid:
If the MALID has been provided, Full address is an optional field. If an address validation has been conducted with IMP’s address validation service previously, supply the MALID of the address of the individual for which a match is to be made.One of these two input fields are mandatory per request. If both fields are available in one request, API will use the MALID.
malid:
If the full address has been provided, MALID is an optional field. See MALID in Glossary
dob:
DOB - Date of birth should be in the format of DD/MM/YYYY
gender:
Gender - Supported valued for gender are M, F and U. [M (Male), F (Female), U (Unknown) ]
lphone:
Landline - The number must be between 9 - 12 digits.
mphone
Mobile Phone Number - The number must be between 9 - 12 digits.
as
Data format in the response body. Possible values are xml and json.

Note

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

10.5. Response Parameters

Parameter Description / Notes
IndividualDetails IndividualDetails contains MatchConfidence, CustomerID and Messages. See Examples
MatchConfidence See Notes
CustomerID See Notes
BannedMessage See Notes
ComplainantMessage See Notes
Under18Message See Notes
GeoCodedAddress See GeoCodedAddress Details
Error See Error Codes

Note

Match Confidence:

The level of confidence and effectiveness of the matching that the data supplied corresponds to a record in the database from Equifax. Values returned can be one of either:

  • VH - Very High
  • H - High
  • M - Medium
CustomerID:
A unique and persistent identifier from Equifax for an individual.
BannedMessage:
A message indicating whether the individual has placed a ban period on their data.
ComplainantMessage:
A message indicating whether the individual has made a complaint about their credit information.
Under18Message:
A message indicating whether the customer is under 18 years of age

10.6. Error Codes

Code Type Reason Message
100 Busy We have reached the maximum threshold of concurrent transactions being processed, please re-try later.
110 Timeout Sorry, your request has timed out, please try again later. If the issue persists, please contact support on 02 9278 7787 or email us at marketingservicessupportAU@equifax.com.
200 Validation Error See Notes below for possible messages
300 System Error We are experiencing some unexpected errors, please try again later. If the issue persists, please contact support on 02 9278 7787 or email us at marketingservicessupportAU@equifax.com
400 Unknown Error N/A

Note

Validation Error Messages:
  • First name is a mandatory field.
  • Last name is a mandatory field.
  • Home Address is a mandatory field and either a Full Address or MALID needs to be supplied.
  • MALID can only be supplied in numbers.
  • DOB needs to be supplied in the format of DD/MM/YYYY.
  • Valid values for the Gender field are M, F or U only.
  • Home Phone needs to be a number between 9 - 12 digits only.
  • Mobile needs to be a number between 9 - 12 digits only.

Tip

For Customer ID API, The response times are not the same as the other APIs. The response time may vary between 2 to 4 seconds.

10.7. Examples

10.7.1. Example 1

This example shows a response with a CustomerID returned successfully with high MatchConfidence.

10.7.1.1. Request

https://services.inivio.com.au/validate/customerid?fname=soren&lastname=great&mname=citizen&malid=20000081

10.7.1.2. Response

{
        "IndividualDetails": {
                "BannedMessage": null,
                "ComplainantMessage": null,
                "CustomerID": "12345000",
                "MatchConfidence": "H",
                "Under18Message": null
        },
        "Error": null
}

10.7.2. Example 2

This example is same as example 1 with XML output.

10.7.2.1. Request

https://services.inivio.com.au/validate/customerid?fname=soren&lastname=great&mname=citizen&malid=20000081&as=xml

10.7.2.2. Response

<IndividualSearch
        xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <IndividualDetails>
                <BannedMessage i:nil="true"/>
                <ComplainantMessage i:nil="true"/>
                <CustomerID>12345000</CustomerID>
                <MatchConfidence>H</MatchConfidence>
                <Under18Message i:nil="true"/>
        </IndividualDetails>
        <Error i:nil="true"/>
</IndividualSearch>

10.7.3. Example 3

This example shows a response with CustomerID and GeoCodedAddress.

10.7.3.1. Request

https://services.inivio.com.au/validate/customerid?fname=John&mname=Good&lastname=Citizen&fulladdress=123%20Best%20st%20Sydney%20NSW%202000

10.7.3.2. Response

{
        "IndividualDetails": {
                "BannedMessage": null,
                "ComplainantMessage": null,
                "CustomerID": "123412932",
                "MatchConfidence": "H",
                "Under18Message": null
        },
        "GeoCodedAddress": {
                "DPID": 12348398,
                "MALID": 45877431,
                "PDPID": 12348398,
                "DPIDAppended": "YES",
                "BName": "",
                "FLNbr": "",
                "FLType": "",
                "FUNbr": "",
                "FUType": "",
                "HNbr1": "11",
                "HNbr1S": "",
                "HNbr2": "",
                "HNbr2S": "",
                "LocName1": "SYDNEY",
                "LocName2": "",
                "LOTNbr": "",
                "PDNbr": "",
                "PDNbrP": "",
                "PDNbrS": "",
                "PDType": "",
                "PostCode": "2000",
                "State": "NSW",
                "StName": "BEST",
                "StType": "ST",
                "StTypeS": "",
                "FullStreetNumber": "123",
                "StreetAddress1": "BEST ST",
                "StreetAddress2": "SYDNEY NSW 2000",
                "StreetAddress3": "",
                "StreetAddress4": "",
                "StreetAddress5": "",
                "SuburbStatePostcode": "SYDNEY NSW 2000",
                "ResultInts": [
                        0
                ],
                "GeoCoderErrorsAndWarnings": [
                        ""
                ]
        },
        "Error": null
}

10.7.4. Example 4

This example shows a response with a ComplainantMessage.

10.7.4.1. Request

https://services.inivio.com.au/validate/customerid?fname=Harry&mname=Good&lastname=Porter&fulladdress=123%20Best%20st%20Sydney%20NSW%202000

10.7.4.2. Response

    {
"IndividualDetails": {
    "BannedMessage": null,
    "ComplainantMessage": "Individual lodged a complaint about their credit information.",
    "CustomerID": "123478145",
    "MatchConfidence": "H",
    "Under18Message": null
},
"GeoCodedAddress": {
    "DPID": 12340446,
    "MALID": 12347998,
    "PDPID": 1343533,
    "DPIDAppended": "YES",
    "BName": "",
    "FLNbr": "",
    "FLType": "",
    "FUNbr": "19",
    "FUType": "U",
    "HNbr1": "81",
    "HNbr1S": "",
    "HNbr2": "85",
    "HNbr2S": "",
    "LocName1": "SYDNEY",
    "LocName2": "",
    "LOTNbr": "",
    "PDNbr": "",
    "PDNbrP": "",
    "PDNbrS": "",
    "PDType": "",
    "PostCode": "2000",
    "State": "NSW",
    "StName": "BEST",
    "StType": "ST",
    "StTypeS": "",
    "FullStreetNumber": "81-85",
    "StreetAddress1": "UNIT 11",
    "StreetAddress2": "123 BEST ST",
    "StreetAddress3": "SYDNEY NSW 2000",
    "StreetAddress4": "",
    "StreetAddress5": "",
    "SuburbStatePostcode": "SYDNEY NSW 2000",
    "ResultInts": [
        0
    ],
    "GeoCoderErrorsAndWarnings": [
        ""
    ]
},
"Error": null
    }

10.7.5. Example 5

This example shows a response with error message with no CustomerID returned

10.7.5.1. Request

https://services.inivio.com.au/validate/customerid?fname=noname&lastname=yyy&fulladdress=100+arthur+st+north+sydney+2060+nsw&as=xml

10.7.5.2. Response

<IndividualSearch  xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <IndividualDetails i:nil="true"/>
        <GeoCodedAddress>
                <DPID>0</DPID>
                <MALID>29236621</MALID>
                <PDPID>95960134</PDPID>
                <DPIDAppended>NO</DPIDAppended>
                <BName i:nil="true"/>
                <FLNbr/>
                <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>100 ARTHUR ST</StreetAddress1>
                <StreetAddress2>NORTH SYDNEY NSW 2060</StreetAddress2>
                <StreetAddress3/>
                <StreetAddress4/>
                <StreetAddress5/>
                <SuburbStatePostcode>NORTH SYDNEY NSW 2060</SuburbStatePostcode>
                <ResultInts
                        xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                        <a:int>20</a:int>
                </ResultInts>
                <GeoCoderErrorsAndWarnings
                        xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                        <a:string>
                                Address is not on the PAF OR there are 2 or more incorrect address elements
                        </a:string>
                </GeoCoderErrorsAndWarnings>
        </GeoCodedAddress>
        <Error i:nil="true"/>
</IndividualSearch>