Asset Classification Overlay

By default, securities reported over the /v2/data/custodian/securities endpoint will have master_asset_class and security_type defined from the source custodian. These classifications are static and cannot be updated.

If you wish to display a security as a different asset class, BridgeFT provides the ability to overlay custom asset classifications on top of the default security record. This gives API consumers the flexibility to report securities as they see fit.

There are two components to creating a custom asset classficiation. The first is the Classification Tag, the second is the Asset Classification itself.

Details on custom asset classfication API endpoints can be found here:

Creating a Classification Tag

Classfication Tags are the custom asset classes you wish to define. If an API consumer wishes to define stocks that they manage as "Tech Stock" for example, a classification tag should be created with that description.

An example create looks like this:

POST to /v2/reporting/class-tags

{
  "name": "Tech Stock",
  "firm_id": <SPECIFIED_FIRM_ID>
}

Returns the created class tag:

{
  "id": 188,
  "name": "Tech Stock",
  "firm_id": <SPECIFIED_FIRM_ID>,
  "object": "reporting.class_tag",
  "created_at_utc": "2017-12-27T16:47:11.253166Z",
  "updated_at_utc": "2022-02-19T15:09:14.621871Z"
}

Creating an Asset Classification

Once classification tags are created, they can then be assigned to securities to create the custom asset classfication.

This is best illustrated by an example. By default, Apple(AAPL) is defined with a master_asset_class of EQ (Equity).

AAPL's security record from the /v2/data/custodian/securities endpoint looks like this:

{
  "id": 62,
  "symbol": "AAPL",
  "description": "Apple Inc",
  "master_asset_class": "EQ",
  "security_type": "Stock",
  "broad_code": 2,
  "identifier": "AAPL",
  "issue_type": "COMMON STOCKS",
  "issue_type_code": 28,
  "prefixed_identifier": "S:AAPL",
  "sic_code": 800,
  "object": "data.custodian.security",
  "created_at_utc": "2018-01-27T12:56:28.742126Z",
  "updated_at_utc": "2021-03-17T08:54:57.433127Z"
}

If the API consumer's application wishes to report AAPL with a description other than what is provided by default like Tech Stock, an asset classfication can be created using the classification tag defined in the previous section.

Creating an Asset Classification looks like this:

POST to /v2/reporting/asset-classfications

{
  "security_id": 62,
  "class_tag_id": 188,
  "firm_id": <SPECIFIED_FIRM_ID>,
}

Returns the asset classfication:

{
  "id": 42784,
  "class_tag_id": 188,
  "firm_id": <SPECIFIED_FIRM_ID>,
  "security_id": 62,
  "object": "reporting.asset_classification",
  "created_at_utc": "2022-02-19T15:09:14.621871Z",
  "updated_at_utc": "2022-02-19T15:09:14.621871Z"
}

The asset classification maps the classification tag created to the specified security. Classfication tags can be mapped to multiple securities, but a security can only have a single asset classfication at a time.

Custom asset classifcations are not automatically displayed on a security record found on /v2/data/custodian/securities endpoint. It is up to the API application to manage and display the asset classfications they have specified.