Usage Info

Use this endpoint when adding metadata to a Person, Bank Account, Business or Location entities.

Request

Parameter	Type	Required	Description
metadata_id	string	Yes	The Metadata record to link
entity_ids	array	No	The Entity Id we want to link to our metadata record. Must be from `Person`, `Bank Account`, `Business` or `Location` entities

Notes:

{
  "metadata_id": "md_6DXWVhevFPsUpUyCpS30L",
  "entity_ids": ["p_3qn9kVmRIxlRjwR3nmui0b", "b_6AV8JrkmpZMOjQkf9xgxeg"]
}

An empty data object is returned when the completion is successful.

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {}
}

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. Enum value provided does not correspond to an available type.
ENTITY_NOT_FOUND	400	Any of the provided Ids do not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below.

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Subject Record	CROSS_SUBJECT_RECORD_REFERENCE	The referenced entities must belong to the same subject record. Associations cannot be created between entities that exist in different subject records.