When you send a request to the API, you need to specify the search key(s) you want to use.
Note that search keys are dataset-specific, and you can only supply one search key per dataset. If you provide a search key that is specific to another dataset, or if you supply multiple search keys for a dataset, your request will be unsuccessful, and the API will return an HTTP status code of "400 – Bad Request".
The table below provides more information about the search keys you can specify for each dataset.
| Dataset | Search key | Description |
|---|---|---|
| Global Geocodes | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| AUS Regional Geocodes | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| ConsumerView Australia - Household data | dpid | Unique 8-digit identifier allocated to each address maintained in Australia Post's Postal Address File which can be used as one of the search key for this dataset. |
| gnaf_pid | Unique 14-character alphanumeric persistent identifier of the address record which can be used as one of the search key for this dataset. | |
| hin | Experian-assigned household identifier which can be used as one of the search key for this dataset. | |
| global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. | |
| ConsumerView Australia - Postcode data | postcode | Postal code of the address which is used as the primary search key for this dataset. |
| NZL Regional Geocodes | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| ConsumerView New Zealand - Household data | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| UK Location Essential | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| UK Location Complete | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| UK Government | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| UK Health | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
| USA Regional Geocodes | global_address_key | A unique Experian identifier which is used as a primary search key for this dataset. |
