Skip to content

Location

Preview

This feature is not subject to our service terms. Pre-GA features are available as is and might have limited support.

List of all current locations discovered for the person in this job. A location typically reveals fewer details than an address.

Schema

The job's payload.locations property is an array of type Location.

A Location object has one property, as described below:

formattedAddress: string read-only
The location does usually show fewer details than an address.

Example

job-response.json
{
  "payload": {
    "locations": [
      {
        "formattedAddress": "Greater Chicago Area, United States"
      }
    ],
    ...
  },
  ...
}

Schema: Location