Usage Info

The Location entity stores comprehensive information about location, including location type, name, owner details and address details. This entity can be associated with businesses as BusinessLocation or used independently within a Subject Record. Use this method if you want to change or add more information for an existing location.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
location_id	string	Yes	The identifier of a Location entity to modify.
location	object	No	The location parameter is defined in the table below.

Location Parameters

Parameter	Type	Required	Nullable	Description
location_type	enum	No	Yes	The type of the location. Must be one of LOCATION_TYPES .
location_name	string	No	Yes	The name of a location.
owner_type	enum	No	Yes	The type of location owner. Must be one of LOCATION_OWNER_TYPES .
owner_name	string	No	Yes	The name of an owner of a location.
address	object	No	yes	The address details for a location. The address parameter is defined in the table below.

Address Parameters

Parameter	Type	Required	Description
line1	string	No	Primary street address information (building number, street name).
line2	string	No	Secondary address information (apartment, suite, unit, etc.)
city	string	No	City or municipality name
state	string	No	Two character code for the state. Must be one of the STATES.
postal_code	string	No	ZIP or postal code for mail delivery
country	string	No	Two character code for the country where the address is located. Must be one of the COUNTRIES.

Example

{
  "location_id": "l_57WfSCnafMnxDiWMKcy3EW",
  "location": {
    "location_type": "PROPERTY",
    "location_name": "Lake House",
    "owner_type": "BUSINESS",
    "owner_name": "Mark Johnson",
    "address": {
      "line1": "123 Maple Avenue",
      "line2": "Apartment 4B",
      "city": "Portland",
      "state": "OR",
      "postal_code": "97204",
      "country": "US"
    }
  }
}

Response

Data

An empty data object is returned when the completion is successful.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Enum value provided does not correspond to an available type.
ENTITY_NOT_FOUND	400	The `location_id` provided does not exist.
ACCOUNT_CONFIGURATION_VIOLATION	400	Account configuration rule violations are described below.

ACCOUNT_CONFIGURATION_VIOLATION

When a ACCOUNT_CONFIGURATION_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Location	FEATURE_NOT_ENABLED	Location feature is not enabled for this account.