person.list

Retrieve a comprehensive list of all Person entities within a Subject Record.

POST http://api.kompliant.com/person.list (OpenAPI specification)

Usage Info

This method returns all Person entities associated with a specific Subject Record, providing a complete view of individuals linked to the record. Each person's details are included, with sensitive information masked by default unless specifically requested. Use this method when selecting individuals for association with other entities, or performing comprehensive reviews.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The identifier for the Subject Record from which to list all the Person 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 Person is the tax_id field.

Example

{
  "subject_record_id": "sr_57WfSCnafMnxDiWMKcy3EW",
  "show_sensitive_data": false
}

Response

Data

Parameter	Type	Description
persons	array	An array of person objects that contain information about Persons within the Subject Record. If the Subject Record has no Person objects, the array will be empty.

Person Parameters

Parameter	Type	Description
email	string	The personal email address of the person. The email must be a validly formatted email address.
first_name	string	The legal first given name for the person.
middle_name	string	The legal middle name for the person.
last_name	string	The legal last name for the person.
date_of_birth	string	The legal date of birth for the person. This must be in the YYYY-MM-DD format and contain only digits [0-9] and dashes.
tax_id	string	The tax ID for the person. In the US this is typically the SSN or ITIN. This field must be 9 characters long and only contain digits [0-9]. Dashes are not accepted.
citizenship	string	Two character code for the country of citizenship for the person. Must be one of the COUNTRIES .
phone_number	string	The primary personal phone number of the person. This field must be 10 characters long and must be in the pattern of NXXNXXXXXX, where N represents any digit from 2-9 and X represents any digit from 0-9. It must follow all other requirements of the North American Number Plan.
addresses	array	The list of addresses for the person. Only one address of each type can be added to the list. This parameter is not required. However, if an address parameter is provided, then type is required. At this time, only one a single entry of Person Address Type of `PERSONAL_RESIDENCE` is allowed. No other entries are supported.
created_at	string	The date-time when the Person 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 Person 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).

Addresses Parameters

Parameter	Type	Description
type	string	The type of address. Must be one of the PERSON_ADDRESS_TYPES.
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 where the address is located. Must be one of the COUNTRIES.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_4bMcsHNHiFUpZJqgWplmD",
    "version": "2025-03-24"
  },
  "data": {
    "persons": [
      {
        "person_id": "p_4PYsekjAX8VMuAOfmW81C7",
        "email": "[email protected]",
        "first_name": "Sarah",
        "middle_name": "Elizabeth",
        "last_name": "Johnson",
        "date_of_birth": "1985-07-15",
        "tax_id": "XXXXXX789",
        "citizenship": "US",
        "phone_number": "5551234567",
        "addresses": [
          {
            "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"
      },
      {
        "person_id": "p_3wmeA2fMPq8L8jbPMDvWrl",
        "email": "[email protected]",
        "first_name": "Michael",
        "middle_name": "Wei",
        "last_name": "Chen",
        "date_of_birth": "1979-03-22",
        "tax_id": "XXXXXX321",
        "citizenship": "US",
        "phone_number": "5559876543",
        "addresses": [
          {
            "type": "PRIMARY_RESIDENCE",
            "line1": "456 Cedar Street",
            "line2": "Unit 7C",
            "city": "Beaverton",
            "state": "OR",
            "postal_code": "97005",
            "country": "US"
          }
        ],
        "created_at": "2025-01-19T10:57:32.895Z",
        "updated_at": "2025-01-19T10:57:32.895Z"
      }
    ]
  }
}

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.

Updated 7 months ago