Retrieve comprehensive list of MetadataDetails entities under a SubjectRecord entity

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

Usage Info

Use this endpoint when retrieving list of a MetadataDetails entity under a SubjectRecord entity.

Request

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The identifier for the SubjectRecord entity to retrieve list of all associated MetadataDetails entities
filters	object	No	The optional filters to apply when listing metadata entries. Each filter params are defined in the table below.

Filters Parameters

Parameter	Type	Required	Description
metadata_type	array	No	Filter metadata entries by their metadata type(s)
linked_entity_id	array	No	Filter metadata entries that are linked to a specific entity ID(s). Must be from `Person`, `Bank Account`, `Business` or `Location` entities

Example

{
  "subject_record_id": "sr_4zamstFMH83R40CQpjaoG9",
	"filters": {
		"metadata_type": ["IP_ADDRESS", "USER_DETAIL"],
		"linked_entity_id": ["p_3Dfcjs7de4BKSV65ambCQT", "b_7KflBrVgWBrBBY5lirMQFr"]
	}
}

Response

Data

Data parameter returns an array of MetadataDetails entities grouped by its metadata_type.

The parameters of each item in data is defined in the tables below.

Item in Data Parameter

Parameter	Type	Description
metadata_type	string	The metadata type defined for an account to capture details for entities that belongs to associated SubjectRecord entity.
entries	array	The array of MetadataDetails entities all belonging to specified `metadata_type`. Each MetadataDetails parameters are defined in the table below.

Metadata Parameters

Parameter	Type	Description
metadata_id	string	The identifier for the Metadata entity for which details are retrieved.
linked_entity_ids	array	The Entity Ids linked to this metadata record. Entities supported are: `Person`, `Bank Account`, `Business` or `Location`.
metadata_type	string	The metadata type defined for an account to capture details for entities that belongs to associated SubjectRecord entity.
metadata_type_owner	string	Represents the owner of metadata type under which Metadata details was created. Possible values are: `ACCOUNT`, `SYSTEM`
details	object	The details parameter consists of additional properties of key-value pair defined as per metadata type fields schema.
created_at	string	The timestamp when the document was created (ISO 8601 format).
updated_at	string	The timestamp when the document was last updated (ISO 8601 format).

Example

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_6Meax0ZLCu3SgZnnjshSyu"
  },
  "data": [
    {
      "metadata_type": "IP_ADDRESS",
      "entries": [
        {
          "metadata_id": "md_2MavBBVxSQektodXVzbESD",
          "linked_entity_ids": [
            "p_3Dfcjs7de4BKSV65ambCQT",
            "b_7KflBrVgWBrBBY5lirMQFr"
          ],
          "metadata_type_owner": "SYSTEM",
          "metadata_type": "IP_ADDRESS",
          "details": {
            "ip_v4": "192.168.1.1",
            "allocation_method": "DHCP"
          },
          "created_at": "2026-01-09T08:37:43.663Z",
          "updated_at": "2026-01-09T08:37:43.663Z"
        }
      ]
    },
    {
      "metadata_type": "USER_DETAIL",
      "entries": [
        {
          "metadata_id": "md_5hGMdwoiCElMRBgkkOHSNj",
          "linked_entity_ids": ["b_7KflBrVgWBrBBY5lirMQFr"],
          "metadata_type_owner": "ACCOUNT",
          "metadata_type": "USER_DETAIL",
          "details": {
            "email": "[email protected]"
          },
          "created_at": "2026-01-14T10:50:06.747Z",
          "updated_at": "2026-01-14T10:50:06.747Z"
        }
      ]
    }
  ]
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Allowed parameters provided not valid.
ENTITY_NOT_FOUND	400	Any of the provided Ids does not exist.