Our data is delivered in two sets of files: entities and relationships. Within each file, a row describes one entity or relationship.
We provide schemas in JSON and text formats here to accommodate various development needs.
Note
Any entity or relationship may have multiple attributes of the same type; for example, an entity may have multiple addresses (physical, mailing, etc.). Accordingly, all attributes are included as arrays.
Entities
Like an entity profile in the Sayari suite of products, a row in an entity file describes a single entity, including its attributes, risk factors, and summary information.
Summary information includes properties that describe the entity, as outlined below:
| Field | Type | Description |
|---|---|---|
| entity_id | string | Unique identifier of the entity |
| type | string | The type of entity |
| label | string | The entity name, or defaults to attributes like identifier, weak identifier, or address if no name is available, e.g., a property identified by its address |
| label_en | string | The name of the entity in Latin script, selected as the most suitable from available sources. |
| num_documents | long | Number of documents that make reference to the entity |
| sanctioned | boolean | Whether or not the entity is sanctioned |
| pep | boolean | Whether or not the entity is considered a politically exposed person |
| degree | long | Number of outgoing relationships |
| closed | string | True if a relevant closed status has been parsed for this entity. Always false for data curation. |
| edge_counts | map | Counts of incoming, outgoing, and total edges |
| risk_factors | struct | Contains the risks associated with the entity |
| name | array of struct | Values of the name attribute |
| identifier | array of struct | Values of the identifier attribute |
| status | array of struct | Values of the status attribute |
| company_type | array of struct | Values of the company_type attribute |
| address | array of struct | Values of the address attribute |
| finances | array of struct | Values of the finances attribute |
| monetary_value | array of struct | Values of the monetary_value attribute |
| business_purpose | array of struct | Values of the business_purpose attribute |
| financials | array of struct | Values of the financials attribute |
| measurement | array of struct | Values of the measurement attribute |
| country | array of struct | Values of the country attribute |
| risk_intelligence | array of struct | Values of the risk_intelligence attribute |
| shares | array of struct | Values of the shares attribute |
| gender | array of struct | Values of the gender attribute |
| additional_information | array of struct | Values of the additional_information attribute |
| contact | array of struct | Values of the contact attribute |
| date_of_birth | array of struct | Values of the date_of_birth attribute |
| sources | array of string | An array of sources associated with the entity |
This schema information is also in available more detail in both JSON and Text format
Relationships
A row in a relationship file describes a single relationship, including its attributes and summary information. Relationships connect two entities (i.e., vertices), which are specified by their entity_idss.
| Field | Type | Description |
|---|---|---|
| src | string | The source / from of the relationship (specified as an entity_id) |
| dst | string | The destination / to of the relationship (specified as an entity_id) |
| type | string | The relationship type |
| date | string | The as-of date of a relationship (YYYY-MM-DD) |
| from_date | string | The start date of a relationship (YYYY-MM-DD) |
| to_date | string | The end date of a relationship (YYYY-MM-DD) |
| position | array of struct | Values of the position attribute |
| additional_information | array of struct | Values of the additional_information attribute |
| business_purpose | array of struct | Values of the business_purpose attribute |
| shares | array of struct | Values of the shares attribute |
| match_keys | array of struct | Specific keys used for matching operations, populated only when type equals possibly_same_as, indicating potential identity matches between entities. |
This schema information is also in available more detail in both JSON and Text format