layouttitle
readmeHome

logo-fire-red

Financial Regulatory (FIRE) Data Standard


Build Status Project Website Apache 2.0 License Join the chat at https://gitter.im/SuadeLabs/fire Contributor Guidelines

What is the FIRE data standard?

The Financial Regulatory Data Standard (FIRE) defines a common specification for the transmission of granular data between regulatory systems in finance. Regulatory data refers to the data that underlies regulatory submissions, requirements, calculations and is used for policy, monitoring and supervision purposes.

The FIRE data schemas and code samples are licensed under the Apache 2.0 License which has been chosen for being open, permissive and already widely accepted within the financial sector (think Hadoop, Cassandra, ActiveMQ).

The FIRE data standard is supported by the European Commission, the Open Data Institute and the Open Data Incubator for Europe via the Horizon 2020 funding programme.


Please see the contributing guidelines and guiding principles if you would like to contribute to this project.

Random FIRE Data Generator

Included is a random data generator which will generate data in line with the FIRE schema, but not necessarily realistic. (eg. You might get a loan with a balance of 10 but accrued interest of 1 million)

Testing

You can run tests locally via ./run_tests.sh or view the CI test results in the Actions tab


layouttitle
readmeHome

logo-fire-red

Financial Regulatory (FIRE) Data Standard


Build Status Project Website Apache 2.0 License Join the chat at https://gitter.im/SuadeLabs/fire Contributor Guidelines

What is the FIRE data standard?

The Financial Regulatory Data Standard (FIRE) defines a common specification for the transmission of granular data between regulatory systems in finance. Regulatory data refers to the data that underlies regulatory submissions, requirements, calculations and is used for policy, monitoring and supervision purposes.

The FIRE data schemas and code samples are licensed under the Apache 2.0 License which has been chosen for being open, permissive and already widely accepted within the financial sector (think Hadoop, Cassandra, ActiveMQ).

The FIRE data standard is supported by the European Commission, the Open Data Institute and the Open Data Incubator for Europe via the Horizon 2020 funding programme.


Please see the contributing guidelines and guiding principles if you would like to contribute to this project.

Random FIRE Data Generator

Included is a random data generator which will generate data in line with the FIRE schema, but not necessarily realistic. (eg. You might get a loan with a balance of 10 but accrued interest of 1 million)

Testing

You can run tests locally via ./run_tests.sh or view the CI test results in the Actions tab


layouttitle
readmeIntroduction

General Information

This is an introduction for people new to JSON and Markdown, if you are already familiar with JSON schemas already, move along now, nothing to see here.

Headers

Please make sure all property markdown files in documentation/properties/ folder start with the following header:


--- 
layout:			property
title:			"name of the data item as it appears in the schemas (ie. lowercase)"
schemas:		[a list of schemas where this data_item is used]
---

JSON

JSON is short for “Javascript Object Notation” and defines the format for an “object”. An object in programming terms can be a variable, data structure or a function (basically anything). More commonly, in Object-Oriented programming an object typically refers to an Instance of a Class. That is to say, a specific description of something more general. Like a Goat being an instance of the Class “Animal”.

For our purposes, we can just consider JSON to be the data and a JSON-schema to just define the format for that data, ie. what it needs to look like so the computer can understand where things are when it receives it.

Properties, names and values

A property in JSON notation is a name-value pair and list of properties is what makes up the data in our schemas. What you would normally call a “field” (like interest_rate) is the name of the property and what we might call an attribute is the value of the property.

One property

{"name": value}

List of properties

{"name1": "value1", "name3": "value3", "name2": "value2"}

JSON is just text, so the formatting is purely visual, even the order (see above) does not matter. As things get more complicated however, it is considered best practice to format your JSON to look more human-friendly:

{
  "name1": "value1",
  "name3": "value3",
  "name2": "value2"
}

You can visit: http://jsonprettyprint.com/ to help with this formatting.

JSON-Schema

While any data sent/received in JSON format will always look like the above, we need a way to make sure it is what we are expecting. For this we define a JSON-Schema which basically describes what the JSON formatted data should look like.

Description

What if we want to add a little more information to describe our property? This is where the “description” parameter comes in. We add some curly brackets where the “value” is supposed to be and add a description as so:

{"name": {"description": "A little blurb about this property"} }

or

{
  "name": {
   "description": "A little blurb about this property"
  }
}

Types

Now that we have described our property value, let’s go a step further and narrow it down to a specific type. Is it a number, a word, a list? The “type” parameter allows us to specify exactly this. So now our schema would look something like this:

{
  "name": {
   "description": "A little blurb about this property",
   "type": "number"
  }
}

JSON has 7 standard types that we can use:

A null value means the value is unknown. Note that this is different from an empty or zero field. If the field is empty, undefined or does not exist, then it can simply be omitted (unless it is indicated as being “required” in which case you should provide a suitable default value).

An integer is a number without a fraction or exponent part.

ex 1. 4
ex 2. 26908289076124561671021

A number is a number with or without a fraction or exponent part.

ex 1. 26908289076124561671021
ex 2. 269082.89076124561671021

A string is a list of characters (except “ or \ ) inside “quotes”. You can think of a string as a word. Note that the “word” can also contain numbers (like your national insurance number). But also note that numbers represented as strings need to be converted back to numbers if you want to add or multiply them.

ex 1. “sheep”
ex 2. “AS546NB8”

A boolean is simple true or false flag. Note that the true/false flag is lowercase and not inside “quotes”.

ex 1. true
ex 2. false

If you were wondering, the word boolean comes from a founding father of modern logic, the English mathematician George Boole.

An array is a list of the other types, separated by commas and inside square brackets [ ].

ex 1. [2, 235, 34634, 34]
ex 2. [“sheep”, “sheep_dog”, “fox”]

An object is a JSON object, or in other words, the thing we are defining. So this allows for nesting of objects within objects. This is valid JSON, but adds time and complexity in the decoding/parsing process so generally should be avoided.

{
  "farm_id": "E2G2K3LSJENJ4J3K10H",
  "animals": {
    "goat": 2,
    "sheep": 7,
    "sheep_dog": 1
  },
  "farm_owner": "peter"
}

Restrictions

Once we have given a description, a type and maybe a format for our property value we can implement some sanity checks by applying further restrictions.

Restrictions can come in the form of visual presentation like formats or enums, or they can come in the form of simple quantitative sanity-checks. Both are extremely useful to narrow down the possibilities of what might be considered as “valid data” according to the schema. These restrictions not only ensure that bad data is caught at the most granular level, but it also ensures that common semantics are used to define the same thing. It is the first step towards a harmonised standard. In other words, if a loan currency is US Dollar, let’s agree to call it “USD” instead of “US_Dollar”, “dollar-USA”, “011” or “$US.”

Restrictions can be difficult to implement as you need to consider all potential edge cases. Account balances are generally positive but sometimes can be negative, too. Leveraging widely used ISO or IFRS standards are therefore a great way to ensure you have considered the full spectrum of possible values. It also means that, more often than not, firms will already be familiar with and recording data in line with these standards.

Formats

How would you represent a date value like 31 August 2014?

  • We could make use of a string type: “31 August 2014” but then “Aug 31 2014” would also be valid and we would have trouble ordering our data by date.
  • We could accept an integer type: 31082014 but then 1235 would also be a valid integer. And even if we restricted it to 8-digits, we would have to remember to make sure single digit months have a leading zeros and still this doesn’t tell us if it is 31 August 2014 or 14 February 8013.

You get the idea, sometimes we need more information. This is where the format parameter comes in.

The following is the list of the formats specified in the JSON Schema specification:

The one we use most commonly from this is the “date-time” format and it basically means your dates and timestamps need to be a valid string but also look like this: YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.

So for our example, if this is your schema:

{"animal_birthday": {
  "description": "The recorded birthday for the animal.",
  "type": "string",
  "format": "date-time"
  }
}

then this would be a valid input:

{"animal_birthday": "1995-06-07T13:00:00Z"}

and this would be an invalid input:

{"animal_birthday": "1995-6-7T13:00:00Z"}

Enums

enum is short for enumeration which is short for “a complete, ordered listing of all the items in a collection.” All that means is a list (an array) of possible values our value can have. Enums are typically used with string types to limit the range of possible strings that are considered valid for a property value.

Again, it is important to consider edge cases and hence where relevant, it is advisable to leave an “other” or “none” value so that and edge case can be temporarily mapped to a generic parameter. Particularly, in the case of an open source project, you can envisage enum lists getting longer as the schemas evolve through contributions.

So for example, if this is your schema:

{"animal_type": {
  "description": "The type of animal on the farm.",
  "type": "string",
  "enum": ["sheep", "goat", "cow", "other"]
  }
}

then this would be a valid input:

{"animal_type": "goat"}

and this would be an invalid input:

{"animal_type": "horse"}

More information

The JSON spec can be found here and JSON-schema spec cane be found here.


layouttitle
readmeFAQs

FAQs


Is FIRE a data model for my database?

No. The FIRE Data Format is designed to define the format and definition for the transmission of data rather than the storage of that data. Financial data as a whole does lend itself naturally to a relational data model, but depending on the use-case, FIRE data might be better stored in a non-relational, graph or denormalised form.

Given that FIRE is not a data model recipe, why do you have multiple schemas and relational ids that suggests an underlying relational table design?

There are a few reasons for separating data into “normalised” components:

  • To reduce redundant information and the amount of data going down the wire. If you are transmitting information on customers and products, doing so in multiple schemas will be less data than having customer information repeated as additional fields in every product schema.
  • To remove possibility for errors and inconsistencies in data. Again, if we had customer information fields in our loan schema you could get two loans with the same customer_id but different credit_impaired statuses.
  • By segregating schemas, it also allows entities (like customers or collateral) to be added independently (without a loan, for example). It also allows for transmitting of product data without customer data which can be particularly useful where data protection and security concerns might exist for different confidentiality levels of data.
layouttitle
readmeContributing

Contributing


  1. Create a (free) Github account: https://github.com/join
  2. Start a discussion in the Issue Tracker: https://github.com/SuadeLabs/fire/issues
  3. Make a pull request: https://help.github.com/articles/using-pull-requests/

Contribution Requirements

  1. When adding an attribute to a schema the attribute should be well defined in terms of data type (i.e. integer, string, enum etc.) and the attribute should respect the guiding principles.

  2. For every new attribute there should be a corresponding documentation file.

  3. There should always be a justification and description in the pull request. This should indicate why the attribute should be in the project and/or why this contribution is important.

  4. All files must be valid, i.e. schema files are valid JSON and documentation is in Markdown format.

Keep in mind

Ensure you respect the project’s guiding principles Ensure that you follow the community guidelines: https://suade.org/fire/guidelines.html


layouttitle
readmeGuiding Principles

Guiding principles

The guiding principles are composed of:

Project principles

The FIRE project should be:

Easy to understand

FIRE should be easy to read, understand and explain for non-technical users. The reason for this is that (like any data specification for a complex, regulated industry) FIRE contains a great deal of embedded subject matter expertise needs to be evaluated and updated by specialists in finance, regulatory policy, accounting and law. Similarly, as FIRE will be implemented and used by developers, who may not necessarily have the same level of subject matter expertise, it should not require a great deal of financial or regulatory knowledge to understand the general concepts for use.

Easy to use

FIRE should be easy to implement and should require drastic and fundamental changes to how financial institutions identify, conceptualize, create, store and manage their data. This is why the schemas attributes will look familiar to those associated with traditional relational tables and financial data models. Despite a relational look and feel, as JSON objects, FIRE data can be easily used with NoSQL or Graph databases.

Free, open and collaborative

This should be a given but is unfortunately not very common in the financial industry as enterprise software vendors are keen to create lock-in to their systems and platforms with closed and proprietary data models and formats. As such, FIRE carries an open-source Apache 2.0 License and is publicly accessible on Github for easy integration with other IT systems.

Schema design principles

The FIRE Data schema specifications should respect the following 3 schema design principles. Note that the terms data attributes and schema properties are interchangeably used.

1. Data attributes should always be true

Schema properties (data attributes) should be self-evident truths and not depend on the application for which they will be used. In the same way that your date of birth doesn’t change depending on who’s asking, properties should follow the same philosophy. Practically, this means data should not be dependent on the intended computation, visualisation, report or application. Data should simply represent a labelling of a contract or entity based on purely legal definitions. As such, every pull request requires a corresponding, documented, legal reference, preferably to a currently in-force financial regulation.

2. Data attributes should be atomic

Schema properties should uniquely describe the data. Properties should be fundamental, atomic units of measurement. One property should not be derivable from other properties. Similar to the “flags” problem, schema properties should not have embedded logic. This was often done with legacy systems for performance reasons when databases were fast, CPUs slow and memory expensive, but today, most applications are I/O bound. You may still choose to store secondary or derived data, but this is the concern of the application and its specific goals rather than the underlying fundamental data.

eg. It would be unwise to have a loan balance in original currency and USD. This inevitably leads to data of the form:

balanceoriginal ccyin USD
100EUR120
100USD90
100EUR130

Can you spot the problem?

Better is to just have an original currency and an exchange rate.

3. Data attributes should be consistent

Schema properties should try to avoid logical inconsistencies. In other words, one schema property should not contradict another. This is a common occurrence in legacy systems where schemas were updated without a big picture consideration. This typically manifests itself in the form of flags

eg. There should not be a security type titled “government_bond” and a “issuer-type-is-government” flag.

This might seem ok:

security typeissuer-type-is-govt
government_bondY

This has the potential to create contradictory data of the nature:

security typeissuer-type-is-govt
government_bondN

Better would be:

security typeissuer-type-is-govt
bondY

Even better would be:

security typeissuer type
bondgovernment

Why? Because flags are limiting and can still lead to inconsistencies:

security typeissuer-type-is-govtissuer-type-is-retail
bondYY

layouttitle
readmeFIRE data examples

The following are a few examples of common financial trades.

Individual element examples

Account examples

Current account

{
  "title": "current_account",
  "comment": "current_account",
  "data": {
    "account": [
      {
        "id": "current_account",
        "date": "2017-06-30T14:03:12Z",
        "trade_date": "2012-02-06T09:30:00Z",
        "start_date": "2012-02-07T00:00:00Z",
        "currency_code": "GBP",
        "balance": 30000,
        "accrued_interest": 2500,
        "type": "current",
        "status": "active",
        "on_balance_sheet": true,
        "asset_liability": "liability",
        "customer_id": "C123456"
      }
    ]
  }
}

Current account with guarantee

{
  "title": "current_account_with_guarantee",
  "comment": "current_account_with_guarantee",
  "data": {
    "account": [
      {
        "id": "current_account_with_guarantee",
        "date": "2017-06-30T14:03:12Z",
        "trade_date": "2012-02-06T09:30:00Z",
        "start_date": "2012-02-07T00:00:00Z",
        "currency_code": "GBP",
        "balance": 30000,
        "accrued_interest": 2500,
        "guarantee_scheme": "gb_fscs",
        "guarantee_amount": 8500,
        "type": "current",
        "status": "active",
        "on_balance_sheet": true,
        "asset_liability": "liability",
        "customer_id": "C123456"
      }
    ]
  }
}

Savings account

{
    "title": "savings_account",
    "comment": "savings_account",
    "data": {
        "account": [
            {
                "id": "savings_account",
                "date": "2017-06-30T14:03:12Z",
                "trade_date": "2012-02-06T09:30:00Z",
                "start_date": "2012-02-07T00:00:00Z",
                "currency_code": "GBP",
                "balance": 30000,
                "accrued_interest": 2500,
                "type": "savings",
                "status": "active",
                "on_balance_sheet": true,
                "asset_liability": "liability",
                "customer_id": "C123456"
            }
        ]
    }
}

Savings account with notice

{{#include savings_account_with_notice.json:5:}}

1-year time deposit

{
  "title": "time_deposit_1year",
  "comment": "time_deposit_1year",
  "data": {
    "account": [
      {
        "id": "time_deposit_1year",
        "date": "2017-06-30T14:03:12Z",
        "trade_date": "2012-02-06T09:30:00Z",
        "start_date": "2012-02-07T00:00:00Z",
        "end_date": "2018-06-30T00:00:00Z",
        "currency_code": "GBP",
        "balance": 30000,
        "accrued_interest": 2500,
        "type": "time_deposit",
        "status": "active",
        "on_balance_sheet": true,
        "asset_liability": "liability",
        "customer_id": "C123456"
      }
    ]
  }
}

1-year time deposit with 6-month withdrawal option

{
  "title": "time_deposit_1year_with_6_month_withdrawal_option",
  "comment": "time_deposit_1year_with_6_month_withdrawal_option",
  "data": {
    "account": [
      {
        "id": "time_deposit_1year_with_6_month_withdrawal_option",
        "date": "2017-06-30T14:03:12Z",
        "trade_date": "2012-02-06T09:30:00Z",
        "start_date": "2012-02-07T00:00:00Z",
        "next_withdrawal_date": "2017-12-31T00:00:00Z",
        "end_date": "2018-06-30T00:00:00Z",
        "currency_code": "GBP",
        "balance": 30000,
        "accrued_interest": 2500,
        "type": "time_deposit",
        "status": "active",
        "on_balance_sheet": true,
        "asset_liability": "liability",
        "customer_id": "C123456"
      }
    ]
  }
}

PNL interest income

{
  "title": "pnl_interest_income",
  "comment": "interest_income",
  "data": {
    "account": [
      {
        "id": "interest_income",
        "date": "2017-06-30T14:03:12Z",
        "currency_code": "GBP",
        "balance": 30000,
        "type": "income",
        "asset_liability": "pnl",
        "purpose": "interest",
        "customer_id": "C123456"
      }
    ]
  }
}

PNL salary expenses

{
  "title": "pnl_salary_expenses",
  "comment": "salary_expenses",
  "data": {
    "account": [
      {
        "id": "salary_expenses",
        "date": "2017-06-30T14:03:12Z",
        "currency_code": "GBP",
        "balance": 30000,
        "type": "expense",
        "asset_liability": "pnl",
        "purpose": "regular_wages"
      }
    ]
  }
}

Loan examples

BBL/CBIL

These loans can be represented as a combination of two independent loans.

The first loan is a 25K GBP payable quarterly during 1 year (From Aug 1st, 2020 to Aug 1st, 2021).

{
    "id": "BBL1",
    "date": "2020-08-08T00:00:00+00:00",
    "balance": 2500000,
    "currency_code": "GBP",
    "end_date": "2021-08-01T00:00:00+00:00",
    "interest_repayment_frequency": "quarterly",
    "repayment_frequency": "at_maturity",
    "repayment_type": "interest_only",
    "start_date": "2020-08-01T00:00:00+00:00",
    "trade_date": "2020-05-11T00:00:00+00:00"
}

The second loan is a 25K GBP payable monthly during 5 years (From Aug 1st, 2021 to Aug 1st, 2026).

{
    "id": "BBL2",
    "date": "2020-08-08T00:00:00+00:00",
    "balance": 2500000,
    "currency_code": "GBP",
    "end_date": "2026-08-01T00:00:00+00:00",
    "repayment_frequency": "monthly",
    "repayment_type": "repayment",
    "start_date": "2021-08-01T00:00:00+00:00",
    "trade_date": "2020-05-11T00:00:00+00:00"
}

BBL_1 will create an inflow of 25K GBP, and BBL_2 will create an outflow of 25K GBP on Aug 1st, 2021.

If you are working with reports that separates inflows from outflows, you will get an excess on the inflow and an excess of the outflow.

To eliminate this excess, we can introduce a third loan.

{
    "id": "BBL_netting",
    "date": "2020-08-08T00:00:00+00:00",
    "balance": -2500000,
    "currency_code": "GBP",
    "end_date": "2021-08-01T00:00:00+00:00",
    "repayment_frequency": "at_maturity",
    "repayment_type": "repayment",
    "start_date": "2021-08-01T00:00:00+00:00"
}

Please download the complete examples

Nostro account

Nostro account, of 1000 GBP, held at another credit institution

{{#include nostro_account.json:5:}}

Loan with two customers

A loan example showing what the json looks like for loans with two customers

{{#include_loan_with_2_customers.json:5:}}

Derivative examples

Bermudan swaption

Short USD 1y into 10y receiver swaption exercisable annually with physical settlement

{
  "title": "bermudan_swaption",
  "comment": "usd_bermudan_swaption",
  "data": {
    "derivative": [
      {
        "date": "2019-01-01T00:00:00",
        "id": "usd_bermudan_swaption",
        "asset_class": "ir",
        "type": "swaption",
        "leg_type": "put",
        "position": "short",
        "currency_code": "USD",
        "notional_amount": 10000,
        "strike": 0.02,
        "underlying_index": "USD_LIBOR",
        "underlying_index_tenor": "6m",
        "start_date": "2019-01-01T00:00:00",
        "end_date": "2020-01-01T00:00:00",
        "last_payment_date": "2030-01-01T00:00:00",
        "next_exercise_date": "2020-01-01T00:00:00",
        "underlying_price": 0.02,
        "settlement_type": "physical",
        "mtm_dirty": -5
      }
    ]
  }
}

Bond future

June IMM Bund future (underlying index is the expected CTD on the reporting date)

{
  "title": "bond_future",
  "comment": "Bund June IMM future",
  "data": {
    "derivative": [
      {
        "id": "Bund June IMM future",
        "date": "2019-04-30T00:00:00",
        "asset_class": "ir",
        "type": "future",
        "leg_type": "indexed",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "rate": 125.5,
        "underlying_index": "BUND0829",
        "trade_date": "2019-04-01T00:00:00",
        "start_date": "2019-05-02T00:00:00",
        "end_date": "2019-05-04T00:00:00",
        "last_payment_date": "2029-08-15T00:00:00",
        "settlement_type": "physical",
        "mtm_dirty": -25
      }
    ]
  }
}

Futures on 20-year treasury bond that matures in 2 years

{
  "title": "bond_future2",
  "comment": "T-Bond Mar21 future",
  "data": {
    "derivative": [
      {
        "id": "T-Bond Mar21 future",
        "date": "2019-04-30T00:00:00",
        "asset_class": "ir",
        "type": "future",
        "leg_type": "indexed",
        "currency_code": "USD",
        "notional_amount": 100,
        "trade_date": "2019-04-01T00:00:00",
        "start_date": "2019-05-02T00:00:00",
        "end_date": "2021-03-15T00:00:00",
        "last_payment_date": "2041-03-15T00:00:00",
        "underlying_index": "T-bondMar41",
        "settlement_type": "physical"
      }
    ]
  }
}

Cross-currency swap

Long 10-year forward_starting AUD/EUR cross-currency swap

{
  "title": "xccy_swap",
  "comment": "USD-AUD xccy",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "AUDUSD_xccy:AUD",
        "deal_id": "AUDUSD_xccy",
        "asset_class": "fx",
        "type": "xccy",
        "leg_type": "fixed",
        "position": "long",
        "currency_code": "AUD",
        "notional_amount": 14000,
        "rate": 0.01,
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2020-02-27T00:00:00",
        "end_date": "2030-02-27T00:00:00",
        "mtm_dirty": 1140
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "AUDUSD_xccy:USD",
        "deal_id": "AUDUSD_xccy",
        "asset_class": "fx",
        "type": "xccy",
        "position": "short",
        "leg_type": "floating",
        "currency_code": "USD",
        "notional_amount": 10000,
        "underlying_index": "USD_LIBOR_BBA",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2020-02-27T00:00:00",
        "end_date": "2030-02-27T00:00:00"
      }
    ],
    "derivative_cash_flow": [
      {
        "id": "1",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:AUD",
        "currency_code": "AUD",
        "notional_amount": 14000,
        "reset_date": "2019-02-27T00:00:00",
        "payment_date": "2019-02-27T00:00:00",
        "balance": -14000,
        "purpose": "principal"
      },
      {
        "id": "2",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:AUD",
        "currency_code": "AUD",
        "notional_amount": 14000,
        "reset_date": "2029-02-27T00:00:00",
        "payment_date": "2029-02-27T00:00:00",
        "balance": 14000,
        "purpose": "principal"
      },
      {
        "id": "3",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:USD",
        "currency_code": "USD",
        "notional_amount": 10000,
        "reset_date": "2019-02-27T00:00:00",
        "payment_date": "2019-02-27T00:00:00",
        "balance": 10000,
        "purpose": "principal"
      },
      {
        "id": "4",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:USD",
        "currency_code": "USD",
        "notional_amount": 10000,
        "reset_date": "2029-02-27T00:00:00",
        "payment_date": "2029-02-27T00:00:00",
        "balance": -10000,
        "purpose": "principal"
      },
      {
        "id": "5",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:AUD",
        "currency_code": "USD",
        "reset_date": "2020-02-27T00:00:00",
        "payment_date": "2021-02-27T00:00:00",
        "notional_amount": 14000,
        "balance": 140,
        "purpose": "interest"
      },
      {
        "id": "6",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:AUD",
        "currency_code": "USD",
        "reset_date": "2028-02-27T00:00:00",
        "payment_date": "2029-02-27T00:00:00",
        "notional_amount": 14000,
        "balance": 140,
        "purpose": "interest"
      },
      {
        "id": "7",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:USD",
        "currency_code": "USD",
        "reset_date": "2020-02-27T00:00:00",
        "payment_date": "2020-05-27T00:00:00",
        "notional_amount": 10000,
        "forward_rate": 0.01,
        "balance": -2466,
        "purpose": "interest"
      },
      {
        "id": "8",
        "date": "2020-03-31T00:00:00",
        "derivative_id": "AUDUSD_xccy:USD",
        "currency_code": "USD",
        "reset_date": "2028-11-27T00:00:00",
        "payment_date": "2029-02-27T00:00:00",
        "notional_amount": 10000,
        "forward_rate": 0.02,
        "balance": -5042,
        "purpose": "interest"
      }
    ]
  }
}

Commodity option

Long 100 June21 at-the-money copper put

{
  "title": "commodity_option",
  "comment": "Commodity Option",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "1",
        "asset_class": "metals",
        "type": "option",
        "leg_type": "put",
        "position": "long",
        "currency_code": "USD",
        "underlying_quantity": 100,
        "strike": 9829,
        "underlying_index": "copper",
        "underlying_price": 9829,
        "trade_date": "2020-02-25T00:00:00",
        "start_date": "2020-02-27T00:00:00",
        "end_date": "2021-06-02T00:00:00",
        "last_exercise_date": "2020-12-05T00:00:00",
        "settlement_type": "physical",
        "mtm_dirty": 193
      }
    ]
  }
}

Credit default swap - Index

Index CDS; CDS on the cdx_na_ig index

{
  "title": "cds_index",
  "comment": "cds_index",
  "data": {
    "derivative": [
      {
        "id": "corp_cds_5y",
        "date": "2019-01-01T00:00:00",
        "asset_class": "cr_index",
        "type": "cds",
        "underlying_security_id": "cdx_na_ig",
        "leg_type": "indexed",
        "position": "short",
        "delta":-1,
        "currency_code": "USD",
        "notional_amount": 100,
        "trade_date": "2018-07-01T00:00:00",
        "start_date": "2018-07-03T00:00:00",
        "end_date": "2023-07-03T00:00:00",
        "rate": 0.005,
        "settlement_type": "cash"
      }
    ],
    "security": [
      {
        "id": "cdx_na_ig",
        "date": "2019-01-01T00:00:00",
        "type": "index",
        "currency_code": "USD",
        "cqs_standardised": 3
      }
    ]
  }
}

Credit default swap - Single name

Single name CDS; reference obligation US corporate bond with July 2028 maturity

{
  "title": "cds_single_name",
  "comment": "cds_single_name",
  "data": {
    "derivative": [
      {
        "id": "corp_cds_5y",
        "date": "2019-01-01T00:00:00",
        "asset_class": "cr_single",
        "type": "cds",
        "underlying_security_id": "Corp_Jul28",
        "leg_type": "indexed",
        "position": "short",
        "delta":-1,
        "currency_code": "USD",
        "notional_amount": 100,
        "trade_date": "2018-07-01T00:00:00",
        "start_date": "2018-07-03T00:00:00",
        "end_date": "2023-07-03T00:00:00",
        "rate": 0.005,
        "settlement_type": "cash"
      }
    ],
    "security": [
      {
        "id": "Corp_Jul28",
        "date": "2019-01-01T00:00:00",
        "type": "bond",
        "underlying_issuer_id": "us_corp",
        "isin_code": "XS1234567890",
        "currency_code": "USD",
        "issue_date": "2018-07-01 00:00:00",
        "maturity_date": "2028-07-01 00:00:00",
        "cqs_standardised": 3
      }
    ],
    "issuer": [
      {
        "id": "us_corp",
        "date": "2019-01-01T00:00:00",
        "type": "corporate",
        "country_code": "US",
        "snp_lt": "a_plus",
        "moodys_lt": "a1"
      }
    ]
  }
}

Equity option

Long 100 1-year 40 call on EquityABC.

{
  "title": "equity_option",
  "comment": "equity_option",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "1",
        "deal_id": "2",
        "asset_class": "eq_single",
        "type": "option",
        "leg_type": "call",
        "position": "long",
        "currency_code": "USD",
        "underlying_quantity": 100.00,
        "strike": 40.00,
        "underlying_security_id": "EquityABC",
        "underlying_price": 25.00,
        "trade_date": "2020-02-25T00:00:00",
        "start_date": "2020-02-27T00:00:00",
        "end_date": "2021-02-27T00:00:00",
        "last_exercise_date": "2020-12-05T00:00:00",
        "settlement_type": "cash",
        "mtm_dirty": 10
      }
    ],
    "security": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "EquityABC",
        "type": "equity",
        "currency_code": "USD",
        "start_date": "2017-01-01T00:00:00",
        "purpose": "reference"
      }
    ]
  }
}

Equity total return swap

Short 5y EUR total return swap on EquityABC

{
  "title": "equity_total_return_swap",
  "comment": "equity_total_return_swap",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "eur_equity_trs:equity_leg",
        "deal_id": "eur_equity_trs",
        "asset_class": "eq",
        "type": "vanilla_swap",
        "leg_type": "indexed",
        "position": "short",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "underlying_security_id": "EquityABC",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2024-02-27T00:00:00",
        "mtm_dirty": 140
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "eur_equity_trs:floating_leg",
        "deal_id": "long_eur_equity_trs",
        "asset_class": "eq",
        "type": "vanilla_swap",
        "leg_type": "floating",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "rate": 0.0225,
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2024-02-27T00:00:00"
      }
    ],
    "security": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "EquityABC",
        "type": "equity",
        "currency_code": "USD",
        "start_date": "2020-03-31T00:00:00",
        "issue_date": "2017-03-01T00:00:00",
        "purpose": "reference"
      }
    ]
  }
}

Forward rate agreement

Short 6x12 USD FRA

{
  "title": "fra_6x12",
  "comment": "6x12-fra",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "6x12-fra",
        "asset_class": "ir",
        "type": "fra",
        "leg_type": "indexed",
        "position": "short",
        "currency_code": "USD",
        "notional_amount": 10000,
        "underlying_index": "USD_LIBOR",
        "underlying_index_tenor": "6m",
        "trade_date": "2019-11-25T00:00:00",
        "start_date": "2020-05-27T00:00:00",
        "end_date": "2020-11-27T00:00:00",
        "settlement_type": "cash",
        "rate": 0.005,
        "mtm_dirty": -25
      }
    ]
  }
}

FX forward

Short AUDUSD forward

{
    "title": "fx_forward",
    "comment": "fx_forward",
    "data": {
      "derivative": [
        {
          "date": "2019-04-30T00:00:00",
          "id": "audusd_swap:aud",
          "deal_id": "audusd_fx_fwd",
          "asset_class": "fx",
          "type": "forward",
          "leg_type": "fixed",
          "position": "short",
          "currency_code": "AUD",
          "notional_amount": 10000,
          "trade_date": "2019-02-25T00:00:00",
          "start_date": "2019-02-27T00:00:00",
          "end_date": "2020-02-27T00:00:00",
          "mtm_dirty": -2
        },
        {
          "date": "2019-04-30T00:00:00",
          "id": "audusd_swap:usd",
          "deal_id": "audusd_fx_fwd",
          "asset_class": "fx",
          "type": "forward",
          "leg_type": "fixed",
          "position": "long",
          "currency_code": "USD",
          "notional_amount": 10275,
          "trade_date": "2019-02-25T00:00:00",
          "start_date": "2019-02-27T00:00:00",
          "end_date": "2020-02-27T00:00:00"
        }
      ]
    }
  }

FX future

Long June EURCAD future

{
  "title": "fx_future",
  "comment": "EUR CAD Future",
  "data": {
    "derivative": [
      {
        "date": "2019-04-01T00:00:00",
        "id": "eur_cad_future",
        "asset_class": "fx",
        "type": "future",
        "leg_type": "indexed",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 100,
        "underlying_currency_code": "CAD",
        "trade_date": "2019-04-01T00:00:00",
        "start_date": "2019-06-15T00:00:00",
        "end_date": "2019-09-15T00:00:00",
        "rate": 1.4,
        "underlying_price": 1.38,
        "settlement_type": "physical",
        "mtm_dirty": -2
      }
    ]
  }
}

FX option

Short USD call YEN put FX option, exercise on Match 2020

{
  "title": "fx_option",
  "comment": "USD-JPY call 130",
  "data": {
    "derivative": [
      {
        "date": "2019-12-31T00:00:00",
        "id": "USDJPY call 130",
        "asset_class": "fx",
        "type": "option",
        "leg_type": "call",
        "position": "short",
        "currency_code": "USD",
        "notional_amount": 100,
        "underlying_currency_code": "JPY",
        "strike": 130,
        "trade_date": "2019-12-01T00:00:00",
        "start_date": "2019-12-05T00:00:00",
        "end_date": "2020-03-05T00:00:00",
        "last_exercise_date": "2020-03-03T00:00:00",
        "underlying_price": 130,
        "mtm_dirty": -2
      }
    ]
  }
}

FX spot

Long EURCAD spot (100 EUR for 140 CAD spot trade)

{
  "title": "fx_spot",
  "comment": "fx_spot",
  "data": {
    "derivative": [
      {
        "date": "2019-04-30T00:00:00",
        "id": "eurcad_spot:eur",
        "deal_id": "eurcad_spot",
        "asset_class": "fx",
        "type": "spot",
        "leg_type": "fixed",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "trade_date": "2019-04-30T00:00:00",
        "start_date": "2019-05-02T00:00:00",
        "end_date": "2019-05-02T00:00:00",
        "mtm_dirty": -2
      },
      {
        "date": "2019-04-30T00:00:00",
        "id": "eurcad_spot:cad",
        "deal_id": "eurcad_spot",
        "asset_class": "fx",
        "type": "spot",
        "leg_type": "fixed",
        "position": "short",
        "currency_code": "CAD",
        "notional_amount": 14000,
        "trade_date": "2019-04-30T00:00:00",
        "start_date": "2019-05-02T00:00:00",
        "end_date": "2019-05-02T00:00:00"
      }
    ]
  }
}

FX swap

Short 1-year AUDUSD fx swap. The notional amounts are used to calculate the spot rate (occuring on the start date).

{
  "title": "fx_swap",
  "comment": "fx_swap: this is a legacy mapping. Please refer to fx_foward.",
  "data": {
    "derivative": [
      {
        "date": "2019-04-30T00:00:00",
        "id": "audusd_swap:aud",
        "deal_id": "audusd_swap",
        "asset_class": "fx",
        "type": "vanilla_swap",
        "leg_type": "fixed",
        "position": "short",
        "currency_code": "AUD",
        "notional_amount": 10000,
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2020-02-27T00:00:00",
        "mtm_dirty": -2
      },
      {
        "date": "2019-04-30T00:00:00",
        "id": "audusd_swap:aud",
        "deal_id": "audusd_swap",
        "asset_class": "fx",
        "type": "vanilla_swap",
        "leg_type": "fixed",
        "position": "long",
        "currency_code": "USD",
        "notional_amount": 10275,
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2020-02-27T00:00:00"
      }
    ]
  }
}

Interest rate cap floor

Short 1y collar vs Euribor 3M

{
  "title": "ir_cap_floor",
  "comment": "IR Cap Floor",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:short_cap",
        "deal_id": "short_eur_1y_collar",
        "asset_class": "ir",
        "type": "cap_floor",
        "leg_type": "call",
        "position": "short",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2020-02-27T00:00:00",
        "next_exercise_date": "2019-05-25T00:00:00",
        "strike": 0.015,
        "underlying_price": 0.01,
        "mtm_dirty": -40
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:long_floor",
        "deal_id": "short_eur_1y_collar",
        "asset_class": "ir",
        "type": "cap_floor",
        "leg_type": "put",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2020-02-27T00:00:00",
        "next_exercise_date": "2019-05-25T00:00:00",
        "strike": 0.005,
        "underlying_price": 0.01,
        "mtm_dirty": 110
      }
    ],
    "derivative_cash_flow": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:short_cap 2",
        "derivative_id": "short_eur_1y_collar:short_cap",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "leg": "pay",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "balance": 0,
        "reset_date": "2019-05-27T00:00:00",
        "payment_date": "2019-08-27T00:00:00",
        "forward_rate": 0.005
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:short_cap 3",
        "derivative_id": "short_eur_1y_collar:short_cap",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "leg": "pay",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "balance": 0,
        "reset_date": "2019-08-27T00:00:00",
        "payment_date": "2019-11-27T00:00:00",
        "forward_rate": 0.01
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:short_cap 4",
        "derivative_id": "short_eur_1y_collar:short_cap",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "leg": "pay",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "balance": 0,
        "reset_date": "2019-11-27T00:00:00",
        "payment_date": "2020-02-27T00:00:00",
        "forward_rate": 0.015
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:long_floor 2",
        "derivative_id": "short_eur_1y_collar:long_floor",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "leg": "receive",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "balance": 0,
        "reset_date": "2019-05-27T00:00:00",
        "payment_date": "2019-08-27T00:00:00",
        "forward_rate": 0.005
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:long_floor 3",
        "derivative_id": "short_eur_1y_collar:long_floor",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "leg": "receive",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "balance": 0,
        "reset_date": "2019-08-27T00:00:00",
        "payment_date": "2019-11-27T00:00:00",
        "forward_rate": 0.01
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "short_eur_1y_collar:long_floor 4",
        "derivative_id": "short_eur_1y_collar:long_floor",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "leg": "receive",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "balance": 0,
        "reset_date": "2019-11-27T00:00:00",
        "payment_date": "2020-02-27T00:00:00",
        "forward_rate": 0.015
      }
    ]
  }
}

Interest rate digital floor

Long EUR 1y 0% digital floor vs Euribor 3M

{
  "title": "ir_digital_floor",
  "comment": "IR Digital Floor",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "1y digital floor:long floor",
        "deal_id": "1y digital floor",
        "asset_class": "ir",
        "type": "cap_floor",
        "leg_type": "put",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2020-02-27T00:00:00",
        "last_exercise_date": "2019-05-25T00:00:00",
        "strike": 0.0005,
        "mtm_dirty": -40
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "1y digital floor:short floor",
        "deal_id": "1y digital floor",
        "asset_class": "ir",
        "type": "cap_floor",
        "leg_type": "put",
        "position": "short",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2020-02-27T00:00:00",
        "last_exercise_date": "2019-05-25T00:00:00",
        "strike": -0.0005
      }
    ],
    "derivative_cash_flow": [
      {
        "id": "1y digital floor:long floor_1",
        "derivative_id": "1y digital floor:long floor",
        "date": "2020-03-31T00:00:00",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "reset_date": "2019-05-27T00:00:00",
        "payment_date": "2019-08-27T00:00:00",
        "forward_rate": 0.0025
      },
      {
        "id": "1y digital floor:long floor_2",
        "derivative_id": "1y digital floor:long floor",
        "date": "2020-03-31T00:00:00",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "reset_date": "2019-08-27T00:00:00",
        "payment_date": "2019-11-27T00:00:00",
        "forward_rate": 0.005
      },
      {
        "id": "1y digital floor:long floor_3",
        "derivative_id": "1y digital floor:long floor",
        "date": "2020-03-31T00:00:00",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "reset_date": "2019-11-27T00:00:00",
        "payment_date": "2020-02-27T00:00:00",
        "forward_rate": 0.0075
      },
      {
        "id": "1y digital floor:short floor_1",
        "derivative_id": "1y digital floor:short floor",
        "date": "2020-03-31T00:00:00",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "reset_date": "2019-05-27T00:00:00",
        "payment_date": "2019-08-27T00:00:00",
        "forward_rate": 0.0025
      },
      {
        "id": "1y digital floor:short floor_2",
        "derivative_id": "1y digital floor:short floor",
        "date": "2020-03-31T00:00:00",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "reset_date": "2019-08-27T00:00:00",
        "payment_date": "2019-11-27T00:00:00",
        "forward_rate": 0.005
      },
      {
        "id": "1y digital floor:short floor_3",
        "derivative_id": "1y digital floor:short floor",
        "date": "2020-03-31T00:00:00",
        "trade_date": "2019-02-25T00:00:00",
        "asset_class": "ir",
        "currency_code": "EUR",
        "notional_amount": 100000,
        "reset_date": "2019-11-27T00:00:00",
        "payment_date": "2020-02-27T00:00:00",
        "forward_rate": 0.0075
      }
    ]
  }
}

Interest rate future

June three-month cash-settled interest rate future.

{
  "title": "ir_future",
  "comment": "ir_future",
  "data": {
    "derivative": [
      {
        "date": "2019-04-30T00:00:00",
        "id": "june_eurodollar_future",
        "asset_class": "ir",
        "type": "future",
        "leg_type": "indexed",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 100,
        "underlying_currency_code": "USD",
        "trade_date": "2018-04-01T00:00:00",
        "start_date": "2019-05-02T00:00:00",
        "end_date": "2019-05-04T00:00:00",
        "last_payment_date": "2019-08-02T00:00:00",
        "mtm_dirty": -2,
        "settlement_type": "cash"
      }
    ]
  }
}

Interest rate swap

Long 10y EUR irs vs Euribor 3M, bullet

{
  "title": "interest_rate_swap",
  "comment": "interest_rate_swap",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "eur_10y_irs_fixed",
        "deal_id": "eur_10y_irs",
        "asset_class": "ir",
        "type": "vanilla_swap",
        "currency_code": "EUR",
        "leg_type": "fixed",
        "position": "long",
        "notional_amount": 10000,
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2029-02-27T00:00:00",
        "rate": 0.01,
        "mtm_dirty": 70
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "eur_10y_irs_floating",
        "deal_id": "long_eur_10y_irs",
        "asset_class": "ir",
        "type": "vanilla_swap",
        "leg_type": "floating",
        "position": "short",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "rate": 0.0025,
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2019-02-27T00:00:00",
        "end_date": "2029-02-27T00:00:00"
      }
    ]
  }
}

Interest rate swap amortising

Long 2y EUR irs vs Euribor 6M, amortising annually

{
  "title": "interest_rate_swap_amortising",
  "comment": "Interest Rate Swap Amortising",
  "data": {
    "derivative": [
      {
        "id": "eur_10y_irs_fixed",
        "deal_id": "eur_10y_irs",
        "date": "2020-03-31T00:00:00",
        "asset_class": "ir",
        "type": "vanilla_swap",
        "leg_type": "fixed",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "trade_date": "2020-01-29T00:00:00",
        "start_date": "2020-01-31T00:00:00",
        "end_date": "2022-01-31T00:00:00",
        "rate": 0.01,
        "mtm_dirty": 70
      },
      {
        "id": "eur_10y_irs_floating",
        "deal_id": "long_eur_10y_irs",
        "date": "2020-03-31T00:00:00",
        "asset_class": "ir",
        "type": "vanilla_swap",
        "leg_type": "floating",
        "position": "short",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "trade_date": "2020-01-29T00:00:00",
        "start_date": "2020-01-31T00:00:00",
        "end_date": "2022-01-31T00:00:00",
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "6m",
        "rate": 0.0025
      }
    ],
    "derivative_cash_flow": [
      {
        "id": "eur_10y_irs_fixed_1",
        "derivative_id": "eur_10y_irs_fixed",
        "date": "2020-03-31T00:00:00",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "reset_date": "2020-01-31T00:00:00",
        "payment_date": "2021-01-31T00:00:00"
      },
      {
        "id": "eur_10y_irs_fixed_2",
        "derivative_id": "eur_10y_irs_fixed",
        "date": "2020-03-31T00:00:00",
        "currency_code": "EUR",
        "notional_amount": 5000,
        "reset_date": "2021-01-31T00:00:00",
        "payment_date": "2022-01-31T00:00:00"
      },
      {
        "id": "eur_10y_irs_floating_1",
        "derivative_id": "eur_10y_irs_floating",
        "date": "2020-03-31T00:00:00",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "reset_date": "2021-01-31T00:00:00",
        "payment_date": "2021_07_31T00:00:00",
        "forward_rate": 0.0075
      },
      {
        "id": "eur_10y_irs_floating_2",
        "derivative_id": "eur_10y_irs_floating",
        "date": "2020-03-31T00:00:00",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "reset_date": "2021-07-31T00:00:00",
        "payment_date": "2022-01-31T00:00:00",
        "forward_rate": 0.0125
      },
      {
        "id": "eur_10y_irs_floating_3",
        "derivative_id": "eur_10y_irs_floating",
        "date": "2020-03-31T00:00:00",
        "currency_code": "EUR",
        "notional_amount": 5000,
        "reset_date": "2022-01-31T00:00:00",
        "payment_date": "2022-07-31T00:00:00",
        "forward_rate": 0.0175
      },
      {
        "id": "eur_10y_irs_floating_4",
        "derivative_id": "eur_10y_irs_floating",
        "date": "2020-03-31T00:00:00",
        "currency_code": "EUR",
        "notional_amount": 5000,
        "reset_date": "2022-07-31T00:00:00",
        "payment_date": "2023-01-31T00:00:00",
        "forward_rate": 0.0225
      }
    ]
  }
}

Margined netting agreement

Margined netting agreement, collateralised with initial collateral amount and variation margin

{
  "title": "margined_netting_agreement",
  "comment": "Margined Netting Set with collateral. Example trade is an IRS. Agreement schemas contain an MNA (representing the netting set) and a CSA (representing margined status - exchanges of collateral)",
  "data": {
    "derivative": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "eur_10y_irs_fixed",
        "deal_id": "eur_10y_irs",
        "customer_id": "ccp_1",
        "mna_id": "isda_master_agreement",
        "csa_id": "csa_daily_margined",
        "asset_class": "ir",
        "type": "vanilla_swap",
        "leg_type": "fixed",
        "position": "long",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2020-02-27T00:00:00",
        "end_date": "2029-02-27T00:00:00",
        "rate": 0.01,
        "mtm_dirty": 70
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "eur_10y_irs_floating",
        "deal_id": "long_eur_10y_irs",
        "customer_id": "counterparty_1",
        "mna_id": "isda_master_agreement",
        "csa_id": "csa_daily_margined",
        "asset_class": "ir",
        "type": "vanilla_swap",
        "leg_type": "floating",
        "position": "short",
        "currency_code": "EUR",
        "notional_amount": 10000,
        "rate": 0.0025,
        "underlying_index": "EURIBOR",
        "underlying_index_tenor": "3m",
        "trade_date": "2019-02-25T00:00:00",
        "start_date": "2020-02-27T00:00:00",
        "end_date": "2029-02-27T00:00:00"
      }
    ],
    "customer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "ccp_1",
        "type": "ccp",
        "currency_code": "GBP",
        "country_code": "GB"
      }
    ],
    "agreement": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "isda_master_agreement",
        "type": "isda",
        "base_currency_code": "GBP",
        "incurred_cva": 0,
        "country_code": "GB"
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "csa_daily_margined",
        "type": "isda",
        "base_currency_code": "EUR",
        "credit_support_type": "scsa_isda_2013",
        "margin_frequency": "daily",
        "threshold": 10,
        "minimum_transfer_amount": 5,
        "country_code": "GB"
      }
    ],
    "security": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "vm_eur_received",
        "customer_id": "ccp_1",
        "mna_id": "isda_master_agreement",
        "csa_id": "csa_daily_margined",
        "type": "cash",
        "purpose": "variation_margin",
        "asset_liability": "liability",
        "currency_code": "EUR",
        "notional_amount": 55,
        "balance": 55,
        "trade_date": "2020-03-31T00:00:00",
        "start_date": "2020-03-31T00:00:00"
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "im_bond_posted",
        "customer_id": "ccp_1",
        "mna_id": "isda_master_agreement",
        "csa_id": "csa_daily_margined",
        "type": "bond",
        "issuer_id": "French Republic",
        "isin_code": "XS1234567890",
        "issue_date": "2018-07-01 00:00:00",
        "maturity_date": "2028-07-01 00:00:00",
        "purpose": "independent_collateral_amount",
        "asset_liability": "asset",
        "currency_code": "EUR",
        "notional_amount": 8,
        "mtm_dirty": -10,
        "trade_date": "2020-03-31T00:00:00",
        "start_date": "2020-03-31T00:00:00",
        "cqs_standardised": 1
      }
    ],
    "issuer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "French Republic",
        "lei_code": "9695006J0AWHMYNZAL19",
        "type": "central_govt",
        "country_code": "FR",
        "snp_lt": "aa_plus",
        "moodys_lt": "aa1"
      }
    ]
  }
}

Swaption

Short USD 1y into 10y payer swaptionwith physical settlement

{
  "title": "usd_payer_swaption",
  "comment": "usd_payer_swaption",
  "data": {
    "derivative": [
      {
        "date": "2019-01-01T00:00:00",
        "id": "usd_payer_swaption",
        "asset_class": "ir",
        "type": "swaption",
        "leg_type": "call",
        "position": "short",
        "currency_code": "USD",
        "notional_amount": 10000,
        "strike": 0.02,
        "underlying_index": "USD_LIBOR",
        "underlying_index_tenor": "6m",
        "start_date": "2019-01-01T00:00:00",
        "end_date": "2020-01-01T00:00:00",
        "last_payment_date": "2030-01-01T00:00:00",
        "last_exercise_date": "2020-01-01T00:00:00",
        "underlying_price": 0.02,
        "settlement_type": "physical",
        "mtm_dirty": -5
      }
    ]
  }
}

Unmargined netting agreement

Unmargined netting agreement, collateralised with initial collateral amount

{
    "title": "unmargined_netting_agreement",
    "comment": "Unmargined netting set with collateral. Example trade is an IRS. Agreement schemas contain an MNA (representing the netting set). There is no CSA, therefore there is no margining. However, one can still post Independent Collateral (security schema)",
    "data": {
      "derivative": [
        {
          "date": "2020-03-31T00:00:00",
          "id": "eur_10y_irs_fixed",
          "deal_id": "eur_10y_irs",
          "customer_id": "ccp_1",
          "mna_id": "isda_master_agreement",
          "csa_id": "csa_daily_margined",
          "asset_class": "ir",
          "type": "vanilla_swap",
          "leg_type": "fixed",
          "position": "long",
          "currency_code": "EUR",
          "notional_amount": 10000,
          "trade_date": "2019-02-25T00:00:00",
          "start_date": "2020-02-27T00:00:00",
          "end_date": "2029-02-27T00:00:00",
          "rate": 0.01,
          "mtm_dirty": 70
        },
        {
          "date": "2020-03-31T00:00:00",
          "id": "eur_10y_irs_floating",
          "deal_id": "long_eur_10y_irs",
          "customer_id": "counterparty_1",
          "mna_id": "isda_master_agreement",
          "csa_id": "csa_daily_margined",
          "asset_class": "ir",
          "type": "vanilla_swap",
          "leg_type": "floating",
          "position": "short",
          "currency_code": "EUR",
          "notional_amount": 10000,
          "rate": 0.0025,
          "underlying_index": "EURIBOR",
          "underlying_index_tenor": "3m",
          "trade_date": "2019-02-25T00:00:00",
          "start_date": "2020-02-27T00:00:00",
          "end_date": "2029-02-27T00:00:00"
        }
      ],
      "customer": [
        {
          "date": "2020-03-31T00:00:00",
          "id": "ccp_1",
          "type": "ccp",
          "currency_code": "GBP",
          "country_code": "GB"
        }
      ],
      "agreement": [
        {
          "date": "2020-03-31T00:00:00",
          "id": "isda_master_agreement",
          "type": "isda",
          "base_currency_code": "GBP",
          "incurred_cva": 0,
          "country_code": "GB"
        }
      ],
      "security": [
        {
          "date": "2020-03-31T00:00:00",
          "id": "im_bond_posted",
          "customer_id": "ccp_1",
          "mna_id": "isda_master_agreement",
          "type": "bond",
          "issuer_id": "French Republic",
          "isin_code": "XS1234567890",
          "issue_date": "2018-07-01 00:00:00",
          "maturity_date": "2028-07-01 00:00:00",
          "purpose": "independent_collateral_amount",
          "asset_liability": "asset",
          "currency_code": "EUR",
          "notional_amount": 8,
          "mtm_dirty": -10,
          "trade_date": "2020-03-31T00:00:00",
          "start_date": "2020-03-31T00:00:00",
          "cqs_standardised": 1
        }
      ],
      "issuer": [
        {
          "date": "2020-03-31T00:00:00",
          "id": "French Republic",
          "lei_code": "9695006J0AWHMYNZAL19",
          "type": "central_govt",
          "country_code": "FR",
          "snp_lt": "aa_plus",
          "moodys_lt": "aa1"
        }
      ]
    }
  }

Security examples

Bank guarantee issued

Guarantee of 1000 GBP issued by the bank for a customer

{
  "title": "bank_guarantee_issued",
  "comment": "bank_guarantee",
  "data": {
    "security": [
      {
        "id": "bank_guarantee",
        "date": "2019-01-01T00:00:00",
        "balance": 100000,
        "currency_code": "GBP",
        "asset_liability": "liability",
        "on_balance_sheet": false,
        "type": "financial_guarantee",
        "customer_id": "corp_123_id"
      }
    ]
  }
}

Core equity tier-1 capital

Core equity tier 1 capital of 1000 GBP

{
  "title": "cet_1_capital",
  "comment": "Core Equity Tier one capital",
  "data": {
    "security": [
      {
        "id": "Core Equity Tier one capital",
        "date": "2019-01-01T00:00:00",
        "balance": 100000,
        "currency_code": "GBP",
        "asset_liability": "equity",
        "type": "share",
        "capital_tier": "ce_tier_1",
        "purpose": "share_capital",
        "status": "paid_up"
      }
    ]
  }
}

Cash on-hand

Cash balance representing 1000 GBP.

{
  "title": "cash_on_hand",
  "comment": "cash_on_hand",
  "data": {
    "security": [
      {
        "id": "cash_on_hand",
        "date": "2019-01-01T00:00:00",
        "balance": 100000,
        "currency_code": "GBP",
        "asset_liability": "asset",
        "type": "cash"
      }
    ]
  }
}

Cash receivable

Cash receivable representing a 1000 GBP claim expiring on August 1st 2020 on a security with isin ‘DUMMYISIN123’.

{
  "title": "cash_receivable",
  "comment": "cash_receivable",
  "data": {
    "security": [
      {
        "id": "cash_receivable",
        "date": "2020-07-30T00:00:00",
        "balance": -100000,
        "currency_code": "GBP",
        "asset_liability": "asset",
        "type": "cash",
        "end_date": "2020-08-01T00:00:00+00:00",
        "isin_code": "DUMMYISIN123"
      }
    ]
  }
}

Cash payable

Cash payable representing a 1000 GBP claim expiring on August 1st 2020 on a security with isin ‘DUMMYISIN123’.

{
  "title": "cash_payable",
  "comment": "cash_payable",
  "data": {
    "security": [
      {
        "id": "cash_payable",
        "date": "2020-07-30T00:00:00",
        "balance": 100000,
        "currency_code": "GBP",
        "asset_liability": "liability",
        "type": "cash",
        "end_date": "2020-08-01T00:00:00+00:00",
        "isin_code": "DUMMYISIN123"
      }
    ]
  }
}

Collateral posted to ccp on non-derivatives

Non-derivatives IM posted to a CCP (e.g. RepoClear)

Security has “purpose” = “collateral” which signals it is not linked to derivative transactions.

{
  "title": "security_collateral_posted_ccp_non_deriv",
  "comment": "security_collateral_posted_ccp_non_deriv",
  "data": {
    "agreement": [
      {
        "id": "MNA1",
        "date": "2018-12-31 00:00:00",
        "start_date": "2017-01-31 00:00:00",
        "country_code": "GB",
        "type": "isda"
      }
    ],
    "customer": [
      {
        "id": "customer_ccp",
        "date": "2018-12-31 00:00:00",
        "type": "ccp",
        "country_code": "GB"
      }
    ],
    "security": [
      {
        "id": "collat_cash_posted_50",
        "date": "2018-12-31 00:00:00",
        "trade_date": "2018-12-31 00:00:00",
        "start_date": "2018-12-31 00:00:00",
        "asset_liability": "asset",
        "currency_code": "GBP",
        "balance": 5000,
        "mtm_dirty": 5000,
        "type": "bond",
        "purpose": "collateral",
        "mna_id": "MNA1",
        "customer_id": "customer_ccp"
      }
    ]
  }
}

Initial margin posted

Bond collateral used as initial margin posted

{
  "title": "collateral_initial_margin_bond_posted",
  "comment": "Collateral Initial Margin Bond Posted",
  "data": {
    "security": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "im_posted_bond",
        "customer_id": "credit_insitution",
        "mna_id": "isda_master_agreement",
        "csa_id": "csa_agreement",
        "type": "bond",
        "issuer_id": "French Republic",
        "isin_code": "FR0000571218",
        "issue_date": "1998-03-12T00:00:00",
        "maturity_date": "2025-04-29T00:00:00",
        "purpose": "independent_collateral_amount",
        "asset_liability": "asset",
        "currency_code": "EUR",
        "notional_amount": 100,
        "mtm_dirty": -145,
        "trade_date": "2020-03-31T00:00:00",
        "start_date": "2020-03-31T00:00:00",
        "cqs_standardised": 1
      }
    ],
    "issuer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "French Republic",
        "lei_code": "9695006J0AWHMYNZAL19",
        "type": "central_govt",
        "country_code": "FR",
        "snp_lt": "aa_plus",
        "moodys_lt": "aa1"
      }
    ],
    "customer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "credit_insitution",
        "type": "credit_institution",
        "currency_code": "GBP",
        "country_code": "GB"
      }
    ],
    "agreement": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "isda_master_agreement",
        "type": "isda",
        "base_currency_code": "GBP",
        "country_code": "GB"
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "csa_agreement",
        "type": "isda",
        "base_currency_code": "EUR",
        "credit_support_type": "scsa_isda_2013",
        "margin_frequency": "daily",
        "threshold": 10,
        "minimum_transfer_amount": 5,
        "country_code": "GB"
      }
    ]
  }
}

Independent amount received

Bond collateral used as independent amount received

{
  "title": "collateral_independent_amount_bond_received",
  "comment": "Collateral Independent Amount Bond Received",
  "data": {
    "security": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "independent_amount",
        "customer_id": "corporate",
        "mna_id": "master_agreement",
        "type": "bond",
        "issuer_id": "Asian Development Bank",
        "isin_code": "NZADBDT007C4",
        "issue_date": "2017-05-30T00:00:00",
        "maturity_date": "2024-05-30T00:00:00",
        "purpose": "independent_collateral_amount",
        "asset_liability": "liability",
        "currency_code": "NZD",
        "notional_amount": 100,
        "mtm_dirty": 17,
        "trade_date": "2020-03-31T00:00:00",
        "start_date": "2020-03-31T00:00:00",
        "cqs_standardised": 1
      }
    ],
    "issuer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "Asian Development Bank",
        "lei_code": "549300X0MVH42CY8Q105",
        "type": "mdb",
        "country_code": "PH",
        "snp_lt": "aaa",
        "moodys_lt": "aaa"
      }
    ],
    "customer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "corporate",
        "type": "corporate",
        "currency_code": "SGD",
        "country_code": "SG"
      }
    ],
    "agreement": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "master_agreement",
        "type": "isda",
        "base_currency_code": "SGD",
        "netting_restriction": "restrictive_covenant",
        "incurred_cva": 10,
        "country_code": "SG"
      }
    ]
  }
}

Reverse repo

Reverse repo transaction with a cash leg of 150 GBP, and a security leg of 140 GBP, starting on June 1st, 2021 and ending on July 1st, 2021. The maturity date on the security leg refers to the maturity of the bond received as collateral.

{
  "title": "rev_repo",
  "comment": "rev_repo",
  "data": {
    "security": [
      {
        "id": "rev_repo_cash_leg",
        "date": "2021-06-15T00:00:00",
        "currency_code": "GBP",
        "end_date": "2021-07-01T00:00:00Z",
	"cqs_standardised": 1,
	"hqla_class": "i",
	"issuer_id": "uk_central_government_id",
        "balance": -15000,
        "movement": "cash",
        "sft_type": "rev_repo",
        "start_date": "2021-06-01T00:00:00Z",
        "type": "bond",
        "trade_date": "2021-06-01T00:00:00Z",
        "asset_liability": "asset"
      },
      {
        "id": "rev_repo_asset_leg",
        "date": "2021-06-15T00:00:00",
        "currency_code": "GBP",
        "end_date": "2021-07-01T00:00:00Z",
	"cqs_standardised": 1,
	"hqla_class": "i",
        "mtm_dirty": 14000,
        "movement": "asset",
        "sft_type": "rev_repo",
        "start_date": "2021-06-01T00:00:00Z",
        "type": "bond",
        "trade_date": "2021-06-01T00:00:00Z",
        "asset_liability": "liability",
        "issuer_id": "uk_central_government_id",
        "maturity_date": "2030-01-01T00:00:00Z"
      }
    ]
  }
}

Repo

Repo transaction with a cash leg of 150 GBP, and a security leg of 140 GBP, starting on June 1st, 2021 and ending on July 1st, 2021. The maturity date on the security leg refers to the maturity of the bond posted as collateral.

{
  "title": "repo",
  "comment": "repo",
  "data": {
    "security": [
      {
        "id": "repo_cash_leg",
        "date": "2021-06-15T00:00:00",
        "currency_code": "GBP",
        "end_date": "2021-07-01T00:00:00Z",
        "balance": 15000,
	"cqs_standardised": 1,
	"hqla_class": "i",
	"issuer_id": "uk_central_government_id",
        "movement": "cash",
        "sft_type": "repo",
        "start_date": "2021-06-01T00:00:00Z",
        "type": "bond",
        "trade_date": "2021-06-01T00:00:00Z",
        "asset_liability": "liability"
      },
      {
        "id": "repo_asset_leg",
        "date": "2021-06-15T00:00:00",
        "currency_code": "GBP",
        "end_date": "2021-07-01T00:00:00Z",
	"cqs_standardised": 1,
	"hqla_class": "i",
        "mtm_dirty": -14000,
        "movement": "asset",
        "sft_type": "repo",
        "start_date": "2021-06-01T00:00:00Z",
        "type": "bond",
        "trade_date": "2021-06-01T00:00:00Z",
        "asset_liability": "asset",
        "issuer_id": "uk_central_government_id",
        "maturity_date": "2030-01-01T00:00:00Z"
      }
    ]
  }
}

Variation margin cash posted

Cash collateral used as variation margin posted

{
  "title": "collateral_variation_margin_cash_posted",
  "comment": "Collateral Variation Margin Cash Posted",
  "data": {
    "security": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "vm_cash_posted",
        "customer_id": "qccp",
        "mna_id": "ccp_master_agreement",
        "csa_id": "ccp_margin_agreement",
        "type": "cash",
        "purpose": "variation_margin",
        "asset_liability": "asset",
        "currency_code": "USD",
        "notional_amount": 25,
        "balance": -25,
        "trade_date": "2020-03-31T00:00:00",
        "start_date": "2020-03-31T00:00:00"
      }
    ],
    "customer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "qccp",
        "type": "qccp",
        "currency_code": "GBP",
        "country_code": "GB"
      }
    ],
    "agreement": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "ccp_master_agreement",
        "type": "isda",
        "base_currency_code": "GBP",
        "incurred_cva": 0,
        "country_code": "GB"
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "ccp_margin_agreement",
        "type": "isda",
        "base_currency_code": "GBP",
        "credit_support_type": "csa_isda_1995",
        "margin_frequency": "daily_settled",
        "country_code": "GB"
      }
    ]
  }
}

Variation margin cash received

Cash collateral used as variation margin received

{
  "title": "collateral_variation_margin_cash_received",
  "comment": "Collateral Variation Margin Cash Received",
  "data": {
    "security": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "vm_cash_received",
        "customer_id": "qccp",
        "mna_id": "ccp_master_agreement",
        "csa_id": "ccp_margin_agreement",
        "type": "cash",
        "purpose": "variation_margin",
        "asset_liability": "liability",
        "currency_code": "EUR",
        "notional_amount": 100,
        "balance": 100,
        "trade_date": "2020-03-31T00:00:00",
        "start_date": "2020-03-31T00:00:00"
      }
    ],
    "customer": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "qccp",
        "type": "qccp",
        "currency_code": "GBP",
        "country_code": "GB"
      }
    ],
    "agreement": [
      {
        "date": "2020-03-31T00:00:00",
        "id": "ccp_master_agreement",
        "type": "isda",
        "base_currency_code": "GBP",
        "incurred_cva": 0,
        "country_code": "GB"
      },
      {
        "date": "2020-03-31T00:00:00",
        "id": "ccp_margin_agreement",
        "type": "isda",
        "base_currency_code": "GBP",
        "credit_support_type": "csa_isda_1995",
        "margin_frequency": "daily_settled",
        "country_code": "GB"
      }
    ]
  }
}

layouttitle
schemaaccount

Account Schema


An Account represents a financial account that describes the funds that a customer has entrusted to a financial institution in the form of deposits or credit balances.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrued_interest
The accrued interest since the last payment date and due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
arrears_balance
The balance of the capital amount that is considered to be in arrears (for overdrafts/credit cards). Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
The contractual balance on the date and in the currency given. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the rate on the balance at the given date as agreed in the terms of the account.
string
FDTRUKBRBASEZERO
behavioral_curve_id
The unique identifier for the behavioral curve used by the financial institution.
string-
behavioral_end_date
Behavioral end date (as opposed to contractual). YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
break_dates
Dates where this contract can be broken (by either party). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_dates
Dates where this contract can be called (by the customer). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
capital_tier
The capital tiers based on own funds requirements.
string
add_tier_1anc_tier_2anc_tier_3at1_grandfatheredbas_tier_2bas_tier_3ce_tier_1cet1_grandfatheredt2_grandfatheredtier_1tier_2tier_3
ccf
The credit conversion factor that indicates the proportion of the undrawn amount that would be drawn down on default.
number-
commission
Commission percentage to be added onto interest rate of the product to calculate the credit spread at inception of receiving the deposit.
integer-
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
count
Describes the number of accounts aggregated into a single row.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
cum_write_offs
The portion of the loan which has been written off.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer that owns the account.
string-
day_count_convention
The methodology for calculating the number of days between two dates. It is used to calculate the amount of accrued interest or the present value.
string
act_360act_365act_actstd_30_360std_30_365
default_date
Date of default.
string-
ead
The EAD field allows users to input monetary exposure-at-default values across the loan’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
ead_irb_ec
The expected gross dollar exposure for each facility upon a borrower’s default as determined by internal ratings-based approach. This value is used in economic capital calculations.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
encumbrance_amount
The amount of the account that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
encumbrance_type
The type of the encumbrance causing the encumbrance_amount.
string
covered_bondderivativenoneotherrepo
end_date
The end or maturity date of the account. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
facility_id
The code assigned by the financial institution to identify a facility.
string-
first_arrears_date
The first date on which this account was in arrears.
string-
first_payment_date
The first payment date for interest payments.
string-
forbearance_date
The date on which the first forbearance measure was granted to this product. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
fraud_loss
The total value of accounting losses incurred by the Financial Institution due to fraudulent activities within the reporting segment.
integer-
frr_id
The internal facility risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
guarantee_amount
The amount of the account that is guaranteed under a Government Deposit Guarantee Scheme. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
guarantee_scheme
The Government Deposit Scheme scheme under which the guarantee_amount is guaranteed.
string
be_pfbg_difca_cdiccy_dpscz_difde_edbde_edode_edwdk_gdfiee_dgses_fgdfi_dgffr_fdggb_fscsgr_dgshk_dpshr_dihu_ndifie_dgsit_fitdlt_vilu_fgdllv_dgfmt_dcsnl_dgspl_bfgpt_fgdro_fgdbse_ndosi_dgssk_dpfus_fdic
impairment_amount
The impairment amount is the allowance set aside by the firm that accounts for the event that the asset becomes impaired in the future.
integer-
impairment_date
The date upon which the product became considered impaired. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
impairment_type
The loss event resulting in the impairment of the loan.
string
collectiveindividualwrite_off
insolvency_rank
The insolvency ranking as per the national legal framework of the reporting institution.
integer-
int_reset_freq
The adjustable rate periodic interest reset period. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
interest_repayment_frequency
Repayment frequency of the interest.
string
dailyweeklybi_weeklymonthlybi_monthlyquarterlysemi_annuallyannuallyat_maturitybienniallysesquiennially
last_drawdown_date
The last date on which a drawdown was made on this account (overdraft).
string-
last_payment_date
The final payment date for interest payments, often coincides with end_date.
string-
last_recovery_date
Date of most recent recovery in the reporting quarter.
string-
last_write_off_date
Date of Financial Institution’s most recent Write Off in the reporting quarter.
string-
ledger_code
The internal ledger code or line item name.
string-
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations.
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
lgd_irb_ec
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
limit_amount
The minimum balance the customer can go overdrawn in their account.
integer-
min_interest_repayment
The minimum interest on outstanding balance and fees that customers are due to repay.
integer-
min_principal_repayment
The minimum principal balance that customers are due to repay.
integer-
minimum_balance
Indicates the minimum balance of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
minimum_balance_eur
Indicates the minimum balance, in Euros, of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
mna_id
The unique identifier of the Master Netting Agreement the account falls under. Typically used where a legally enforceable right to offset exists and where the reporting entity intends to settle on a net basis.
string-
mtd_deposits
Month to date amount deposited within the account as a naturally positive integer number of cents/pence.
integer-
mtd_interest_paid
Month to date interest added to account as a naturally positive integer number of cents/pence.
integer-
mtd_withdrawals
Month to date amount withdrawn from the account as a naturally positive integer number of cents/pence.
integer-
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_repricing_date
The date on which the interest rate of the account will be re-calculated. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
next_withdrawal_date
The next date at which customer is allowed to withdraw money from this account.
string-
on_balance_sheet
Is the account or deposit reported on the balance sheet of the financial institution?
boolean-
orig_credit_score
The credit score of the customer at origination of the product using a commercially available credit bureau score.
integer-
orig_limit_amount
The original line of credit amount that was granted at the origination of the facility
integer-
parent_facility_id
The parent code assigned by the financial institution to identify a facility.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
purpose
The purpose for which the account was created or is being used.
string
adj_syn_inv_decon_subsadj_syn_inv_own_sharesadj_syn_mtg_def_insadj_syn_nonsig_inv_finadj_syn_other_inv_finadminannual_bonus_accrualsbenefit_in_kindcapital_gain_taxcapital_reservecash_managementcf_hedgecf_hedge_reclassci_serviceclearingcollateralcommitmentscomputer_and_it_costcomputer_peripheralcomputer_softwarecorporation_taxcredit_card_feecritical_servicecurrent_account_feecustodydealing_rev_crdealing_rev_dbt_issuedealing_rev_debtdealing_rev_depositsdealing_rev_derivdealing_rev_deriv_comdealing_rev_deriv_ecodealing_rev_deriv_equdealing_rev_deriv_fxdealing_rev_deriv_intdealing_rev_deriv_nsedealing_rev_deriv_othdealing_rev_equitydealing_rev_fxdealing_rev_fx_nsedealing_rev_irdealing_rev_loandealing_rev_non_findealing_rev_oth_finandealing_rev_secdealing_rev_sec_nsedealing_rev_shortdealing_revenueded_fut_profded_fut_prof_temp_diffdefined_benefitdepositderivative_feedgs_contributiondiv_from_cisdiv_from_money_mktdividenddonationemployeeemployee_stock_optionescrowfeesfinefirm_operating_expensesfirm_operationsfurniturefut_proffut_prof_temp_difffxgeneral_credit_riskgoodwillinsurance_feeint_on_assetint_on_bond_and_frnint_on_bridging_loanint_on_credit_cardint_on_debt_issuedint_on_depositint_on_deriv_hedgeint_on_derivativeint_on_ecgd_lendingint_on_finance_leasingint_on_liabilityint_on_loan_and_advint_on_money_mktint_on_mortgageint_on_sftint_unallocatedintangibleintangible_leaseinterestintra_group_feeinv_in_subsidiaryinvestment_banking_feeinvestment_prop_leaseinvestment_propertyipsit_outsourcinglandloan_and_advance_feemachinerymanufactured_dividendmortgage_feemsrmtg_ins_nonconformmtg_insuranceni_contributionnol_carrybacknon_life_ins_premiumnot_fut_profoccupancy_costoperationaloperational_escrowoperational_excessoth_tax_excl_temp_diffotherother_expenditureother_fs_feeother_non_fs_feeother_social_contribother_staff_costother_staff_removerdraft_feeown_propertypensionppeprime_brokeragepropertyproperty_leasepv_future_spread_increc_unidentified_cptyreclass_taxrecoveryredundancy_pymtreferencereg_lossregular_wagesreleaserentres_fund_contributionrestructuringretained_earningsrevaluationrevaluation_reclassrevenue_reserveshare_planshare_premiumstaffsystemtaxtelecom_equipmentthird_party_interestunderwriting_feeunsecured_loan_feevehiclewrite_off
rate
The full interest rate applied to the account balance in percentage terms. Note that this therefore includes the base_rate (ie. not the spread).
number-
rate_type
Describes the type of interest rate applied to the account.
string
combinedfixedpreferentialtrackervariable
recourse
Whether there is recourse on a loan. Recourse on a loan refers to terms in the mortgage contract that give the owner of the note the right to pursue additional claims against the borrower beyond possession of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
fullnonepartial
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
resolution_date
Date of resolution of the defaulted facility.
string-
review_date
The currently scheduled review date for Counterparty exposure. This date should be set in the future. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
rollover_date
A particular predetermined date at which an account is rolled-over.
string-
seniority
The seniority of the security in the event of sale or bankruptcy of the issuer.
string
mezzaninepari_passusenior_securedsenior_unsecuredsubordinated_securedsubordinated_unsecured
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
start_date
The timestamp that the trade or financial product commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Describes if the Account is active or been cancelled.
string
activeauditedcancelledcancelled_payout_agreedotherpendingtransactionalunaudited
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
type
This is the type of the account with regards to common regulatory classifications.
string
accrualsamortisationbondscallcdcredit_cardcurrentcurrent_iodebt_securities_issueddeferreddeferred_taxdepreciationexpensefinancial_leaseincomeintangibleinternet_onlyiraisaisa_currentisa_current_ioisa_ioisa_time_depositisa_time_deposit_ioloans_and_advancesmoney_marketnon_deferrednon_productotherother_financial_liabprepaid_cardprepaymentsprovisionreserveretail_bondssavingssavings_iosuspensetangiblethird_party_savingstime_deposittime_deposit_iovaluation_allowancevostro
uk_funding_type
Funding type calculated according to BIPRU 12.5/12.6
string
ab
undrawn_provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the undrawn portion of a loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
withdrawal_penalty
This is the penalty incurred by the customer for an early withdrawal on this account. An early withdrawal is defined as a withdrawal prior to the next_withdrawal_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
layouttitle
schemaaccount

Account Schema


An Account represents a financial account that describes the funds that a customer has entrusted to a financial institution in the form of deposits or credit balances.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrued_interest
The accrued interest since the last payment date and due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
arrears_balance
The balance of the capital amount that is considered to be in arrears (for overdrafts/credit cards). Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
The contractual balance on the date and in the currency given. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the rate on the balance at the given date as agreed in the terms of the account.
string
FDTRUKBRBASEZERO
behavioral_curve_id
The unique identifier for the behavioral curve used by the financial institution.
string-
behavioral_end_date
Behavioral end date (as opposed to contractual). YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
break_dates
Dates where this contract can be broken (by either party). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_dates
Dates where this contract can be called (by the customer). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
capital_tier
The capital tiers based on own funds requirements.
string
add_tier_1anc_tier_2anc_tier_3at1_grandfatheredbas_tier_2bas_tier_3ce_tier_1cet1_grandfatheredt2_grandfatheredtier_1tier_2tier_3
ccf
The credit conversion factor that indicates the proportion of the undrawn amount that would be drawn down on default.
number-
commission
Commission percentage to be added onto interest rate of the product to calculate the credit spread at inception of receiving the deposit.
integer-
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
count
Describes the number of accounts aggregated into a single row.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
cum_write_offs
The portion of the loan which has been written off.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer that owns the account.
string-
day_count_convention
The methodology for calculating the number of days between two dates. It is used to calculate the amount of accrued interest or the present value.
string
act_360act_365act_actstd_30_360std_30_365
default_date
Date of default.
string-
ead
The EAD field allows users to input monetary exposure-at-default values across the loan’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
ead_irb_ec
The expected gross dollar exposure for each facility upon a borrower’s default as determined by internal ratings-based approach. This value is used in economic capital calculations.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
encumbrance_amount
The amount of the account that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
encumbrance_type
The type of the encumbrance causing the encumbrance_amount.
string
covered_bondderivativenoneotherrepo
end_date
The end or maturity date of the account. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
facility_id
The code assigned by the financial institution to identify a facility.
string-
first_arrears_date
The first date on which this account was in arrears.
string-
first_payment_date
The first payment date for interest payments.
string-
forbearance_date
The date on which the first forbearance measure was granted to this product. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
fraud_loss
The total value of accounting losses incurred by the Financial Institution due to fraudulent activities within the reporting segment.
integer-
frr_id
The internal facility risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
guarantee_amount
The amount of the account that is guaranteed under a Government Deposit Guarantee Scheme. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
guarantee_scheme
The Government Deposit Scheme scheme under which the guarantee_amount is guaranteed.
string
be_pfbg_difca_cdiccy_dpscz_difde_edbde_edode_edwdk_gdfiee_dgses_fgdfi_dgffr_fdggb_fscsgr_dgshk_dpshr_dihu_ndifie_dgsit_fitdlt_vilu_fgdllv_dgfmt_dcsnl_dgspl_bfgpt_fgdro_fgdbse_ndosi_dgssk_dpfus_fdic
impairment_amount
The impairment amount is the allowance set aside by the firm that accounts for the event that the asset becomes impaired in the future.
integer-
impairment_date
The date upon which the product became considered impaired. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
impairment_type
The loss event resulting in the impairment of the loan.
string
collectiveindividualwrite_off
insolvency_rank
The insolvency ranking as per the national legal framework of the reporting institution.
integer-
int_reset_freq
The adjustable rate periodic interest reset period. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
interest_repayment_frequency
Repayment frequency of the interest.
string
dailyweeklybi_weeklymonthlybi_monthlyquarterlysemi_annuallyannuallyat_maturitybienniallysesquiennially
last_drawdown_date
The last date on which a drawdown was made on this account (overdraft).
string-
last_payment_date
The final payment date for interest payments, often coincides with end_date.
string-
last_recovery_date
Date of most recent recovery in the reporting quarter.
string-
last_write_off_date
Date of Financial Institution’s most recent Write Off in the reporting quarter.
string-
ledger_code
The internal ledger code or line item name.
string-
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations.
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
lgd_irb_ec
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
limit_amount
The minimum balance the customer can go overdrawn in their account.
integer-
min_interest_repayment
The minimum interest on outstanding balance and fees that customers are due to repay.
integer-
min_principal_repayment
The minimum principal balance that customers are due to repay.
integer-
minimum_balance
Indicates the minimum balance of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
minimum_balance_eur
Indicates the minimum balance, in Euros, of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
mna_id
The unique identifier of the Master Netting Agreement the account falls under. Typically used where a legally enforceable right to offset exists and where the reporting entity intends to settle on a net basis.
string-
mtd_deposits
Month to date amount deposited within the account as a naturally positive integer number of cents/pence.
integer-
mtd_interest_paid
Month to date interest added to account as a naturally positive integer number of cents/pence.
integer-
mtd_withdrawals
Month to date amount withdrawn from the account as a naturally positive integer number of cents/pence.
integer-
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_repricing_date
The date on which the interest rate of the account will be re-calculated. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
next_withdrawal_date
The next date at which customer is allowed to withdraw money from this account.
string-
on_balance_sheet
Is the account or deposit reported on the balance sheet of the financial institution?
boolean-
orig_credit_score
The credit score of the customer at origination of the product using a commercially available credit bureau score.
integer-
orig_limit_amount
The original line of credit amount that was granted at the origination of the facility
integer-
parent_facility_id
The parent code assigned by the financial institution to identify a facility.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
purpose
The purpose for which the account was created or is being used.
string
adj_syn_inv_decon_subsadj_syn_inv_own_sharesadj_syn_mtg_def_insadj_syn_nonsig_inv_finadj_syn_other_inv_finadminannual_bonus_accrualsbenefit_in_kindcapital_gain_taxcapital_reservecash_managementcf_hedgecf_hedge_reclassci_serviceclearingcollateralcommitmentscomputer_and_it_costcomputer_peripheralcomputer_softwarecorporation_taxcredit_card_feecritical_servicecurrent_account_feecustodydealing_rev_crdealing_rev_dbt_issuedealing_rev_debtdealing_rev_depositsdealing_rev_derivdealing_rev_deriv_comdealing_rev_deriv_ecodealing_rev_deriv_equdealing_rev_deriv_fxdealing_rev_deriv_intdealing_rev_deriv_nsedealing_rev_deriv_othdealing_rev_equitydealing_rev_fxdealing_rev_fx_nsedealing_rev_irdealing_rev_loandealing_rev_non_findealing_rev_oth_finandealing_rev_secdealing_rev_sec_nsedealing_rev_shortdealing_revenueded_fut_profded_fut_prof_temp_diffdefined_benefitdepositderivative_feedgs_contributiondiv_from_cisdiv_from_money_mktdividenddonationemployeeemployee_stock_optionescrowfeesfinefirm_operating_expensesfirm_operationsfurniturefut_proffut_prof_temp_difffxgeneral_credit_riskgoodwillinsurance_feeint_on_assetint_on_bond_and_frnint_on_bridging_loanint_on_credit_cardint_on_debt_issuedint_on_depositint_on_deriv_hedgeint_on_derivativeint_on_ecgd_lendingint_on_finance_leasingint_on_liabilityint_on_loan_and_advint_on_money_mktint_on_mortgageint_on_sftint_unallocatedintangibleintangible_leaseinterestintra_group_feeinv_in_subsidiaryinvestment_banking_feeinvestment_prop_leaseinvestment_propertyipsit_outsourcinglandloan_and_advance_feemachinerymanufactured_dividendmortgage_feemsrmtg_ins_nonconformmtg_insuranceni_contributionnol_carrybacknon_life_ins_premiumnot_fut_profoccupancy_costoperationaloperational_escrowoperational_excessoth_tax_excl_temp_diffotherother_expenditureother_fs_feeother_non_fs_feeother_social_contribother_staff_costother_staff_removerdraft_feeown_propertypensionppeprime_brokeragepropertyproperty_leasepv_future_spread_increc_unidentified_cptyreclass_taxrecoveryredundancy_pymtreferencereg_lossregular_wagesreleaserentres_fund_contributionrestructuringretained_earningsrevaluationrevaluation_reclassrevenue_reserveshare_planshare_premiumstaffsystemtaxtelecom_equipmentthird_party_interestunderwriting_feeunsecured_loan_feevehiclewrite_off
rate
The full interest rate applied to the account balance in percentage terms. Note that this therefore includes the base_rate (ie. not the spread).
number-
rate_type
Describes the type of interest rate applied to the account.
string
combinedfixedpreferentialtrackervariable
recourse
Whether there is recourse on a loan. Recourse on a loan refers to terms in the mortgage contract that give the owner of the note the right to pursue additional claims against the borrower beyond possession of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
fullnonepartial
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
resolution_date
Date of resolution of the defaulted facility.
string-
review_date
The currently scheduled review date for Counterparty exposure. This date should be set in the future. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
rollover_date
A particular predetermined date at which an account is rolled-over.
string-
seniority
The seniority of the security in the event of sale or bankruptcy of the issuer.
string
mezzaninepari_passusenior_securedsenior_unsecuredsubordinated_securedsubordinated_unsecured
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
start_date
The timestamp that the trade or financial product commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Describes if the Account is active or been cancelled.
string
activeauditedcancelledcancelled_payout_agreedotherpendingtransactionalunaudited
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
type
This is the type of the account with regards to common regulatory classifications.
string
accrualsamortisationbondscallcdcredit_cardcurrentcurrent_iodebt_securities_issueddeferreddeferred_taxdepreciationexpensefinancial_leaseincomeintangibleinternet_onlyiraisaisa_currentisa_current_ioisa_ioisa_time_depositisa_time_deposit_ioloans_and_advancesmoney_marketnon_deferrednon_productotherother_financial_liabprepaid_cardprepaymentsprovisionreserveretail_bondssavingssavings_iosuspensetangiblethird_party_savingstime_deposittime_deposit_iovaluation_allowancevostro
uk_funding_type
Funding type calculated according to BIPRU 12.5/12.6
string
ab
undrawn_provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the undrawn portion of a loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
withdrawal_penalty
This is the penalty incurred by the customer for an early withdrawal on this account. An early withdrawal is defined as a withdrawal prior to the next_withdrawal_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
layouttitle
schemaadjustment

Adjustment Schema


An adjustment represents a modification to a report.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
col
The column of the report that this adjustment relates to.
string-
comment
The description or commentary around the adjustment.
string-
contribution_amount
The contribution amount this adjustment should make to the specified report cell. A positive/negative number in minor units (cents/pence).
integer-
contribution_text
The text to use for the adjustment where the reported cell is not a monetary value.
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
page
The page of the report that this adjustment relates to.
string-
report_type
The report that this adjustment relates to.
string-
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
row
The row of the report that this adjustment relates to.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaagreement

Agreement Schema


An agreement represents the standard terms agreed between two parties.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
base_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
credit_support_type
The type of credit support document
string
csa_isda_1994csa_isda_1995csd_isda_1995scsa_isda_2013
customer_id
The unique identifier used by the financial institution to identify the counterparty to this agreement.
string-
guarantor_id
The unique identifier used by the financial institution to identify the guarantor of the transactions covered by this agreement.
string-
margin_frequency
Indicates the periodic timescale at which variation margin is exchanged. Cleared derivatives which are daily settled can be flagged as daily_settled.
string
dailydaily_settledweeklybi_weeklymonthly
margin_period_of_risk
Margin period of risk estimated for the transactions covered by the [CSA] agreement
integer-
minimum_transfer_amount
Smallest amount of collateral that can be transferred. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
netting_restriction
populated only if any netting restriction applies, in relation to the nature of the agreement or the enforceability of netting in the jurisdiction of the counterparty, preventing the recognition of the agreement as risk-reducing, pursuant to CRR Articles 295 to 298
string
national_supervisionno_right_to_offsetrestrictive_covenant
number_of_disputes
Indicates the number of disputes threshold to be used in the margin period of risk
integer-
source
The source where this data originated.
string-
start_date
The timestamp that the agreement commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
stay_protocol
Indicates whether a stay protocol has been signed by one or both parties to the agreement.
string
bothcustomerself_signed
threshold
Amount below which collateral is not required. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
type
The type of the master agreement.
string
afbdrvemafbfgmragmslaicma_1992icma_1995icma_2000icma_2011isdaisda_1985isda_1986isda_1987isda_1992isda_2002otherother_gmraother_isdaright_to_set_off
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemacollateral

Collateral Schema


Data schema to define collateral (currently can reference loans or accounts).

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
account_ids
The unique identifier/s for the account/s within the financial institution.
array-
charge
Lender charge on collateral, 1 indicates first charge, 2 second and so on. 0 indicates a combination of charge levels.
integer-
city
The city in which the property is located.
string-
claims
The total amount of 3rd party claims on the collateral.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
encumbrance_amount
The amount of the collateral that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
encumbrance_type
The type of the encumbrance causing the encumbrance_amount.
string
covered_bondderivativenoneotherreal_estaterepo
end_date
The end date for recognition of the collateral
string-
loan_ids
The unique identifiers for the loans within the financial institution.
array-
orig_value
The valuation as used by the bank for the collateral at the origination of the related loan or line of credit. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
postal_code
The zip code in which the property is located. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
regulated
Identifies whether the collateral qualifies the exposure as ‘regulatory’ for credit risk purposes.
boolean-
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
security_id
The unique identifier used by the financial institution to identify the security representing collateral.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
start_date
The start date for recognition of the collateral
string-
street_address
The street address associated with the property. Must include street direction prefixes, direction suffixes, and unit number for condos and co-ops. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
type
The collateral type defines the form of the collateral provided
string
autoauto_otherblanket_liencarcashco_opcommercial_propertycommercial_property_hrcondoconvertibledebenturefarmfour_unitsguaranteehealthcarehospitalityimmovable_propertyindustriallife_policyluxurymanufactured_housemultifamilyofficeone_unitotherplanned_unit_devres_property_hrresi_mixed_useresidential_propertyretailsecuritysingle_familysportsuvthree_unitstownhousetrucktwo_unitsvanwarehouse
value
The valuation as used by the bank for the collateral on the value_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
value_date
The timestamp that the collateral was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
vol_adj
The volatility adjustment appropriate to the collateral.
number-
vol_adj_fx
The volatility adjustment appropriate to currency mismatch.
number-
layouttitle
schemacurve

Curve Schema


A Curve represents a series of points on a plot. Typically, interest rates, volatility or forward prices.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
name
The internal name of the curve.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
type
The curve type.
string
behavioralraterisk_ratingvolatility
values
The list of values for this curve.
array-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemacustomer

Customer Schema


Data schema to define a customer or legal entity related to a financial product or transaction.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
address_city
City, town or village.
string-
address_county
The county or administrative region (e.g. NUTS code) for an entity’s address.
string-
address_street
Street address for the Entity.
string-
bankruptcy_date
The date the bankruptcy proceedings were initiated. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
bankruptcy_type
The bankruptcy chapter of the borrower.
string
chapter_11chapter_12chapter_13chapter_7chapter_9court_administrationinsolvencyother
birr_curve_id
The ID of the curve containing historical Borrower Internal Risk Ratings (BIRR) for this entity. The curve must be of type ‘risk_rating’.
string-
birr_id
The unique identifier of the Borrower Internal Risk Rating (BIRR), representing an internally assigned risk assessment for a customer based on their creditworthiness and financial stability.
string-
boe_industry_code
Bank of England industry code.
string-
boe_sector_code
Bank of England sector code.
string-
count
Describes the number of entities represented by this record. eg. joint customers should have a count > 1.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cqs_irb
The credit quality step for internal ratings based approach.
integer-
cqs_standardised
The credit quality step for standardised approach.
integer-
credit_impaired
Flag to determine if the entity credit quality is impaired.
boolean-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
dbrs_lt
DBRS long term credit ratings
string
aaaaa_haaaa_la_haa_lbbb_hbbbbbb_lbb_hbbbb_lb_hbb_lccc_hcccccc_lcccd
dbrs_st
DBRS short term credit ratings
string
r1_hr1_mr1_lr2_hr2_mr2_lr3r4r5d
fitch_lt
Fitch long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccrdd
fitch_st
Fitch short term credit ratings
string
f1_plusf1f2f3bcrdd
head_office_id
The unique identifier for the head office of the legal entity.
string-
headcount
The number of full time staff.
integer-
internal_rating
Categorization of unrated exposure
string
investmentnon_investment
intra_group
Flag to indicate that this should be considered an intra-group entity.
boolean-
kbra_lt
KBRA long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
kbra_st
KBRA short term credit ratings
string
k1_plusk1k2k3bcd
legal_entity_name
The official legal name of the entity.
string-
lei_code
The LEI code for the legal entity (for corporates).
string-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
moodys_lt
Moody’s long term credit ratings
string
aaaaa1aa2aa3a1a2a3baa1baa2baa3ba1ba2ba3b1b2b3caa1caa2caa3cac
moodys_st
Moodys short term credit ratings
string
p1p2p3np
nace_code
The EU NACE economic activity classification.
string
A.01.10A.01.11A.01.12A.01.13A.01.14A.01.15A.01.16A.01.19A.01.20A.01.21A.01.22A.01.23A.01.24A.01.25A.01.26A.01.27A.01.28A.01.29A.01.30A.01.40A.01.41A.01.42A.01.43A.01.44A.01.45A.01.46A.01.47A.01.49A.01.50A.01.60A.01.61A.01.62A.01.63A.01.64A.01.70A.02.10A.02.20A.02.30A.02.40A.03.10A.03.11A.03.12A.03.20A.03.21A.03.22B.05.10B.05.20B.06.10B.06.20B.07.10B.07.20B.07.21B.07.29B.08.10B.08.11B.08.12B.08.90B.08.91B.08.92B.08.93B.08.99B.09.10B.09.90C.10.10C.10.11C.10.12C.10.13C.10.20C.10.30C.10.31C.10.32C.10.39C.10.40C.10.41C.10.42C.10.50C.10.51C.10.52C.10.60C.10.61C.10.62C.10.70C.10.71C.10.72C.10.73C.10.80C.10.81C.10.82C.10.83C.10.84C.10.85C.10.86C.10.89C.10.90C.10.91C.10.92C.11.00C.11.01C.11.02C.11.03C.11.04C.11.05C.11.06C.11.07C.12.00C.13.10C.13.20C.13.30C.13.90C.13.91C.13.92C.13.93C.13.94C.13.95C.13.96C.13.99C.14.10C.14.11C.14.12C.14.13C.14.14C.14.19C.14.20C.14.30C.14.31C.14.39C.15.10C.15.11C.15.12C.15.20C.16.10C.16.20C.16.21C.16.22C.16.23C.16.24C.16.26C.16.27C.16.28C.16.29C.17.10C.17.11C.17.12C.17.20C.17.21C.17.22C.17.23C.17.24C.17.25C.17.29C.18.10C.18.11C.18.12C.18.13C.18.14C.18.20C.19.10C.19.20C.20.10C.20.11C.20.12C.20.13C.20.14C.20.15C.20.16C.20.17C.20.20C.20.30C.20.40C.20.41C.20.42C.20.50C.20.51C.20.52C.20.53C.20.59C.20.60C.21.10C.21.20C.22.10C.22.11C.22.19C.22.20C.22.21C.22.22C.22.23C.22.29C.23.10C.23.11C.23.12C.23.13C.23.14C.23.19C.23.20C.23.30C.23.31C.23.32C.23.40C.23.41C.23.42C.23.43C.23.44C.23.49C.23.50C.23.51C.23.52C.23.60C.23.61C.23.62C.23.63C.23.64C.23.65C.23.69C.23.70C.23.90C.23.91C.23.99C.24.10C.24.20C.24.30C.24.31C.24.32C.24.33C.24.34C.24.40C.24.41C.24.42C.24.43C.24.44C.24.45C.24.46C.24.50C.24.51C.24.52C.24.53C.24.54C.25.10C.25.11C.25.12C.25.20C.25.21C.25.29C.25.30C.25.40C.25.50C.25.60C.25.61C.25.62C.25.70C.25.71C.25.72C.25.73C.25.90C.25.91C.25.92C.25.93C.25.94C.25.99C.26.10C.26.11C.26.12C.26.20C.26.30C.26.40C.26.50C.26.51C.26.52C.26.60C.26.70C.26.80C.27.10C.27.11C.27.12C.27.20C.27.30C.27.31C.27.32C.27.33C.27.40C.27.50C.27.51C.27.52C.27.90C.28.10C.28.11C.28.12C.28.13C.28.14C.28.15C.28.20C.28.21C.28.22C.28.23C.28.24C.28.25C.28.29C.28.30C.28.40C.28.41C.28.49C.28.90C.28.91C.28.92C.28.93C.28.94C.28.95C.28.96C.28.99C.29.10C.29.20C.29.30C.29.31C.29.32C.30.10C.30.11C.30.12C.30.20C.30.30C.30.40C.30.90C.30.91C.30.92C.30.99C.31.00C.31.01C.31.02C.31.03C.31.09C.32.10C.32.11C.32.12C.32.13C.32.20C.32.30C.32.40C.32.50C.32.90C.32.91C.32.99C.33.10C.33.11C.33.12C.33.13C.33.14C.33.15C.33.16C.33.17C.33.19C.33.20D.35.10D.35.11D.35.12D.35.13D.35.14D.35.16D.35.20D.35.21D.35.22D.35.23D.35.30E.36.00E.37.00E.38.10E.38.11E.38.12E.38.20E.38.21E.38.22E.38.30E.38.31E.38.32E.39.00F.41.10F.41.20F.42.10F.42.11F.42.12F.42.13F.42.20F.42.21F.42.22F.42.90F.42.91F.42.99F.43.10F.43.11F.43.12F.43.13F.43.20F.43.21F.43.22F.43.29F.43.30F.43.31F.43.32F.43.33F.43.34F.43.39F.43.90F.43.91F.43.99G.45.10G.45.11G.45.19G.45.20G.45.30G.45.31G.45.32G.45.40G.46.10G.46.11G.46.12G.46.13G.46.14G.46.15G.46.16G.46.17G.46.18G.46.19G.46.20G.46.21G.46.22G.46.23G.46.24G.46.30G.46.31G.46.32G.46.33G.46.34G.46.35G.46.36G.46.37G.46.38G.46.39G.46.40G.46.41G.46.42G.46.43G.46.44G.46.45G.46.46G.46.47G.46.48G.46.49G.46.50G.46.51G.46.52G.46.60G.46.61G.46.62G.46.63G.46.64G.46.65G.46.66G.46.69G.46.70G.46.71G.46.72G.46.73G.46.74G.46.75G.46.76G.46.77G.46.90G.47.10G.47.11G.47.19G.47.20G.47.21G.47.22G.47.23G.47.24G.47.25G.47.26G.47.29G.47.30G.47.40G.47.41G.47.42G.47.43G.47.50G.47.51G.47.52G.47.53G.47.54G.47.59G.47.60G.47.61G.47.62G.47.63G.47.64G.47.65G.47.70G.47.71G.47.72G.47.73G.47.74G.47.75G.47.76G.47.77G.47.78G.47.79G.47.80G.47.81G.47.82G.47.89G.47.90G.47.91G.47.99H.49.10H.49.11H.49.12H.49.20H.49.30H.49.31H.49.32H.49.33H.49.34H.49.39H.49.40H.49.41H.49.42H.49.50H.50.10H.50.20H.50.30H.50.40H.51.10H.51.20H.51.21H.51.22H.52.10H.52.20H.52.21H.52.22H.52.23H.52.24H.52.25H.52.26H.52.29H.52.30H.52.31H.52.32H.53.10H.53.20H.53.30I.55.10I.55.20I.55.30I.55.40I.55.90I.56.10I.56.11I.56.12I.56.20I.56.21I.56.22I.56.29I.56.30I.56.40J.58.10J.58.11J.58.12J.58.13J.58.14J.58.19J.58.20J.58.21J.58.29J.59.10J.59.11J.59.12J.59.13J.59.14J.59.20J.60.10J.60.20J.60.30J.60.31J.60.39J.61.10J.61.20J.61.30J.61.90J.62.00J.62.01J.62.02J.62.03J.62.09J.63.10J.63.11J.63.12J.63.90J.63.91J.63.99K.61.10K.61.20K.61.90K.62.10K.62.20K.62.90K.63.10K.63.90K.63.91K.63.92K.64.10K.64.11K.64.19K.64.20K.64.30K.64.90K.64.91K.64.92K.64.99K.65.10K.65.11K.65.12K.65.20K.65.30K.66.10K.66.11K.66.12K.66.19K.66.20K.66.21K.66.22K.66.29K.66.30L.64.10L.64.11L.64.19L.64.20L.64.21L.64.22L.64.30L.64.31L.64.32L.64.90L.64.91L.64.92L.64.99L.65.10L.65.11L.65.12L.65.20L.65.30L.66.10L.66.11L.66.12L.66.19L.66.20L.66.21L.66.22L.66.29L.66.30L.68.10L.68.20L.68.30L.68.31L.68.32M.68.10M.68.11M.68.12M.68.20M.68.30M.68.31M.68.32M.69.10M.69.20M.70.10M.70.20M.70.21M.70.22M.71.10M.71.11M.71.12M.71.20M.72.10M.72.11M.72.19M.72.20M.73.10M.73.11M.73.12M.73.20M.74.10M.74.20M.74.30M.74.90M.75.00N.69.10N.69.20N.70.10N.70.20N.71.10N.71.11N.71.12N.71.20N.72.10N.72.20N.73.10N.73.11N.73.12N.73.20N.73.30N.74.10N.74.11N.74.12N.74.13N.74.14N.74.20N.74.30N.74.90N.74.91N.74.99N.75.00N.77.10N.77.11N.77.12N.77.20N.77.21N.77.22N.77.29N.77.30N.77.31N.77.32N.77.33N.77.34N.77.35N.77.39N.77.40N.78.10N.78.20N.78.30N.79.10N.79.11N.79.12N.79.90N.80.10N.80.20N.80.30N.81.10N.81.20N.81.21N.81.22N.81.29N.81.30N.82.10N.82.11N.82.19N.82.20N.82.30N.82.90N.82.91N.82.92N.82.99O.77.10O.77.11O.77.12O.77.20O.77.21O.77.22O.77.30O.77.31O.77.32O.77.33O.77.34O.77.35O.77.39O.77.40O.77.50O.77.51O.77.52O.78.10O.78.20O.79.10O.79.11O.79.12O.79.90O.80.00O.80.01O.80.09O.80.10O.80.20O.80.30O.81.10O.81.20O.81.21O.81.22O.81.23O.81.30O.82.10O.82.20O.82.30O.82.40O.82.90O.82.91O.82.92O.82.99O.84.10O.84.11O.84.12O.84.13O.84.20O.84.21O.84.22O.84.23O.84.24O.84.25O.84.30P.84.10P.84.11P.84.12P.84.13P.84.20P.84.21P.84.22P.84.23P.84.24P.84.25P.84.30P.85.10P.85.20P.85.30P.85.31P.85.32P.85.40P.85.41P.85.42P.85.50P.85.51P.85.52P.85.53P.85.59P.85.60Q.85.10Q.85.20Q.85.30Q.85.31Q.85.32Q.85.33Q.85.40Q.85.50Q.85.51Q.85.52Q.85.53Q.85.59Q.85.60Q.85.61Q.85.69Q.86.10Q.86.20Q.86.21Q.86.22Q.86.23Q.86.90Q.87.10Q.87.20Q.87.30Q.87.90Q.88.10Q.88.90Q.88.91Q.88.99R.86.10R.86.20R.86.21R.86.22R.86.23R.86.90R.86.91R.86.92R.86.93R.86.94R.86.95R.86.96R.86.97R.86.99R.87.10R.87.20R.87.30R.87.90R.87.91R.87.99R.88.10R.88.90R.88.91R.88.99R.90.00R.90.01R.90.02R.90.03R.90.04R.91.01R.91.02R.91.03R.91.04R.92.00R.93.10R.93.11R.93.12R.93.13R.93.19R.93.20R.93.21R.93.29S.90.00S.90.10S.90.11S.90.12S.90.13S.90.20S.90.30S.90.31S.90.39S.91.10S.91.11S.91.12S.91.20S.91.21S.91.22S.91.30S.91.40S.91.41S.91.42S.92.00S.93.10S.93.11S.93.12S.93.13S.93.19S.93.20S.93.21S.93.29S.94.10S.94.11S.94.12S.94.20S.94.90S.94.91S.94.92S.94.99S.95.10S.95.11S.95.12S.95.20S.95.21S.95.22S.95.23S.95.24S.95.25S.95.29S.96.00S.96.01S.96.02S.96.03S.96.04S.96.09T.94.10T.94.11T.94.12T.94.20T.94.90T.94.91T.94.92T.94.99T.95.10T.95.20T.95.21T.95.22T.95.23T.95.24T.95.25T.95.29T.95.30T.95.31T.95.32T.95.40T.96.00T.96.10T.96.20T.96.21T.96.22T.96.23T.96.30T.96.40T.96.90T.96.91T.96.99T.97.00T.98.10T.98.20U.97.00U.98.10U.98.20U.99.00V.99.00
naics_code
North American Industry Classification System - NAICS Code
integer-
name
The name of the person or legal entity to be used for display and reference purposes.
string-
national_reporting_code
Unique identifier established by the national reporting system
string-
parent_id
The unique identifier for the immediate parent of the person or legal entity.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
postal_code
The post (zip) code in which the entity is domiciled.
string-
relationship
Relationship to parent.
string
branchhead_officejvparentparent_branchparent_subsidiaryparticipationsubsidiary
reporting_relationship
Relationship to reporting entity. See: relationship.
string
branchhead_officejvparentparent_branchparent_subsidiaryparticipationsubsidiary
riad_code
RIAD code is the unique counterparty identifier for all counterparties when reported from the NCBs to the ECB;
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_group_id
The unique identifier for the group representing a single risk entity where no relationship of control exists
string-
risk_group_id_2
The secondary identifier for the secondary group representing a single risk entity where no relationship of control exists
string-
scra
Grade calculated using the Basel Standardised Credit Risk Assessment
string
aa_plusbc
sic_code
Standard Industrial Classification (SIC) system. The applicable reference depends on jurisdiction.
integer-
snp_lt
S&P long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
snp_st
S&P short term credit ratings
string
a1a2a3bcd
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
ssic_code
The Singaporean standard industry and sector classification.
integer-
total_assets
The annual balance sheet total of the entity as at the last accounting reference date.
integer-
turnover
The annual turnover of the entity as at the last accounting reference date.
integer-
type
The designated financial or legal entity category this person or legal entity falls under
string
building_societyccpcentral_bankcentral_govtcharityciucommunity_charitycorporatecredit_institutioncredit_uniondeposit_brokerexport_credit_agencyfederal_credit_unionfinancialfinancial_holdingfundhedge_fundhousing_coopindividualinsurerintl_orginvestment_firmlocal_authoritymdbmmkt_fundnational_banknatural_personnon_member_bankotherother_financialother_psepartnershippension_fundpicpmiprivate_equity_fundprivate_fundpromo_fed_home_loanpromo_fed_reservepromotional_lenderproperty_spepsepublic_corporationqccpreal_estate_fundregional_govtsmesocial_housing_entitysocial_security_fundsovereignsspestate_credit_unionstate_member_bankstate_owned_bankstatutory_boardsupported_smeunincorp_inv_fundunincorporated_bizunregulated_financial
ultimate_parent_id
The unique identifier for the ultimate parent of the person or legal entity.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
annual_debit_turnover
The annual debit turnover in the business account of the entity. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
clearing_threshold
Status of the clearing threshold as defined in EMIR
string
abovebelow
df_ccp
The pre-funded financial resources of the CCP in accordance with Article 50c of Regulation (EU) No 648/2012
integer-
df_cm
The sum of pre-funded contributions of all clearing members of the QCCP in accordance with Article 50c of Regulation (EU) No 648/2012.
integer-
incurred_cva
The amount of credit valuation adjustments being recognised by the institution as an incurred write-down, calculated without taking into account any offsetting debit value adjustment attributed to the firm’s own credit risk, that has been already excluded from own funds.
integer-
k_ccp
Hypothetical capital of the QCCP in accordance with Article 50c of Regulation (EU) No 648/2012
integer-
mic_code
The market identifier code as defined by the International Standards Organisation.
string-
product_count
The number of active products/trades this customer has with the firm.
integer-
risk_profile
The evaluation of the customer’s willingness and/or capacity to take on financial risk.
integer-
start_date
The date that the customer first became a customer. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
The status of the relationship with the customer from the firm’s point of view.
string
established
layouttitle
schemaderivative

Derivative Schema


A derivative is a contract which derives its value from an underlying reference index, security or asset.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrued_interest
The accrued interest since the last payment date and due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_class
The asset class to which the derivative belongs.
string
agricoco_othercoalcoffeecorncrcr_indexcr_singleelectricityenergyeqeq_indexeq_singlefxgasgoldinflationirmetalsoilotherpalladiumplatinumprecious_metalssilversugar
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
Outstanding amount including accrued interest. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the rate on the balance at the given date as agreed in the terms of the financial product.
string
FDTRFESRUKBRBASEUSTSRZERObbswbbsw_3meuriboreuribor_1meuribor_3meuribor_6motherpbocsofrsofr_1msofr_3msofr_6m
break_dates
Dates where this contract can be broken (by either party). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_dates
Dates where this contract can be called (by the customer). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
ccr_approach
Specifies the approved counterparty credit risk methodology for calculating exposures.
string
immoemsassa
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
csa_id
The unique identifier of the credit support annex for this derivative
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer for this product.
string-
deal_id
The unique identifier used by the financial institution for the deal to which this derivative belongs.
string-
default_date
Date of default.
string-
delta
Price sensitivity to the underlying.
number-
ead
The EAD field allows users to input monetary exposure-at-default values across the derivative’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
end_date
YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
first_payment_date
The first payment date for interest payments.
string-
frr_id
The internal risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
gamma
Second-order price sensitivity to the underlying or rate of change of the delta.
number-
hedge_designation
ASU 2017-12 hedge designations allowed in conjunction with partial-term hedging election in ASC 815-20-25-12b(2)(ii). These designations are described in ASC 815-20-25-12A and 815-25-35-13B.
https://asc.fasb.org/1943274/2147480682/815-20-25-12A
https://asc.fasb.org/1943274/2147480295/815-25-35-13B
string
cash_flowslast_of_layer
hedge_id
Unique identifier that establishes a relational link between a security and its associated derivative hedge. Enables consistent tracking, aggregation, and reconciliation of hedged positions across systems and datasets.
string-
hedge_sidedness
Whether the hedging instrument provides a one-sided effective offset of the hedged risk, as permitted under ASC 815-20-25-76.
https://asc.fasb.org/1943274/2147480682/815-20-25-76
string
one_sidedtwo_sided
hedge_type
The type of hedge (fair value or cash flow hedge) associated with the holding. Whether it is hedging individually or is hedging as part of a portfolio of assets with similar risk that are hedged as a group in line with ASC 815-20-25-12 (b), ASC 815-20-2512A, or ASC 815-10-25-15.
https://asc.fasb.org/1943274/2147480682/815-20-25-12
https://asc.fasb.org/1943274/2147480682/815-20-25-12A
https://asc.fasb.org/1943274/2147480682/815-10-25-15
string
cf_hedgefv_hedgeportfolio_cf_hedgeportfolio_fv_hedge
hedged_cf_type
The type of cash flow associated with the hedge if it is a cash flow hedge. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string
interest_onlyotherpartialprincipal_interestprincipal_only
hedged_risk
The risk being hedged, among the potential hedged risks described under ASC 815-20-25-12 and ASC 815-20-25-15.
https://asc.fasb.org/1943274/2147480682/815-20-25-12
https://asc.fasb.org/1943274/2147480682/815-20-25-15
string
crfv_optionfxfx_cririr_crir_fxir_fx_crotheroverall_fv_cf
impairment_amount
The impairment amount for a security is the allowance set aside by the firm for losses.
integer-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
implied_vol
Options: implied volatility used to compute mtm and greeks.
number-
initial_margin
Upfront margin posted/received for the trade. Monetary type as integer number of cents.
integer-
insolvency_rank
The insolvency ranking as per the national legal framework of the reporting institution.
integer-
last_exercise_date
The last date on which an option can be exercised. For European options, it is the option exercise date
string-
last_payment_date
The final payment date for interest payments, often coincides with end_date.
string-
ledger_code
The internal ledger code or line item name.
string-
leg_type
Describe the payoff type of the derivative leg.
string
callfixedfloatingindexedput
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations.
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
mic_code
The market identifier code as defined by the International Standards Organisation.
string-
mna_id
The unique identifier of the Master Netting Agreement for this derivative
string-
mtm_clean
The mark-to-market value of the derivative excluding interest. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
mtm_dirty
The mark-to-market value of the derivative including interest. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
next_exercise_date
The next date at which the option can be exercised.
string-
next_payment_amount
The amount that will need to be paid at the next_payment_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_receive_amount
The amount that is expected to be received at the next_receive_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
next_receive_date
The next date at which interest will be received or accrued_interest balance returned to zero.
string-
next_reset_date
The date on which the periodic payment term and conditions of a contract agreement are reset/re-established.
string-
notional_amount
The notional value is the total value with regard to a derivative’s underlying index, security or asset at its spot price in accordance with the specifications (i.e. leverage) of the derivative product. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
on_balance_sheet
Is the derivative reported on the balance sheet of the financial institution?
boolean-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
position
Specifies the market position, i.e. long or short, of the derivative leg
string
longshort
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
purpose
The purpose for which the derivative is being held.
string
back_to_backclient_executionclient_transmissioncva_hedgereference
rate
The full interest rate applied to the derivative notional in percentage terms. Note that this therefore includes the base_rate (ie. not the spread).
number-
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
resolution_date
Date of resolution of the defaulted facility.
string-
rho
Price sensitivity to interest rates.
number-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_weight_irb
The internal risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
settlement_type
The type of settlement for the contract.
string
cashphysical
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
spread
The additional rate that is added to the relevant index. The paid-spread-over-index rate plus the difference between the fixed coupon on the underlying note and the received fixed rate on the swap. This is represented in basis points (bps). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
start_date
Contract effective or commencement date; security issue date. Format YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Provides additional information regarding the status of the derivative.
string
free_deliveriesunsettled
strike
Strike price of the option, which is compared to the underlying price on the option exercise date.
number-
supervisory_price
Current price/value of the underlying of an option when different from underlying_price, e.g. for Asian-style options.
number-
theta
Price sensitivity with respect to time.
number-
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
type
This is the type of the derivative with regards to common regulatory classifications.
string
cap_floorccdscdsforwardfrafuturemtm_swapndfndsoisoptionspotswaptionvanilla_swapvariance_swapxccy
underlying_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
underlying_derivative_id
The unique identifier used by the financial institution to identify the underlying reference derivative for this derivative.
string-
underlying_index
The name of a derivative contract underlying which can be used for all derivative asset classes (e.g. interest rate index, credit index, equity index
string-
underlying_index_tenor
The designated maturity of the underlying interest rate index used in the underlying_index property for interest rate derivatives
string
1d7d28d91d182d1m2m3m4m5m6m7m8m9m12m24m60m120m360m
underlying_issuer_id
The unique identifier used by the financial institution to identify the underlying reference issuer for this derivative.
string-
underlying_price
Current price/value of the underlying.
number-
underlying_quantity
Number of underlying units related to the underlying_price
number-
underlying_security_id
The unique identifier used by the financial institution to identify the underlying reference security for this derivative.
string-
underlying_strike
Strike price of the option, which is compared to the underlying price on the option exercise date.
number-
value_date
The timestamp that the derivative was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
vega
Price sensitivity to volatility.
number-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaderivative_cash_flow

Derivative Cash Flow Schema


A derivative cash flow where two parties exchange cash flows (or assets) derived from an underlying reference index, security or financial instrument.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
accrued_interest
The accrued interest/premium due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_class
The asset class to which the derivative belongs.
string
agricoco_othercoalcoffeecorncrcr_indexcr_singleelectricityenergyeqeq_indexeq_singlefxgasgoldinflationirmetalsoilotherpalladiumplatinumprecious_metalssilversugar
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
The contractual balance due on the payment date in the currency given. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
csa_id
The unique identifier of the credit support annex for this derivative cash flow
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
Counterparty to the cash flow
string-
derivative_id
Unique identifier to the derivative to which this cash flow relates
string-
forward_rate
Rate used to set a variable cash flow on the reset_date
number-
leg
The type of the payment leg.
string
payreceive
mna_id
The unique identifier of the Master Netting Agreement for this derivative cash flow.
string-
mtm_clean
The mark-to-market value of the derivative cash flow excluding interest/premium/coupons. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
mtm_dirty
The mark-to-market value of the derivative cash flow including interest/premium/coupons. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
notional_amount
The notional value is the total value with regard to a derivative’s underlying index, security or asset at its spot price in accordance with the specifications (i.e. leverage) of the derivative product. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
on_balance_sheet
Is the financial product reported on the balance sheet of the financial institution?
boolean-
payment_date
The timestamp that the cash flow will occur or was paid. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
purpose
The purpose for which the derivative cash flow is calculated
string
interestprincipalreference
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
reset_date
Date on which a variable cash flow amount is set. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
settlement_type
The type of settlement for the contract.
string
cashphysical
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
trade_date
The date that the derivative cash flow terms were agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
value_date
The timestamp that the cash flow was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaexample

Example Schema


FIRE schema for representing and validating FIRE examples

Properties

NameDescriptionTypeEnum
comment
Additional comments describing the FIRE example
string-
data
An object of FIRE data lists, with data types as keys
object-
title
Title of the FIRE product example
string-
layouttitle
schemaexchange_rate

Exchange Rate Schema


An Exchange Rate represents the conversion rate between two currencies.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
base_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
quote
The amount of the quote currency received in exchange for 1 unit of the base currency.
number-
quote_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaguarantor

Guarantor Schema


Data schema to define a guarantor for a security.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
address_city
City, town or village.
string-
address_county
The county or administrative region (e.g. NUTS code) for an entity’s address.
string-
address_street
Street address for the Entity.
string-
bankruptcy_date
The date the bankruptcy proceedings were initiated. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
bankruptcy_type
The bankruptcy chapter of the borrower.
string
chapter_11chapter_12chapter_13chapter_7chapter_9court_administrationinsolvencyother
birr_curve_id
The ID of the curve containing historical Borrower Internal Risk Ratings (BIRR) for this entity. The curve must be of type ‘risk_rating’.
string-
birr_id
The unique identifier of the Borrower Internal Risk Rating (BIRR), representing an internally assigned risk assessment for a customer based on their creditworthiness and financial stability.
string-
boe_industry_code
Bank of England industry code.
string-
boe_sector_code
Bank of England sector code.
string-
count
Describes the number of entities represented by this record. eg. joint customers should have a count > 1.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cqs_irb
The credit quality step for internal ratings based approach.
integer-
cqs_standardised
The credit quality step for standardised approach.
integer-
credit_impaired
Flag to determine if the entity credit quality is impaired.
boolean-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
dbrs_lt
DBRS long term credit ratings
string
aaaaa_haaaa_la_haa_lbbb_hbbbbbb_lbb_hbbbb_lb_hbb_lccc_hcccccc_lcccd
dbrs_st
DBRS short term credit ratings
string
r1_hr1_mr1_lr2_hr2_mr2_lr3r4r5d
fitch_lt
Fitch long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccrdd
fitch_st
Fitch short term credit ratings
string
f1_plusf1f2f3bcrdd
head_office_id
The unique identifier for the head office of the legal entity.
string-
headcount
The number of full time staff.
integer-
internal_rating
Categorization of unrated exposure
string
investmentnon_investment
intra_group
Flag to indicate that this should be considered an intra-group entity.
boolean-
kbra_lt
KBRA long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
kbra_st
KBRA short term credit ratings
string
k1_plusk1k2k3bcd
legal_entity_name
The official legal name of the entity.
string-
lei_code
The LEI code for the legal entity (for corporates).
string-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
moodys_lt
Moody’s long term credit ratings
string
aaaaa1aa2aa3a1a2a3baa1baa2baa3ba1ba2ba3b1b2b3caa1caa2caa3cac
moodys_st
Moodys short term credit ratings
string
p1p2p3np
nace_code
The EU NACE economic activity classification.
string
A.01.10A.01.11A.01.12A.01.13A.01.14A.01.15A.01.16A.01.19A.01.20A.01.21A.01.22A.01.23A.01.24A.01.25A.01.26A.01.27A.01.28A.01.29A.01.30A.01.40A.01.41A.01.42A.01.43A.01.44A.01.45A.01.46A.01.47A.01.49A.01.50A.01.60A.01.61A.01.62A.01.63A.01.64A.01.70A.02.10A.02.20A.02.30A.02.40A.03.10A.03.11A.03.12A.03.20A.03.21A.03.22B.05.10B.05.20B.06.10B.06.20B.07.10B.07.20B.07.21B.07.29B.08.10B.08.11B.08.12B.08.90B.08.91B.08.92B.08.93B.08.99B.09.10B.09.90C.10.10C.10.11C.10.12C.10.13C.10.20C.10.30C.10.31C.10.32C.10.39C.10.40C.10.41C.10.42C.10.50C.10.51C.10.52C.10.60C.10.61C.10.62C.10.70C.10.71C.10.72C.10.73C.10.80C.10.81C.10.82C.10.83C.10.84C.10.85C.10.86C.10.89C.10.90C.10.91C.10.92C.11.00C.11.01C.11.02C.11.03C.11.04C.11.05C.11.06C.11.07C.12.00C.13.10C.13.20C.13.30C.13.90C.13.91C.13.92C.13.93C.13.94C.13.95C.13.96C.13.99C.14.10C.14.11C.14.12C.14.13C.14.14C.14.19C.14.20C.14.30C.14.31C.14.39C.15.10C.15.11C.15.12C.15.20C.16.10C.16.20C.16.21C.16.22C.16.23C.16.24C.16.26C.16.27C.16.28C.16.29C.17.10C.17.11C.17.12C.17.20C.17.21C.17.22C.17.23C.17.24C.17.25C.17.29C.18.10C.18.11C.18.12C.18.13C.18.14C.18.20C.19.10C.19.20C.20.10C.20.11C.20.12C.20.13C.20.14C.20.15C.20.16C.20.17C.20.20C.20.30C.20.40C.20.41C.20.42C.20.50C.20.51C.20.52C.20.53C.20.59C.20.60C.21.10C.21.20C.22.10C.22.11C.22.19C.22.20C.22.21C.22.22C.22.23C.22.29C.23.10C.23.11C.23.12C.23.13C.23.14C.23.19C.23.20C.23.30C.23.31C.23.32C.23.40C.23.41C.23.42C.23.43C.23.44C.23.49C.23.50C.23.51C.23.52C.23.60C.23.61C.23.62C.23.63C.23.64C.23.65C.23.69C.23.70C.23.90C.23.91C.23.99C.24.10C.24.20C.24.30C.24.31C.24.32C.24.33C.24.34C.24.40C.24.41C.24.42C.24.43C.24.44C.24.45C.24.46C.24.50C.24.51C.24.52C.24.53C.24.54C.25.10C.25.11C.25.12C.25.20C.25.21C.25.29C.25.30C.25.40C.25.50C.25.60C.25.61C.25.62C.25.70C.25.71C.25.72C.25.73C.25.90C.25.91C.25.92C.25.93C.25.94C.25.99C.26.10C.26.11C.26.12C.26.20C.26.30C.26.40C.26.50C.26.51C.26.52C.26.60C.26.70C.26.80C.27.10C.27.11C.27.12C.27.20C.27.30C.27.31C.27.32C.27.33C.27.40C.27.50C.27.51C.27.52C.27.90C.28.10C.28.11C.28.12C.28.13C.28.14C.28.15C.28.20C.28.21C.28.22C.28.23C.28.24C.28.25C.28.29C.28.30C.28.40C.28.41C.28.49C.28.90C.28.91C.28.92C.28.93C.28.94C.28.95C.28.96C.28.99C.29.10C.29.20C.29.30C.29.31C.29.32C.30.10C.30.11C.30.12C.30.20C.30.30C.30.40C.30.90C.30.91C.30.92C.30.99C.31.00C.31.01C.31.02C.31.03C.31.09C.32.10C.32.11C.32.12C.32.13C.32.20C.32.30C.32.40C.32.50C.32.90C.32.91C.32.99C.33.10C.33.11C.33.12C.33.13C.33.14C.33.15C.33.16C.33.17C.33.19C.33.20D.35.10D.35.11D.35.12D.35.13D.35.14D.35.16D.35.20D.35.21D.35.22D.35.23D.35.30E.36.00E.37.00E.38.10E.38.11E.38.12E.38.20E.38.21E.38.22E.38.30E.38.31E.38.32E.39.00F.41.10F.41.20F.42.10F.42.11F.42.12F.42.13F.42.20F.42.21F.42.22F.42.90F.42.91F.42.99F.43.10F.43.11F.43.12F.43.13F.43.20F.43.21F.43.22F.43.29F.43.30F.43.31F.43.32F.43.33F.43.34F.43.39F.43.90F.43.91F.43.99G.45.10G.45.11G.45.19G.45.20G.45.30G.45.31G.45.32G.45.40G.46.10G.46.11G.46.12G.46.13G.46.14G.46.15G.46.16G.46.17G.46.18G.46.19G.46.20G.46.21G.46.22G.46.23G.46.24G.46.30G.46.31G.46.32G.46.33G.46.34G.46.35G.46.36G.46.37G.46.38G.46.39G.46.40G.46.41G.46.42G.46.43G.46.44G.46.45G.46.46G.46.47G.46.48G.46.49G.46.50G.46.51G.46.52G.46.60G.46.61G.46.62G.46.63G.46.64G.46.65G.46.66G.46.69G.46.70G.46.71G.46.72G.46.73G.46.74G.46.75G.46.76G.46.77G.46.90G.47.10G.47.11G.47.19G.47.20G.47.21G.47.22G.47.23G.47.24G.47.25G.47.26G.47.29G.47.30G.47.40G.47.41G.47.42G.47.43G.47.50G.47.51G.47.52G.47.53G.47.54G.47.59G.47.60G.47.61G.47.62G.47.63G.47.64G.47.65G.47.70G.47.71G.47.72G.47.73G.47.74G.47.75G.47.76G.47.77G.47.78G.47.79G.47.80G.47.81G.47.82G.47.89G.47.90G.47.91G.47.99H.49.10H.49.11H.49.12H.49.20H.49.30H.49.31H.49.32H.49.33H.49.34H.49.39H.49.40H.49.41H.49.42H.49.50H.50.10H.50.20H.50.30H.50.40H.51.10H.51.20H.51.21H.51.22H.52.10H.52.20H.52.21H.52.22H.52.23H.52.24H.52.25H.52.26H.52.29H.52.30H.52.31H.52.32H.53.10H.53.20H.53.30I.55.10I.55.20I.55.30I.55.40I.55.90I.56.10I.56.11I.56.12I.56.20I.56.21I.56.22I.56.29I.56.30I.56.40J.58.10J.58.11J.58.12J.58.13J.58.14J.58.19J.58.20J.58.21J.58.29J.59.10J.59.11J.59.12J.59.13J.59.14J.59.20J.60.10J.60.20J.60.30J.60.31J.60.39J.61.10J.61.20J.61.30J.61.90J.62.00J.62.01J.62.02J.62.03J.62.09J.63.10J.63.11J.63.12J.63.90J.63.91J.63.99K.61.10K.61.20K.61.90K.62.10K.62.20K.62.90K.63.10K.63.90K.63.91K.63.92K.64.10K.64.11K.64.19K.64.20K.64.30K.64.90K.64.91K.64.92K.64.99K.65.10K.65.11K.65.12K.65.20K.65.30K.66.10K.66.11K.66.12K.66.19K.66.20K.66.21K.66.22K.66.29K.66.30L.64.10L.64.11L.64.19L.64.20L.64.21L.64.22L.64.30L.64.31L.64.32L.64.90L.64.91L.64.92L.64.99L.65.10L.65.11L.65.12L.65.20L.65.30L.66.10L.66.11L.66.12L.66.19L.66.20L.66.21L.66.22L.66.29L.66.30L.68.10L.68.20L.68.30L.68.31L.68.32M.68.10M.68.11M.68.12M.68.20M.68.30M.68.31M.68.32M.69.10M.69.20M.70.10M.70.20M.70.21M.70.22M.71.10M.71.11M.71.12M.71.20M.72.10M.72.11M.72.19M.72.20M.73.10M.73.11M.73.12M.73.20M.74.10M.74.20M.74.30M.74.90M.75.00N.69.10N.69.20N.70.10N.70.20N.71.10N.71.11N.71.12N.71.20N.72.10N.72.20N.73.10N.73.11N.73.12N.73.20N.73.30N.74.10N.74.11N.74.12N.74.13N.74.14N.74.20N.74.30N.74.90N.74.91N.74.99N.75.00N.77.10N.77.11N.77.12N.77.20N.77.21N.77.22N.77.29N.77.30N.77.31N.77.32N.77.33N.77.34N.77.35N.77.39N.77.40N.78.10N.78.20N.78.30N.79.10N.79.11N.79.12N.79.90N.80.10N.80.20N.80.30N.81.10N.81.20N.81.21N.81.22N.81.29N.81.30N.82.10N.82.11N.82.19N.82.20N.82.30N.82.90N.82.91N.82.92N.82.99O.77.10O.77.11O.77.12O.77.20O.77.21O.77.22O.77.30O.77.31O.77.32O.77.33O.77.34O.77.35O.77.39O.77.40O.77.50O.77.51O.77.52O.78.10O.78.20O.79.10O.79.11O.79.12O.79.90O.80.00O.80.01O.80.09O.80.10O.80.20O.80.30O.81.10O.81.20O.81.21O.81.22O.81.23O.81.30O.82.10O.82.20O.82.30O.82.40O.82.90O.82.91O.82.92O.82.99O.84.10O.84.11O.84.12O.84.13O.84.20O.84.21O.84.22O.84.23O.84.24O.84.25O.84.30P.84.10P.84.11P.84.12P.84.13P.84.20P.84.21P.84.22P.84.23P.84.24P.84.25P.84.30P.85.10P.85.20P.85.30P.85.31P.85.32P.85.40P.85.41P.85.42P.85.50P.85.51P.85.52P.85.53P.85.59P.85.60Q.85.10Q.85.20Q.85.30Q.85.31Q.85.32Q.85.33Q.85.40Q.85.50Q.85.51Q.85.52Q.85.53Q.85.59Q.85.60Q.85.61Q.85.69Q.86.10Q.86.20Q.86.21Q.86.22Q.86.23Q.86.90Q.87.10Q.87.20Q.87.30Q.87.90Q.88.10Q.88.90Q.88.91Q.88.99R.86.10R.86.20R.86.21R.86.22R.86.23R.86.90R.86.91R.86.92R.86.93R.86.94R.86.95R.86.96R.86.97R.86.99R.87.10R.87.20R.87.30R.87.90R.87.91R.87.99R.88.10R.88.90R.88.91R.88.99R.90.00R.90.01R.90.02R.90.03R.90.04R.91.01R.91.02R.91.03R.91.04R.92.00R.93.10R.93.11R.93.12R.93.13R.93.19R.93.20R.93.21R.93.29S.90.00S.90.10S.90.11S.90.12S.90.13S.90.20S.90.30S.90.31S.90.39S.91.10S.91.11S.91.12S.91.20S.91.21S.91.22S.91.30S.91.40S.91.41S.91.42S.92.00S.93.10S.93.11S.93.12S.93.13S.93.19S.93.20S.93.21S.93.29S.94.10S.94.11S.94.12S.94.20S.94.90S.94.91S.94.92S.94.99S.95.10S.95.11S.95.12S.95.20S.95.21S.95.22S.95.23S.95.24S.95.25S.95.29S.96.00S.96.01S.96.02S.96.03S.96.04S.96.09T.94.10T.94.11T.94.12T.94.20T.94.90T.94.91T.94.92T.94.99T.95.10T.95.20T.95.21T.95.22T.95.23T.95.24T.95.25T.95.29T.95.30T.95.31T.95.32T.95.40T.96.00T.96.10T.96.20T.96.21T.96.22T.96.23T.96.30T.96.40T.96.90T.96.91T.96.99T.97.00T.98.10T.98.20U.97.00U.98.10U.98.20U.99.00V.99.00
naics_code
North American Industry Classification System - NAICS Code
integer-
name
The name of the person or legal entity to be used for display and reference purposes.
string-
national_reporting_code
Unique identifier established by the national reporting system
string-
parent_id
The unique identifier for the immediate parent of the person or legal entity.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
postal_code
The post (zip) code in which the entity is domiciled.
string-
relationship
Relationship to parent.
string
branchhead_officejvparentparent_branchparent_subsidiaryparticipationsubsidiary
reporting_relationship
Relationship to reporting entity. See: relationship.
string
branchhead_officejvparentparent_branchparent_subsidiaryparticipationsubsidiary
riad_code
RIAD code is the unique counterparty identifier for all counterparties when reported from the NCBs to the ECB;
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_group_id
The unique identifier for the group representing a single risk entity where no relationship of control exists
string-
risk_group_id_2
The secondary identifier for the secondary group representing a single risk entity where no relationship of control exists
string-
scra
Grade calculated using the Basel Standardised Credit Risk Assessment
string
aa_plusbc
sic_code
Standard Industrial Classification (SIC) system. The applicable reference depends on jurisdiction.
integer-
snp_lt
S&P long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
snp_st
S&P short term credit ratings
string
a1a2a3bcd
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
ssic_code
The Singaporean standard industry and sector classification.
integer-
total_assets
The annual balance sheet total of the entity as at the last accounting reference date.
integer-
turnover
The annual turnover of the entity as at the last accounting reference date.
integer-
type
The designated financial or legal entity category this person or legal entity falls under
string
building_societyccpcentral_bankcentral_govtcharityciucommunity_charitycorporatecredit_institutioncredit_uniondeposit_brokerexport_credit_agencyfederal_credit_unionfinancialfinancial_holdingfundhedge_fundhousing_coopindividualinsurerintl_orginvestment_firmlocal_authoritymdbmmkt_fundnational_banknatural_personnon_member_bankotherother_financialother_psepartnershippension_fundpicpmiprivate_equity_fundprivate_fundpromo_fed_home_loanpromo_fed_reservepromotional_lenderproperty_spepsepublic_corporationqccpreal_estate_fundregional_govtsmesocial_housing_entitysocial_security_fundsovereignsspestate_credit_unionstate_member_bankstate_owned_bankstatutory_boardsupported_smeunincorp_inv_fundunincorporated_bizunregulated_financial
ultimate_parent_id
The unique identifier for the ultimate parent of the person or legal entity.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaissuer

Issuer Schema


Data schema to define an issuer for a security.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
address_city
City, town or village.
string-
address_county
The county or administrative region (e.g. NUTS code) for an entity’s address.
string-
address_street
Street address for the Entity.
string-
bankruptcy_date
The date the bankruptcy proceedings were initiated. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
bankruptcy_type
The bankruptcy chapter of the borrower.
string
chapter_11chapter_12chapter_13chapter_7chapter_9court_administrationinsolvencyother
birr_curve_id
The ID of the curve containing historical Borrower Internal Risk Ratings (BIRR) for this entity. The curve must be of type ‘risk_rating’.
string-
birr_id
The unique identifier of the Borrower Internal Risk Rating (BIRR), representing an internally assigned risk assessment for a customer based on their creditworthiness and financial stability.
string-
boe_industry_code
Bank of England industry code.
string-
boe_sector_code
Bank of England sector code.
string-
count
Describes the number of entities represented by this record. eg. joint customers should have a count > 1.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cqs_irb
The credit quality step for internal ratings based approach.
integer-
cqs_standardised
The credit quality step for standardised approach.
integer-
credit_impaired
Flag to determine if the entity credit quality is impaired.
boolean-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
dbrs_lt
DBRS long term credit ratings
string
aaaaa_haaaa_la_haa_lbbb_hbbbbbb_lbb_hbbbb_lb_hbb_lccc_hcccccc_lcccd
dbrs_st
DBRS short term credit ratings
string
r1_hr1_mr1_lr2_hr2_mr2_lr3r4r5d
fitch_lt
Fitch long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccrdd
fitch_st
Fitch short term credit ratings
string
f1_plusf1f2f3bcrdd
head_office_id
The unique identifier for the head office of the legal entity.
string-
headcount
The number of full time staff.
integer-
internal_rating
Categorization of unrated exposure
string
investmentnon_investment
intra_group
Flag to indicate that this should be considered an intra-group entity.
boolean-
kbra_lt
KBRA long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
kbra_st
KBRA short term credit ratings
string
k1_plusk1k2k3bcd
legal_entity_name
The official legal name of the entity.
string-
lei_code
The LEI code for the legal entity (for corporates).
string-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
moodys_lt
Moody’s long term credit ratings
string
aaaaa1aa2aa3a1a2a3baa1baa2baa3ba1ba2ba3b1b2b3caa1caa2caa3cac
moodys_st
Moodys short term credit ratings
string
p1p2p3np
nace_code
The EU NACE economic activity classification.
string
A.01.10A.01.11A.01.12A.01.13A.01.14A.01.15A.01.16A.01.19A.01.20A.01.21A.01.22A.01.23A.01.24A.01.25A.01.26A.01.27A.01.28A.01.29A.01.30A.01.40A.01.41A.01.42A.01.43A.01.44A.01.45A.01.46A.01.47A.01.49A.01.50A.01.60A.01.61A.01.62A.01.63A.01.64A.01.70A.02.10A.02.20A.02.30A.02.40A.03.10A.03.11A.03.12A.03.20A.03.21A.03.22B.05.10B.05.20B.06.10B.06.20B.07.10B.07.20B.07.21B.07.29B.08.10B.08.11B.08.12B.08.90B.08.91B.08.92B.08.93B.08.99B.09.10B.09.90C.10.10C.10.11C.10.12C.10.13C.10.20C.10.30C.10.31C.10.32C.10.39C.10.40C.10.41C.10.42C.10.50C.10.51C.10.52C.10.60C.10.61C.10.62C.10.70C.10.71C.10.72C.10.73C.10.80C.10.81C.10.82C.10.83C.10.84C.10.85C.10.86C.10.89C.10.90C.10.91C.10.92C.11.00C.11.01C.11.02C.11.03C.11.04C.11.05C.11.06C.11.07C.12.00C.13.10C.13.20C.13.30C.13.90C.13.91C.13.92C.13.93C.13.94C.13.95C.13.96C.13.99C.14.10C.14.11C.14.12C.14.13C.14.14C.14.19C.14.20C.14.30C.14.31C.14.39C.15.10C.15.11C.15.12C.15.20C.16.10C.16.20C.16.21C.16.22C.16.23C.16.24C.16.26C.16.27C.16.28C.16.29C.17.10C.17.11C.17.12C.17.20C.17.21C.17.22C.17.23C.17.24C.17.25C.17.29C.18.10C.18.11C.18.12C.18.13C.18.14C.18.20C.19.10C.19.20C.20.10C.20.11C.20.12C.20.13C.20.14C.20.15C.20.16C.20.17C.20.20C.20.30C.20.40C.20.41C.20.42C.20.50C.20.51C.20.52C.20.53C.20.59C.20.60C.21.10C.21.20C.22.10C.22.11C.22.19C.22.20C.22.21C.22.22C.22.23C.22.29C.23.10C.23.11C.23.12C.23.13C.23.14C.23.19C.23.20C.23.30C.23.31C.23.32C.23.40C.23.41C.23.42C.23.43C.23.44C.23.49C.23.50C.23.51C.23.52C.23.60C.23.61C.23.62C.23.63C.23.64C.23.65C.23.69C.23.70C.23.90C.23.91C.23.99C.24.10C.24.20C.24.30C.24.31C.24.32C.24.33C.24.34C.24.40C.24.41C.24.42C.24.43C.24.44C.24.45C.24.46C.24.50C.24.51C.24.52C.24.53C.24.54C.25.10C.25.11C.25.12C.25.20C.25.21C.25.29C.25.30C.25.40C.25.50C.25.60C.25.61C.25.62C.25.70C.25.71C.25.72C.25.73C.25.90C.25.91C.25.92C.25.93C.25.94C.25.99C.26.10C.26.11C.26.12C.26.20C.26.30C.26.40C.26.50C.26.51C.26.52C.26.60C.26.70C.26.80C.27.10C.27.11C.27.12C.27.20C.27.30C.27.31C.27.32C.27.33C.27.40C.27.50C.27.51C.27.52C.27.90C.28.10C.28.11C.28.12C.28.13C.28.14C.28.15C.28.20C.28.21C.28.22C.28.23C.28.24C.28.25C.28.29C.28.30C.28.40C.28.41C.28.49C.28.90C.28.91C.28.92C.28.93C.28.94C.28.95C.28.96C.28.99C.29.10C.29.20C.29.30C.29.31C.29.32C.30.10C.30.11C.30.12C.30.20C.30.30C.30.40C.30.90C.30.91C.30.92C.30.99C.31.00C.31.01C.31.02C.31.03C.31.09C.32.10C.32.11C.32.12C.32.13C.32.20C.32.30C.32.40C.32.50C.32.90C.32.91C.32.99C.33.10C.33.11C.33.12C.33.13C.33.14C.33.15C.33.16C.33.17C.33.19C.33.20D.35.10D.35.11D.35.12D.35.13D.35.14D.35.16D.35.20D.35.21D.35.22D.35.23D.35.30E.36.00E.37.00E.38.10E.38.11E.38.12E.38.20E.38.21E.38.22E.38.30E.38.31E.38.32E.39.00F.41.10F.41.20F.42.10F.42.11F.42.12F.42.13F.42.20F.42.21F.42.22F.42.90F.42.91F.42.99F.43.10F.43.11F.43.12F.43.13F.43.20F.43.21F.43.22F.43.29F.43.30F.43.31F.43.32F.43.33F.43.34F.43.39F.43.90F.43.91F.43.99G.45.10G.45.11G.45.19G.45.20G.45.30G.45.31G.45.32G.45.40G.46.10G.46.11G.46.12G.46.13G.46.14G.46.15G.46.16G.46.17G.46.18G.46.19G.46.20G.46.21G.46.22G.46.23G.46.24G.46.30G.46.31G.46.32G.46.33G.46.34G.46.35G.46.36G.46.37G.46.38G.46.39G.46.40G.46.41G.46.42G.46.43G.46.44G.46.45G.46.46G.46.47G.46.48G.46.49G.46.50G.46.51G.46.52G.46.60G.46.61G.46.62G.46.63G.46.64G.46.65G.46.66G.46.69G.46.70G.46.71G.46.72G.46.73G.46.74G.46.75G.46.76G.46.77G.46.90G.47.10G.47.11G.47.19G.47.20G.47.21G.47.22G.47.23G.47.24G.47.25G.47.26G.47.29G.47.30G.47.40G.47.41G.47.42G.47.43G.47.50G.47.51G.47.52G.47.53G.47.54G.47.59G.47.60G.47.61G.47.62G.47.63G.47.64G.47.65G.47.70G.47.71G.47.72G.47.73G.47.74G.47.75G.47.76G.47.77G.47.78G.47.79G.47.80G.47.81G.47.82G.47.89G.47.90G.47.91G.47.99H.49.10H.49.11H.49.12H.49.20H.49.30H.49.31H.49.32H.49.33H.49.34H.49.39H.49.40H.49.41H.49.42H.49.50H.50.10H.50.20H.50.30H.50.40H.51.10H.51.20H.51.21H.51.22H.52.10H.52.20H.52.21H.52.22H.52.23H.52.24H.52.25H.52.26H.52.29H.52.30H.52.31H.52.32H.53.10H.53.20H.53.30I.55.10I.55.20I.55.30I.55.40I.55.90I.56.10I.56.11I.56.12I.56.20I.56.21I.56.22I.56.29I.56.30I.56.40J.58.10J.58.11J.58.12J.58.13J.58.14J.58.19J.58.20J.58.21J.58.29J.59.10J.59.11J.59.12J.59.13J.59.14J.59.20J.60.10J.60.20J.60.30J.60.31J.60.39J.61.10J.61.20J.61.30J.61.90J.62.00J.62.01J.62.02J.62.03J.62.09J.63.10J.63.11J.63.12J.63.90J.63.91J.63.99K.61.10K.61.20K.61.90K.62.10K.62.20K.62.90K.63.10K.63.90K.63.91K.63.92K.64.10K.64.11K.64.19K.64.20K.64.30K.64.90K.64.91K.64.92K.64.99K.65.10K.65.11K.65.12K.65.20K.65.30K.66.10K.66.11K.66.12K.66.19K.66.20K.66.21K.66.22K.66.29K.66.30L.64.10L.64.11L.64.19L.64.20L.64.21L.64.22L.64.30L.64.31L.64.32L.64.90L.64.91L.64.92L.64.99L.65.10L.65.11L.65.12L.65.20L.65.30L.66.10L.66.11L.66.12L.66.19L.66.20L.66.21L.66.22L.66.29L.66.30L.68.10L.68.20L.68.30L.68.31L.68.32M.68.10M.68.11M.68.12M.68.20M.68.30M.68.31M.68.32M.69.10M.69.20M.70.10M.70.20M.70.21M.70.22M.71.10M.71.11M.71.12M.71.20M.72.10M.72.11M.72.19M.72.20M.73.10M.73.11M.73.12M.73.20M.74.10M.74.20M.74.30M.74.90M.75.00N.69.10N.69.20N.70.10N.70.20N.71.10N.71.11N.71.12N.71.20N.72.10N.72.20N.73.10N.73.11N.73.12N.73.20N.73.30N.74.10N.74.11N.74.12N.74.13N.74.14N.74.20N.74.30N.74.90N.74.91N.74.99N.75.00N.77.10N.77.11N.77.12N.77.20N.77.21N.77.22N.77.29N.77.30N.77.31N.77.32N.77.33N.77.34N.77.35N.77.39N.77.40N.78.10N.78.20N.78.30N.79.10N.79.11N.79.12N.79.90N.80.10N.80.20N.80.30N.81.10N.81.20N.81.21N.81.22N.81.29N.81.30N.82.10N.82.11N.82.19N.82.20N.82.30N.82.90N.82.91N.82.92N.82.99O.77.10O.77.11O.77.12O.77.20O.77.21O.77.22O.77.30O.77.31O.77.32O.77.33O.77.34O.77.35O.77.39O.77.40O.77.50O.77.51O.77.52O.78.10O.78.20O.79.10O.79.11O.79.12O.79.90O.80.00O.80.01O.80.09O.80.10O.80.20O.80.30O.81.10O.81.20O.81.21O.81.22O.81.23O.81.30O.82.10O.82.20O.82.30O.82.40O.82.90O.82.91O.82.92O.82.99O.84.10O.84.11O.84.12O.84.13O.84.20O.84.21O.84.22O.84.23O.84.24O.84.25O.84.30P.84.10P.84.11P.84.12P.84.13P.84.20P.84.21P.84.22P.84.23P.84.24P.84.25P.84.30P.85.10P.85.20P.85.30P.85.31P.85.32P.85.40P.85.41P.85.42P.85.50P.85.51P.85.52P.85.53P.85.59P.85.60Q.85.10Q.85.20Q.85.30Q.85.31Q.85.32Q.85.33Q.85.40Q.85.50Q.85.51Q.85.52Q.85.53Q.85.59Q.85.60Q.85.61Q.85.69Q.86.10Q.86.20Q.86.21Q.86.22Q.86.23Q.86.90Q.87.10Q.87.20Q.87.30Q.87.90Q.88.10Q.88.90Q.88.91Q.88.99R.86.10R.86.20R.86.21R.86.22R.86.23R.86.90R.86.91R.86.92R.86.93R.86.94R.86.95R.86.96R.86.97R.86.99R.87.10R.87.20R.87.30R.87.90R.87.91R.87.99R.88.10R.88.90R.88.91R.88.99R.90.00R.90.01R.90.02R.90.03R.90.04R.91.01R.91.02R.91.03R.91.04R.92.00R.93.10R.93.11R.93.12R.93.13R.93.19R.93.20R.93.21R.93.29S.90.00S.90.10S.90.11S.90.12S.90.13S.90.20S.90.30S.90.31S.90.39S.91.10S.91.11S.91.12S.91.20S.91.21S.91.22S.91.30S.91.40S.91.41S.91.42S.92.00S.93.10S.93.11S.93.12S.93.13S.93.19S.93.20S.93.21S.93.29S.94.10S.94.11S.94.12S.94.20S.94.90S.94.91S.94.92S.94.99S.95.10S.95.11S.95.12S.95.20S.95.21S.95.22S.95.23S.95.24S.95.25S.95.29S.96.00S.96.01S.96.02S.96.03S.96.04S.96.09T.94.10T.94.11T.94.12T.94.20T.94.90T.94.91T.94.92T.94.99T.95.10T.95.20T.95.21T.95.22T.95.23T.95.24T.95.25T.95.29T.95.30T.95.31T.95.32T.95.40T.96.00T.96.10T.96.20T.96.21T.96.22T.96.23T.96.30T.96.40T.96.90T.96.91T.96.99T.97.00T.98.10T.98.20U.97.00U.98.10U.98.20U.99.00V.99.00
naics_code
North American Industry Classification System - NAICS Code
integer-
name
The name of the person or legal entity to be used for display and reference purposes.
string-
national_reporting_code
Unique identifier established by the national reporting system
string-
parent_id
The unique identifier for the immediate parent of the person or legal entity.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
postal_code
The post (zip) code in which the entity is domiciled.
string-
relationship
Relationship to parent.
string
branchhead_officejvparentparent_branchparent_subsidiaryparticipationsubsidiary
reporting_relationship
Relationship to reporting entity. See: relationship.
string
branchhead_officejvparentparent_branchparent_subsidiaryparticipationsubsidiary
riad_code
RIAD code is the unique counterparty identifier for all counterparties when reported from the NCBs to the ECB;
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_group_id
The unique identifier for the group representing a single risk entity where no relationship of control exists
string-
risk_group_id_2
The secondary identifier for the secondary group representing a single risk entity where no relationship of control exists
string-
scra
Grade calculated using the Basel Standardised Credit Risk Assessment
string
aa_plusbc
sic_code
Standard Industrial Classification (SIC) system. The applicable reference depends on jurisdiction.
integer-
snp_lt
S&P long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
snp_st
S&P short term credit ratings
string
a1a2a3bcd
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
ssic_code
The Singaporean standard industry and sector classification.
integer-
total_assets
The annual balance sheet total of the entity as at the last accounting reference date.
integer-
turnover
The annual turnover of the entity as at the last accounting reference date.
integer-
type
The designated financial or legal entity category this person or legal entity falls under
string
building_societyccpcentral_bankcentral_govtcharityciucommunity_charitycorporatecredit_institutioncredit_uniondeposit_brokerexport_credit_agencyfederal_credit_unionfinancialfinancial_holdingfundhedge_fundhousing_coopindividualinsurerintl_orginvestment_firmlocal_authoritymdbmmkt_fundnational_banknatural_personnon_member_bankotherother_financialother_psepartnershippension_fundpicpmiprivate_equity_fundprivate_fundpromo_fed_home_loanpromo_fed_reservepromotional_lenderproperty_spepsepublic_corporationqccpreal_estate_fundregional_govtsmesocial_housing_entitysocial_security_fundsovereignsspestate_credit_unionstate_member_bankstate_owned_bankstatutory_boardsupported_smeunincorp_inv_fundunincorporated_bizunregulated_financial
ultimate_parent_id
The unique identifier for the ultimate parent of the person or legal entity.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaloan

Loan Schema


Data schema defining the characteristics of a loan product.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
acc_fv_change_credit_risk
Accumulated changes in fair value due to credit risk.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrual_status
The accrual status of the loan or line of credit.
string
accrualnon_accrualsecuritisedserviced_for_others
accrued_interest_12m
The cumulative accrued interest over the past 12 months. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
accrued_interest_balance
The accrued interest due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
administration
How the loan was administered by the lender.
string
otherprincipal
arrears_arrangement
The arrangement the lender has made with the borrower regarding the amount referenced in the arrears_balance.
string
formalinterest_grace_periodmi_claim_advmodified_tncnonepossessedprin_def_rateprin_def_rate_termprin_def_termprincipal_deferprincipal_forgiverate_prin_forgiverate_red_frozenrate_termrate_term_prin_forgiverecaprefinancingrenewalreosettlementshort_saletemporaryterm_extterm_prin_forgiveterm_recap
arrears_balance
The balance of the loan or capital amount that is considered to be in arrears. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
The balance of the loan or capital still to be repaid. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the repayment rate on the borrowed funds at the given date as agreed in the terms of the loan.
string
FDTRUKBRBASEZEROcert_depcoficofi_11thcofi_nmcofi_othercosimtaotherprimesofrsofr_1msofr_1ysofr_3msofr_6msofr_othertbilltbill_1ytbill_3mtbill_3ytbill_5ytbill_6mtbill_other
behavioral_curve_id
The unique identifier for the behavioral curve used by the financial institution.
string-
behavioral_end_date
Behavioral end date (as opposed to contractual). YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
beneficiary_id
The unique identifier for the beneficiary of the loan cashflows.
string-
cb_haircut
The haircut as determined by the firm’s central bank
number-
ccf
The credit conversion factor that indicates the proportion of the undrawn amount that would be drawn down on default.
number-
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
count
Describes the number of loans aggregated into a single row.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
credit_process
Identifier for how a loan is credit assessed during the underwriting process
string
delinquency_managedgradedratedscored
cum_recoveries
The total amount recovered since the date of default of the instrument.
integer-
cum_write_offs
The portion of the loan which has been written off.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer.
string-
customers
The list of customers for this loan
array-
day_count_convention
The methodology for calculating the number of days between two dates. It is used to calculate the amount of accrued interest or the present value.
string
act_360act_365act_actstd_30_360std_30_365
deal_id
Identifier used for linking this product as part of a larger deal. e.g. Two components of a single loan or matching a securitisation with it’s underlying loan.
string-
default_date
Date of default.
string-
deferred_fees
Deferred fees are deferred payments subject to prepayment risk and not included in the balance.
integer-
ead
The EAD field allows users to input monetary exposure-at-default values across the loan’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
ead_irb_ec
The expected gross dollar exposure for each facility upon a borrower’s default as determined by internal ratings-based approach. This value is used in economic capital calculations.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
el_irb
The best estimate of expected loss when in default.
number-
encumbrance_amount
The amount of the loan that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
encumbrance_end_date
Date encumbrance amount goes to zero. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
encumbrance_type
The type of the encumbrance causing the encumbrance_amount.
string
abscb_fundingcovered_bond
end_date
YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
facility_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
facility_id
The code assigned by the financial institution to identify a facility.
string-
fees
The fees associated with the loan.
integer-
fiduciary_status
Identification of instruments in which the observed agent acts in its own name but on behalf of and with the risk borne by a third party
string
fiduciarynon_fiduciary
first_arrears_date
The first date on which this loan was in arrears.
string-
first_payment_date
The first payment date for interest payments.
string-
forbearance_date
The date on which the first forbearance measure was granted to this product. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
fraud_loss
The total value of accounting losses incurred by the Financial Institution due to fraudulent activities within the reporting segment.
integer-
frr_id
The internal facility risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
guarantee_amount
The amount of the loan that is guaranteed by the guarantor. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
guarantor_id
The unique identifier for the guarantor of the loan.
string-
impairment_amount
The impairment amount for a loan is the allowance for loan impairments set aside by the firm that accounts for the event that the loan becomes impaired in the future.
integer-
impairment_date
The date upon which the product became considered impaired. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
impairment_type
The loss event resulting in the impairment of the loan.
string
collectiveindividualwrite_off
income_assessment
Was the loan assessed against a single or joint incomes?
string
jointjoint_not_evidencedsinglesingle_not_evidenced
int_reset_freq
The adjustable rate periodic interest reset period. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
interest_repayment_frequency
Repayment frequency of the loan interest, if different from principal.
string
dailyweeklybi_weeklymonthlybi_monthlyquarterlysemi_annuallyannuallyat_maturitybienniallysesquiennially
issuer_id
The unique identifier for the issuer of the loan.
string-
last_arrears_date
The last date on which this loan was in arrears.
string-
last_drawdown_date
The last date on which a drawdown was made on this loan
string-
last_payment_date
The final payment date for interest payments, often coincides with end_date.
string-
last_recovery_date
Date of most recent recovery in the reporting quarter.
string-
last_write_off_date
Date of Financial Institution’s most recent Write Off in the reporting quarter.
string-
ledger_code
The internal ledger code or line item name.
string-
lgd_downturn
The loss given default in the event of an economic downturn. Percentage between 0 and 1.
number-
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
lgd_irb_ec
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
lifetime_rate_cap
The lifetime interest rate cap for adjustable rate loans. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
number-
lifetime_rate_floor
The lifetime interest rate floor for adjustable rate loans. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
number-
limit_amount
The total credit limit on the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
lnrf_amount
The total amount of non-recourse funding linked to the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
min_interest_repayment
The minimum interest on outstanding balance and fees that customers are due to repay.
integer-
min_principal_repayment
The minimum principal balance that customers are due to repay.
integer-
minimum_balance
Indicates the minimum balance of each loan within the aggregate.
integer-
minimum_balance_eur
Indicates the minimum balance, in Euros, of each loan within the aggregate.
integer-
mna_id
The unique identifier of the Master Netting Agreement the loan falls under. Typically used where a legally enforceable right to offset exists and where the reporting entity intends to settle on a net basis.
string-
movement
The movement parameter describes how the loan arrived to the firm.
string
acquiredacquired_impairedothersecuritisedsoldsyndicatedsyndicated_lead
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_repricing_date
The date on which the interest rate of the loan will be re-calculated. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
notional_amount
The original notional amount of the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
on_balance_sheet
Is the loan reported on the balance sheet of the financial institution?
boolean-
orig_acc_fv_change_credit_risk
The difference between the outstanding nominal amount and the purchase price of the instrument at the purchase date. This amount should be reported for instruments purchased for an amount lower than the outstanding amount due to credit risk deterioration.
integer-
orig_credit_score
The credit score of the customer at origination of the product using a commercially available credit bureau score.
integer-
orig_limit_amount
The original line of credit amount that was granted at the origination of the facility
integer-
orig_notional
The notional of the loan at origination.
integer-
originator_id
The unique identifier used by the financial institution to identify the originator of the loan product.
string-
originator_type
The type of financial institution that acted as the originator of the loan product.
string
mortgage_lenderotherspv
parent_facility_id
The parent code assigned by the financial institution to identify a facility.
string-
participation_int
For participated or syndicated credit facilities that have closed and settled, the percentage of the total loan commitment held by the reporting entity. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
number-
participation_type
For participated or syndicated credit facilities that have closed and settled, indicates the type of participation in the loan. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string
agent_non_sncagent_sncnoneparticipant_non_sncparticipant_snc
pd_irb
The probability of default as determined by internal rating-based methods. Percentage between 0 and 1.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
pd_retail_irb
The retail probability of default as determined by internal rating-based methods. Percentage between 0 and 1.
number-
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
provision_type
The provision type parameter details the provisions the issuing firm has allocated to cover potential losses from issuing a loan.
string
noneother
purpose
The underlying reason the borrower has requested the loan.
string
agriculturebridging_loanbusiness_recapbuy_to_letbuy_to_let_constructbuy_to_let_further_advancebuy_to_let_house_purchasebuy_to_let_otherbuy_to_let_remortgagecash_outcommercialcommercial_propertycommodities_financeconstructionconsumer_buy_to_letcorporate_financedebt_consolidationeducationesopfirst_time_buyerfirst_time_buyer_cstrfurther_advancefurther_advance_cstrhouse_purchasehouse_purchase_cstripslifetime_mortgagemedicalmergers_acquisitionsnon_b20object_financeobject_finance_hqoperationaloperational_non_symoperational_symotherportfolio_acquisitionproject_financeproject_hq_phaseproject_pre_oppromotionalratereferencerefinanceremortgageremortgage_constructremortgage_otherremortgage_othr_cstrrenovationspeculative_propertystock_buybackterm
rate
The full interest rate applied to the loan balance. Note that for tracker rates this includes the benchmark (ie. not the credit spread). Percentages represented as a decimal/float, so 1.5 implies 1.5%.
number-
rate_type
Describes the type of interest rate applied to the loan.
string
combinedfixedtrackervariable
recourse
Whether there is recourse on a loan. Recourse on a loan refers to terms in the mortgage contract that give the owner of the note the right to pursue additional claims against the borrower beyond possession of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
fullnonepartial
ref_income_amount
The reference income used for the customer(s) for this loan. Monetary type represented as an integer number of cents/pence.
integer-
regulated
Is this loan regulated or unregulated?
boolean-
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
repayment_frequency
Repayment frequency of the loan.
string
dailyweeklybi_weeklymonthlybi_monthlyquarterlysemi_annuallyannuallyat_maturitybienniallysesquiennially
repayment_type
Repayment type of the loan refers to whether the customer will be repaying capital + interest, just interest or a combination of the two.
string
combinedinterest_onlyoption_armotherrepayment
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
repurchase_status
The current status of the repurchase of the loan.
string
complete_no_repurchasecomplete_repurchasedin_processinitiated
resolution_date
Date of resolution of the defaulted facility.
string-
reversion_date
The timestamp that indicates the end of an initial period where the ‘rate’ is applied to a loan. After this the interest is calculated using the ‘reversion_rate’. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
reversion_rate
The rate to which the loan will revert after the reversion date. Percentages represented as a decimal/float, so 1.5 implies 1.5%.
number-
review_date
The currently scheduled review date for Counterparty exposure. This date should be set in the future. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_weight_irb
The internal risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
secured
Is this loan secured or unsecured?
boolean-
seniority
The seniority of the security in the event of sale or bankruptcy of the issuer.
string
mezzaninepari_passusenior_securedsenior_unsecuredsubordinated_securedsubordinated_unsecured
servicer_id
This is the unique id to identify the servicer of a loan.
string-
servicing
The method by which the loan shall be repaid
string
businesspensionrentsalary
servicing_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
spread
The additional rate that is added to the relevant base rate to determine the monthly interest rate of the loan. This is represented in basis points (bps). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
start_date
The timestamp that the trade or financial product commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Describes if the loan is active or been cancelled.
string
actualcancellablecancelledclosedcommitteddefaultedfrozenrevolving
syndication_id
The code assigned by the lead arranger of the syndicated contract to uniquely identify each contract. Each syndicated contract will have one syndicated contract identifier. This value will not change over time and cannot be used by the lead arranger as the contract identifier for any other contract
string-
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
type
The form of the loan product administered by the financial institution, with regards to common regulatory classifications.
string
autocdcharge_cardcommercialcommercial_propertycorporate_cardcredit_cardcredit_facilityeducationfinancial_leaseheloanhelocheloc_lockoutliquidity_facilitymortgagemortgage_chartermortgage_cramortgage_fha_projectmortgage_fha_resmortgage_hud235mortgage_no_pmimortgage_pmimortgage_vamulticcy_facilitynew_autonostrootherpersonalq_reverse_mortgagereverse_mortgagetrade_financeused_auto
undrawn_provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the undrawn portion of a loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
vol_adj
The volatility adjustment appropriate to the exposure.
number-
layouttitle
schemaloan_cash_flow

Loan Cash Flow Schema


A loan cash flow represents the future movement of cash as part of contractually agreed payments for an existing loan.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
amount
The size of the cash flow. Monetary type represented as a naturally positive integer number of cents/pence denominated in the currency code.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
loan_id
The unique identifier for the affected loan/s within the financial institution.
string-
payment_date
The timestamp that the cash flow will occur or was paid. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
type
The type of the payment, signifying whether interest or principal is being paid.
string
interestprincipal
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaloan_transaction

Loan Transaction Schema


A Loan Transaction is an event that has an impact on a loan, typically the balance.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
amount
The size of the transaction in the loan transaction event. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
loan_id
The unique identifier for the affected loan/s within the financial institution.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
type
The type of impact on the balance of the loan.
string
acquisitionadvancecapital_repaymentcapitalisationcommitmentduefurther_advanceinterestinterest_repaymentotherreceivedrecoverysalesecuritisationwrite_offwrite_off_bankruptcy
value_date
The timestamp that the transaction was valued or took place. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemarisk_rating

Risk Rating


A risk rating entry for a risk rating system

Properties

NameDescriptionTypeEnum
id
Unique identifier for the risk rating
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
description
A description of the internal risk rating.
string-
lgd_max
Maximum Loss Given Default, representing the highest expected loss as a percentage of exposure at default.
number-
lgd_min
Minimum Loss Given Default, representing the lowest expected loss as a percentage of exposure at default.
number-
name
The name or classification of the risk rating, used for reporting and segmentation.
string-
pd_max
Maximum Probability of Default
number-
pd_min
Minimum Probability of Default
number-
risk_rating_system_id
Reference to the risk rating system that this Internal Risk Rating belongs to
string-
source
The source where this data originated.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemasecurity

Security Schema


A security represents a tradable financial instrument held or financed by an institution for investment or collateral.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
acc_fv_change_credit_risk
Accumulated changes in fair value due to credit risk.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrued_interest
The accrued interest since the last payment date and due at the next payment date. Monetary type represented as an integer number of cents/pence.
integer-
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
attachment_point
The threshold at which losses within the pool of underlying exposures would start to be allocated to the relevant securitisation position.
number-
balance
Outstanding amount including accrued interest. Monetary integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the rate on the balance at the given date as agreed in the terms of the financial product.
string
FDTRUKBRBASEZERObbswbbsw_3meuriboreuribor_1meuribor_3meuribor_6motherpbocsofrsofr_1msofr_3msofr_6m
break_dates
Dates where this contract can be broken (by either party). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_dates
Dates where this contract can be called (by the customer). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_type
The call mechanism, if present, for the issuance. For securitisations and other callable securities.
string
clean_upclean_up_regother
capital_tier
The capital tiers based on own funds requirements.
string
add_tier_1anc_tier_2anc_tier_3at1_grandfatheredbas_tier_2bas_tier_3ce_tier_1cet1_grandfatheredt2_grandfatheredtier_1tier_2tier_3
cb_haircut
The haircut as determined by the firm’s central bank
number-
ccf
The credit conversion factor that indicates the proportion of the undrawn amount that would be drawn down on default.
number-
ccr_approach
Specifies the approved counterparty credit risk methodology for calculating exposures.
string
immoemsassa
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cover_pool_balance
The balance of the assets that are held in the cover pool
integer-
cqs_irb
The credit quality step for internal ratings based approach.
integer-
cqs_standardised
The credit quality step for standardised approach.
integer-
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
csa_id
The unique identifier of the credit support annex this security falls under. Typically where used as derivatives collateral.
string-
cum_write_offs
The portion of the security which has been written off.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer for this product.
string-
day_count_convention
The methodology for calculating the number of days between two dates. It is used to calculate the amount of accrued interest or the present value.
string
act_360act_365act_actstd_30_360std_30_365
dbrs_lt
DBRS long term credit ratings
string
aaaaa_haaaa_la_haa_lbbb_hbbbbbb_lbb_hbbbb_lb_hbb_lccc_hcccccc_lcccd
dbrs_st
DBRS short term credit ratings
string
r1_hr1_mr1_lr2_hr2_mr2_lr3r4r5d
deal_id
The unique identifier used by the financial institution to identify the deal for this product that links it to other products of the same or different type.
string-
default_date
Date of default.
string-
description
A more user-friendly description of the security.
string-
detachment_point
The threshold at which losses within the pool of underlying exposures would result in a complete loss of principal for the tranche containing the relevant securitisation position.
number-
distribution_type
The instrument’s coupon/dividend distribution type, such as cumulative or noncumulative. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string
cumulativenon_cumulative
ead
The EAD field allows users to input monetary exposure-at-default values across the security’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
encumbrance_amount
The amount of the security that is encumbered by potential future commitments or legal liabilities such as within a repo pool. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
end_date
YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
excess_spread_type
Excess spread
string
fixedfixed_trappednonevariablevariable_trapped
fees
The fees associated with the security.
integer-
fiduciary_status
Identification of instruments in which the observed agent acts in its own name but on behalf of and with the risk borne by a third party
string
fiduciarynon_fiduciary
first_arrears_date
The first date on which this security was in arrears.
string-
first_payment_date
The first payment date for interest payments.
string-
fitch_lt
Fitch long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccrdd
fitch_st
Fitch short term credit ratings
string
f1_plusf1f2f3bcrdd
forbearance_date
The date on which the first forbearance measure was granted to this product. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
frr_id
The internal facility risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
guarantee_start_date
The first day the security became guaranteed by the guarantor. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
guarantor_id
The unique identifier for the guarantor within the financial institution.
string-
hedge_id
Unique identifier that establishes a relational link between a security and its associated derivative hedge. Enables consistent tracking, aggregation, and reconciliation of hedged positions across systems and datasets.
string-
hedged_percentage
In the case of a designated fair value hedge, the portion of the asset being hedged, as determined according to ASC 815-20-25-12 (b) and ASC 815-20-25-12A.
number-
hqla_class
What is the HQLA classification of this security?
string
excludeii_non_opiiaiia_non_opiibiib_non_opineligibleineligible_non_op
impairment_amount
The impairment amount for a security is the allowance set aside by the firm for losses.
integer-
impairment_date
The date upon which the product became considered impaired. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
index_composition
Constituents and their proportion in an index.
array-
insolvency_rank
The insolvency ranking as per the national legal fraamework of the reporting institution.
integer-
int_reset_freq
The adjustable rate periodic interest reset period. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
interest_repayment_frequency
Repayment frequency of the interest.
string
dailyweeklybi_weeklymonthlybi_monthlyquarterlysemi_annuallyannuallyat_maturitybienniallysesquiennially
isin_code
The unique International Securities Identification Number for the security according to ISO 6166.
string-
issuance_type
Indicates the type of placement for issuances. For example, private placements, other non-publicly offered securites, publicly offered securities or direct purchase municipal securities. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string
direct_purch_municipalnon_publicprivate_placementpublic_offering
issue_date
The date on which the security is issued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
issue_size
The size of the issue denominated in the original currency of the security
integer-
issuer_id
The unique identifier for the issuer within the financial institution.
string-
kbra_lt
KBRA long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
kbra_st
KBRA short term credit ratings
string
k1_plusk1k2k3bcd
last_payment_date
The final payment date for interest payments, often coincides with end_date or the maturity date
string-
ledger_code
The internal ledger code or line item name.
string-
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations.
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
maturity_date
The date on which the principal repayment of the security is due. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
mic_code
The market identifier code as defined by the International Standards Organisation.
string-
mna_id
The unique identifier of the Master Netting Agreement this security falls under. Typically where used as derivatives collateral.
string-
moodys_lt
Moody’s long term credit ratings
string
aaaaa1aa2aa3a1a2a3baa1baa2baa3ba1ba2ba3b1b2b3caa1caa2caa3cac
moodys_st
Moodys short term credit ratings
string
p1p2p3np
movement
The movement parameter describes how the security arrived to the firm.
string
assetcashcb_omodebt_issueissuanceother
mtm_clean
The mark-to-market value of the security excluding interest. Monetary number of cents/pence.
integer-
mtm_dirty
The mark-to-market value of the security including interest. Monetary number of cents/pence.
integer-
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_repricing_date
The date on which the interest rate of the security will be re-calculated. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
notional_amount
The notional value is the total amount of a security’s underlying asset at its spot price. Monetary number of cents.
integer-
on_balance_sheet
Is the security reported on the balance sheet of the financial institution?
boolean-
orig_acc_fv_change_credit_risk
The difference between the outstanding nominal amount and the purchase price of the instrument at the purchase date. This amount should be reported for instruments purchased for an amount lower than the outstanding amount due to credit risk deterioration.
integer-
originator_id
The unique identifier used by the financial institution to identify the originator of the security or securitisation.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
purpose
The purpose for which the security is being held.
string
aircraft_financeback_to_backcollateralcustodydefault_fundderivative_collateralindependent_collateral_amountinsuranceinvestmentinvestment_advicenon_controllingocirotherportfolio_managementreferenceshare_capitalsingle_collateral_pooltrade_financevariation_margin
rate
The full interest rate applied to the security notional in percentage terms. Note that this therefore includes the base_rate (ie. not the spread).
number-
rate_type
Describes the type of interest rate applied to the security.
string
combinedfixedfixed_to_fixedfixed_to_floatstep_uptrackervariable
recourse
Whether there is recourse on a loan. Recourse on a loan refers to terms in the mortgage contract that give the owner of the note the right to pursue additional claims against the borrower beyond possession of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
fullnonepartial
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
rehypothecation
Can the security be rehypothecated by the borrower?
boolean-
repayment_type
The repayment or amortisation mechanism of the security or securitisation.
string
otherpr2spr2s_abcppr2s_non_abcppro_ratasequential
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
resolution_date
Date of resolution of the defaulted facility.
string-
retention_pct
The percentage of the issuance retained by the issuer. e.g. 0.05 is 5%.
number-
retention_type
The repayment or amortisation mechanism of the security or securitisation.
string
exemptedfirst_losson_bsrevolvingvertical_nominalvertical_risk
reversion_date
The timestamp that indicates the end of an initial period where the ‘rate’ is applied to a security. After this the interest is calculated using the ‘reversion_rate’. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
reversion_rate
The rate to which the security will revert after the reversion date. Percentages represented as a decimal/float, so 1.5 implies 1.5%.
number-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_profile
The evaluation of the financial risk associated to the portfolio
integer-
risk_weight_irb
The internal risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
securitisation_type
The type of securitisation with regards to common regulatory classifications.
string
pass_throughstssts_syntheticsts_traditionalsynthetictraditional
sedol
The stock exchange daily official list (SEDOL) is a seven-character identification code assigned to securities that trade on the London Stock Exchange and various smaller exchanges in the United Kingdom. SEDOL codes are used for unit trusts, investment trusts, insurance-linked securities, and domestic and foreign stocks.
string-
seniority
The seniority of the security in the event of sale or bankruptcy of the issuer.
string
first_loss_securedsenior_securedsenior_unsecuredsubordinated_securedsubordinated_unsecured
servicing
The method by which the debt shall be repaid
string
app_backedgeneral_obligationotherrevenuerevenue_educationrevenue_healthrevenue_ind_devrevenue_multi_housingrevenue_otherrevenue_single_housingrevenue_taxrevenue_transportrevenue_utilities
sft_type
The sft_type parameter defines the transaction mechanism conducted for the SFT for this security product.
string
bond_borrowbond_loanbuy_sell_backmargin_loanreporev_reposell_buy_backstock_borrowstock_loanterm_funding_scheme
snp_lt
S&P long term credit ratings
string
aaaaa_plusaaaa_minusa_plusaa_minusbbb_plusbbbbbb_minusbb_plusbbbb_minusb_plusbb_minusccc_pluscccccc_minuscccd
snp_st
S&P short term credit ratings
string
a1a2a3bcd
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
spread
The additional rate that is added to the relevant index for instruments with a coupon/dividend rate that is linked to the rate of a particular index (e.g., 1M LIBOR+50bps) at issuance. This is represented in basis points (bps).
integer-
start_date
The timestamp that the trade or financial product commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Provides additional information regarding the status of the security.
string
bankruptcy_remotecalled_upconversionfree_deliveriesnon_operationalotherpaid_upredeemedrefinancedreplacedrepurchaseunsettled
status_date
Provides the date on which the security status was executed.
string-
stress_change
The level of variation on the security’s price or haircut or during a 30 day calendar market stress period in percentage terms
number-
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
transferable
Can the security be transferred between parties or negotiated on the capital market?
boolean-
type
This is the type of the security with regards to common regulatory classifications.
string
absabs_autoabs_ccabs_consumerabs_corpabs_leaseabs_otherabs_smeabs_sme_corpabs_sme_retailabs_studentabs_trade_recabs_wholesaleacceptancearsbill_of_exchangebondcashcash_ratio_depositcb_facilitycb_reservecb_restricted_reservecdcdoclocmbscmbs_incomecommercial_papercommonconvertible_bondcovered_bondcppcpp_tarp_prefcs_usgcs_warrantdebtdividenddocumentaryemtnequityfinancialfinancial_guaranteefinancial_slocfrnguaranteeindexindex_linkedletter_of_creditloan_poolmain_index_equitymbsmcpmcp_usgmtnncppncpp_convertiblenha_mbsotherperformanceperformance_bondperformance_guaranteeperformance_slocpibspref_sharereit_prefrmbsrmbs_incomermbs_transshareshare_aggspeculative_unlistedspv_mortgagesspv_otherstandbystruct_notetreasurytrupstrups_usg_prefurpwarranty
undrawn_provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the undrawn portion of a loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
value_date
The timestamp that the trade or financial product was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaaccount

Account Extended Schema


Extended account schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrued_interest
The accrued interest since the last payment date and due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
arrears_balance
The balance of the capital amount that is considered to be in arrears (for overdrafts/credit cards). Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
The contractual balance on the date and in the currency given. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the rate on the balance at the given date as agreed in the terms of the account.
string
FDTRUKBRBASEZERO
behavioral_curve_id
The unique identifier for the behavioral curve used by the financial institution.
string-
behavioral_end_date
Behavioral end date (as opposed to contractual). YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
break_dates
Dates where this contract can be broken (by either party). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_dates
Dates where this contract can be called (by the customer). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
capital_tier
The capital tiers based on own funds requirements.
string
add_tier_1anc_tier_2anc_tier_3at1_grandfatheredbas_tier_2bas_tier_3ce_tier_1cet1_grandfatheredt2_grandfatheredtier_1tier_2tier_3
ccf
The credit conversion factor that indicates the proportion of the undrawn amount that would be drawn down on default.
number-
commission
Commission percentage to be added onto interest rate of the product to calculate the credit spread at inception of receiving the deposit.
integer-
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
count
Describes the number of accounts aggregated into a single row.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
cum_write_offs
The portion of the loan which has been written off.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer that owns the account.
string-
day_count_convention
The methodology for calculating the number of days between two dates. It is used to calculate the amount of accrued interest or the present value.
string
act_360act_365act_actstd_30_360std_30_365
default_date
Date of default.
string-
ead
The EAD field allows users to input monetary exposure-at-default values across the loan’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
ead_irb_ec
The expected gross dollar exposure for each facility upon a borrower’s default as determined by internal ratings-based approach. This value is used in economic capital calculations.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
encumbrance_amount
The amount of the account that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
encumbrance_type
The type of the encumbrance causing the encumbrance_amount.
string
covered_bondderivativenoneotherrepo
end_date
The end or maturity date of the account. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
facility_id
The code assigned by the financial institution to identify a facility.
string-
first_arrears_date
The first date on which this account was in arrears.
string-
first_payment_date
The first payment date for interest payments.
string-
forbearance_date
The date on which the first forbearance measure was granted to this product. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
fraud_loss
The total value of accounting losses incurred by the Financial Institution due to fraudulent activities within the reporting segment.
integer-
frr_id
The internal facility risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
guarantee_amount
The amount of the account that is guaranteed under a Government Deposit Guarantee Scheme. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
guarantee_scheme
The Government Deposit Scheme scheme under which the guarantee_amount is guaranteed.
string
be_pfbg_difca_cdiccy_dpscz_difde_edbde_edode_edwdk_gdfiee_dgses_fgdfi_dgffr_fdggb_fscsgr_dgshk_dpshr_dihu_ndifie_dgsit_fitdlt_vilu_fgdllv_dgfmt_dcsnl_dgspl_bfgpt_fgdro_fgdbse_ndosi_dgssk_dpfus_fdic
impairment_amount
The impairment amount is the allowance set aside by the firm that accounts for the event that the asset becomes impaired in the future.
integer-
impairment_date
The date upon which the product became considered impaired. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
impairment_type
The loss event resulting in the impairment of the loan.
string
collectiveindividualwrite_off
insolvency_rank
The insolvency ranking as per the national legal framework of the reporting institution.
integer-
int_reset_freq
The adjustable rate periodic interest reset period. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
interest_repayment_frequency
Repayment frequency of the interest.
string
dailyweeklybi_weeklymonthlybi_monthlyquarterlysemi_annuallyannuallyat_maturitybienniallysesquiennially
last_drawdown_date
The last date on which a drawdown was made on this account (overdraft).
string-
last_payment_date
The final payment date for interest payments, often coincides with end_date.
string-
last_recovery_date
Date of most recent recovery in the reporting quarter.
string-
last_write_off_date
Date of Financial Institution’s most recent Write Off in the reporting quarter.
string-
ledger_code
The internal ledger code or line item name.
string-
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations.
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
lgd_irb_ec
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
limit_amount
The minimum balance the customer can go overdrawn in their account.
integer-
min_interest_repayment
The minimum interest on outstanding balance and fees that customers are due to repay.
integer-
min_principal_repayment
The minimum principal balance that customers are due to repay.
integer-
minimum_balance
Indicates the minimum balance of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
minimum_balance_eur
Indicates the minimum balance, in Euros, of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
mna_id
The unique identifier of the Master Netting Agreement the account falls under. Typically used where a legally enforceable right to offset exists and where the reporting entity intends to settle on a net basis.
string-
mtd_deposits
Month to date amount deposited within the account as a naturally positive integer number of cents/pence.
integer-
mtd_interest_paid
Month to date interest added to account as a naturally positive integer number of cents/pence.
integer-
mtd_withdrawals
Month to date amount withdrawn from the account as a naturally positive integer number of cents/pence.
integer-
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_repricing_date
The date on which the interest rate of the account will be re-calculated. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
next_withdrawal_date
The next date at which customer is allowed to withdraw money from this account.
string-
on_balance_sheet
Is the account or deposit reported on the balance sheet of the financial institution?
boolean-
orig_credit_score
The credit score of the customer at origination of the product using a commercially available credit bureau score.
integer-
orig_limit_amount
The original line of credit amount that was granted at the origination of the facility
integer-
parent_facility_id
The parent code assigned by the financial institution to identify a facility.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
purpose
The purpose for which the account was created or is being used.
string
adj_syn_inv_decon_subsadj_syn_inv_own_sharesadj_syn_mtg_def_insadj_syn_nonsig_inv_finadj_syn_other_inv_finadminannual_bonus_accrualsbenefit_in_kindcapital_gain_taxcapital_reservecash_managementcf_hedgecf_hedge_reclassci_serviceclearingcollateralcommitmentscomputer_and_it_costcomputer_peripheralcomputer_softwarecorporation_taxcredit_card_feecritical_servicecurrent_account_feecustodydealing_rev_crdealing_rev_dbt_issuedealing_rev_debtdealing_rev_depositsdealing_rev_derivdealing_rev_deriv_comdealing_rev_deriv_ecodealing_rev_deriv_equdealing_rev_deriv_fxdealing_rev_deriv_intdealing_rev_deriv_nsedealing_rev_deriv_othdealing_rev_equitydealing_rev_fxdealing_rev_fx_nsedealing_rev_irdealing_rev_loandealing_rev_non_findealing_rev_oth_finandealing_rev_secdealing_rev_sec_nsedealing_rev_shortdealing_revenueded_fut_profded_fut_prof_temp_diffdefined_benefitdepositderivative_feedgs_contributiondiv_from_cisdiv_from_money_mktdividenddonationemployeeemployee_stock_optionescrowfeesfinefirm_operating_expensesfirm_operationsfurniturefut_proffut_prof_temp_difffxgeneral_credit_riskgoodwillinsurance_feeint_on_assetint_on_bond_and_frnint_on_bridging_loanint_on_credit_cardint_on_debt_issuedint_on_depositint_on_deriv_hedgeint_on_derivativeint_on_ecgd_lendingint_on_finance_leasingint_on_liabilityint_on_loan_and_advint_on_money_mktint_on_mortgageint_on_sftint_unallocatedintangibleintangible_leaseinterestintra_group_feeinv_in_subsidiaryinvestment_banking_feeinvestment_prop_leaseinvestment_propertyipsit_outsourcinglandloan_and_advance_feemachinerymanufactured_dividendmortgage_feemsrmtg_ins_nonconformmtg_insuranceni_contributionnol_carrybacknon_life_ins_premiumnot_fut_profoccupancy_costoperationaloperational_escrowoperational_excessoth_tax_excl_temp_diffotherother_expenditureother_fs_feeother_non_fs_feeother_social_contribother_staff_costother_staff_removerdraft_feeown_propertypensionppeprime_brokeragepropertyproperty_leasepv_future_spread_increc_unidentified_cptyreclass_taxrecoveryredundancy_pymtreferencereg_lossregular_wagesreleaserentres_fund_contributionrestructuringretained_earningsrevaluationrevaluation_reclassrevenue_reserveshare_planshare_premiumstaffsystemtaxtelecom_equipmentthird_party_interestunderwriting_feeunsecured_loan_feevehiclewrite_off
rate
The full interest rate applied to the account balance in percentage terms. Note that this therefore includes the base_rate (ie. not the spread).
number-
rate_type
Describes the type of interest rate applied to the account.
string
combinedfixedpreferentialtrackervariable
recourse
Whether there is recourse on a loan. Recourse on a loan refers to terms in the mortgage contract that give the owner of the note the right to pursue additional claims against the borrower beyond possession of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
fullnonepartial
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
resolution_date
Date of resolution of the defaulted facility.
string-
review_date
The currently scheduled review date for Counterparty exposure. This date should be set in the future. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
rollover_date
A particular predetermined date at which an account is rolled-over.
string-
seniority
The seniority of the security in the event of sale or bankruptcy of the issuer.
string
mezzaninepari_passusenior_securedsenior_unsecuredsubordinated_securedsubordinated_unsecured
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
start_date
The timestamp that the trade or financial product commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Describes if the Account is active or been cancelled.
string
activeauditedcancelledcancelled_payout_agreedotherpendingtransactionalunaudited
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
type
This is the type of the account with regards to common regulatory classifications.
string
accrualsamortisationbondscallcdcredit_cardcurrentcurrent_iodebt_securities_issueddeferreddeferred_taxdepreciationexpensefinancial_leaseincomeintangibleinternet_onlyiraisaisa_currentisa_current_ioisa_ioisa_time_depositisa_time_deposit_ioloans_and_advancesmoney_marketnon_deferrednon_productotherother_financial_liabprepaid_cardprepaymentsprovisionreserveretail_bondssavingssavings_iosuspensetangiblethird_party_savingstime_deposittime_deposit_iovaluation_allowancevostro
uk_funding_type
Funding type calculated according to BIPRU 12.5/12.6
string
ab
undrawn_provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the undrawn portion of a loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
withdrawal_penalty
This is the penalty incurred by the customer for an early withdrawal on this account. An early withdrawal is defined as a withdrawal prior to the next_withdrawal_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
layouttitle
schemaaccount

Account Extended Schema


Extended account schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrued_interest
The accrued interest since the last payment date and due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
arrears_balance
The balance of the capital amount that is considered to be in arrears (for overdrafts/credit cards). Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
The contractual balance on the date and in the currency given. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the rate on the balance at the given date as agreed in the terms of the account.
string
FDTRUKBRBASEZERO
behavioral_curve_id
The unique identifier for the behavioral curve used by the financial institution.
string-
behavioral_end_date
Behavioral end date (as opposed to contractual). YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
break_dates
Dates where this contract can be broken (by either party). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_dates
Dates where this contract can be called (by the customer). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
capital_tier
The capital tiers based on own funds requirements.
string
add_tier_1anc_tier_2anc_tier_3at1_grandfatheredbas_tier_2bas_tier_3ce_tier_1cet1_grandfatheredt2_grandfatheredtier_1tier_2tier_3
ccf
The credit conversion factor that indicates the proportion of the undrawn amount that would be drawn down on default.
number-
commission
Commission percentage to be added onto interest rate of the product to calculate the credit spread at inception of receiving the deposit.
integer-
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
count
Describes the number of accounts aggregated into a single row.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
cum_write_offs
The portion of the loan which has been written off.
integer-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer that owns the account.
string-
day_count_convention
The methodology for calculating the number of days between two dates. It is used to calculate the amount of accrued interest or the present value.
string
act_360act_365act_actstd_30_360std_30_365
default_date
Date of default.
string-
ead
The EAD field allows users to input monetary exposure-at-default values across the loan’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
ead_irb_ec
The expected gross dollar exposure for each facility upon a borrower’s default as determined by internal ratings-based approach. This value is used in economic capital calculations.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
encumbrance_amount
The amount of the account that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
encumbrance_type
The type of the encumbrance causing the encumbrance_amount.
string
covered_bondderivativenoneotherrepo
end_date
The end or maturity date of the account. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
facility_id
The code assigned by the financial institution to identify a facility.
string-
first_arrears_date
The first date on which this account was in arrears.
string-
first_payment_date
The first payment date for interest payments.
string-
forbearance_date
The date on which the first forbearance measure was granted to this product. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
fraud_loss
The total value of accounting losses incurred by the Financial Institution due to fraudulent activities within the reporting segment.
integer-
frr_id
The internal facility risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
guarantee_amount
The amount of the account that is guaranteed under a Government Deposit Guarantee Scheme. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
guarantee_scheme
The Government Deposit Scheme scheme under which the guarantee_amount is guaranteed.
string
be_pfbg_difca_cdiccy_dpscz_difde_edbde_edode_edwdk_gdfiee_dgses_fgdfi_dgffr_fdggb_fscsgr_dgshk_dpshr_dihu_ndifie_dgsit_fitdlt_vilu_fgdllv_dgfmt_dcsnl_dgspl_bfgpt_fgdro_fgdbse_ndosi_dgssk_dpfus_fdic
impairment_amount
The impairment amount is the allowance set aside by the firm that accounts for the event that the asset becomes impaired in the future.
integer-
impairment_date
The date upon which the product became considered impaired. Format should be YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
impairment_type
The loss event resulting in the impairment of the loan.
string
collectiveindividualwrite_off
insolvency_rank
The insolvency ranking as per the national legal framework of the reporting institution.
integer-
int_reset_freq
The adjustable rate periodic interest reset period. Denominated in whole multiples of the interest_repayment_frequency. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
interest_repayment_frequency
Repayment frequency of the interest.
string
dailyweeklybi_weeklymonthlybi_monthlyquarterlysemi_annuallyannuallyat_maturitybienniallysesquiennially
last_drawdown_date
The last date on which a drawdown was made on this account (overdraft).
string-
last_payment_date
The final payment date for interest payments, often coincides with end_date.
string-
last_recovery_date
Date of most recent recovery in the reporting quarter.
string-
last_write_off_date
Date of Financial Institution’s most recent Write Off in the reporting quarter.
string-
ledger_code
The internal ledger code or line item name.
string-
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations.
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
lgd_irb_ec
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
limit_amount
The minimum balance the customer can go overdrawn in their account.
integer-
min_interest_repayment
The minimum interest on outstanding balance and fees that customers are due to repay.
integer-
min_principal_repayment
The minimum principal balance that customers are due to repay.
integer-
minimum_balance
Indicates the minimum balance of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
minimum_balance_eur
Indicates the minimum balance, in Euros, of each account within the aggregate. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
mna_id
The unique identifier of the Master Netting Agreement the account falls under. Typically used where a legally enforceable right to offset exists and where the reporting entity intends to settle on a net basis.
string-
mtd_deposits
Month to date amount deposited within the account as a naturally positive integer number of cents/pence.
integer-
mtd_interest_paid
Month to date interest added to account as a naturally positive integer number of cents/pence.
integer-
mtd_withdrawals
Month to date amount withdrawn from the account as a naturally positive integer number of cents/pence.
integer-
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_repricing_date
The date on which the interest rate of the account will be re-calculated. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
next_withdrawal_date
The next date at which customer is allowed to withdraw money from this account.
string-
on_balance_sheet
Is the account or deposit reported on the balance sheet of the financial institution?
boolean-
orig_credit_score
The credit score of the customer at origination of the product using a commercially available credit bureau score.
integer-
orig_limit_amount
The original line of credit amount that was granted at the origination of the facility
integer-
parent_facility_id
The parent code assigned by the financial institution to identify a facility.
string-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
purpose
The purpose for which the account was created or is being used.
string
adj_syn_inv_decon_subsadj_syn_inv_own_sharesadj_syn_mtg_def_insadj_syn_nonsig_inv_finadj_syn_other_inv_finadminannual_bonus_accrualsbenefit_in_kindcapital_gain_taxcapital_reservecash_managementcf_hedgecf_hedge_reclassci_serviceclearingcollateralcommitmentscomputer_and_it_costcomputer_peripheralcomputer_softwarecorporation_taxcredit_card_feecritical_servicecurrent_account_feecustodydealing_rev_crdealing_rev_dbt_issuedealing_rev_debtdealing_rev_depositsdealing_rev_derivdealing_rev_deriv_comdealing_rev_deriv_ecodealing_rev_deriv_equdealing_rev_deriv_fxdealing_rev_deriv_intdealing_rev_deriv_nsedealing_rev_deriv_othdealing_rev_equitydealing_rev_fxdealing_rev_fx_nsedealing_rev_irdealing_rev_loandealing_rev_non_findealing_rev_oth_finandealing_rev_secdealing_rev_sec_nsedealing_rev_shortdealing_revenueded_fut_profded_fut_prof_temp_diffdefined_benefitdepositderivative_feedgs_contributiondiv_from_cisdiv_from_money_mktdividenddonationemployeeemployee_stock_optionescrowfeesfinefirm_operating_expensesfirm_operationsfurniturefut_proffut_prof_temp_difffxgeneral_credit_riskgoodwillinsurance_feeint_on_assetint_on_bond_and_frnint_on_bridging_loanint_on_credit_cardint_on_debt_issuedint_on_depositint_on_deriv_hedgeint_on_derivativeint_on_ecgd_lendingint_on_finance_leasingint_on_liabilityint_on_loan_and_advint_on_money_mktint_on_mortgageint_on_sftint_unallocatedintangibleintangible_leaseinterestintra_group_feeinv_in_subsidiaryinvestment_banking_feeinvestment_prop_leaseinvestment_propertyipsit_outsourcinglandloan_and_advance_feemachinerymanufactured_dividendmortgage_feemsrmtg_ins_nonconformmtg_insuranceni_contributionnol_carrybacknon_life_ins_premiumnot_fut_profoccupancy_costoperationaloperational_escrowoperational_excessoth_tax_excl_temp_diffotherother_expenditureother_fs_feeother_non_fs_feeother_social_contribother_staff_costother_staff_removerdraft_feeown_propertypensionppeprime_brokeragepropertyproperty_leasepv_future_spread_increc_unidentified_cptyreclass_taxrecoveryredundancy_pymtreferencereg_lossregular_wagesreleaserentres_fund_contributionrestructuringretained_earningsrevaluationrevaluation_reclassrevenue_reserveshare_planshare_premiumstaffsystemtaxtelecom_equipmentthird_party_interestunderwriting_feeunsecured_loan_feevehiclewrite_off
rate
The full interest rate applied to the account balance in percentage terms. Note that this therefore includes the base_rate (ie. not the spread).
number-
rate_type
Describes the type of interest rate applied to the account.
string
combinedfixedpreferentialtrackervariable
recourse
Whether there is recourse on a loan. Recourse on a loan refers to terms in the mortgage contract that give the owner of the note the right to pursue additional claims against the borrower beyond possession of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
fullnonepartial
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
resolution_date
Date of resolution of the defaulted facility.
string-
review_date
The currently scheduled review date for Counterparty exposure. This date should be set in the future. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
rollover_date
A particular predetermined date at which an account is rolled-over.
string-
seniority
The seniority of the security in the event of sale or bankruptcy of the issuer.
string
mezzaninepari_passusenior_securedsenior_unsecuredsubordinated_securedsubordinated_unsecured
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
start_date
The timestamp that the trade or financial product commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Describes if the Account is active or been cancelled.
string
activeauditedcancelledcancelled_payout_agreedotherpendingtransactionalunaudited
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
type
This is the type of the account with regards to common regulatory classifications.
string
accrualsamortisationbondscallcdcredit_cardcurrentcurrent_iodebt_securities_issueddeferreddeferred_taxdepreciationexpensefinancial_leaseincomeintangibleinternet_onlyiraisaisa_currentisa_current_ioisa_ioisa_time_depositisa_time_deposit_ioloans_and_advancesmoney_marketnon_deferrednon_productotherother_financial_liabprepaid_cardprepaymentsprovisionreserveretail_bondssavingssavings_iosuspensetangiblethird_party_savingstime_deposittime_deposit_iovaluation_allowancevostro
uk_funding_type
Funding type calculated according to BIPRU 12.5/12.6
string
ab
undrawn_provision_amount
The amount of reserves that is provisioned by the financial institution to cover the potential loss on the undrawn portion of a loan. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
withdrawal_penalty
This is the penalty incurred by the customer for an early withdrawal on this account. An early withdrawal is defined as a withdrawal prior to the next_withdrawal_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
layouttitle
schemaadjustment

Adjustment Extended Schema


Extended adjustment schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
col
The column of the report that this adjustment relates to.
string-
comment
The description or commentary around the adjustment.
string-
contribution_amount
The contribution amount this adjustment should make to the specified report cell. A positive/negative number in minor units (cents/pence).
integer-
contribution_text
The text to use for the adjustment where the reported cell is not a monetary value.
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
page
The page of the report that this adjustment relates to.
string-
report_type
The report that this adjustment relates to.
string-
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
row
The row of the report that this adjustment relates to.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemaagreement

Agreement Extended Schema


Extended agreement schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
base_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
credit_support_type
The type of credit support document
string
csa_isda_1994csa_isda_1995csd_isda_1995scsa_isda_2013
customer_id
The unique identifier used by the financial institution to identify the counterparty to this agreement.
string-
guarantor_id
The unique identifier used by the financial institution to identify the guarantor of the transactions covered by this agreement.
string-
margin_frequency
Indicates the periodic timescale at which variation margin is exchanged. Cleared derivatives which are daily settled can be flagged as daily_settled.
string
dailydaily_settledweeklybi_weeklymonthly
margin_period_of_risk
Margin period of risk estimated for the transactions covered by the [CSA] agreement
integer-
minimum_transfer_amount
Smallest amount of collateral that can be transferred. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
netting_restriction
populated only if any netting restriction applies, in relation to the nature of the agreement or the enforceability of netting in the jurisdiction of the counterparty, preventing the recognition of the agreement as risk-reducing, pursuant to CRR Articles 295 to 298
string
national_supervisionno_right_to_offsetrestrictive_covenant
number_of_disputes
Indicates the number of disputes threshold to be used in the margin period of risk
integer-
source
The source where this data originated.
string-
start_date
The timestamp that the agreement commences. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
stay_protocol
Indicates whether a stay protocol has been signed by one or both parties to the agreement.
string
bothcustomerself_signed
threshold
Amount below which collateral is not required. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
type
The type of the master agreement.
string
afbdrvemafbfgmragmslaicma_1992icma_1995icma_2000icma_2011isdaisda_1985isda_1986isda_1987isda_1992isda_2002otherother_gmraother_isdaright_to_set_off
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemacollateral

Collateral Extended Schema


Extended collateral schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
account_ids
The unique identifier/s for the account/s within the financial institution.
array-
charge
Lender charge on collateral, 1 indicates first charge, 2 second and so on. 0 indicates a combination of charge levels.
integer-
city
The city in which the property is located.
string-
claims
The total amount of 3rd party claims on the collateral.
integer-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
encumbrance_amount
The amount of the collateral that is encumbered by potential future commitments or legal liabilities. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
encumbrance_type
The type of the encumbrance causing the encumbrance_amount.
string
covered_bondderivativenoneotherreal_estaterepo
end_date
The end date for recognition of the collateral
string-
loan_ids
The unique identifiers for the loans within the financial institution.
array-
orig_value
The valuation as used by the bank for the collateral at the origination of the related loan or line of credit. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
postal_code
The zip code in which the property is located. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
regulated
Identifies whether the collateral qualifies the exposure as ‘regulatory’ for credit risk purposes.
boolean-
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
security_id
The unique identifier used by the financial institution to identify the security representing collateral.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
start_date
The start date for recognition of the collateral
string-
street_address
The street address associated with the property. Must include street direction prefixes, direction suffixes, and unit number for condos and co-ops. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
type
The collateral type defines the form of the collateral provided
string
autoauto_otherblanket_liencarcashco_opcommercial_propertycommercial_property_hrcondoconvertibledebenturefarmfour_unitsguaranteehealthcarehospitalityimmovable_propertyindustriallife_policyluxurymanufactured_housemultifamilyofficeone_unitotherplanned_unit_devres_property_hrresi_mixed_useresidential_propertyretailsecuritysingle_familysportsuvthree_unitstownhousetrucktwo_unitsvanwarehouse
value
The valuation as used by the bank for the collateral on the value_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
value_date
The timestamp that the collateral was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
vol_adj
The volatility adjustment appropriate to the collateral.
number-
vol_adj_fx
The volatility adjustment appropriate to currency mismatch.
number-
census_tract
Census tracts are identified by an up to four digit integer number and may have an optional two?digit suffix. The census tract codes consist of six digits with an implied decimal between the fourth and fifth digit corresponding to the basic census tract number but with leading zeroes and trailing zeroes for census tracts without a suffix. For additional details refer to the Census Bureau website: https://www.census.gov/data/academy/data-gems/2018/tract.html
string-
orig_charge
The lender charge on collateral at origination. See: charge.
integer-
orig_valuation_type
Data schema to define collateral (currently can reference loans or accounts).
object-
property_size
The size of the property. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
sale_price
The final sales price at which the property was disposed by the reporting entity in the case of involuntary termination. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
integer-
valuation_type
Methodology used in the determination of the collateral value. Refer to https://www.ecfr.gov/current/title-12/chapter-VI/subchapter-B/part-614/subpart-F/section-614.4265 and https://www.federalreserve.gov/boarddocs/srletters/2010/sr1016a1.pdf
string
as_completedas_isas_stabilizedauto_val_modelbroker_pricedesktopfulllimitedprospective_market_valuepurchase_pricetav
value_after_mod
The collateral value after the loan has been modified. A loan arrears arrangement or modification refers to a situation where a lender and borrower agree to adjust the terms of an existing loan due to the borrower’s difficulty in making scheduled repayments. This typically occurs after the borrower falls behind, enters arrears, or anticipates they soon will.
integer-
layouttitle
schemacurve

Curve Extended Schema


Extended curve schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
name
The internal name of the curve.
string-
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
type
The curve type.
string
behavioralraterisk_ratingvolatility
values
The list of values for this curve.
array-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
layouttitle
schemacustomer

Customer Extended Schema


Extended customer schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
annual_debit_turnover
The annual debit turnover in the business account of the entity. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
clearing_threshold
Status of the clearing threshold as defined in EMIR
string
abovebelow
df_ccp
The pre-funded financial resources of the CCP in accordance with Article 50c of Regulation (EU) No 648/2012
integer-
df_cm
The sum of pre-funded contributions of all clearing members of the QCCP in accordance with Article 50c of Regulation (EU) No 648/2012.
integer-
incurred_cva
The amount of credit valuation adjustments being recognised by the institution as an incurred write-down, calculated without taking into account any offsetting debit value adjustment attributed to the firm’s own credit risk, that has been already excluded from own funds.
integer-
k_ccp
Hypothetical capital of the QCCP in accordance with Article 50c of Regulation (EU) No 648/2012
integer-
mic_code
The market identifier code as defined by the International Standards Organisation.
string-
pd_irb_ec
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in economic capital calculations.
number-
product_count
The number of active products/trades this customer has with the firm.
integer-
risk_profile
The evaluation of the customer’s willingness and/or capacity to take on financial risk.
integer-
start_date
The date that the customer first became a customer. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
The status of the relationship with the customer from the firm’s point of view.
string
established
accounts_payable
From the entity’s financial statements: The obligations owed to creditors arising from the entity’s ongoing operations, including the purchase of goods, materials, supplies, and services. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
accounts_payable_prev
From the entity’s financial statements: The obligations owed to creditors arising from the entity’s ongoing operations, including the purchase of goods, materials, supplies, and services from the previous reporting period. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
accounts_receivable
From the entity’s financial statements: The money owed to the entity for merchandise or services or services sold on open account. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
accounts_receivable_prev
From the entity’s financial statements: The money owed to the entity for merchandise or services or services sold on open account from the previous reporting period. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
audit_date
The date of the last audited financial statements. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string-
capital_exp
From the entity’s financial statements: The funds used to acquire a long-term asset resulting in depreciation deductions over the life of the acquired asset, gross of depreciation. This should include the trailing twelve month period ended one year prior to the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
cash_securities
From the entity’s financial statements: The cash, depository accounts and marketable securities of the entity that can be easily sold and readily converted into cash. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
credit_score
The credit score of the borrower. Also see [credit_score_vendor], [credit_score_version] and [credit_score_date]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
credit_score_date
The date on which the commercially available credit bureau score was obtained. Also see [credit_score_vendor], [credit_score_version] and [credit_score]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
credit_score_vendor
The vendor of the commercially available credit bureau score. Also see [credit_score_date], [credit_score_version] and [credit_score]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
ficoothervantage
credit_score_version
The version of the commercially available credit bureau score. Also see [credit_score_vendor], [credit_score_date] and [credit_score]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
curr_assets
From the entity’s financial statements: The cash, accounts receivable, inventory, and other assets of the entity that are likely to be converted into cash, sold, exchanged, or expensed in the normal course of business, usually within one year and other assets expected to be converted to cash within a year. Examples include accounts receivable, prepaid expenses, and many negotiable securities as of the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
curr_assets_prev
From the entity’s financial statements: The cash, accounts receivable, inventory, and other assets of the entity that are likely to be converted into cash, sold, exchanged, or expensed in the normal course of business, usually within one year and other assets expected to be converted to cash within a year. This is the data one year prior to the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
curr_liabilities
From the entity’s financial statements: The short-term debt, accounts payable and other current liabilities of the entity that are due within one year. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
curr_liabilities_prev
From the entity’s financial statements: The short-term debt, accounts payable and other current liabilities of the entity that are due within one year. This is the data one year prior to financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
curr_long_term_debt
From the entity’s financial statements: The portion of long-term debt of the entity due within one year. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
cusip
CUSIPs are identifiers created and delivered by the CSB (CUSIP Service Bureau). The CSB is managed on behalf of the American Bankers Association by Standard & Poor’s. Customer codes are assigned alphabetically from a series that includes deliberate built-in ‘gaps’ for future expansion. The first six characters which are known as the base (or CUSIP-6) uniquely identify the customer. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string-
depr_amort
From the entity’s financial statements: The total depreciation and amortisation costs of the entity of tangible and intangible assets allocated against revenue for the current period. This is the data for the trailing twelve month (TTM) period ended on the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
financials_date
The as of date of the financial information. Also see [accounts_payable], [accounts_receivable], [capital_exp], [cash_securities], [curr_assets], [curr_liabilities], [depr_amort], [fixed_assets], [interest_expense], [inventory], [long_term_debt], [long_term_debt_maturity_amount], [net_income], [net_sales], [operating_income], [retained_earnings], [short_term_debt], [tangible_assets], [total_assets], [total_liabilities]
Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string-
fixed_assets
From the entity’s financial statements: The tangible property of the entity used in the business and not for resale, net of depreciation. This includes, but is not limited to, buildings, furniture, fixtures, equipment, and land. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
interest_expense
From the entity’s financial statements: The periodic expense to the entity of securing short and long-term debt. This is the data for the trailing twelve month (TTM) period ended on the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
inventory
From the entity’s financial statements: The value of the raw materials, work in process, supplies used in operations, finished goods, and merchandise bought for resale of the entity . Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
inventory_prev
From the entity’s financial statements: The value of the raw materials, work in process, supplies used in operations, finished goods, and merchandise bought for resale of the entity . This is the data one year prior to financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
long_term_debt
From the entity’s financial statements: The liabilities of the entity that are due in one year or more. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
mailing_address
The borrower’s mailing street address. Must include street prefixes, suffixes, and unit number for condos and co-ops. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
mailing_city
The borrower’s mailing city. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
mailing_postal_code
The borrower’s mailing zip code. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string-
mailing_state
The borrower’s mailing state. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
minority_interest
The interest of shareholders who, in the aggregate, own less than half the shares in a corporation. On the consolidated balance sheets of companies whose subsidiaries are not wholly owned, the minority interest is shown as a separate equity account or as a liability of indefinite term. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
number-
net_income
From the entity’s financial statements: The income (or loss) reported by the entity after expenses and losses have been subtracted from all revenues and gains for the fiscal period including discontinued operations. This is the data for the trailing twelve month (TTM) period ended on the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
net_income_prev
From the entity’s financial statements: The income (or loss) reported by the entity after expenses and losses have been subtracted from all revenues and gains for the fiscal period including discontinued operations. This is the data for the trailing twelve month (TTM) period ended one year prior to the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
net_sales
From the entity’s financial statements: The gross sales of the entity reduced by cash discounts, trade discounts, and returned sales and allowances for which credit is given to customers less returns and allowances, freight out, and cash discounts allowed for the designated period. This is the data for the trailing twelve month (TTM) period ended on the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
net_sales_prev
From the entity’s financial statements: The gross sales of the entity reduced by cash discounts, trade discounts, and returned sales and allowances for which credit is given to customers less returns and allowances, freight out, and cash discounts allowed for the designated period. This should include the trailing twelve month period ended one year prior to the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
noi
From the entity’s financial statements: The most recent annualized net operating income as of the report date that serves as the primary source of repayment. Also see [noi_date]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
noi_date
The date of the current Net Operating Income (NOI). Also see [noi]. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string-
operating_income
From the entity’s financial statements: The amount of profit (or loss) realized from continuing operations of the entity; typically represented as sales less items such as cost of goods sold, operating expenses, amortisation and depreciation. This is the data for the trailing twelve month (TTM) period ended on the financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
orig_noi
The Net Operating Income (NOI) at origination.
integer-
regulator
Report the federal regulator of the entity. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string
fdicfrbocc
retained_earnings
From the entity’s financial statements: The cumulative retained earnings of the entity less total dividend distributions to shareholders. Typically, it is the prior year’s retained earnings plus net income less distributions. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
rssd_id
The RSSD ID of the national bank that has a financial interest in the loan. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14M for more information.
string-
short_term_debt
From the entity’s financial statements: The debt obligations of the entity with a term of less than one year. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
stock_symbol
The Stock Symbol for stocks listed and traded on the regulated exchange. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string-
tangible_assets
From the entity’s financial statements: The assets of the entity having a physical existence, such as cash, equipment, real estate, real property, and personal property such as buildings and machinery; accounts receivable are also usually considered tangible assets for accounting purposes. Tangible assets are distinguished from intangible assets, such as trademarks, copyrights, and goodwill, and natural resources (timberlands, oil reserves, and coal deposits). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
tin
The Taxpayer Identification Number (TIN) assigned to the guarantor by the U.S. Internal Revenue Service (IRS) in the administration of tax laws. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string-
total_assets_prev
From the entity’s financial statements: The sum of the current assets of the entity plus net property, plant, and equipment plus other non-current assets (including, but not limited to, intangible assets, deferred items, and investments and advances). This is the data one year prior to financials_date. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
total_liabilities
From the entity’s financial statements: The sum of current liabilities plus long-term debt plus other non-current liabilities (including deferred taxes, investment tax credit, and minority interest) of the entity . Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
total_resi_mortgages
Total number of mortgaged residential properties held by the obligor across all lenders, excluding the primary residence.
integer-
layouttitle
schemaderivative

Derivative Extended Schema


Extended derivative schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
acc_fv_change_before_taxes
Accumulated change in fair value before taxes.
integer-
accounting_treatment
The accounting treatment in accordance with IAS/IFRS9 accounting principles.
string
amortised_costavailable_for_salecb_or_demanddeed_in_lieufv_mandatorilyfv_ocifv_thru_pnlheld_for_hedgeheld_for_investheld_for_invest_fvoheld_for_saleheld_for_tradingheld_to_maturityloans_and_recsntnd_cost_basedntnd_fv_equityntnd_fv_plother_gaaptrading_gaap
accrued_interest
The accrued interest since the last payment date and due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_class
The asset class to which the derivative belongs.
string
agricoco_othercoalcoffeecorncrcr_indexcr_singleelectricityenergyeqeq_indexeq_singlefxgasgoldinflationirmetalsoilotherpalladiumplatinumprecious_metalssilversugar
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
Outstanding amount including accrued interest. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
base_rate
The base rate represents the basis of the rate on the balance at the given date as agreed in the terms of the financial product.
string
FDTRFESRUKBRBASEUSTSRZERObbswbbsw_3meuriboreuribor_1meuribor_3meuribor_6motherpbocsofrsofr_1msofr_3msofr_6m
break_dates
Dates where this contract can be broken (by either party). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
call_dates
Dates where this contract can be called (by the customer). Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
array-
ccr_approach
Specifies the approved counterparty credit risk methodology for calculating exposures.
string
immoemsassa
cost_center_code
The organizational unit or sub-unit to which costs/profits are booked.
string-
country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
cr_approach
Specifies the approved credit risk rwa calculation approach to be applied to the exposure.
string
airbeif_fbeif_lteif_mbafirbsec_erbasec_sasec_sa_ltstd
csa_id
The unique identifier of the credit support annex for this derivative
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
customer_id
The unique identifier used by the financial institution to identify the customer for this product.
string-
deal_id
The unique identifier used by the financial institution for the deal to which this derivative belongs.
string-
default_date
Date of default.
string-
delta
Price sensitivity to the underlying.
number-
ead
The EAD field allows users to input monetary exposure-at-default values across the derivative’s lifecycle. Upon default, this field must be updated to reflect the final realised EAD value — that is, the actual exposure outstanding at the moment of default.
integer-
economic_loss
The definition of loss, used in estimating Loss Given Default for the reporting segment. When measuring economic loss, as opposed to accounting loss
integer-
end_date
YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601
string-
first_payment_date
The first payment date for interest payments.
string-
frr_id
The internal risk rating assigned to a facility based on its specific risk characteristics, including collateral and seniority.
string-
fvh_level
Fair value hierarchy category according to IFRS 13.93 (b)
integer-
gamma
Second-order price sensitivity to the underlying or rate of change of the delta.
number-
hedge_designation
ASU 2017-12 hedge designations allowed in conjunction with partial-term hedging election in ASC 815-20-25-12b(2)(ii). These designations are described in ASC 815-20-25-12A and 815-25-35-13B.
https://asc.fasb.org/1943274/2147480682/815-20-25-12A
https://asc.fasb.org/1943274/2147480295/815-25-35-13B
string
cash_flowslast_of_layer
hedge_id
Unique identifier that establishes a relational link between a security and its associated derivative hedge. Enables consistent tracking, aggregation, and reconciliation of hedged positions across systems and datasets.
string-
hedge_sidedness
Whether the hedging instrument provides a one-sided effective offset of the hedged risk, as permitted under ASC 815-20-25-76.
https://asc.fasb.org/1943274/2147480682/815-20-25-76
string
one_sidedtwo_sided
hedge_type
The type of hedge (fair value or cash flow hedge) associated with the holding. Whether it is hedging individually or is hedging as part of a portfolio of assets with similar risk that are hedged as a group in line with ASC 815-20-25-12 (b), ASC 815-20-2512A, or ASC 815-10-25-15.
https://asc.fasb.org/1943274/2147480682/815-20-25-12
https://asc.fasb.org/1943274/2147480682/815-20-25-12A
https://asc.fasb.org/1943274/2147480682/815-10-25-15
string
cf_hedgefv_hedgeportfolio_cf_hedgeportfolio_fv_hedge
hedged_cf_type
The type of cash flow associated with the hedge if it is a cash flow hedge. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
string
interest_onlyotherpartialprincipal_interestprincipal_only
hedged_risk
The risk being hedged, among the potential hedged risks described under ASC 815-20-25-12 and ASC 815-20-25-15.
https://asc.fasb.org/1943274/2147480682/815-20-25-12
https://asc.fasb.org/1943274/2147480682/815-20-25-15
string
crfv_optionfxfx_cririr_crir_fxir_fx_crotheroverall_fv_cf
impairment_amount
The impairment amount for a security is the allowance set aside by the firm for losses.
integer-
impairment_status
The recognition stage for the impairment/expected credit loss of the product.
string
doubtfulin_litigationlossnon_performingnormalperformingpre_litigationstage_1stage_1_doubtfulstage_1_lossstage_1_normalstage_1_substandardstage_1_watchstage_2stage_2_doubtfulstage_2_lossstage_2_normalstage_2_substandardstage_2_watchstage_3stage_3_doubtfulstage_3_lossstage_3_normalstage_3_substandardstage_3_watchsubstandardwatch
implied_vol
Options: implied volatility used to compute mtm and greeks.
number-
initial_margin
Upfront margin posted/received for the trade. Monetary type as integer number of cents.
integer-
insolvency_rank
The insolvency ranking as per the national legal framework of the reporting institution.
integer-
last_exercise_date
The last date on which an option can be exercised. For European options, it is the option exercise date
string-
last_payment_date
The final payment date for interest payments, often coincides with end_date.
string-
ledger_code
The internal ledger code or line item name.
string-
leg_type
Describe the payoff type of the derivative leg.
string
callfixedfloatingindexedput
lgd_floored
The final LGD value after the relevant floors have been applied. To be used in the IRB RWA calculations.
number-
lgd_irb
The loss given default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
mic_code
The market identifier code as defined by the International Standards Organisation.
string-
mna_id
The unique identifier of the Master Netting Agreement for this derivative
string-
mtm_clean
The mark-to-market value of the derivative excluding interest. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
mtm_dirty
The mark-to-market value of the derivative including interest. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
next_exercise_date
The next date at which the option can be exercised.
string-
next_payment_amount
The amount that will need to be paid at the next_payment_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
next_payment_date
The next date at which interest will be paid or accrued_interest balance returned to zero.
string-
next_receive_amount
The amount that is expected to be received at the next_receive_date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
next_receive_date
The next date at which interest will be received or accrued_interest balance returned to zero.
string-
next_reset_date
The date on which the periodic payment term and conditions of a contract agreement are reset/re-established.
string-
notional_amount
The notional value is the total value with regard to a derivative’s underlying index, security or asset at its spot price in accordance with the specifications (i.e. leverage) of the derivative product. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
on_balance_sheet
Is the derivative reported on the balance sheet of the financial institution?
boolean-
pd_irb
The probability of default as determined by internal ratings-based approach. Expressed as a percentage between 0 and 1. This value is used in regulatory capital calculations.
number-
position
Specifies the market position, i.e. long or short, of the derivative leg
string
longshort
prev_payment_date
The most recent previous date at which interest was paid or accrued_interest balance returned to zero.
string-
product_name
The name of the product as given by the financial institution to be used for display and reference purposes.
string-
purpose
The purpose for which the derivative is being held.
string
back_to_backclient_executionclient_transmissioncva_hedgereference
rate
The full interest rate applied to the derivative notional in percentage terms. Note that this therefore includes the base_rate (ie. not the spread).
number-
regulatory_book
The type of portfolio in which the instrument is held.
string
banking_booktrading_book
reporting_entity_name
The name of the reporting legal entity for display purposes.
string-
reporting_id
The internal ID for the legal entity under which the account is being reported.
string-
resolution_date
Date of resolution of the defaulted facility.
string-
rho
Price sensitivity to interest rates.
number-
risk_country_code
Two-letter country code as defined according to ISO 3166-1 plus ISO allowed, user-assignable codes (AA, QM to QZ, XA to XZ, and ZZ).
string
AAADAEAE-AJAE-AZAE-DUAE-FUAE-RKAE-SHAE-UQAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACA-ABCA-BCCA-MBCA-NBCA-NLCA-NSCA-NTCA-NUCA-ONCA-PECA-QCCA-SKCA-YTCCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQAQMQNQOQPQQQRQSQTQUQVQWQXQYQZRERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUS-AKUS-ALUS-ARUS-AZUS-CAUS-COUS-CTUS-DCUS-DEUS-FLUS-GAUS-HIUS-IAUS-IDUS-ILUS-INUS-KSUS-KYUS-LAUS-MAUS-MDUS-MEUS-MIUS-MNUS-MOUS-MSUS-MTUS-NCUS-NDUS-NEUS-NHUS-NJUS-NMUS-NVUS-NYUS-OHUS-OKUS-ORUS-PAUS-RIUS-SCUS-SDUS-TNUS-TXUS-UTUS-VAUS-VTUS-WAUS-WIUS-WVUS-WYUYUZVAVCVEVGVIVNVUWFWSXAXBXCXDXEXFXGXHXIXJXKXLXMXNXOXPXQXRXSXTXUXVXWXXXYXZYEYTZAZMZWZZ
risk_weight_irb
The internal risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
risk_weight_std
The standardised approach risk weight represented as a decimal/float such that 1.5% is 0.015.
number-
settlement_type
The type of settlement for the contract.
string
cashphysical
source
The source(s) where this data originated. If more than one source needs to be stored for data lineage, it should be separated by a dash. eg. Source1-Source2
string-
spread
The additional rate that is added to the relevant index. The paid-spread-over-index rate plus the difference between the fixed coupon on the underlying note and the received fixed rate on the swap. This is represented in basis points (bps). Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
start_date
Contract effective or commencement date; security issue date. Format YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
status
Provides additional information regarding the status of the derivative.
string
free_deliveriesunsettled
strike
Strike price of the option, which is compared to the underlying price on the option exercise date.
number-
supervisory_price
Current price/value of the underlying of an option when different from underlying_price, e.g. for Asian-style options.
number-
theta
Price sensitivity with respect to time.
number-
trade_date
The timestamp that the trade or financial product terms are agreed. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
type
This is the type of the derivative with regards to common regulatory classifications.
string
cap_floorccdscdsforwardfrafuturemtm_swapndfndsoisoptionspotswaptionvanilla_swapvariance_swapxccy
underlying_currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEDVESVNDVUVWSTXADXAFXAGXAUXBAXBBXBCXBDXCDXCGXDRXOFXPDXPFXPTXSUXTSXUAXXXYERZARZMWZWG
underlying_derivative_id
The unique identifier used by the financial institution to identify the underlying reference derivative for this derivative.
string-
underlying_index
The name of a derivative contract underlying which can be used for all derivative asset classes (e.g. interest rate index, credit index, equity index
string-
underlying_index_tenor
The designated maturity of the underlying interest rate index used in the underlying_index property for interest rate derivatives
string
1d7d28d91d182d1m2m3m4m5m6m7m8m9m12m24m60m120m360m
underlying_issuer_id
The unique identifier used by the financial institution to identify the underlying reference issuer for this derivative.
string-
underlying_price
Current price/value of the underlying.
number-
underlying_quantity
Number of underlying units related to the underlying_price
number-
underlying_security_id
The unique identifier used by the financial institution to identify the underlying reference security for this derivative.
string-
underlying_strike
Strike price of the option, which is compared to the underlying price on the option exercise date.
number-
value_date
The timestamp that the derivative was valued. YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
vega
Price sensitivity to volatility.
number-
version_id
The version identifier of the data such as the firm’s internal batch identifier.
string-
period_pnl
The gains and losses in the period of the hedging instrument(s), associated with the hedged_risk and hedged_percentage. Refer to https://www.federalreserve.gov/apps/reportingforms/Report/Index/FR_Y-14Q for more information.
integer-
layouttitle
schemaderivative_cash_flow

Derivative Cash Flow Extended Schema


Extended derivative cash flow schema containing all jurisdiction-specific extensions.

Properties

NameDescriptionTypeEnum
id
The unique identifier for the record within the firm.
string-
date
The observation or value date for the data in this object. Formatted as YYYY-MM-DDTHH:MM:SSZ in accordance with ISO 8601.
string-
accrued_interest
The accrued interest/premium due at the next payment date. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
asset_class
The asset class to which the derivative belongs.
string
agricoco_othercoalcoffeecorncrcr_indexcr_singleelectricityenergyeqeq_indexeq_singlefxgasgoldinflationirmetalsoilotherpalladiumplatinumprecious_metalssilversugar
asset_liability
Is the data an asset, a liability, or equity on the firm’s balance sheet?
string
assetequityliabilityocipnl
balance
The contractual balance due on the payment date in the currency given. Monetary type represented as a naturally positive integer number of cents/pence.
integer-
csa_id
The unique identifier of the credit support annex for this derivative cash flow
string-
currency_code
Currency in accordance with ISO 4217 standards plus CNH for practical considerations.
string
AEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYNBZDCADCDFCHECHFCHWCLFCLPCNHCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLYDMADMDLMGAMKDMMKMNTMOPMRUMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLESLLSOSSRDSSPSTNSYPSZLTHBTJSTMTTNDTOP