Usage Info

Use this endpoint when creating an entry for a metadata to capture details of a certain metadata type.

Request

Parameters

Parameter	Type	Required	Description
subject_record_id	string	Yes	The Subject Record to add this Business to.
metadata	object	Yes	The metadata parameter defined in the tables below.

Metadata Parameters

Parameter	Type	Required	Description
metadata_type	string	Yes	The metadata type defined for an account to capture details for entities that belongs to associated SubjectRecord entity.
details	object	Yes	The details parameter consists of additional properties of key-value pair defined as per metadata type fields schema.

Example

{
  "subject_record_id": "{{subject_record_id}}",
  "metadata": {
    "metadata_type": "ip_address",
    "details": {
      "ipv4": "192.168.1.1",
      "allocation_method": "DHCP"
    }
  }
}

Response

Data

Parameter	Type	Description
metadata	object	The metadata parameter defined in the tables below.

Person Parameters

Parameter	Type	Description
metadata_id	string	The identifier for the Metadata just created.

Example

{
  "meta": {
    "status": "SUCCESS",
    "version": "2025-03-24",
    "trace_id": "trc_3OwNmn7AgCvLGqeCIjKjSD"
  },
  "data": {
    "metadata": {
      "metadata_id": "md_62B8bzHqB59D8bxPBZkjF0"
    }
  }
}

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.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below.

System Rule Violations

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	MAX_METADATA_TYPE_LIMIT	The maximum number of metadata entries for a certain metadata type has been reached for a Subject Record entity.