Key Lookup Request Fields

Parameter Description

country

Code or standardized name for the country.

key

A unique identifier for the address.

type

The type of key for a lookup.

PB_KEY for USA data, GNAF_PID for AUS G-NAF data

To create a key lookup in your application, follow this snippet.

 {
 "keys": [
    {
      "value": "P0000GL638OL",
      "country": "USA"
    }
  ],
  "type": "PB_KEY",
  "preferences": {
    "returnAllCandidateInfo": true
  }
}