| layout | title |
|---|---|
| readme | Home |
Financial Regulatory (FIRE) Data Standard
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
| layout | title |
|---|---|
| readme | Home |
Financial Regulatory (FIRE) Data Standard
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
| layout | title |
|---|---|
| readme | Introduction |
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:
- “date-time”: Date representation, as defined by RFC 3339, section 5.6.
- “email”: Internet email address, see RFC 5322, section 3.4.1.
- “hostname”: Internet host name, see RFC 1034, section 3.1.
- “ipv4”: IPv4 address, according to dotted-quad ABNF syntax as defined in RFC 2673, section 3.2.
- “ipv6”: IPv6 address, as defined in RFC 2373, section 2.2.
- “uri”: A universal resource identifier (URI), according to RFC3986.
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.
| layout | title |
|---|---|
| readme | FAQs |
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.
| layout | title |
|---|---|
| readme | Contributing |
Contributing
- Create a (free) Github account: https://github.com/join
- Start a discussion in the Issue Tracker: https://github.com/SuadeLabs/fire/issues
- Make a pull request: https://help.github.com/articles/using-pull-requests/
Contribution Requirements
-
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.
-
For every new attribute there should be a corresponding documentation file.
-
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.
-
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
| layout | title |
|---|---|
| readme | Guiding 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:
| balance | original ccy | in USD |
|---|---|---|
| 100 | EUR | 120 |
| 100 | USD | 90 |
| 100 | EUR | 130 |
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 type | issuer-type-is-govt |
|---|---|
| government_bond | Y |
This has the potential to create contradictory data of the nature:
| security type | issuer-type-is-govt |
|---|---|
| government_bond | N |
Better would be:
| security type | issuer-type-is-govt |
|---|---|
| bond | Y |
Even better would be:
| security type | issuer type |
|---|---|
| bond | government |
Why? Because flags are limiting and can still lead to inconsistencies:
| security type | issuer-type-is-govt | issuer-type-is-retail |
|---|---|---|
| bond | Y | Y |
| layout | title |
|---|---|
| readme | FIRE data examples |
The following are a few examples of common financial trades.
- Individual element examples
- Account examples
- Loan examples
- Derivative examples
- Bermudan swaption
- Bond future
- Cross-currency swap
- Commodity option
- Credit default swap - Index
- Credit default swap - Single name
- Equity option
- Equity total return swap
- Forward rate agreement
- FX forward
- FX future
- FX option
- FX spot
- FX swap
- Interest rate cap floor
- Interest rate digital floor
- Interest rate future
- Interest rate swap
- Interest rate swap amortising
- Margined netting agreement
- USD Payer Swaption
- Unmargined netting agreement
- Security examples
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"
}
]
}
}
| layout | title |
|---|---|
| schema | account |
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
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_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 | asset, equity, liability, oci, pnl, |
| 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 | FDTR, UKBRBASE, ZERO, |
| 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_1, anc_tier_2, anc_tier_3, at1_grandfathered, bas_tier_2, bas_tier_3, ce_tier_1, cet1_grandfathered, t2_grandfathered, tier_1, tier_2, tier_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_360, act_365, act_act, std_30_360, std_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_bond, derivative, none, other, repo, |
| 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_pf, bg_dif, ca_cdic, cy_dps, cz_dif, de_edb, de_edo, de_edw, dk_gdfi, ee_dgs, es_fgd, fi_dgf, fr_fdg, gb_fscs, gr_dgs, hk_dps, hr_di, hu_ndif, ie_dgs, it_fitd, lt_vi, lu_fgdl, lv_dgf, mt_dcs, nl_dgs, pl_bfg, pt_fgd, ro_fgdb, se_ndo, si_dgs, sk_dpf, us_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| impairment_type | The loss event resulting in the impairment of the loan. | string | collective, individual, write_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 | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
| 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_subs, adj_syn_inv_own_shares, adj_syn_mtg_def_ins, adj_syn_nonsig_inv_fin, adj_syn_other_inv_fin, admin, annual_bonus_accruals, benefit_in_kind, capital_gain_tax, capital_reserve, cash_management, cf_hedge, cf_hedge_reclass, ci_service, clearing, collateral, commitments, computer_and_it_cost, computer_peripheral, computer_software, corporation_tax, credit_card_fee, critical_service, current_account_fee, custody, dealing_rev_cr, dealing_rev_dbt_issue, dealing_rev_debt, dealing_rev_deposits, dealing_rev_deriv, dealing_rev_deriv_com, dealing_rev_deriv_eco, dealing_rev_deriv_equ, dealing_rev_deriv_fx, dealing_rev_deriv_int, dealing_rev_deriv_nse, dealing_rev_deriv_oth, dealing_rev_equity, dealing_rev_fx, dealing_rev_fx_nse, dealing_rev_ir, dealing_rev_loan, dealing_rev_non_fin, dealing_rev_oth_finan, dealing_rev_sec, dealing_rev_sec_nse, dealing_rev_short, dealing_revenue, ded_fut_prof, ded_fut_prof_temp_diff, defined_benefit, deposit, derivative_fee, dgs_contribution, div_from_cis, div_from_money_mkt, dividend, donation, employee, employee_stock_option, escrow, fees, fine, firm_operating_expenses, firm_operations, furniture, fut_prof, fut_prof_temp_diff, fx, general_credit_risk, goodwill, insurance_fee, int_on_asset, int_on_bond_and_frn, int_on_bridging_loan, int_on_credit_card, int_on_debt_issued, int_on_deposit, int_on_deriv_hedge, int_on_derivative, int_on_ecgd_lending, int_on_finance_leasing, int_on_liability, int_on_loan_and_adv, int_on_money_mkt, int_on_mortgage, int_on_sft, int_unallocated, intangible, intangible_lease, interest, intra_group_fee, inv_in_subsidiary, investment_banking_fee, investment_prop_lease, investment_property, ips, it_outsourcing, land, loan_and_advance_fee, machinery, manufactured_dividend, mortgage_fee, msr, mtg_ins_nonconform, mtg_insurance, ni_contribution, nol_carryback, non_life_ins_premium, not_fut_prof, occupancy_cost, operational, operational_escrow, operational_excess, oth_tax_excl_temp_diff, other, other_expenditure, other_fs_fee, other_non_fs_fee, other_social_contrib, other_staff_cost, other_staff_rem, overdraft_fee, own_property, pension, ppe, prime_brokerage, property, property_lease, pv_future_spread_inc, rec_unidentified_cpty, reclass_tax, recovery, redundancy_pymt, reference, reg_loss, regular_wages, release, rent, res_fund_contribution, restructuring, retained_earnings, revaluation, revaluation_reclass, revenue_reserve, share_plan, share_premium, staff, system, tax, telecom_equipment, third_party_interest, underwriting_fee, unsecured_loan_fee, vehicle, write_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 | combined, fixed, preferential, tracker, variable, |
| 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 | full, none, partial, |
| regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | mezzanine, pari_passu, senior_secured, senior_unsecured, subordinated_secured, subordinated_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 | active, audited, cancelled, cancelled_payout_agreed, other, pending, transactional, unaudited, |
| 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 | accruals, amortisation, bonds, call, cd, credit_card, current, current_io, debt_securities_issued, deferred, deferred_tax, depreciation, expense, financial_lease, income, intangible, internet_only, ira, isa, isa_current, isa_current_io, isa_io, isa_time_deposit, isa_time_deposit_io, loans_and_advances, money_market, non_deferred, non_product, other, other_financial_liab, prepaid_card, prepayments, provision, reserve, retail_bonds, savings, savings_io, suspense, tangible, third_party_savings, time_deposit, time_deposit_io, valuation_allowance, vostro, |
| uk_funding_type | Funding type calculated according to BIPRU 12.5/12.6 | string | a, b, |
| 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 | - |
| layout | title |
|---|---|
| schema | account |
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
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_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 | asset, equity, liability, oci, pnl, |
| 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 | FDTR, UKBRBASE, ZERO, |
| 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_1, anc_tier_2, anc_tier_3, at1_grandfathered, bas_tier_2, bas_tier_3, ce_tier_1, cet1_grandfathered, t2_grandfathered, tier_1, tier_2, tier_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_360, act_365, act_act, std_30_360, std_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_bond, derivative, none, other, repo, |
| 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_pf, bg_dif, ca_cdic, cy_dps, cz_dif, de_edb, de_edo, de_edw, dk_gdfi, ee_dgs, es_fgd, fi_dgf, fr_fdg, gb_fscs, gr_dgs, hk_dps, hr_di, hu_ndif, ie_dgs, it_fitd, lt_vi, lu_fgdl, lv_dgf, mt_dcs, nl_dgs, pl_bfg, pt_fgd, ro_fgdb, se_ndo, si_dgs, sk_dpf, us_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| impairment_type | The loss event resulting in the impairment of the loan. | string | collective, individual, write_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 | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
| 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_subs, adj_syn_inv_own_shares, adj_syn_mtg_def_ins, adj_syn_nonsig_inv_fin, adj_syn_other_inv_fin, admin, annual_bonus_accruals, benefit_in_kind, capital_gain_tax, capital_reserve, cash_management, cf_hedge, cf_hedge_reclass, ci_service, clearing, collateral, commitments, computer_and_it_cost, computer_peripheral, computer_software, corporation_tax, credit_card_fee, critical_service, current_account_fee, custody, dealing_rev_cr, dealing_rev_dbt_issue, dealing_rev_debt, dealing_rev_deposits, dealing_rev_deriv, dealing_rev_deriv_com, dealing_rev_deriv_eco, dealing_rev_deriv_equ, dealing_rev_deriv_fx, dealing_rev_deriv_int, dealing_rev_deriv_nse, dealing_rev_deriv_oth, dealing_rev_equity, dealing_rev_fx, dealing_rev_fx_nse, dealing_rev_ir, dealing_rev_loan, dealing_rev_non_fin, dealing_rev_oth_finan, dealing_rev_sec, dealing_rev_sec_nse, dealing_rev_short, dealing_revenue, ded_fut_prof, ded_fut_prof_temp_diff, defined_benefit, deposit, derivative_fee, dgs_contribution, div_from_cis, div_from_money_mkt, dividend, donation, employee, employee_stock_option, escrow, fees, fine, firm_operating_expenses, firm_operations, furniture, fut_prof, fut_prof_temp_diff, fx, general_credit_risk, goodwill, insurance_fee, int_on_asset, int_on_bond_and_frn, int_on_bridging_loan, int_on_credit_card, int_on_debt_issued, int_on_deposit, int_on_deriv_hedge, int_on_derivative, int_on_ecgd_lending, int_on_finance_leasing, int_on_liability, int_on_loan_and_adv, int_on_money_mkt, int_on_mortgage, int_on_sft, int_unallocated, intangible, intangible_lease, interest, intra_group_fee, inv_in_subsidiary, investment_banking_fee, investment_prop_lease, investment_property, ips, it_outsourcing, land, loan_and_advance_fee, machinery, manufactured_dividend, mortgage_fee, msr, mtg_ins_nonconform, mtg_insurance, ni_contribution, nol_carryback, non_life_ins_premium, not_fut_prof, occupancy_cost, operational, operational_escrow, operational_excess, oth_tax_excl_temp_diff, other, other_expenditure, other_fs_fee, other_non_fs_fee, other_social_contrib, other_staff_cost, other_staff_rem, overdraft_fee, own_property, pension, ppe, prime_brokerage, property, property_lease, pv_future_spread_inc, rec_unidentified_cpty, reclass_tax, recovery, redundancy_pymt, reference, reg_loss, regular_wages, release, rent, res_fund_contribution, restructuring, retained_earnings, revaluation, revaluation_reclass, revenue_reserve, share_plan, share_premium, staff, system, tax, telecom_equipment, third_party_interest, underwriting_fee, unsecured_loan_fee, vehicle, write_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 | combined, fixed, preferential, tracker, variable, |
| 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 | full, none, partial, |
| regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | mezzanine, pari_passu, senior_secured, senior_unsecured, subordinated_secured, subordinated_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 | active, audited, cancelled, cancelled_payout_agreed, other, pending, transactional, unaudited, |
| 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 | accruals, amortisation, bonds, call, cd, credit_card, current, current_io, debt_securities_issued, deferred, deferred_tax, depreciation, expense, financial_lease, income, intangible, internet_only, ira, isa, isa_current, isa_current_io, isa_io, isa_time_deposit, isa_time_deposit_io, loans_and_advances, money_market, non_deferred, non_product, other, other_financial_liab, prepaid_card, prepayments, provision, reserve, retail_bonds, savings, savings_io, suspense, tangible, third_party_savings, time_deposit, time_deposit_io, valuation_allowance, vostro, |
| uk_funding_type | Funding type calculated according to BIPRU 12.5/12.6 | string | a, b, |
| 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 | - |
| layout | title |
|---|---|
| schema | adjustment |
Adjustment Schema
An adjustment represents a modification to a report.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | - |
| layout | title |
|---|---|
| schema | agreement |
Agreement Schema
An agreement represents the standard terms agreed between two parties.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| credit_support_type | The type of credit support document | string | csa_isda_1994, csa_isda_1995, csd_isda_1995, scsa_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 | daily, daily_settled, weekly, bi_weekly, monthly, |
| 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_supervision, no_right_to_offset, restrictive_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 | both, customer, self_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 | afb, drv, ema, fbf, gmra, gmsla, icma_1992, icma_1995, icma_2000, icma_2011, isda, isda_1985, isda_1986, isda_1987, isda_1992, isda_2002, other, other_gmra, other_isda, right_to_set_off, |
| version_id | The version identifier of the data such as the firm’s internal batch identifier. | string | - |
| layout | title |
|---|---|
| schema | collateral |
Collateral Schema
Data schema to define collateral (currently can reference loans or accounts).
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| currency_code | Currency in accordance with ISO 4217 standards plus CNH for practical considerations. | string | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_bond, derivative, none, other, real_estate, repo, |
| 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_book, trading_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 | auto, auto_other, blanket_lien, car, cash, co_op, commercial_property, commercial_property_hr, condo, convertible, debenture, farm, four_units, guarantee, healthcare, hospitality, immovable_property, industrial, life_policy, luxury, manufactured_house, multifamily, office, one_unit, other, planned_unit_dev, res_property_hr, resi_mixed_use, residential_property, retail, security, single_family, sport, suv, three_units, townhouse, truck, two_units, van, warehouse, |
| 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 | - |
| layout | title |
|---|---|
| schema | curve |
Curve Schema
A Curve represents a series of points on a plot. Typically, interest rates, volatility or forward prices.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | behavioral, rate, risk_rating, volatility, |
| 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 | - |
| layout | title |
|---|---|
| schema | customer |
Customer Schema
Data schema to define a customer or legal entity related to a financial product or transaction.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_11, chapter_12, chapter_13, chapter_7, chapter_9, court_administration, insolvency, other, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| dbrs_lt | DBRS long term credit ratings | string | aaa, aa_h, aa, aa_l, a_h, a, a_l, bbb_h, bbb, bbb_l, bb_h, bb, bb_l, b_h, b, b_l, ccc_h, ccc, ccc_l, cc, c, d, |
| dbrs_st | DBRS short term credit ratings | string | r1_h, r1_m, r1_l, r2_h, r2_m, r2_l, r3, r4, r5, d, |
| fitch_lt | Fitch long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, rd, d, |
| fitch_st | Fitch short term credit ratings | string | f1_plus, f1, f2, f3, b, c, rd, d, |
| 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 | investment, non_investment, |
| intra_group | Flag to indicate that this should be considered an intra-group entity. | boolean | - |
| kbra_lt | KBRA long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| kbra_st | KBRA short term credit ratings | string | k1_plus, k1, k2, k3, b, c, d, |
| 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 | aaa, aa1, aa2, aa3, a1, a2, a3, baa1, baa2, baa3, ba1, ba2, ba3, b1, b2, b3, caa1, caa2, caa3, ca, c, |
| moodys_st | Moodys short term credit ratings | string | p1, p2, p3, np, |
| nace_code | The EU NACE economic activity classification. | string | A.01.10, A.01.11, A.01.12, A.01.13, A.01.14, A.01.15, A.01.16, A.01.19, A.01.20, A.01.21, A.01.22, A.01.23, A.01.24, A.01.25, A.01.26, A.01.27, A.01.28, A.01.29, A.01.30, A.01.40, A.01.41, A.01.42, A.01.43, A.01.44, A.01.45, A.01.46, A.01.47, A.01.49, A.01.50, A.01.60, A.01.61, A.01.62, A.01.63, A.01.64, A.01.70, A.02.10, A.02.20, A.02.30, A.02.40, A.03.10, A.03.11, A.03.12, A.03.20, A.03.21, A.03.22, B.05.10, B.05.20, B.06.10, B.06.20, B.07.10, B.07.20, B.07.21, B.07.29, B.08.10, B.08.11, B.08.12, B.08.90, B.08.91, B.08.92, B.08.93, B.08.99, B.09.10, B.09.90, C.10.10, C.10.11, C.10.12, C.10.13, C.10.20, C.10.30, C.10.31, C.10.32, C.10.39, C.10.40, C.10.41, C.10.42, C.10.50, C.10.51, C.10.52, C.10.60, C.10.61, C.10.62, C.10.70, C.10.71, C.10.72, C.10.73, C.10.80, C.10.81, C.10.82, C.10.83, C.10.84, C.10.85, C.10.86, C.10.89, C.10.90, C.10.91, C.10.92, C.11.00, C.11.01, C.11.02, C.11.03, C.11.04, C.11.05, C.11.06, C.11.07, C.12.00, C.13.10, C.13.20, C.13.30, C.13.90, C.13.91, C.13.92, C.13.93, C.13.94, C.13.95, C.13.96, C.13.99, C.14.10, C.14.11, C.14.12, C.14.13, C.14.14, C.14.19, C.14.20, C.14.30, C.14.31, C.14.39, C.15.10, C.15.11, C.15.12, C.15.20, C.16.10, C.16.20, C.16.21, C.16.22, C.16.23, C.16.24, C.16.26, C.16.27, C.16.28, C.16.29, C.17.10, C.17.11, C.17.12, C.17.20, C.17.21, C.17.22, C.17.23, C.17.24, C.17.25, C.17.29, C.18.10, C.18.11, C.18.12, C.18.13, C.18.14, C.18.20, C.19.10, C.19.20, C.20.10, C.20.11, C.20.12, C.20.13, C.20.14, C.20.15, C.20.16, C.20.17, C.20.20, C.20.30, C.20.40, C.20.41, C.20.42, C.20.50, C.20.51, C.20.52, C.20.53, C.20.59, C.20.60, C.21.10, C.21.20, C.22.10, C.22.11, C.22.19, C.22.20, C.22.21, C.22.22, C.22.23, C.22.29, C.23.10, C.23.11, C.23.12, C.23.13, C.23.14, C.23.19, C.23.20, C.23.30, C.23.31, C.23.32, C.23.40, C.23.41, C.23.42, C.23.43, C.23.44, C.23.49, C.23.50, C.23.51, C.23.52, C.23.60, C.23.61, C.23.62, C.23.63, C.23.64, C.23.65, C.23.69, C.23.70, C.23.90, C.23.91, C.23.99, C.24.10, C.24.20, C.24.30, C.24.31, C.24.32, C.24.33, C.24.34, C.24.40, C.24.41, C.24.42, C.24.43, C.24.44, C.24.45, C.24.46, C.24.50, C.24.51, C.24.52, C.24.53, C.24.54, C.25.10, C.25.11, C.25.12, C.25.20, C.25.21, C.25.29, C.25.30, C.25.40, C.25.50, C.25.60, C.25.61, C.25.62, C.25.70, C.25.71, C.25.72, C.25.73, C.25.90, C.25.91, C.25.92, C.25.93, C.25.94, C.25.99, C.26.10, C.26.11, C.26.12, C.26.20, C.26.30, C.26.40, C.26.50, C.26.51, C.26.52, C.26.60, C.26.70, C.26.80, C.27.10, C.27.11, C.27.12, C.27.20, C.27.30, C.27.31, C.27.32, C.27.33, C.27.40, C.27.50, C.27.51, C.27.52, C.27.90, C.28.10, C.28.11, C.28.12, C.28.13, C.28.14, C.28.15, C.28.20, C.28.21, C.28.22, C.28.23, C.28.24, C.28.25, C.28.29, C.28.30, C.28.40, C.28.41, C.28.49, C.28.90, C.28.91, C.28.92, C.28.93, C.28.94, C.28.95, C.28.96, C.28.99, C.29.10, C.29.20, C.29.30, C.29.31, C.29.32, C.30.10, C.30.11, C.30.12, C.30.20, C.30.30, C.30.40, C.30.90, C.30.91, C.30.92, C.30.99, C.31.00, C.31.01, C.31.02, C.31.03, C.31.09, C.32.10, C.32.11, C.32.12, C.32.13, C.32.20, C.32.30, C.32.40, C.32.50, C.32.90, C.32.91, C.32.99, C.33.10, C.33.11, C.33.12, C.33.13, C.33.14, C.33.15, C.33.16, C.33.17, C.33.19, C.33.20, D.35.10, D.35.11, D.35.12, D.35.13, D.35.14, D.35.16, D.35.20, D.35.21, D.35.22, D.35.23, D.35.30, E.36.00, E.37.00, E.38.10, E.38.11, E.38.12, E.38.20, E.38.21, E.38.22, E.38.30, E.38.31, E.38.32, E.39.00, F.41.10, F.41.20, F.42.10, F.42.11, F.42.12, F.42.13, F.42.20, F.42.21, F.42.22, F.42.90, F.42.91, F.42.99, F.43.10, F.43.11, F.43.12, F.43.13, F.43.20, F.43.21, F.43.22, F.43.29, F.43.30, F.43.31, F.43.32, F.43.33, F.43.34, F.43.39, F.43.90, F.43.91, F.43.99, G.45.10, G.45.11, G.45.19, G.45.20, G.45.30, G.45.31, G.45.32, G.45.40, G.46.10, G.46.11, G.46.12, G.46.13, G.46.14, G.46.15, G.46.16, G.46.17, G.46.18, G.46.19, G.46.20, G.46.21, G.46.22, G.46.23, G.46.24, G.46.30, G.46.31, G.46.32, G.46.33, G.46.34, G.46.35, G.46.36, G.46.37, G.46.38, G.46.39, G.46.40, G.46.41, G.46.42, G.46.43, G.46.44, G.46.45, G.46.46, G.46.47, G.46.48, G.46.49, G.46.50, G.46.51, G.46.52, G.46.60, G.46.61, G.46.62, G.46.63, G.46.64, G.46.65, G.46.66, G.46.69, G.46.70, G.46.71, G.46.72, G.46.73, G.46.74, G.46.75, G.46.76, G.46.77, G.46.90, G.47.10, G.47.11, G.47.19, G.47.20, G.47.21, G.47.22, G.47.23, G.47.24, G.47.25, G.47.26, G.47.29, G.47.30, G.47.40, G.47.41, G.47.42, G.47.43, G.47.50, G.47.51, G.47.52, G.47.53, G.47.54, G.47.59, G.47.60, G.47.61, G.47.62, G.47.63, G.47.64, G.47.65, G.47.70, G.47.71, G.47.72, G.47.73, G.47.74, G.47.75, G.47.76, G.47.77, G.47.78, G.47.79, G.47.80, G.47.81, G.47.82, G.47.89, G.47.90, G.47.91, G.47.99, H.49.10, H.49.11, H.49.12, H.49.20, H.49.30, H.49.31, H.49.32, H.49.33, H.49.34, H.49.39, H.49.40, H.49.41, H.49.42, H.49.50, H.50.10, H.50.20, H.50.30, H.50.40, H.51.10, H.51.20, H.51.21, H.51.22, H.52.10, H.52.20, H.52.21, H.52.22, H.52.23, H.52.24, H.52.25, H.52.26, H.52.29, H.52.30, H.52.31, H.52.32, H.53.10, H.53.20, H.53.30, I.55.10, I.55.20, I.55.30, I.55.40, I.55.90, I.56.10, I.56.11, I.56.12, I.56.20, I.56.21, I.56.22, I.56.29, I.56.30, I.56.40, J.58.10, J.58.11, J.58.12, J.58.13, J.58.14, J.58.19, J.58.20, J.58.21, J.58.29, J.59.10, J.59.11, J.59.12, J.59.13, J.59.14, J.59.20, J.60.10, J.60.20, J.60.30, J.60.31, J.60.39, J.61.10, J.61.20, J.61.30, J.61.90, J.62.00, J.62.01, J.62.02, J.62.03, J.62.09, J.63.10, J.63.11, J.63.12, J.63.90, J.63.91, J.63.99, K.61.10, K.61.20, K.61.90, K.62.10, K.62.20, K.62.90, K.63.10, K.63.90, K.63.91, K.63.92, K.64.10, K.64.11, K.64.19, K.64.20, K.64.30, K.64.90, K.64.91, K.64.92, K.64.99, K.65.10, K.65.11, K.65.12, K.65.20, K.65.30, K.66.10, K.66.11, K.66.12, K.66.19, K.66.20, K.66.21, K.66.22, K.66.29, K.66.30, L.64.10, L.64.11, L.64.19, L.64.20, L.64.21, L.64.22, L.64.30, L.64.31, L.64.32, L.64.90, L.64.91, L.64.92, L.64.99, L.65.10, L.65.11, L.65.12, L.65.20, L.65.30, L.66.10, L.66.11, L.66.12, L.66.19, L.66.20, L.66.21, L.66.22, L.66.29, L.66.30, L.68.10, L.68.20, L.68.30, L.68.31, L.68.32, M.68.10, M.68.11, M.68.12, M.68.20, M.68.30, M.68.31, M.68.32, M.69.10, M.69.20, M.70.10, M.70.20, M.70.21, M.70.22, M.71.10, M.71.11, M.71.12, M.71.20, M.72.10, M.72.11, M.72.19, M.72.20, M.73.10, M.73.11, M.73.12, M.73.20, M.74.10, M.74.20, M.74.30, M.74.90, M.75.00, N.69.10, N.69.20, N.70.10, N.70.20, N.71.10, N.71.11, N.71.12, N.71.20, N.72.10, N.72.20, N.73.10, N.73.11, N.73.12, N.73.20, N.73.30, N.74.10, N.74.11, N.74.12, N.74.13, N.74.14, N.74.20, N.74.30, N.74.90, N.74.91, N.74.99, N.75.00, N.77.10, N.77.11, N.77.12, N.77.20, N.77.21, N.77.22, N.77.29, N.77.30, N.77.31, N.77.32, N.77.33, N.77.34, N.77.35, N.77.39, N.77.40, N.78.10, N.78.20, N.78.30, N.79.10, N.79.11, N.79.12, N.79.90, N.80.10, N.80.20, N.80.30, N.81.10, N.81.20, N.81.21, N.81.22, N.81.29, N.81.30, N.82.10, N.82.11, N.82.19, N.82.20, N.82.30, N.82.90, N.82.91, N.82.92, N.82.99, O.77.10, O.77.11, O.77.12, O.77.20, O.77.21, O.77.22, O.77.30, O.77.31, O.77.32, O.77.33, O.77.34, O.77.35, O.77.39, O.77.40, O.77.50, O.77.51, O.77.52, O.78.10, O.78.20, O.79.10, O.79.11, O.79.12, O.79.90, O.80.00, O.80.01, O.80.09, O.80.10, O.80.20, O.80.30, O.81.10, O.81.20, O.81.21, O.81.22, O.81.23, O.81.30, O.82.10, O.82.20, O.82.30, O.82.40, O.82.90, O.82.91, O.82.92, O.82.99, O.84.10, O.84.11, O.84.12, O.84.13, O.84.20, O.84.21, O.84.22, O.84.23, O.84.24, O.84.25, O.84.30, P.84.10, P.84.11, P.84.12, P.84.13, P.84.20, P.84.21, P.84.22, P.84.23, P.84.24, P.84.25, P.84.30, P.85.10, P.85.20, P.85.30, P.85.31, P.85.32, P.85.40, P.85.41, P.85.42, P.85.50, P.85.51, P.85.52, P.85.53, P.85.59, P.85.60, Q.85.10, Q.85.20, Q.85.30, Q.85.31, Q.85.32, Q.85.33, Q.85.40, Q.85.50, Q.85.51, Q.85.52, Q.85.53, Q.85.59, Q.85.60, Q.85.61, Q.85.69, Q.86.10, Q.86.20, Q.86.21, Q.86.22, Q.86.23, Q.86.90, Q.87.10, Q.87.20, Q.87.30, Q.87.90, Q.88.10, Q.88.90, Q.88.91, Q.88.99, R.86.10, R.86.20, R.86.21, R.86.22, R.86.23, R.86.90, R.86.91, R.86.92, R.86.93, R.86.94, R.86.95, R.86.96, R.86.97, R.86.99, R.87.10, R.87.20, R.87.30, R.87.90, R.87.91, R.87.99, R.88.10, R.88.90, R.88.91, R.88.99, R.90.00, R.90.01, R.90.02, R.90.03, R.90.04, R.91.01, R.91.02, R.91.03, R.91.04, R.92.00, R.93.10, R.93.11, R.93.12, R.93.13, R.93.19, R.93.20, R.93.21, R.93.29, S.90.00, S.90.10, S.90.11, S.90.12, S.90.13, S.90.20, S.90.30, S.90.31, S.90.39, S.91.10, S.91.11, S.91.12, S.91.20, S.91.21, S.91.22, S.91.30, S.91.40, S.91.41, S.91.42, S.92.00, S.93.10, S.93.11, S.93.12, S.93.13, S.93.19, S.93.20, S.93.21, S.93.29, S.94.10, S.94.11, S.94.12, S.94.20, S.94.90, S.94.91, S.94.92, S.94.99, S.95.10, S.95.11, S.95.12, S.95.20, S.95.21, S.95.22, S.95.23, S.95.24, S.95.25, S.95.29, S.96.00, S.96.01, S.96.02, S.96.03, S.96.04, S.96.09, T.94.10, T.94.11, T.94.12, T.94.20, T.94.90, T.94.91, T.94.92, T.94.99, T.95.10, T.95.20, T.95.21, T.95.22, T.95.23, T.95.24, T.95.25, T.95.29, T.95.30, T.95.31, T.95.32, T.95.40, T.96.00, T.96.10, T.96.20, T.96.21, T.96.22, T.96.23, T.96.30, T.96.40, T.96.90, T.96.91, T.96.99, T.97.00, T.98.10, T.98.20, U.97.00, U.98.10, U.98.20, U.99.00, V.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 | branch, head_office, jv, parent, parent_branch, parent_subsidiary, participation, subsidiary, |
| reporting_relationship | Relationship to reporting entity. See: relationship. | string | branch, head_office, jv, parent, parent_branch, parent_subsidiary, participation, subsidiary, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | a, a_plus, b, c, |
| sic_code | Standard Industrial Classification (SIC) system. The applicable reference depends on jurisdiction. | integer | - |
| snp_lt | S&P long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| snp_st | S&P short term credit ratings | string | a1, a2, a3, b, c, d, |
| 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_society, ccp, central_bank, central_govt, charity, ciu, community_charity, corporate, credit_institution, credit_union, deposit_broker, export_credit_agency, federal_credit_union, financial, financial_holding, fund, hedge_fund, housing_coop, individual, insurer, intl_org, investment_firm, local_authority, mdb, mmkt_fund, national_bank, natural_person, non_member_bank, other, other_financial, other_pse, partnership, pension_fund, pic, pmi, private_equity_fund, private_fund, promo_fed_home_loan, promo_fed_reserve, promotional_lender, property_spe, pse, public_corporation, qccp, real_estate_fund, regional_govt, sme, social_housing_entity, social_security_fund, sovereign, sspe, state_credit_union, state_member_bank, state_owned_bank, statutory_board, supported_sme, unincorp_inv_fund, unincorporated_biz, unregulated_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 | above, below, |
| 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, |
| layout | title |
|---|---|
| schema | derivative |
Derivative Schema
A derivative is a contract which derives its value from an underlying reference index, security or asset.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_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 | agri, co, co_other, coal, coffee, corn, cr, cr_index, cr_single, electricity, energy, eq, eq_index, eq_single, fx, gas, gold, inflation, ir, metals, oil, other, palladium, platinum, precious_metals, silver, sugar, |
| asset_liability | Is the data an asset, a liability, or equity on the firm’s balance sheet? | string | asset, equity, liability, oci, pnl, |
| 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 | FDTR, FESR, UKBRBASE, USTSR, ZERO, bbsw, bbsw_3m, euribor, euribor_1m, euribor_3m, euribor_6m, other, pboc, sofr, sofr_1m, sofr_3m, sofr_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 | imm, oem, sa, ssa, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_flows, last_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_sided, two_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_hedge, fv_hedge, portfolio_cf_hedge, portfolio_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_only, other, partial, principal_interest, principal_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 | cr, fv_option, fx, fx_cr, ir, ir_cr, ir_fx, ir_fx_cr, other, overall_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| 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 | call, fixed, floating, indexed, put, |
| 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 | long, short, |
| 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_back, client_execution, client_transmission, cva_hedge, reference, |
| 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_book, trading_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | cash, physical, |
| 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_deliveries, unsettled, |
| 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_floor, ccds, cds, forward, fra, future, mtm_swap, ndf, nds, ois, option, spot, swaption, vanilla_swap, variance_swap, xccy, |
| underlying_currency_code | Currency in accordance with ISO 4217 standards plus CNH for practical considerations. | string | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | 1d, 7d, 28d, 91d, 182d, 1m, 2m, 3m, 4m, 5m, 6m, 7m, 8m, 9m, 12m, 24m, 60m, 120m, 360m, |
| 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 | - |
| layout | title |
|---|---|
| schema | derivative_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
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | agri, co, co_other, coal, coffee, corn, cr, cr_index, cr_single, electricity, energy, eq, eq_index, eq_single, fx, gas, gold, inflation, ir, metals, oil, other, palladium, platinum, precious_metals, silver, sugar, |
| asset_liability | Is the data an asset, a liability, or equity on the firm’s balance sheet? | string | asset, equity, liability, oci, pnl, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | pay, receive, |
| 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 | interest, principal, reference, |
| regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_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 | cash, physical, |
| 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 | - |
| layout | title |
|---|---|
| schema | example |
Example Schema
FIRE schema for representing and validating FIRE examples
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | - |
| layout | title |
|---|---|
| schema | exchange_rate |
Exchange Rate Schema
An Exchange Rate represents the conversion rate between two currencies.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | - |
| layout | title |
|---|---|
| schema | guarantor |
Guarantor Schema
Data schema to define a guarantor for a security.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_11, chapter_12, chapter_13, chapter_7, chapter_9, court_administration, insolvency, other, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| dbrs_lt | DBRS long term credit ratings | string | aaa, aa_h, aa, aa_l, a_h, a, a_l, bbb_h, bbb, bbb_l, bb_h, bb, bb_l, b_h, b, b_l, ccc_h, ccc, ccc_l, cc, c, d, |
| dbrs_st | DBRS short term credit ratings | string | r1_h, r1_m, r1_l, r2_h, r2_m, r2_l, r3, r4, r5, d, |
| fitch_lt | Fitch long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, rd, d, |
| fitch_st | Fitch short term credit ratings | string | f1_plus, f1, f2, f3, b, c, rd, d, |
| 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 | investment, non_investment, |
| intra_group | Flag to indicate that this should be considered an intra-group entity. | boolean | - |
| kbra_lt | KBRA long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| kbra_st | KBRA short term credit ratings | string | k1_plus, k1, k2, k3, b, c, d, |
| 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 | aaa, aa1, aa2, aa3, a1, a2, a3, baa1, baa2, baa3, ba1, ba2, ba3, b1, b2, b3, caa1, caa2, caa3, ca, c, |
| moodys_st | Moodys short term credit ratings | string | p1, p2, p3, np, |
| nace_code | The EU NACE economic activity classification. | string | A.01.10, A.01.11, A.01.12, A.01.13, A.01.14, A.01.15, A.01.16, A.01.19, A.01.20, A.01.21, A.01.22, A.01.23, A.01.24, A.01.25, A.01.26, A.01.27, A.01.28, A.01.29, A.01.30, A.01.40, A.01.41, A.01.42, A.01.43, A.01.44, A.01.45, A.01.46, A.01.47, A.01.49, A.01.50, A.01.60, A.01.61, A.01.62, A.01.63, A.01.64, A.01.70, A.02.10, A.02.20, A.02.30, A.02.40, A.03.10, A.03.11, A.03.12, A.03.20, A.03.21, A.03.22, B.05.10, B.05.20, B.06.10, B.06.20, B.07.10, B.07.20, B.07.21, B.07.29, B.08.10, B.08.11, B.08.12, B.08.90, B.08.91, B.08.92, B.08.93, B.08.99, B.09.10, B.09.90, C.10.10, C.10.11, C.10.12, C.10.13, C.10.20, C.10.30, C.10.31, C.10.32, C.10.39, C.10.40, C.10.41, C.10.42, C.10.50, C.10.51, C.10.52, C.10.60, C.10.61, C.10.62, C.10.70, C.10.71, C.10.72, C.10.73, C.10.80, C.10.81, C.10.82, C.10.83, C.10.84, C.10.85, C.10.86, C.10.89, C.10.90, C.10.91, C.10.92, C.11.00, C.11.01, C.11.02, C.11.03, C.11.04, C.11.05, C.11.06, C.11.07, C.12.00, C.13.10, C.13.20, C.13.30, C.13.90, C.13.91, C.13.92, C.13.93, C.13.94, C.13.95, C.13.96, C.13.99, C.14.10, C.14.11, C.14.12, C.14.13, C.14.14, C.14.19, C.14.20, C.14.30, C.14.31, C.14.39, C.15.10, C.15.11, C.15.12, C.15.20, C.16.10, C.16.20, C.16.21, C.16.22, C.16.23, C.16.24, C.16.26, C.16.27, C.16.28, C.16.29, C.17.10, C.17.11, C.17.12, C.17.20, C.17.21, C.17.22, C.17.23, C.17.24, C.17.25, C.17.29, C.18.10, C.18.11, C.18.12, C.18.13, C.18.14, C.18.20, C.19.10, C.19.20, C.20.10, C.20.11, C.20.12, C.20.13, C.20.14, C.20.15, C.20.16, C.20.17, C.20.20, C.20.30, C.20.40, C.20.41, C.20.42, C.20.50, C.20.51, C.20.52, C.20.53, C.20.59, C.20.60, C.21.10, C.21.20, C.22.10, C.22.11, C.22.19, C.22.20, C.22.21, C.22.22, C.22.23, C.22.29, C.23.10, C.23.11, C.23.12, C.23.13, C.23.14, C.23.19, C.23.20, C.23.30, C.23.31, C.23.32, C.23.40, C.23.41, C.23.42, C.23.43, C.23.44, C.23.49, C.23.50, C.23.51, C.23.52, C.23.60, C.23.61, C.23.62, C.23.63, C.23.64, C.23.65, C.23.69, C.23.70, C.23.90, C.23.91, C.23.99, C.24.10, C.24.20, C.24.30, C.24.31, C.24.32, C.24.33, C.24.34, C.24.40, C.24.41, C.24.42, C.24.43, C.24.44, C.24.45, C.24.46, C.24.50, C.24.51, C.24.52, C.24.53, C.24.54, C.25.10, C.25.11, C.25.12, C.25.20, C.25.21, C.25.29, C.25.30, C.25.40, C.25.50, C.25.60, C.25.61, C.25.62, C.25.70, C.25.71, C.25.72, C.25.73, C.25.90, C.25.91, C.25.92, C.25.93, C.25.94, C.25.99, C.26.10, C.26.11, C.26.12, C.26.20, C.26.30, C.26.40, C.26.50, C.26.51, C.26.52, C.26.60, C.26.70, C.26.80, C.27.10, C.27.11, C.27.12, C.27.20, C.27.30, C.27.31, C.27.32, C.27.33, C.27.40, C.27.50, C.27.51, C.27.52, C.27.90, C.28.10, C.28.11, C.28.12, C.28.13, C.28.14, C.28.15, C.28.20, C.28.21, C.28.22, C.28.23, C.28.24, C.28.25, C.28.29, C.28.30, C.28.40, C.28.41, C.28.49, C.28.90, C.28.91, C.28.92, C.28.93, C.28.94, C.28.95, C.28.96, C.28.99, C.29.10, C.29.20, C.29.30, C.29.31, C.29.32, C.30.10, C.30.11, C.30.12, C.30.20, C.30.30, C.30.40, C.30.90, C.30.91, C.30.92, C.30.99, C.31.00, C.31.01, C.31.02, C.31.03, C.31.09, C.32.10, C.32.11, C.32.12, C.32.13, C.32.20, C.32.30, C.32.40, C.32.50, C.32.90, C.32.91, C.32.99, C.33.10, C.33.11, C.33.12, C.33.13, C.33.14, C.33.15, C.33.16, C.33.17, C.33.19, C.33.20, D.35.10, D.35.11, D.35.12, D.35.13, D.35.14, D.35.16, D.35.20, D.35.21, D.35.22, D.35.23, D.35.30, E.36.00, E.37.00, E.38.10, E.38.11, E.38.12, E.38.20, E.38.21, E.38.22, E.38.30, E.38.31, E.38.32, E.39.00, F.41.10, F.41.20, F.42.10, F.42.11, F.42.12, F.42.13, F.42.20, F.42.21, F.42.22, F.42.90, F.42.91, F.42.99, F.43.10, F.43.11, F.43.12, F.43.13, F.43.20, F.43.21, F.43.22, F.43.29, F.43.30, F.43.31, F.43.32, F.43.33, F.43.34, F.43.39, F.43.90, F.43.91, F.43.99, G.45.10, G.45.11, G.45.19, G.45.20, G.45.30, G.45.31, G.45.32, G.45.40, G.46.10, G.46.11, G.46.12, G.46.13, G.46.14, G.46.15, G.46.16, G.46.17, G.46.18, G.46.19, G.46.20, G.46.21, G.46.22, G.46.23, G.46.24, G.46.30, G.46.31, G.46.32, G.46.33, G.46.34, G.46.35, G.46.36, G.46.37, G.46.38, G.46.39, G.46.40, G.46.41, G.46.42, G.46.43, G.46.44, G.46.45, G.46.46, G.46.47, G.46.48, G.46.49, G.46.50, G.46.51, G.46.52, G.46.60, G.46.61, G.46.62, G.46.63, G.46.64, G.46.65, G.46.66, G.46.69, G.46.70, G.46.71, G.46.72, G.46.73, G.46.74, G.46.75, G.46.76, G.46.77, G.46.90, G.47.10, G.47.11, G.47.19, G.47.20, G.47.21, G.47.22, G.47.23, G.47.24, G.47.25, G.47.26, G.47.29, G.47.30, G.47.40, G.47.41, G.47.42, G.47.43, G.47.50, G.47.51, G.47.52, G.47.53, G.47.54, G.47.59, G.47.60, G.47.61, G.47.62, G.47.63, G.47.64, G.47.65, G.47.70, G.47.71, G.47.72, G.47.73, G.47.74, G.47.75, G.47.76, G.47.77, G.47.78, G.47.79, G.47.80, G.47.81, G.47.82, G.47.89, G.47.90, G.47.91, G.47.99, H.49.10, H.49.11, H.49.12, H.49.20, H.49.30, H.49.31, H.49.32, H.49.33, H.49.34, H.49.39, H.49.40, H.49.41, H.49.42, H.49.50, H.50.10, H.50.20, H.50.30, H.50.40, H.51.10, H.51.20, H.51.21, H.51.22, H.52.10, H.52.20, H.52.21, H.52.22, H.52.23, H.52.24, H.52.25, H.52.26, H.52.29, H.52.30, H.52.31, H.52.32, H.53.10, H.53.20, H.53.30, I.55.10, I.55.20, I.55.30, I.55.40, I.55.90, I.56.10, I.56.11, I.56.12, I.56.20, I.56.21, I.56.22, I.56.29, I.56.30, I.56.40, J.58.10, J.58.11, J.58.12, J.58.13, J.58.14, J.58.19, J.58.20, J.58.21, J.58.29, J.59.10, J.59.11, J.59.12, J.59.13, J.59.14, J.59.20, J.60.10, J.60.20, J.60.30, J.60.31, J.60.39, J.61.10, J.61.20, J.61.30, J.61.90, J.62.00, J.62.01, J.62.02, J.62.03, J.62.09, J.63.10, J.63.11, J.63.12, J.63.90, J.63.91, J.63.99, K.61.10, K.61.20, K.61.90, K.62.10, K.62.20, K.62.90, K.63.10, K.63.90, K.63.91, K.63.92, K.64.10, K.64.11, K.64.19, K.64.20, K.64.30, K.64.90, K.64.91, K.64.92, K.64.99, K.65.10, K.65.11, K.65.12, K.65.20, K.65.30, K.66.10, K.66.11, K.66.12, K.66.19, K.66.20, K.66.21, K.66.22, K.66.29, K.66.30, L.64.10, L.64.11, L.64.19, L.64.20, L.64.21, L.64.22, L.64.30, L.64.31, L.64.32, L.64.90, L.64.91, L.64.92, L.64.99, L.65.10, L.65.11, L.65.12, L.65.20, L.65.30, L.66.10, L.66.11, L.66.12, L.66.19, L.66.20, L.66.21, L.66.22, L.66.29, L.66.30, L.68.10, L.68.20, L.68.30, L.68.31, L.68.32, M.68.10, M.68.11, M.68.12, M.68.20, M.68.30, M.68.31, M.68.32, M.69.10, M.69.20, M.70.10, M.70.20, M.70.21, M.70.22, M.71.10, M.71.11, M.71.12, M.71.20, M.72.10, M.72.11, M.72.19, M.72.20, M.73.10, M.73.11, M.73.12, M.73.20, M.74.10, M.74.20, M.74.30, M.74.90, M.75.00, N.69.10, N.69.20, N.70.10, N.70.20, N.71.10, N.71.11, N.71.12, N.71.20, N.72.10, N.72.20, N.73.10, N.73.11, N.73.12, N.73.20, N.73.30, N.74.10, N.74.11, N.74.12, N.74.13, N.74.14, N.74.20, N.74.30, N.74.90, N.74.91, N.74.99, N.75.00, N.77.10, N.77.11, N.77.12, N.77.20, N.77.21, N.77.22, N.77.29, N.77.30, N.77.31, N.77.32, N.77.33, N.77.34, N.77.35, N.77.39, N.77.40, N.78.10, N.78.20, N.78.30, N.79.10, N.79.11, N.79.12, N.79.90, N.80.10, N.80.20, N.80.30, N.81.10, N.81.20, N.81.21, N.81.22, N.81.29, N.81.30, N.82.10, N.82.11, N.82.19, N.82.20, N.82.30, N.82.90, N.82.91, N.82.92, N.82.99, O.77.10, O.77.11, O.77.12, O.77.20, O.77.21, O.77.22, O.77.30, O.77.31, O.77.32, O.77.33, O.77.34, O.77.35, O.77.39, O.77.40, O.77.50, O.77.51, O.77.52, O.78.10, O.78.20, O.79.10, O.79.11, O.79.12, O.79.90, O.80.00, O.80.01, O.80.09, O.80.10, O.80.20, O.80.30, O.81.10, O.81.20, O.81.21, O.81.22, O.81.23, O.81.30, O.82.10, O.82.20, O.82.30, O.82.40, O.82.90, O.82.91, O.82.92, O.82.99, O.84.10, O.84.11, O.84.12, O.84.13, O.84.20, O.84.21, O.84.22, O.84.23, O.84.24, O.84.25, O.84.30, P.84.10, P.84.11, P.84.12, P.84.13, P.84.20, P.84.21, P.84.22, P.84.23, P.84.24, P.84.25, P.84.30, P.85.10, P.85.20, P.85.30, P.85.31, P.85.32, P.85.40, P.85.41, P.85.42, P.85.50, P.85.51, P.85.52, P.85.53, P.85.59, P.85.60, Q.85.10, Q.85.20, Q.85.30, Q.85.31, Q.85.32, Q.85.33, Q.85.40, Q.85.50, Q.85.51, Q.85.52, Q.85.53, Q.85.59, Q.85.60, Q.85.61, Q.85.69, Q.86.10, Q.86.20, Q.86.21, Q.86.22, Q.86.23, Q.86.90, Q.87.10, Q.87.20, Q.87.30, Q.87.90, Q.88.10, Q.88.90, Q.88.91, Q.88.99, R.86.10, R.86.20, R.86.21, R.86.22, R.86.23, R.86.90, R.86.91, R.86.92, R.86.93, R.86.94, R.86.95, R.86.96, R.86.97, R.86.99, R.87.10, R.87.20, R.87.30, R.87.90, R.87.91, R.87.99, R.88.10, R.88.90, R.88.91, R.88.99, R.90.00, R.90.01, R.90.02, R.90.03, R.90.04, R.91.01, R.91.02, R.91.03, R.91.04, R.92.00, R.93.10, R.93.11, R.93.12, R.93.13, R.93.19, R.93.20, R.93.21, R.93.29, S.90.00, S.90.10, S.90.11, S.90.12, S.90.13, S.90.20, S.90.30, S.90.31, S.90.39, S.91.10, S.91.11, S.91.12, S.91.20, S.91.21, S.91.22, S.91.30, S.91.40, S.91.41, S.91.42, S.92.00, S.93.10, S.93.11, S.93.12, S.93.13, S.93.19, S.93.20, S.93.21, S.93.29, S.94.10, S.94.11, S.94.12, S.94.20, S.94.90, S.94.91, S.94.92, S.94.99, S.95.10, S.95.11, S.95.12, S.95.20, S.95.21, S.95.22, S.95.23, S.95.24, S.95.25, S.95.29, S.96.00, S.96.01, S.96.02, S.96.03, S.96.04, S.96.09, T.94.10, T.94.11, T.94.12, T.94.20, T.94.90, T.94.91, T.94.92, T.94.99, T.95.10, T.95.20, T.95.21, T.95.22, T.95.23, T.95.24, T.95.25, T.95.29, T.95.30, T.95.31, T.95.32, T.95.40, T.96.00, T.96.10, T.96.20, T.96.21, T.96.22, T.96.23, T.96.30, T.96.40, T.96.90, T.96.91, T.96.99, T.97.00, T.98.10, T.98.20, U.97.00, U.98.10, U.98.20, U.99.00, V.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 | branch, head_office, jv, parent, parent_branch, parent_subsidiary, participation, subsidiary, |
| reporting_relationship | Relationship to reporting entity. See: relationship. | string | branch, head_office, jv, parent, parent_branch, parent_subsidiary, participation, subsidiary, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | a, a_plus, b, c, |
| sic_code | Standard Industrial Classification (SIC) system. The applicable reference depends on jurisdiction. | integer | - |
| snp_lt | S&P long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| snp_st | S&P short term credit ratings | string | a1, a2, a3, b, c, d, |
| 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_society, ccp, central_bank, central_govt, charity, ciu, community_charity, corporate, credit_institution, credit_union, deposit_broker, export_credit_agency, federal_credit_union, financial, financial_holding, fund, hedge_fund, housing_coop, individual, insurer, intl_org, investment_firm, local_authority, mdb, mmkt_fund, national_bank, natural_person, non_member_bank, other, other_financial, other_pse, partnership, pension_fund, pic, pmi, private_equity_fund, private_fund, promo_fed_home_loan, promo_fed_reserve, promotional_lender, property_spe, pse, public_corporation, qccp, real_estate_fund, regional_govt, sme, social_housing_entity, social_security_fund, sovereign, sspe, state_credit_union, state_member_bank, state_owned_bank, statutory_board, supported_sme, unincorp_inv_fund, unincorporated_biz, unregulated_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 | - |
| layout | title |
|---|---|
| schema | issuer |
Issuer Schema
Data schema to define an issuer for a security.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_11, chapter_12, chapter_13, chapter_7, chapter_9, court_administration, insolvency, other, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| dbrs_lt | DBRS long term credit ratings | string | aaa, aa_h, aa, aa_l, a_h, a, a_l, bbb_h, bbb, bbb_l, bb_h, bb, bb_l, b_h, b, b_l, ccc_h, ccc, ccc_l, cc, c, d, |
| dbrs_st | DBRS short term credit ratings | string | r1_h, r1_m, r1_l, r2_h, r2_m, r2_l, r3, r4, r5, d, |
| fitch_lt | Fitch long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, rd, d, |
| fitch_st | Fitch short term credit ratings | string | f1_plus, f1, f2, f3, b, c, rd, d, |
| 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 | investment, non_investment, |
| intra_group | Flag to indicate that this should be considered an intra-group entity. | boolean | - |
| kbra_lt | KBRA long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| kbra_st | KBRA short term credit ratings | string | k1_plus, k1, k2, k3, b, c, d, |
| 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 | aaa, aa1, aa2, aa3, a1, a2, a3, baa1, baa2, baa3, ba1, ba2, ba3, b1, b2, b3, caa1, caa2, caa3, ca, c, |
| moodys_st | Moodys short term credit ratings | string | p1, p2, p3, np, |
| nace_code | The EU NACE economic activity classification. | string | A.01.10, A.01.11, A.01.12, A.01.13, A.01.14, A.01.15, A.01.16, A.01.19, A.01.20, A.01.21, A.01.22, A.01.23, A.01.24, A.01.25, A.01.26, A.01.27, A.01.28, A.01.29, A.01.30, A.01.40, A.01.41, A.01.42, A.01.43, A.01.44, A.01.45, A.01.46, A.01.47, A.01.49, A.01.50, A.01.60, A.01.61, A.01.62, A.01.63, A.01.64, A.01.70, A.02.10, A.02.20, A.02.30, A.02.40, A.03.10, A.03.11, A.03.12, A.03.20, A.03.21, A.03.22, B.05.10, B.05.20, B.06.10, B.06.20, B.07.10, B.07.20, B.07.21, B.07.29, B.08.10, B.08.11, B.08.12, B.08.90, B.08.91, B.08.92, B.08.93, B.08.99, B.09.10, B.09.90, C.10.10, C.10.11, C.10.12, C.10.13, C.10.20, C.10.30, C.10.31, C.10.32, C.10.39, C.10.40, C.10.41, C.10.42, C.10.50, C.10.51, C.10.52, C.10.60, C.10.61, C.10.62, C.10.70, C.10.71, C.10.72, C.10.73, C.10.80, C.10.81, C.10.82, C.10.83, C.10.84, C.10.85, C.10.86, C.10.89, C.10.90, C.10.91, C.10.92, C.11.00, C.11.01, C.11.02, C.11.03, C.11.04, C.11.05, C.11.06, C.11.07, C.12.00, C.13.10, C.13.20, C.13.30, C.13.90, C.13.91, C.13.92, C.13.93, C.13.94, C.13.95, C.13.96, C.13.99, C.14.10, C.14.11, C.14.12, C.14.13, C.14.14, C.14.19, C.14.20, C.14.30, C.14.31, C.14.39, C.15.10, C.15.11, C.15.12, C.15.20, C.16.10, C.16.20, C.16.21, C.16.22, C.16.23, C.16.24, C.16.26, C.16.27, C.16.28, C.16.29, C.17.10, C.17.11, C.17.12, C.17.20, C.17.21, C.17.22, C.17.23, C.17.24, C.17.25, C.17.29, C.18.10, C.18.11, C.18.12, C.18.13, C.18.14, C.18.20, C.19.10, C.19.20, C.20.10, C.20.11, C.20.12, C.20.13, C.20.14, C.20.15, C.20.16, C.20.17, C.20.20, C.20.30, C.20.40, C.20.41, C.20.42, C.20.50, C.20.51, C.20.52, C.20.53, C.20.59, C.20.60, C.21.10, C.21.20, C.22.10, C.22.11, C.22.19, C.22.20, C.22.21, C.22.22, C.22.23, C.22.29, C.23.10, C.23.11, C.23.12, C.23.13, C.23.14, C.23.19, C.23.20, C.23.30, C.23.31, C.23.32, C.23.40, C.23.41, C.23.42, C.23.43, C.23.44, C.23.49, C.23.50, C.23.51, C.23.52, C.23.60, C.23.61, C.23.62, C.23.63, C.23.64, C.23.65, C.23.69, C.23.70, C.23.90, C.23.91, C.23.99, C.24.10, C.24.20, C.24.30, C.24.31, C.24.32, C.24.33, C.24.34, C.24.40, C.24.41, C.24.42, C.24.43, C.24.44, C.24.45, C.24.46, C.24.50, C.24.51, C.24.52, C.24.53, C.24.54, C.25.10, C.25.11, C.25.12, C.25.20, C.25.21, C.25.29, C.25.30, C.25.40, C.25.50, C.25.60, C.25.61, C.25.62, C.25.70, C.25.71, C.25.72, C.25.73, C.25.90, C.25.91, C.25.92, C.25.93, C.25.94, C.25.99, C.26.10, C.26.11, C.26.12, C.26.20, C.26.30, C.26.40, C.26.50, C.26.51, C.26.52, C.26.60, C.26.70, C.26.80, C.27.10, C.27.11, C.27.12, C.27.20, C.27.30, C.27.31, C.27.32, C.27.33, C.27.40, C.27.50, C.27.51, C.27.52, C.27.90, C.28.10, C.28.11, C.28.12, C.28.13, C.28.14, C.28.15, C.28.20, C.28.21, C.28.22, C.28.23, C.28.24, C.28.25, C.28.29, C.28.30, C.28.40, C.28.41, C.28.49, C.28.90, C.28.91, C.28.92, C.28.93, C.28.94, C.28.95, C.28.96, C.28.99, C.29.10, C.29.20, C.29.30, C.29.31, C.29.32, C.30.10, C.30.11, C.30.12, C.30.20, C.30.30, C.30.40, C.30.90, C.30.91, C.30.92, C.30.99, C.31.00, C.31.01, C.31.02, C.31.03, C.31.09, C.32.10, C.32.11, C.32.12, C.32.13, C.32.20, C.32.30, C.32.40, C.32.50, C.32.90, C.32.91, C.32.99, C.33.10, C.33.11, C.33.12, C.33.13, C.33.14, C.33.15, C.33.16, C.33.17, C.33.19, C.33.20, D.35.10, D.35.11, D.35.12, D.35.13, D.35.14, D.35.16, D.35.20, D.35.21, D.35.22, D.35.23, D.35.30, E.36.00, E.37.00, E.38.10, E.38.11, E.38.12, E.38.20, E.38.21, E.38.22, E.38.30, E.38.31, E.38.32, E.39.00, F.41.10, F.41.20, F.42.10, F.42.11, F.42.12, F.42.13, F.42.20, F.42.21, F.42.22, F.42.90, F.42.91, F.42.99, F.43.10, F.43.11, F.43.12, F.43.13, F.43.20, F.43.21, F.43.22, F.43.29, F.43.30, F.43.31, F.43.32, F.43.33, F.43.34, F.43.39, F.43.90, F.43.91, F.43.99, G.45.10, G.45.11, G.45.19, G.45.20, G.45.30, G.45.31, G.45.32, G.45.40, G.46.10, G.46.11, G.46.12, G.46.13, G.46.14, G.46.15, G.46.16, G.46.17, G.46.18, G.46.19, G.46.20, G.46.21, G.46.22, G.46.23, G.46.24, G.46.30, G.46.31, G.46.32, G.46.33, G.46.34, G.46.35, G.46.36, G.46.37, G.46.38, G.46.39, G.46.40, G.46.41, G.46.42, G.46.43, G.46.44, G.46.45, G.46.46, G.46.47, G.46.48, G.46.49, G.46.50, G.46.51, G.46.52, G.46.60, G.46.61, G.46.62, G.46.63, G.46.64, G.46.65, G.46.66, G.46.69, G.46.70, G.46.71, G.46.72, G.46.73, G.46.74, G.46.75, G.46.76, G.46.77, G.46.90, G.47.10, G.47.11, G.47.19, G.47.20, G.47.21, G.47.22, G.47.23, G.47.24, G.47.25, G.47.26, G.47.29, G.47.30, G.47.40, G.47.41, G.47.42, G.47.43, G.47.50, G.47.51, G.47.52, G.47.53, G.47.54, G.47.59, G.47.60, G.47.61, G.47.62, G.47.63, G.47.64, G.47.65, G.47.70, G.47.71, G.47.72, G.47.73, G.47.74, G.47.75, G.47.76, G.47.77, G.47.78, G.47.79, G.47.80, G.47.81, G.47.82, G.47.89, G.47.90, G.47.91, G.47.99, H.49.10, H.49.11, H.49.12, H.49.20, H.49.30, H.49.31, H.49.32, H.49.33, H.49.34, H.49.39, H.49.40, H.49.41, H.49.42, H.49.50, H.50.10, H.50.20, H.50.30, H.50.40, H.51.10, H.51.20, H.51.21, H.51.22, H.52.10, H.52.20, H.52.21, H.52.22, H.52.23, H.52.24, H.52.25, H.52.26, H.52.29, H.52.30, H.52.31, H.52.32, H.53.10, H.53.20, H.53.30, I.55.10, I.55.20, I.55.30, I.55.40, I.55.90, I.56.10, I.56.11, I.56.12, I.56.20, I.56.21, I.56.22, I.56.29, I.56.30, I.56.40, J.58.10, J.58.11, J.58.12, J.58.13, J.58.14, J.58.19, J.58.20, J.58.21, J.58.29, J.59.10, J.59.11, J.59.12, J.59.13, J.59.14, J.59.20, J.60.10, J.60.20, J.60.30, J.60.31, J.60.39, J.61.10, J.61.20, J.61.30, J.61.90, J.62.00, J.62.01, J.62.02, J.62.03, J.62.09, J.63.10, J.63.11, J.63.12, J.63.90, J.63.91, J.63.99, K.61.10, K.61.20, K.61.90, K.62.10, K.62.20, K.62.90, K.63.10, K.63.90, K.63.91, K.63.92, K.64.10, K.64.11, K.64.19, K.64.20, K.64.30, K.64.90, K.64.91, K.64.92, K.64.99, K.65.10, K.65.11, K.65.12, K.65.20, K.65.30, K.66.10, K.66.11, K.66.12, K.66.19, K.66.20, K.66.21, K.66.22, K.66.29, K.66.30, L.64.10, L.64.11, L.64.19, L.64.20, L.64.21, L.64.22, L.64.30, L.64.31, L.64.32, L.64.90, L.64.91, L.64.92, L.64.99, L.65.10, L.65.11, L.65.12, L.65.20, L.65.30, L.66.10, L.66.11, L.66.12, L.66.19, L.66.20, L.66.21, L.66.22, L.66.29, L.66.30, L.68.10, L.68.20, L.68.30, L.68.31, L.68.32, M.68.10, M.68.11, M.68.12, M.68.20, M.68.30, M.68.31, M.68.32, M.69.10, M.69.20, M.70.10, M.70.20, M.70.21, M.70.22, M.71.10, M.71.11, M.71.12, M.71.20, M.72.10, M.72.11, M.72.19, M.72.20, M.73.10, M.73.11, M.73.12, M.73.20, M.74.10, M.74.20, M.74.30, M.74.90, M.75.00, N.69.10, N.69.20, N.70.10, N.70.20, N.71.10, N.71.11, N.71.12, N.71.20, N.72.10, N.72.20, N.73.10, N.73.11, N.73.12, N.73.20, N.73.30, N.74.10, N.74.11, N.74.12, N.74.13, N.74.14, N.74.20, N.74.30, N.74.90, N.74.91, N.74.99, N.75.00, N.77.10, N.77.11, N.77.12, N.77.20, N.77.21, N.77.22, N.77.29, N.77.30, N.77.31, N.77.32, N.77.33, N.77.34, N.77.35, N.77.39, N.77.40, N.78.10, N.78.20, N.78.30, N.79.10, N.79.11, N.79.12, N.79.90, N.80.10, N.80.20, N.80.30, N.81.10, N.81.20, N.81.21, N.81.22, N.81.29, N.81.30, N.82.10, N.82.11, N.82.19, N.82.20, N.82.30, N.82.90, N.82.91, N.82.92, N.82.99, O.77.10, O.77.11, O.77.12, O.77.20, O.77.21, O.77.22, O.77.30, O.77.31, O.77.32, O.77.33, O.77.34, O.77.35, O.77.39, O.77.40, O.77.50, O.77.51, O.77.52, O.78.10, O.78.20, O.79.10, O.79.11, O.79.12, O.79.90, O.80.00, O.80.01, O.80.09, O.80.10, O.80.20, O.80.30, O.81.10, O.81.20, O.81.21, O.81.22, O.81.23, O.81.30, O.82.10, O.82.20, O.82.30, O.82.40, O.82.90, O.82.91, O.82.92, O.82.99, O.84.10, O.84.11, O.84.12, O.84.13, O.84.20, O.84.21, O.84.22, O.84.23, O.84.24, O.84.25, O.84.30, P.84.10, P.84.11, P.84.12, P.84.13, P.84.20, P.84.21, P.84.22, P.84.23, P.84.24, P.84.25, P.84.30, P.85.10, P.85.20, P.85.30, P.85.31, P.85.32, P.85.40, P.85.41, P.85.42, P.85.50, P.85.51, P.85.52, P.85.53, P.85.59, P.85.60, Q.85.10, Q.85.20, Q.85.30, Q.85.31, Q.85.32, Q.85.33, Q.85.40, Q.85.50, Q.85.51, Q.85.52, Q.85.53, Q.85.59, Q.85.60, Q.85.61, Q.85.69, Q.86.10, Q.86.20, Q.86.21, Q.86.22, Q.86.23, Q.86.90, Q.87.10, Q.87.20, Q.87.30, Q.87.90, Q.88.10, Q.88.90, Q.88.91, Q.88.99, R.86.10, R.86.20, R.86.21, R.86.22, R.86.23, R.86.90, R.86.91, R.86.92, R.86.93, R.86.94, R.86.95, R.86.96, R.86.97, R.86.99, R.87.10, R.87.20, R.87.30, R.87.90, R.87.91, R.87.99, R.88.10, R.88.90, R.88.91, R.88.99, R.90.00, R.90.01, R.90.02, R.90.03, R.90.04, R.91.01, R.91.02, R.91.03, R.91.04, R.92.00, R.93.10, R.93.11, R.93.12, R.93.13, R.93.19, R.93.20, R.93.21, R.93.29, S.90.00, S.90.10, S.90.11, S.90.12, S.90.13, S.90.20, S.90.30, S.90.31, S.90.39, S.91.10, S.91.11, S.91.12, S.91.20, S.91.21, S.91.22, S.91.30, S.91.40, S.91.41, S.91.42, S.92.00, S.93.10, S.93.11, S.93.12, S.93.13, S.93.19, S.93.20, S.93.21, S.93.29, S.94.10, S.94.11, S.94.12, S.94.20, S.94.90, S.94.91, S.94.92, S.94.99, S.95.10, S.95.11, S.95.12, S.95.20, S.95.21, S.95.22, S.95.23, S.95.24, S.95.25, S.95.29, S.96.00, S.96.01, S.96.02, S.96.03, S.96.04, S.96.09, T.94.10, T.94.11, T.94.12, T.94.20, T.94.90, T.94.91, T.94.92, T.94.99, T.95.10, T.95.20, T.95.21, T.95.22, T.95.23, T.95.24, T.95.25, T.95.29, T.95.30, T.95.31, T.95.32, T.95.40, T.96.00, T.96.10, T.96.20, T.96.21, T.96.22, T.96.23, T.96.30, T.96.40, T.96.90, T.96.91, T.96.99, T.97.00, T.98.10, T.98.20, U.97.00, U.98.10, U.98.20, U.99.00, V.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 | branch, head_office, jv, parent, parent_branch, parent_subsidiary, participation, subsidiary, |
| reporting_relationship | Relationship to reporting entity. See: relationship. | string | branch, head_office, jv, parent, parent_branch, parent_subsidiary, participation, subsidiary, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | a, a_plus, b, c, |
| sic_code | Standard Industrial Classification (SIC) system. The applicable reference depends on jurisdiction. | integer | - |
| snp_lt | S&P long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| snp_st | S&P short term credit ratings | string | a1, a2, a3, b, c, d, |
| 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_society, ccp, central_bank, central_govt, charity, ciu, community_charity, corporate, credit_institution, credit_union, deposit_broker, export_credit_agency, federal_credit_union, financial, financial_holding, fund, hedge_fund, housing_coop, individual, insurer, intl_org, investment_firm, local_authority, mdb, mmkt_fund, national_bank, natural_person, non_member_bank, other, other_financial, other_pse, partnership, pension_fund, pic, pmi, private_equity_fund, private_fund, promo_fed_home_loan, promo_fed_reserve, promotional_lender, property_spe, pse, public_corporation, qccp, real_estate_fund, regional_govt, sme, social_housing_entity, social_security_fund, sovereign, sspe, state_credit_union, state_member_bank, state_owned_bank, statutory_board, supported_sme, unincorp_inv_fund, unincorporated_biz, unregulated_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 | - |
| layout | title |
|---|---|
| schema | loan |
Loan Schema
Data schema defining the characteristics of a loan product.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_gaap, |
| accrual_status | The accrual status of the loan or line of credit. | string | accrual, non_accrual, securitised, serviced_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 | other, principal, |
| arrears_arrangement | The arrangement the lender has made with the borrower regarding the amount referenced in the arrears_balance. | string | formal, interest_grace_period, mi_claim_adv, modified_tnc, none, possessed, prin_def_rate, prin_def_rate_term, prin_def_term, principal_defer, principal_forgive, rate_prin_forgive, rate_red_frozen, rate_term, rate_term_prin_forgive, recap, refinancing, renewal, reo, settlement, short_sale, temporary, term_ext, term_prin_forgive, term_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 | asset, equity, liability, oci, pnl, |
| 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 | FDTR, UKBRBASE, ZERO, cert_dep, cofi, cofi_11th, cofi_nm, cofi_other, cosi, mta, other, prime, sofr, sofr_1m, sofr_1y, sofr_3m, sofr_6m, sofr_other, tbill, tbill_1y, tbill_3m, tbill_3y, tbill_5y, tbill_6m, tbill_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| credit_process | Identifier for how a loan is credit assessed during the underwriting process | string | delinquency_managed, graded, rated, scored, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_360, act_365, act_act, std_30_360, std_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 | abs, cb_funding, covered_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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | fiduciary, non_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| impairment_type | The loss event resulting in the impairment of the loan. | string | collective, individual, write_off, |
| income_assessment | Was the loan assessed against a single or joint incomes? | string | joint, joint_not_evidenced, single, single_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 | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
| 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 | acquired, acquired_impaired, other, securitised, sold, syndicated, syndicated_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_lender, other, spv, |
| 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_snc, agent_snc, none, participant_non_snc, participant_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 | none, other, |
| purpose | The underlying reason the borrower has requested the loan. | string | agriculture, bridging_loan, business_recap, buy_to_let, buy_to_let_construct, buy_to_let_further_advance, buy_to_let_house_purchase, buy_to_let_other, buy_to_let_remortgage, cash_out, commercial, commercial_property, commodities_finance, construction, consumer_buy_to_let, corporate_finance, debt_consolidation, education, esop, first_time_buyer, first_time_buyer_cstr, further_advance, further_advance_cstr, house_purchase, house_purchase_cstr, ips, lifetime_mortgage, medical, mergers_acquisitions, non_b20, object_finance, object_finance_hq, operational, operational_non_sym, operational_sym, other, portfolio_acquisition, project_finance, project_hq_phase, project_pre_op, promotional, rate, reference, refinance, remortgage, remortgage_construct, remortgage_other, remortgage_othr_cstr, renovation, speculative_property, stock_buyback, term, |
| 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 | combined, fixed, tracker, variable, |
| 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 | full, none, partial, |
| 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_book, trading_book, |
| repayment_frequency | Repayment frequency of the loan. | string | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
| 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 | combined, interest_only, option_arm, other, repayment, |
| 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_repurchase, complete_repurchased, in_process, initiated, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | mezzanine, pari_passu, senior_secured, senior_unsecured, subordinated_secured, subordinated_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 | business, pension, rent, salary, |
| servicing_currency_code | Currency in accordance with ISO 4217 standards plus CNH for practical considerations. | string | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | actual, cancellable, cancelled, closed, committed, defaulted, frozen, revolving, |
| 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 | auto, cd, charge_card, commercial, commercial_property, corporate_card, credit_card, credit_facility, education, financial_lease, heloan, heloc, heloc_lockout, liquidity_facility, mortgage, mortgage_charter, mortgage_cra, mortgage_fha_project, mortgage_fha_res, mortgage_hud235, mortgage_no_pmi, mortgage_pmi, mortgage_va, multiccy_facility, new_auto, nostro, other, personal, q_reverse_mortgage, reverse_mortgage, trade_finance, used_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 | - |
| layout | title |
|---|---|
| schema | loan_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
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | interest, principal, |
| version_id | The version identifier of the data such as the firm’s internal batch identifier. | string | - |
| layout | title |
|---|---|
| schema | loan_transaction |
Loan Transaction Schema
A Loan Transaction is an event that has an impact on a loan, typically the balance.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | acquisition, advance, capital_repayment, capitalisation, commitment, due, further_advance, interest, interest_repayment, other, received, recovery, sale, securitisation, write_off, write_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 | - |
| layout | title |
|---|---|
| schema | risk_rating |
Risk Rating
A risk rating entry for a risk rating system
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | - |
| layout | title |
|---|---|
| schema | security |
Security Schema
A security represents a tradable financial instrument held or financed by an institution for investment or collateral.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_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 | asset, equity, liability, oci, pnl, |
| 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 | FDTR, UKBRBASE, ZERO, bbsw, bbsw_3m, euribor, euribor_1m, euribor_3m, euribor_6m, other, pboc, sofr, sofr_1m, sofr_3m, sofr_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_up, clean_up_reg, other, |
| capital_tier | The capital tiers based on own funds requirements. | string | add_tier_1, anc_tier_2, anc_tier_3, at1_grandfathered, bas_tier_2, bas_tier_3, ce_tier_1, cet1_grandfathered, t2_grandfathered, tier_1, tier_2, tier_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 | imm, oem, sa, ssa, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_360, act_365, act_act, std_30_360, std_30_365, |
| dbrs_lt | DBRS long term credit ratings | string | aaa, aa_h, aa, aa_l, a_h, a, a_l, bbb_h, bbb, bbb_l, bb_h, bb, bb_l, b_h, b, b_l, ccc_h, ccc, ccc_l, cc, c, d, |
| dbrs_st | DBRS short term credit ratings | string | r1_h, r1_m, r1_l, r2_h, r2_m, r2_l, r3, r4, r5, d, |
| 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 | cumulative, non_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 | fixed, fixed_trapped, none, variable, variable_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 | fiduciary, non_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 | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, rd, d, |
| fitch_st | Fitch short term credit ratings | string | f1_plus, f1, f2, f3, b, c, rd, d, |
| 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 | exclude, i, i_non_op, iia, iia_non_op, iib, iib_non_op, ineligible, ineligible_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| 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 | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
| 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_municipal, non_public, private_placement, public_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 | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| kbra_st | KBRA short term credit ratings | string | k1_plus, k1, k2, k3, b, c, d, |
| 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 | aaa, aa1, aa2, aa3, a1, a2, a3, baa1, baa2, baa3, ba1, ba2, ba3, b1, b2, b3, caa1, caa2, caa3, ca, c, |
| moodys_st | Moodys short term credit ratings | string | p1, p2, p3, np, |
| movement | The movement parameter describes how the security arrived to the firm. | string | asset, cash, cb_omo, debt_issue, issuance, other, |
| 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_finance, back_to_back, collateral, custody, default_fund, derivative_collateral, independent_collateral_amount, insurance, investment, investment_advice, non_controlling, ocir, other, portfolio_management, reference, share_capital, single_collateral_pool, trade_finance, variation_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 | combined, fixed, fixed_to_fixed, fixed_to_float, step_up, tracker, variable, |
| 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 | full, none, partial, |
| regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_book, |
| rehypothecation | Can the security be rehypothecated by the borrower? | boolean | - |
| repayment_type | The repayment or amortisation mechanism of the security or securitisation. | string | other, pr2s, pr2s_abcp, pr2s_non_abcp, pro_rata, sequential, |
| 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 | exempted, first_loss, on_bs, revolving, vertical_nominal, vertical_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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_through, sts, sts_synthetic, sts_traditional, synthetic, traditional, |
| 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_secured, senior_secured, senior_unsecured, subordinated_secured, subordinated_unsecured, |
| servicing | The method by which the debt shall be repaid | string | app_backed, general_obligation, other, revenue, revenue_education, revenue_health, revenue_ind_dev, revenue_multi_housing, revenue_other, revenue_single_housing, revenue_tax, revenue_transport, revenue_utilities, |
| sft_type | The sft_type parameter defines the transaction mechanism conducted for the SFT for this security product. | string | bond_borrow, bond_loan, buy_sell_back, margin_loan, repo, rev_repo, sell_buy_back, stock_borrow, stock_loan, term_funding_scheme, |
| snp_lt | S&P long term credit ratings | string | aaa, aa_plus, aa, aa_minus, a_plus, a, a_minus, bbb_plus, bbb, bbb_minus, bb_plus, bb, bb_minus, b_plus, b, b_minus, ccc_plus, ccc, ccc_minus, cc, c, d, |
| snp_st | S&P short term credit ratings | string | a1, a2, a3, b, c, d, |
| 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_remote, called_up, conversion, free_deliveries, non_operational, other, paid_up, redeemed, refinanced, replaced, repurchase, unsettled, |
| 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 | abs, abs_auto, abs_cc, abs_consumer, abs_corp, abs_lease, abs_other, abs_sme, abs_sme_corp, abs_sme_retail, abs_student, abs_trade_rec, abs_wholesale, acceptance, ars, bill_of_exchange, bond, cash, cash_ratio_deposit, cb_facility, cb_reserve, cb_restricted_reserve, cd, cdo, clo, cmbs, cmbs_income, commercial_paper, common, convertible_bond, covered_bond, cpp, cpp_tarp_pref, cs_usg, cs_warrant, debt, dividend, documentary, emtn, equity, financial, financial_guarantee, financial_sloc, frn, guarantee, index, index_linked, letter_of_credit, loan_pool, main_index_equity, mbs, mcp, mcp_usg, mtn, ncpp, ncpp_convertible, nha_mbs, other, performance, performance_bond, performance_guarantee, performance_sloc, pibs, pref_share, reit_pref, rmbs, rmbs_income, rmbs_trans, share, share_agg, speculative_unlisted, spv_mortgages, spv_other, standby, struct_note, treasury, trups, trups_usg_pref, urp, warranty, |
| 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 | - |
| layout | title |
|---|---|
| schema | account |
Account Extended Schema
Extended account schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_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 | asset, equity, liability, oci, pnl, |
| 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 | FDTR, UKBRBASE, ZERO, |
| 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_1, anc_tier_2, anc_tier_3, at1_grandfathered, bas_tier_2, bas_tier_3, ce_tier_1, cet1_grandfathered, t2_grandfathered, tier_1, tier_2, tier_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_360, act_365, act_act, std_30_360, std_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_bond, derivative, none, other, repo, |
| 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_pf, bg_dif, ca_cdic, cy_dps, cz_dif, de_edb, de_edo, de_edw, dk_gdfi, ee_dgs, es_fgd, fi_dgf, fr_fdg, gb_fscs, gr_dgs, hk_dps, hr_di, hu_ndif, ie_dgs, it_fitd, lt_vi, lu_fgdl, lv_dgf, mt_dcs, nl_dgs, pl_bfg, pt_fgd, ro_fgdb, se_ndo, si_dgs, sk_dpf, us_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| impairment_type | The loss event resulting in the impairment of the loan. | string | collective, individual, write_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 | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
| 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_subs, adj_syn_inv_own_shares, adj_syn_mtg_def_ins, adj_syn_nonsig_inv_fin, adj_syn_other_inv_fin, admin, annual_bonus_accruals, benefit_in_kind, capital_gain_tax, capital_reserve, cash_management, cf_hedge, cf_hedge_reclass, ci_service, clearing, collateral, commitments, computer_and_it_cost, computer_peripheral, computer_software, corporation_tax, credit_card_fee, critical_service, current_account_fee, custody, dealing_rev_cr, dealing_rev_dbt_issue, dealing_rev_debt, dealing_rev_deposits, dealing_rev_deriv, dealing_rev_deriv_com, dealing_rev_deriv_eco, dealing_rev_deriv_equ, dealing_rev_deriv_fx, dealing_rev_deriv_int, dealing_rev_deriv_nse, dealing_rev_deriv_oth, dealing_rev_equity, dealing_rev_fx, dealing_rev_fx_nse, dealing_rev_ir, dealing_rev_loan, dealing_rev_non_fin, dealing_rev_oth_finan, dealing_rev_sec, dealing_rev_sec_nse, dealing_rev_short, dealing_revenue, ded_fut_prof, ded_fut_prof_temp_diff, defined_benefit, deposit, derivative_fee, dgs_contribution, div_from_cis, div_from_money_mkt, dividend, donation, employee, employee_stock_option, escrow, fees, fine, firm_operating_expenses, firm_operations, furniture, fut_prof, fut_prof_temp_diff, fx, general_credit_risk, goodwill, insurance_fee, int_on_asset, int_on_bond_and_frn, int_on_bridging_loan, int_on_credit_card, int_on_debt_issued, int_on_deposit, int_on_deriv_hedge, int_on_derivative, int_on_ecgd_lending, int_on_finance_leasing, int_on_liability, int_on_loan_and_adv, int_on_money_mkt, int_on_mortgage, int_on_sft, int_unallocated, intangible, intangible_lease, interest, intra_group_fee, inv_in_subsidiary, investment_banking_fee, investment_prop_lease, investment_property, ips, it_outsourcing, land, loan_and_advance_fee, machinery, manufactured_dividend, mortgage_fee, msr, mtg_ins_nonconform, mtg_insurance, ni_contribution, nol_carryback, non_life_ins_premium, not_fut_prof, occupancy_cost, operational, operational_escrow, operational_excess, oth_tax_excl_temp_diff, other, other_expenditure, other_fs_fee, other_non_fs_fee, other_social_contrib, other_staff_cost, other_staff_rem, overdraft_fee, own_property, pension, ppe, prime_brokerage, property, property_lease, pv_future_spread_inc, rec_unidentified_cpty, reclass_tax, recovery, redundancy_pymt, reference, reg_loss, regular_wages, release, rent, res_fund_contribution, restructuring, retained_earnings, revaluation, revaluation_reclass, revenue_reserve, share_plan, share_premium, staff, system, tax, telecom_equipment, third_party_interest, underwriting_fee, unsecured_loan_fee, vehicle, write_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 | combined, fixed, preferential, tracker, variable, |
| 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 | full, none, partial, |
| regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | mezzanine, pari_passu, senior_secured, senior_unsecured, subordinated_secured, subordinated_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 | active, audited, cancelled, cancelled_payout_agreed, other, pending, transactional, unaudited, |
| 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 | accruals, amortisation, bonds, call, cd, credit_card, current, current_io, debt_securities_issued, deferred, deferred_tax, depreciation, expense, financial_lease, income, intangible, internet_only, ira, isa, isa_current, isa_current_io, isa_io, isa_time_deposit, isa_time_deposit_io, loans_and_advances, money_market, non_deferred, non_product, other, other_financial_liab, prepaid_card, prepayments, provision, reserve, retail_bonds, savings, savings_io, suspense, tangible, third_party_savings, time_deposit, time_deposit_io, valuation_allowance, vostro, |
| uk_funding_type | Funding type calculated according to BIPRU 12.5/12.6 | string | a, b, |
| 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 | - |
| layout | title |
|---|---|
| schema | account |
Account Extended Schema
Extended account schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_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 | asset, equity, liability, oci, pnl, |
| 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 | FDTR, UKBRBASE, ZERO, |
| 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_1, anc_tier_2, anc_tier_3, at1_grandfathered, bas_tier_2, bas_tier_3, ce_tier_1, cet1_grandfathered, t2_grandfathered, tier_1, tier_2, tier_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_360, act_365, act_act, std_30_360, std_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_bond, derivative, none, other, repo, |
| 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_pf, bg_dif, ca_cdic, cy_dps, cz_dif, de_edb, de_edo, de_edw, dk_gdfi, ee_dgs, es_fgd, fi_dgf, fr_fdg, gb_fscs, gr_dgs, hk_dps, hr_di, hu_ndif, ie_dgs, it_fitd, lt_vi, lu_fgdl, lv_dgf, mt_dcs, nl_dgs, pl_bfg, pt_fgd, ro_fgdb, se_ndo, si_dgs, sk_dpf, us_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| impairment_type | The loss event resulting in the impairment of the loan. | string | collective, individual, write_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 | daily, weekly, bi_weekly, monthly, bi_monthly, quarterly, semi_annually, annually, at_maturity, biennially, sesquiennially, |
| 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_subs, adj_syn_inv_own_shares, adj_syn_mtg_def_ins, adj_syn_nonsig_inv_fin, adj_syn_other_inv_fin, admin, annual_bonus_accruals, benefit_in_kind, capital_gain_tax, capital_reserve, cash_management, cf_hedge, cf_hedge_reclass, ci_service, clearing, collateral, commitments, computer_and_it_cost, computer_peripheral, computer_software, corporation_tax, credit_card_fee, critical_service, current_account_fee, custody, dealing_rev_cr, dealing_rev_dbt_issue, dealing_rev_debt, dealing_rev_deposits, dealing_rev_deriv, dealing_rev_deriv_com, dealing_rev_deriv_eco, dealing_rev_deriv_equ, dealing_rev_deriv_fx, dealing_rev_deriv_int, dealing_rev_deriv_nse, dealing_rev_deriv_oth, dealing_rev_equity, dealing_rev_fx, dealing_rev_fx_nse, dealing_rev_ir, dealing_rev_loan, dealing_rev_non_fin, dealing_rev_oth_finan, dealing_rev_sec, dealing_rev_sec_nse, dealing_rev_short, dealing_revenue, ded_fut_prof, ded_fut_prof_temp_diff, defined_benefit, deposit, derivative_fee, dgs_contribution, div_from_cis, div_from_money_mkt, dividend, donation, employee, employee_stock_option, escrow, fees, fine, firm_operating_expenses, firm_operations, furniture, fut_prof, fut_prof_temp_diff, fx, general_credit_risk, goodwill, insurance_fee, int_on_asset, int_on_bond_and_frn, int_on_bridging_loan, int_on_credit_card, int_on_debt_issued, int_on_deposit, int_on_deriv_hedge, int_on_derivative, int_on_ecgd_lending, int_on_finance_leasing, int_on_liability, int_on_loan_and_adv, int_on_money_mkt, int_on_mortgage, int_on_sft, int_unallocated, intangible, intangible_lease, interest, intra_group_fee, inv_in_subsidiary, investment_banking_fee, investment_prop_lease, investment_property, ips, it_outsourcing, land, loan_and_advance_fee, machinery, manufactured_dividend, mortgage_fee, msr, mtg_ins_nonconform, mtg_insurance, ni_contribution, nol_carryback, non_life_ins_premium, not_fut_prof, occupancy_cost, operational, operational_escrow, operational_excess, oth_tax_excl_temp_diff, other, other_expenditure, other_fs_fee, other_non_fs_fee, other_social_contrib, other_staff_cost, other_staff_rem, overdraft_fee, own_property, pension, ppe, prime_brokerage, property, property_lease, pv_future_spread_inc, rec_unidentified_cpty, reclass_tax, recovery, redundancy_pymt, reference, reg_loss, regular_wages, release, rent, res_fund_contribution, restructuring, retained_earnings, revaluation, revaluation_reclass, revenue_reserve, share_plan, share_premium, staff, system, tax, telecom_equipment, third_party_interest, underwriting_fee, unsecured_loan_fee, vehicle, write_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 | combined, fixed, preferential, tracker, variable, |
| 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 | full, none, partial, |
| regulatory_book | The type of portfolio in which the instrument is held. | string | banking_book, trading_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | mezzanine, pari_passu, senior_secured, senior_unsecured, subordinated_secured, subordinated_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 | active, audited, cancelled, cancelled_payout_agreed, other, pending, transactional, unaudited, |
| 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 | accruals, amortisation, bonds, call, cd, credit_card, current, current_io, debt_securities_issued, deferred, deferred_tax, depreciation, expense, financial_lease, income, intangible, internet_only, ira, isa, isa_current, isa_current_io, isa_io, isa_time_deposit, isa_time_deposit_io, loans_and_advances, money_market, non_deferred, non_product, other, other_financial_liab, prepaid_card, prepayments, provision, reserve, retail_bonds, savings, savings_io, suspense, tangible, third_party_savings, time_deposit, time_deposit_io, valuation_allowance, vostro, |
| uk_funding_type | Funding type calculated according to BIPRU 12.5/12.6 | string | a, b, |
| 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 | - |
| layout | title |
|---|---|
| schema | adjustment |
Adjustment Extended Schema
Extended adjustment schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | - |
| layout | title |
|---|---|
| schema | agreement |
Agreement Extended Schema
Extended agreement schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| credit_support_type | The type of credit support document | string | csa_isda_1994, csa_isda_1995, csd_isda_1995, scsa_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 | daily, daily_settled, weekly, bi_weekly, monthly, |
| 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_supervision, no_right_to_offset, restrictive_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 | both, customer, self_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 | afb, drv, ema, fbf, gmra, gmsla, icma_1992, icma_1995, icma_2000, icma_2011, isda, isda_1985, isda_1986, isda_1987, isda_1992, isda_2002, other, other_gmra, other_isda, right_to_set_off, |
| version_id | The version identifier of the data such as the firm’s internal batch identifier. | string | - |
| layout | title |
|---|---|
| schema | collateral |
Collateral Extended Schema
Extended collateral schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| currency_code | Currency in accordance with ISO 4217 standards plus CNH for practical considerations. | string | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_bond, derivative, none, other, real_estate, repo, |
| 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_book, trading_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 | auto, auto_other, blanket_lien, car, cash, co_op, commercial_property, commercial_property_hr, condo, convertible, debenture, farm, four_units, guarantee, healthcare, hospitality, immovable_property, industrial, life_policy, luxury, manufactured_house, multifamily, office, one_unit, other, planned_unit_dev, res_property_hr, resi_mixed_use, residential_property, retail, security, single_family, sport, suv, three_units, townhouse, truck, two_units, van, warehouse, |
| 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_completed, as_is, as_stabilized, auto_val_model, broker_price, desktop, full, limited, prospective_market_value, purchase_price, tav, |
| 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 | - |
| layout | title |
|---|---|
| schema | curve |
Curve Extended Schema
Extended curve schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | behavioral, rate, risk_rating, volatility, |
| 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 | - |
| layout | title |
|---|---|
| schema | customer |
Customer Extended Schema
Extended customer schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | above, below, |
| 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 | fico, other, vantage, |
| 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 | fdic, frb, occ, |
| 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 | - |
| layout | title |
|---|---|
| schema | derivative |
Derivative Extended Schema
Extended derivative schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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_cost, available_for_sale, cb_or_demand, deed_in_lieu, fv_mandatorily, fv_oci, fv_thru_pnl, held_for_hedge, held_for_invest, held_for_invest_fvo, held_for_sale, held_for_trading, held_to_maturity, loans_and_recs, ntnd_cost_based, ntnd_fv_equity, ntnd_fv_pl, other_gaap, trading_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 | agri, co, co_other, coal, coffee, corn, cr, cr_index, cr_single, electricity, energy, eq, eq_index, eq_single, fx, gas, gold, inflation, ir, metals, oil, other, palladium, platinum, precious_metals, silver, sugar, |
| asset_liability | Is the data an asset, a liability, or equity on the firm’s balance sheet? | string | asset, equity, liability, oci, pnl, |
| 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 | FDTR, FESR, UKBRBASE, USTSR, ZERO, bbsw, bbsw_3m, euribor, euribor_1m, euribor_3m, euribor_6m, other, pboc, sofr, sofr_1m, sofr_3m, sofr_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 | imm, oem, sa, ssa, |
| 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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| cr_approach | Specifies the approved credit risk rwa calculation approach to be applied to the exposure. | string | airb, eif_fb, eif_lt, eif_mba, firb, sec_erba, sec_sa, sec_sa_lt, std, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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_flows, last_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_sided, two_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_hedge, fv_hedge, portfolio_cf_hedge, portfolio_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_only, other, partial, principal_interest, principal_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 | cr, fv_option, fx, fx_cr, ir, ir_cr, ir_fx, ir_fx_cr, other, overall_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 | doubtful, in_litigation, loss, non_performing, normal, performing, pre_litigation, stage_1, stage_1_doubtful, stage_1_loss, stage_1_normal, stage_1_substandard, stage_1_watch, stage_2, stage_2_doubtful, stage_2_loss, stage_2_normal, stage_2_substandard, stage_2_watch, stage_3, stage_3_doubtful, stage_3_loss, stage_3_normal, stage_3_substandard, stage_3_watch, substandard, watch, |
| 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 | call, fixed, floating, indexed, put, |
| 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 | long, short, |
| 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_back, client_execution, client_transmission, cva_hedge, reference, |
| 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_book, trading_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 | AA, AD, AE, AE-AJ, AE-AZ, AE-DU, AE-FU, AE-RK, AE-SH, AE-UQ, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CA-AB, CA-BC, CA-MB, CA-NB, CA-NL, CA-NS, CA-NT, CA-NU, CA-ON, CA-PE, CA-QC, CA-SK, CA-YT, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, QM, QN, QO, QP, QQ, QR, QS, QT, QU, QV, QW, QX, QY, QZ, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, US-AK, US-AL, US-AR, US-AZ, US-CA, US-CO, US-CT, US-DC, US-DE, US-FL, US-GA, US-HI, US-IA, US-ID, US-IL, US-IN, US-KS, US-KY, US-LA, US-MA, US-MD, US-ME, US-MI, US-MN, US-MO, US-MS, US-MT, US-NC, US-ND, US-NE, US-NH, US-NJ, US-NM, US-NV, US-NY, US-OH, US-OK, US-OR, US-PA, US-RI, US-SC, US-SD, US-TN, US-TX, US-UT, US-VA, US-VT, US-WA, US-WI, US-WV, US-WY, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XA, XB, XC, XD, XE, XF, XG, XH, XI, XJ, XK, XL, XM, XN, XO, XP, XQ, XR, XS, XT, XU, XV, XW, XX, XY, XZ, YE, YT, ZA, ZM, ZW, ZZ, |
| 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 | cash, physical, |
| 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_deliveries, unsettled, |
| 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_floor, ccds, cds, forward, fra, future, mtm_swap, ndf, nds, ois, option, spot, swaption, vanilla_swap, variance_swap, xccy, |
| underlying_currency_code | Currency in accordance with ISO 4217 standards plus CNH for practical considerations. | string | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, |
| 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 | 1d, 7d, 28d, 91d, 182d, 1m, 2m, 3m, 4m, 5m, 6m, 7m, 8m, 9m, 12m, 24m, 60m, 120m, 360m, |
| 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 | - |
| layout | title |
|---|---|
| schema | derivative_cash_flow |
Derivative Cash Flow Extended Schema
Extended derivative cash flow schema containing all jurisdiction-specific extensions.
Properties
| Name | Description | Type | Enum |
|---|---|---|---|
| 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 | agri, co, co_other, coal, coffee, corn, cr, cr_index, cr_single, electricity, energy, eq, eq_index, eq_single, fx, gas, gold, inflation, ir, metals, oil, other, palladium, platinum, precious_metals, silver, sugar, |
| asset_liability | Is the data an asset, a liability, or equity on the firm’s balance sheet? | string | asset, equity, liability, oci, pnl, |
| 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 | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SYP, SZL, THB, TJS, TMT, TND, TOP, |