Usage Info

This method returns all the Location entities for a SubjectRecord. Sensitive information like bank_account_number in LocationBankAccount are masked by default and revealed only when specifically requested. Use this method when displaying location profiles, populating forms with existing data, or retrieving specific attributes for compliance verification.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The identifier for the SubjectRecord Entity to list locations for.
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 Location is `bank_account_number`in location_bank_accounts field.
verbose	boolean	No	A boolean value that when `true` includes the sub entities of the location in the response. The sub entities for locations are: location bank accounts.

Example

{
  "subject_record_id": "sr_4PYsekjAX8VMuAOfmW81C7",
  "show_sensitive_data": true,
  "verbose": true
}

Response

Data

Parameter	Type	Description
locations	array of objects	The location parameters are defined in the tables below.

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.
location_bank_accounts	array of objects	The location bank account object parameters are defined in the table below. Requires verbose to be `true` to be displayed.
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).

Address Parameters

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

LocationBankAccount Parameters

Parameter	Type	Description
location_bank_account_id	string	The ID of the Location Bank Account
bank_account_id	string	The Bank Account that is part of business.
bank_account_purposes	array	The list of purposes the bank account servers for the location. Must be one or more of the LOCATION_BANK_ACOUNT_PURPOSES.
created_at	string	The date-time when the LocationBankAccount 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 LocationBankAccount 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",
    "trace_id": "trc_4bMcsHNHiFUpZJqgWplmD",
    "version": "2025-03-24"
  },
  "data": {
    "locations": [
      {
        "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"
      }
    ]
  }
}

Example with Verbose

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_CoFlm5EO82uLCce6nkl3p"
  },
  "data": {
    "locations": [
      {
        "location_id": "l_7R8E0nnE6ehxGCrr5sd37d",
        "location_type": "PROPERTY",
        "location_name": "LakeHouse Property",
        "owner_type": "BUSINESS",
        "owner_name": "Arcane Business",
        "address": {
          "line1": "123 MAPLE AVENUE",
          "line2": "APARTMENT 4B",
          "city": "PORTLAND",
          "state": "OR",
          "postal_code": "97204",
          "country": "US"
        },
        "location_bank_accounts": [
          {
            "location_bank_account_id": "lba_31cIZ7tXEm29kMcpbi9Ifn",
            "bank_account_id": "ba_4D7RLVenGMNFhocD4IcUNM",
            "bank_account_purposes": [
              "FEES",
              "SETTLEMENT"
            ],
            "created_at": "2025-11-17T09:13:16.248Z",
            "updated_at": "2025-11-17T09:13:16.248Z"
          }
        ],
        "created_at": "2025-11-13T09:00:02.299Z",
        "updated_at": "2025-11-13T09:00:02.299Z",
      }
    ]
  }
}

Errors

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