Usage Info

Use this endpoint when retrieving details of a Metadata entity of a certain metadata type.

Request

Parameters

Parameter	Type	Required	Description
metadata_id	string	Yes	The identifier for the Metadata entity to retrieve details for.

Example

{
  "metadata_id": "md_2MavBBVxSQektodXVzbESD"
}

Response

Data

Parameter	Type	Description
metadata	object	The metadata parameter defined in the tables 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_56jU2lt19KuQdQxtevT0ob"
  },
  "data": {
    "metadata": {
      "metadata_id": "md_2MavBBVxSQektodXVzbESD",
      "linked_entity_ids": [
        "p_3Dfcjs7de4BKSV65ambCQT",
        "b_7KflBrVgWBrBBY5lirMQFr",
        "ba_BLB3h9n77hSrRMl4t3Rvy",
        "p_52vaTFB8otmXuhXpy0iR3P",
        "l_6eGsmTH8KOud6VLYWJIDIF"
      ],
      "metadata_type_owner": "ACCOUNT",
      "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"
    }
  }
}

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.