business.listLocations

Retrieve a comprehensive list of all Locations associated with a specific Business entity.

POST http://api.kompliant.com/business.listLocations (OpenAPI specification)

Usage Info

This method returns all locations associated with a specific Business, including detailed information about each location such as location name, location type, owner name owner type and location address. Use this method when displaying location profiles associated with business, populating forms with existing data, or retrieving specific attributes for compliance verification.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
business_id	string	Yes	The identifier for the Business from which to list all the Business Locations objects.
show_sensitive_data	boolean	No	A boolean value that if `true`, indicates that sensitive data should shown. If the parameter is not provided, the value defaults to `false` and the sensitive data will be masked. The sensitive data for the `business location` is dependant on the sub entity `location`
verbose	boolean	No	A boolean value that when `true` includes the sub entities of the business location in the response. The sub entity is `location`

Example

{
  "business_id": "b_7eobHllxknr7mfqbjnX2Pp",
  "show_sensitive_data": true, 
  "verbose": true
}

Response

Data

Parameter	Type	Description
business_locations	array of object	An array of business location objects that contain information about Business Locations associated with the Business. If the Business has no Business Locations objects, the array will be empty. The Location object parameter is defined in the tables below.

Business Location Parameters

Parameter	Type	Description
business_location_id	string	The ID of the Business Owner.
location_id	string	The Person that is an owner of business.
created_at	string	The date-time when the Business Location was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the Business Location was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
location	string	The location info parameter is defined in the table below. Requires verbose to be `true` to be displayed.

Location Parameters

Parameter	Type	Description
location_id	string	The identifier of the Location entity.
location_type	string	The type of the location. Must be one of the LOCATION_TYPES .
location_name	string	The name of the location.
owner_type	string	The type of the owner for a location. Must be one of the LOCATION_OWNER_TYPES .
owner_name	string	The name of the owner for a location.
address	object	The address details for a location. The address parameter is defined in the table below.
created_at	string	The date-time when the Location was created. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_at	string	The date-time when the Location was last updated. If there has been no update, the value will be the same as the created_at value. The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).

Example

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_1aslBdgFDzXzxjC1iYz1ep"
  },
  "data": {
    "business_locations": [
      {
        "business_location_id": "bl_5nCWRq51h3ILIJvOOhfF4i",
        "location_id": "l_4PYsekjAX8VMuAOfmW81C7",
        "created_at": "2025-01-17T22:45:38.206Z",
        "updated_at": "2025-01-17T22:45:38.206Z"
      }
    ]
  }
}

Example with verbose

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_1aslBdgFDzXzxjC1iYz1ep"
  },
  "data": {
    "business_locations": [
      {
        "business_location_id": "bl_5nCWRq51h3ILIJvOOhfF4i",
        "location_id": "l_4PYsekjAX8VMuAOfmW81C7",
        "created_at": "2025-01-17T22:45:38.206Z",
        "updated_at": "2025-01-17T22:45:38.206Z",
        "location": {
          "location_id": "l_4PYsekjAX8VMuAOfmW81C7",
          "location_type": "PROPERTY",
          "location_name": "Lake House Property",
          "owner_type": "BUSINESS",
          "owner_name": "Mark Johnson",
          "address": {
            "type": "PRIMARY_RESIDENCE",
            "line1": "123 Maple Avenue",
            "line2": "Apartment 4B",
            "city": "Portland",
            "state": "OR",
            "postal_code": "97204",
            "country": "US"
          },
          "created_at": "2025-01-18T14:22:55.109Z",
          "updated_at": "2025-01-18T14:22:55.109Z"
        }
      }
    ]
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Invalid values provided.
ENTITY_NOT_FOUND	400	The `business_lcoation_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.

Updated 6 months ago