Data Zoo offers users the ability to specify a unique Client Reference for any verification request.


A unique Client Reference helps users to track and identify their own requests, and can be incredibly useful when integrating the Data Zoo services into customised systems. 


This can be done through both the API and the IDU interface.


To see how to specify a unique Client Reference, please refer to the following:


IDU

When making a request through the IDU interface, you will notice a field at the bottom of the form that says "Client Reference" 

Please enter your desired unique Client Reference into this field before submitting and it will be applied.



API

To add a unique Client Reference in an API call, you will need to include the appropriate tags in the search criteria of your API request. NOTE: It does not matter what order the Client Reference tags are included in the Search Criteria (EG, first or last), as long as the tags are contained within the Search Criteria section of the request. This is the section where you will include the personal details of your request, such as first name, address, etc. You can find a complete working example in the below section on Line 5.





{
    "countryCode": "NZ",
    "service": [
        "New Zealand MVR NAD"
    ],
    "clientReference": "Weekly Monitoring",
    "firstName": "Montgomery",
    "middleName": null,
    "lastName": "Mercury",    
    "addressElement1": "1 Mercury street",
    "addressElement2": "Milson",
    "addressElement3": "Manawatu 4414",
    "addressElement4": "",
    "addressElement5": ""
}