Ontology

Attributes

All attributes include

FieldOptionalTypeDescription
from_date      ✔stringstart date of an attribute
date      ✔stringas-of date of an attribute
to_date      ✔stringend date of an attribute

Additional Information

This is a generic attribute used to hold miscellaneous information not covered by any other attribute. Includes “value” (for the attribute itself), “type” (a name: e.g., “Real property description”), and “extra” (a miscellaneous field to hold any other details).

FieldOptionalTypeDescription
value      ✔stringThe additional information itself
type      ✔stringThe type of additional information being conveyed
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Address

A physical location description. Addresses may exist as a simple string (“123 South Main St., South Bend, IN 46556”), or may be in smaller chunks with separate fields (“Number: 123”, “Street name: South Main …”). Where possible, these fields will be parsed using the Libpostal ontology, which facilitates more robust address analysis and comparison.

FieldOptionalTypeDescription
valuestringA single string that expresses the entire address. If this is created in the parser, it should run from the most specific part of the address to the least specific.
translated      ✔stringThe address value translated to English
transliterated      ✔stringThe address value transliterated to English
type      ✔Address TypeIndicates what the address is referring to. For example, it could be a physical address, mailing address, or other address type.
language      ✔LanguageThe language in which the address was provided in the record
house      ✔stringBuilding/site name (e.g., “Brooklyn Academy of Music”, “Empire State Building”)
house_number      ✔stringUsually refers to the external (street-facing) building number. In some jurisdictions, this may be a compound number that also includes an apartment/block number.
po_box      ✔stringTypically found in non-physical (mail-only) addresses
building      ✔string
entrance      ✔stringNumbered/lettered entrance
staircase      ✔stringNumbered/lettered staircase
level      ✔stringExpressions indicating a floor number (e.g., “3rd Floor”, “Ground Floor”)
unit      ✔stringAn apartment, unit, office, lot, or other secondary unit designator
road      ✔stringStreet name(s)
metro_station      ✔string
suburb      ✔stringUsually an unofficial neighborhood name, like “Harlem”, “South Bronx”, or “Crown Heights”
city_district      ✔stringBoroughs or districts within a city that serve some official purpose (e.g., “Brooklyn”, “Hackney”, or “Bratislava IV”)
city      ✔stringAny human settlement, including cities, towns, villages, hamlets, localities, etc.
state_district      ✔stringA second-level administrative division or county
island      ✔stringNamed islands (e.g., “Maui”)
state      ✔stringA first-level administrative division, including provinces and departments. Scotland, Northern Ireland, Wales, and England in the UK are also mapped to “state” (convention commonly used in geocoding tools).
postcode      ✔stringPostal codes used for mail sorting
country_region      ✔stringInformal subdivision of a country without any political status
country      ✔stringSovereign nations and their dependent territories; anything with an ISO 3166 code
world_region      ✔stringCurrently only used for appending “West Indies” after the country name, a pattern frequently used in the English-speaking Caribbean (e.g., “Jamaica, West Indies”)
category      ✔stringFor category queries like “restaurants”, etc.
near      ✔stringPhrases like “in”, “near”, etc. used after a category phrase, to help with parsing queries like “restaurants in Brooklyn”
x      ✔doubleThe X coordinate (longitude) of the address
y      ✔doubleThe Y coordinate (latitude) of the address
precision_code      ✔stringA code describing the precision of the X and Y coordinates
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Business Purpose

Text and/or a code (NAICS, NACE, ISIC, etc.) that describes what a company is legally allowed to do or produce

FieldOptionalTypeDescription
value      ✔stringA text description
code      ✔stringA code
standard      ✔Business Purpose StandardThe type of code (e.g., “ISIC4”, “NACE1”)
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Company Type

A type of legal entity in a given jurisdiction (e.g., “LLC”, “Sociedad Anonima”, “Private Company Limited by Shares”)

FieldOptionalTypeDescription
valuestringFree text
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Contact

Contact information for an entity

FieldOptionalTypeDescription
valuestringThe contact detail itself (e.g., “[email protected]”, “202-555-5555”)
type      ✔Contact TypeEmail, fax, phone number, or URL
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Country

An affiliation of an entity with a given country through residence, nationality, etc.

FieldOptionalTypeDescription
valueCountryThe country, ideally normalized to an ISO trigram
context      ✔Country ContextThe type of affiliation
state      ✔stringThe subnational state, province, region, etc.
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Date Of Birth

Birth date of a person

FieldOptionalTypeDescription
valuestringThe date of birth in YYYY-MM-DD, YYYY-MM, or YYYY format
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Finances

This attribute is deprecated.

A financial figure, typically share capital

FieldOptionalTypeDescription
valuedoubleThe numerical amount
context      ✔Finance TypeThe type of figure
type      ✔stringA free-text definition of the type
currency      ✔CurrencyThe currency, if applicable
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Financials

A summary of financial information at one point in time

FieldOptionalTypeDescription
revenue      ✔doubleThe total amount of income generated by the sale of goods or services related to the company’s primary operations
net_income      ✔doubleCompany’s earnings for a period after subtracting operating costs, taxes, and interest
assets      ✔doubleThe total value of assets owned by a company
liabilities      ✔doubleSum of the combined debts a company owes
total_current_liabilities      ✔doubleThe total amount of a company’s short-term financial obligations that are due within one year, such as accounts payable, short-term loans, and wages payable
registered_capital      ✔doubleRegistered capital is the maximum amount of share capital that a company is authorized to raise
paid_up_capital      ✔doublePaid-up capital is the capital already held by the company
employees      ✔intTotal employees
currency      ✔CurrencyReporting currency
common_stock      ✔doubleTotal Common Stock
operating_income      ✔doubleReported Operating Income
total_debt      ✔doubleTotal Debt
inventory      ✔doubleTotal Inventory
cash_and_equivalent      ✔doubleTotal Cash and Equivalent
gross_profit      ✔doubleTotal Gross Profit
reporting_period_type      ✔Reporting Period TypeReporting period type
rd_expenses      ✔doubleCosts incurred by a company on the development of a new product, innovation relating to technology formulation, process development, or on the process undertaken in upgrading the existing product or service line.
total_operating_expenses      ✔doubleThe costs a business incurs to maintain its day-to-day operations, excluding the cost of goods sold.
total_liabilities      ✔doubleAll liabilities (current and long-term) as of the date indicated, as carried on the balance sheet.
unusual_items      ✔doubleSum of all income or expenses that are deemed infrequent and not typical of a company’s ordinary operations.
cash_operations      ✔doubleNet cash used or generated in operating activities, during the stated period of time.
cash_investing      ✔doubleNet cash used or generated in investing activities, during the stated period of time.
cash_financing      ✔doubleNet cash used or generated in financing activities, during the stated period of time.
total_equity      ✔doubleEquity as defined under the indicated accounting principles. Includes par value, paid in capital, retained earnings, and other adjustments to equity.
asset_writeoff      ✔doubleWrite-off of any intangible or tangible fixed assets by the company and includes any value charged towards restructuring of operations.
sale_ppe      ✔doubleCash flows obtained by the company through the sale of property, plant, and equipment.
issued_common_stock      ✔doubleThe total cash inflow received from issuing new common shares during the reporting period.
total_dividends      ✔doubleCash outflows towards dividends or distributions, either to common or preferred stockholders during the relevant period. The value paid may relate to pending dividend of earlier period also.
interest_expense      ✔doubleInterest expense (net of capitalized interest) incurred by the company on the debt taken. Also includes debt procurement costs, and dividend paid by parent company on the preferred stock of its subsidiary or on trust preferred securities reported in the income statement.
legal_settlements      ✔doubleCosts incurred in legal disputes or receipts from legal settlements received by the company and reflected on the income statement.
total_current_assets      ✔doubleAssets which are expected to be converted into cash or used in the production of revenue within a period of twelve months.
total_capitalization      ✔doubleThe sum of total debt and all types of equity of a company.
total_receivables      ✔doubleSummation of accounts receivable - trade, accounts receivable - other, and loans receivable current.
total_debt_issued      ✔doubleCash inflow from issuance of debt.
net_change_cash      ✔doubleNet increase or decrease in cash and cash equivalents during the stated period of time. Sum of cash flows from operating activities, investing activities and financing activities plus foreign exchange rate adjustments and other miscellaneous cash flows.
basic_eps      ✔doubleProfitability metric that indicates how much profit a company generates for each outstanding share of common stock.
accounts_payable      ✔doubleTrade payables for the purchase of materials and supplies to be used in the production of goods or in providing of services and are due in customary trade terms within one year or within the normal operating cycle of the company.
change_accounts_receivable      ✔doubleIncrease or decrease in the accounts receivable of the company during the stated period.
change_inventory      ✔doubleChange in the inventory of the company reflected in the operating section of cash flow statement.
change_accounts_payable      ✔doubleIncrease or decrease in accounts payable by the company during the stated period.
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Gender

A person’s gender

FieldOptionalTypeDescription
valueGenderMay be described as “female”, “male”, or “other”
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Generic

This attribute is deprecated.

A placeholder attribute. Rarely used. A generic attribute typically does not fit any other attribute type.

FieldOptionalTypeDescription
value      ✔stringThe value of the attribute as text (e.g., “Max”)
type      ✔stringA text description of the attribute (e.g., “name of pet”)
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Identifier

An ID number that uniquely identifies one entity when value and type are taken into account.

FieldOptionalTypeDescription
valuestringThe text/number value of the identifier
typeIdentifier TypeThe type must include the jurisdiction in which it is issued
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Measurement

A numerical measurement of a dimension of an entity (e.g., weight) using a standard unit

FieldOptionalTypeDescription
valuedoubleThe value of the measurement
typeMeasurement TypeType of the measurement
unitUnitThe unit of the measurement
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Monetary Value

The financial value of an asset (e.g., FOB, CIF)

FieldOptionalTypeDescription
valuedoubleThe financial value of the asset
currency      ✔CurrencyThe ISO 4217 currency code
contextMonetary Value ContextThe type of value
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Name

An entity’s name. The value may be straightforward (e.g., “Acme LLC”, “John Doe”) or context specific (e.g., “Jones v. Smith” as a legal matter name).

FieldOptionalTypeDescription
valuestringThe name, as text
language      ✔LanguageThe language that the name is in
context      ✔Name ContextThe type of name
translated      ✔stringThe name value translated to English
transliterated      ✔stringThe name value transliterated to English
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Person Status

This attribute is deprecated.

A key event occurring in a person’s life, usually temporal

FieldOptionalTypeDescription
valuePerson StatusThe event
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Position

An attribute used for many different relationship types that allows for the inclusion of a title or designation (e.g., member_of_the_board_of, Position: “Secretary of the Board” or shareholder_of, Position: “Minority shareholder”)

FieldOptionalTypeDescription
valuestringThe position as text
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Risk Intelligence

An attribute for risk intelligence metadata

FieldOptionalTypeDescription
typeTagType of risk intelligence
authority      ✔stringGovernment authority issuing the enforcement or risk intelligence action
program      ✔stringSpecific to sanctions risk. Sanctions program under which the entity is designated.
list      ✔stringOfficial list where the entity’s risk information or enforcement action is recorded
reason      ✔stringExplanation or legal basis for the risk intelligence
score      ✔doubleA value indicating the assessed level of a certain risk tied to an entity. Meaning and scale depend on the specific scoring model used.
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Shares

Shares associated with an entity (e.g., number of shares issued by a company or number of shares held by a shareholder)

FieldOptionalTypeDescription
num_shares      ✔doubleThe number of shares held, issued, etc.
monetary_value      ✔doubleThe total monetary value of the shares
currency      ✔CurrencyThe currency of the monetary_value
percentage      ✔doubleThe percentage of shares owned
type      ✔stringA string describing the type of shares (e.g., “Class B”, “Protected cell shares”)
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Status

The status of an entity. This attribute is used to indicate details such as registration, operating, or liquidation status as well as an entity’s license or sole proprietorship status.

FieldOptionalTypeDescription
value      ✔Company StatusThe status, normalized to one of the status enums
text      ✔stringThe raw status text
context      ✔Status ContextThe type of status, such as license or partnership type
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Translated Name

This attribute is deprecated.

A name that has been translated to English

FieldOptionalTypeDescription
valuestringThe name, as text
original      ✔stringThe original name
context      ✔Translation ContextThe type of translation
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute

Weak Identifier

A non-unique ID number, like a partially redacted tax ID or a registry identifier, whose value and type may be shared by multiple entities

FieldOptionalTypeDescription
valuestringThe text value of the identifier
typeWeak Identifier TypeThe type of the identifier, including the country/jurisdiction that issued it
date      ✔stringas-of date of attribute
from_date      ✔stringstart date of attribute
to_date      ✔stringend date of attribute
extra      ✔Mapextra information of attribute