Cloud Address Verification API

Back Next

Reference Data Specification

When you run an address job, Address Verification uses the country information in the input addresses and the process mode that the job specifies to select the appropriate reference data file for each address. Address Verification selects the file from the files that are loaded into memory for the current job.

Address Verification doesn't have multiple data sets available for a country.

You can additionally use the DataSet array on the DataSetDetermination parameter to specify the reference data files that Address Verification can use for an address job.

Use a DataSet array when more than one reference data file meets the country and process mode requirements that the input address defines. If you configure a DataSet array, Address Verification uses only the files that the array identifies in the current address job.

Configuring the DataSet Array

Use a DataSet array to specify a single reference data file that Address Verification can use for a given country and process mode.

Populate the DataSet array with the following values:

The three-character ISO code for the country to which each address belongs. Enter the ISO code on the Country property.

The three-digit identifier of the reference data file. Enter the identifier on the ID property.

The type of reference data that the file supports, for example BatchInteractive. Enter the type on the SubType property.

You can enter the following SubType values:

AddressCodeLookup

BatchInteractive

Certified

GeocodeToAddress

GeocodingArrivalPoint

GeocodingRooftop

GeocodingStandard

QuickCapture

Supplementary

Rules and Guidelines for Dataset Arrays

Consider the following rules and guidelines when you configure the Dataset array:

The DataSet array values are optional in the following cases:

Address Verification loaded a single data file into memory for the current job.

If you do not populate any DataSet array and a single data file is loaded into memory, Address Verification uses the available file regardless of the file name.

Address Verification loaded multiple data file into memory, and a single file includes the default data set ID in the file name.

If you do not populate any DataSet array, and if the loaded files include a single file with the default ID, Address Verification uses the file with the default ID.

When you use a DataSet array, populate all of the values on the array.

If a DataSet array specifies a reference data file for an address but the file is not loaded into memory, Address Verification does not process the address.

You can add multiple arrays to DatasetDetermination element.

A DataSet array may specify a data set that the address job does not use. In such cases, the job ignores the data set.

Defining an Address Job with a Single Data Set

The following code fragment shows a single data set in the DataSet array:

"DataSetDetermination": {
      "DataSet": [
         {
            "Country": "AUS",
            "ID": "002",
            "SubType": "BatchInteractive"
         }
      ]
   }

In this example, Address Verification will search the files in memory for an Australia reference data file with the sub type BatchInteractive and a data set ID of 002.

Defining an Address Job with Multiple Data Sets

The following code fragment shows a sample of multiple data sets in the DataSet array:

{
   "DataSet": [
      {
         "Country": "IRL",
         "ID": "001",
         "SubType": "BatchInteractive"
      },
      {
         "Country": "AUS",
         "ID": "001",
         "SubType": "BatchInteractive"
      }
   ]
}

In this example, Address Verification can search the files in memory for the following data files:

A batch and interactive data file for Ireland with a data set ID of 001.

A batch and interactive data file for Australia with a data set ID of 001.

Address structure and elements

Download Guide

Watch

Comments

Cloud Data Quality Homepage