subjectRecord.list

Retrieve a comprehensive list of all Subject Record entities within an account.

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

Usage Info

This method returns the list of Subject Record entities associated with an account.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

ParameterTypeRequiredDescription
account_idstringYesThe identifier for the Account for which all the associated Subject Records is to be listed

Example

{
  "account_id": "sb_j8gh53b"
}

Response

Data

ParameterTypeDescription
subject_recordsarrayAn array of Subject Record objects within an account .

If an account has no Subject Record objects, the array will be empty.

Subject Record Parameters

ParameterTypeDescription
subject_record_idstringThe subject record Id.
subject_record_typestringThe subject record type. Must be one of SUBJECT_RECORD_TYPES .
created_atstringThe date-time when the Subject Record was created.

The value will be in ISO 8601 date and time format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_atstringThe date-time when the Subject Record 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_3P0QaPzjXxFDUqn0F0BH3a"
  },
  "data": {
    "subject_records": [
      {
        "subject_record_id": "sr_5wGyh1yS1MaYUlSWKRA5Uz",
        "type": "BUSINESS",
        "created_at": "2025-08-29T08:23:58.696Z",
        "updated_at": "2025-08-29T08:23:58.696Z"
      }
    ]
  }
}

Errors

Error CodeHTTP CodePossible Cause
BAD_REQUEST400Required parameters not provided.
Invalid values provided.
ENTITY_NOT_FOUND400The account_id provided does not exist.