Skip to main content

The Location object

Location refers to the geographic location of the recipients of the document.

Attributes​

city
nullable string
The location city.
country_code
nullable string
Two letter ISO country code.
country_name
nullable string
The location country name.
geolocated_at
nullable string
The time at which the location was geolocated.
id
string
Unique identifier for the location.
ip_address
string
Location IP address.
timezone
nullable string
The timezone of the location.
zip_code
nullable string
The ZIP code of the location.
The User object
{
  "city": "New York",
  "country_code": "US",
  "country_name": "United States",
  "geolocated_at": "2024-05-14T08:36:49+00:00",
  "id": "loc_cbqsa3fean3953ajgk14b3pt",
  "ip_address": "247.225.148.247",
  "timezone": "America/New_York",
  "zip_code": "10001"
}