Welcome to Qumundo API! We offer a wide selection of data feeds sourced by our own proprietary processes as well as from many partner companies.
This getting started guide presents:
an overview of the Qumundo API for developers and others, with examples of common use cases.
The available API-Endpoints can be found here:
Each endpoint detail page includes a listing of parameters that can be used to build requests, and an example value for each parameter.
The endpoints are grouped first according to the resource path (API URL) section, and then by the content of their responses.
The Qumundo API uses HTTPS verbs and a RESTful endpoint structure, which makes it easy to request data from our platform. Authentication is administered over HTTPS and the standard responses are delivered in JSON-format, according to the JSON API specification.
We provide a vast collection of free and open data collected from a variety of sources. You can use them without payment and in some cases with few restrictions. We also offer premium data that can only be accessed with a subscription. You can request access and subscribe to the individual premium data sets in your account section, when logged in.
How to get started? First, you'll need a free QUMUNDO account:
After you log in to our platform, go to your ‘Account’ section and request access to the solutions/APIs you are interested in. Once you have been granted access, you can access the desired API-Endpoints.
The BASE_URL
for the API is:
https://api.qumundo.com
From time to time we will release new versions of the API when we make backwards-incompatible changes like adding new response attributes, changing endpoints or altering query parameters. We will give advanced notice before releasing a new version or retiring an old version.
Versions are added to the base url, for example:
https://api.qumundo.com/v1/
Beta versions will include a -beta, for example:
https://api.qumundo.com/v1-beta/
The current version is v1
:
https://api.qumundo.com/v1/
Requests are HTTP REST calls, following the JSON API specification. General and detailed example requests can be found in the authentication and corresponding endpoint sections.
The Qumundo API returns data in JSON-formatted responses according to the JSON API specification.
JSON API responses represent resources in a REST-ful way, so they include URLs to related resources.
When a response contains more than a certain amount of results, the available data sets have pagination information and page links are available.
The HTTP response status code of 200
indicates that a request is well formed and valid. A status code of 401
indicates that API authorization is not authenticated, due to being invalid or a outdated API token was provided. The response message will give further indication to the reason for the error.
The standard responses are delivered in JSON-format. Numerous endpoints also support a format parameter to return data in a format other than the default JSON.
Supported data formats:
Format: | Content-Type: | Example: |
---|---|---|
json | application/json | ?format=json or by not passing the format parameter. |
Additional formats like csv, xml, psv or txt are also available upon request.
Qumundo API uses HTTP response codes to indicate the success or failure of an API request. A response code of 200
indicates success and codes in the 4xx
range indicate an error that failed given the information provided, and codes in the 5xx
range indicate an error:
Code: | Meaning: |
---|---|
200 | OK – Everything worked as expected. |
400 | Validation – Your provided values fail to match the required pattern. |
401 | Unauthorized – Your User/Password API Keys are incorrect. |
403 | Forbidden – You are not subscribed to the data feed requested. |
404 | Not Found – The endpoint requested does not exist. |
429 | Request Limit reached – The rate limit of the endpoint was reached. |
500 | Internal Server Error – We had a problem with our server. Try again later. |
503 | Service Unavailable – You have hit your limit or our platform may be experiencing high system load. |
You must include a valid API token with every request in-order to access the individual API endpoints and corresponding data sets.
Qumundo API authenticates your API requests using temporary API tokens. To use any Qumundo API, you must pass a valid and active API token with each request to our platform. If you do not include your API token when making an API request, or use one that is incorrect, disabled or outdated, Qumundo API returns an error. In general, the API token is valid for 60 minutes. Afterwards, you need to re-login. To get a temporary API token, you must first send your login credentials to the Qumundo API login
endpoint. When your log in is successful, you will receive a temporary API token as response:
HTTP Request (POST
):
/* Login Process - Example */
request.post({
headers: {
"Content-Type": "application/json"
},
url: BASE_URL+"/v1/login",
body: JSON.stringify({
email: 'YOUR_EMAIL',
password: 'YOUR_PASSWORD'
})
}, (error, response, body) => {
var getToken = JSON.parse(body).token;
console.log(getToken);
});
HTTP Response - Success (200
):
/* Example - API token */
{
"status": 200,
"success": true,
"token": api_token
}
Qumundo API uses header authentication. You must include your API token in the HTTPS request by specifying an authorization
header with the value:
Bearer {api_token}
HTTP Request (POST
):
/* Authentication Example - Get all LEI records */
var auth = 'Bearer '+getToken;
request.get({
headers: {
"authorization": auth
},
url: BASE_URL+"/v1/lei/search?"
}, (error, response, body) => {
var jsonBody = JSON.parse(body);
console.log(jsonBody)
});
HTTP Response - Success (200
):
/* Response Success Example - Get all LEI records */
{
"status": 200,
"error": null,
"record_count": 100,
"total_record_count": 1510264,
"page_number": 1,
"page_size": 100,
"total_pages": 15103,
"more_pages": true,
"records": [
{ ... }
]
}
HTTP Response - Error (401
):
/* Response Authentication Error Example */
{
"status": 401,
"success": false,
"message": {
"name": "Authentication Error",
"message": "Not authorized! Permission denied or invalid token!"
}
}
Account credentials and API tokens should be kept confidential at all times and only stored on your own server. Your account’s secret temporary API token can perform any API request you have been granted access to.
Protecting your API tokens:
Keep your account credentials and secret temporary API token safe. Your secret temporary API token can make any API call on behalf of your account, including changes that may impact billing. Do not store your account credentials and secret temporary API token in your version control system. Do not use your account credentials and secret temporary API token outside your web server, such as a browser, mobile app, or distributed file.
Monitor usage of your API for anomalies. If you observe unauthorized or abnormal usage, rotate your login credentials and temporary API token.
Do not embed login credentials and API tokens directly in code. Instead of directly embedding login credentials and API tokens in your application’s code, put them in environment variables or in include files that are stored separately from the bulk of your code—outside the source repository of your application. Then, if you share your code, the login credentials and temporary API tokens will not be included in the shared files.
Do not store API tokens in inside your application’s source control. If you store your login credentials and API tokens in files, keep the files outside your application’s source control system. This is particularly important if you use a public source code management system such as GitHub.
Limit access with restricted tokens. Qumundo API console will allow you to specify the IP addresses or referrer URLs associated with each token, reducing the impact of a compromised API tokens.
Use independent login credentials and API tokens for different apps. This limits the scope of each token. If a login credential or an API token is compromised, you can rotate the impacted account and token without impacting other applications and API tokens.
In many occasions too much information is returned in a single request. To limit the results to a reasonable size and to a certain number per request, we provide paging meta information which can be used to retrieve the remaining pages of data. Endpoints that use paging will return 100 records per request. To receive more records per request, you may specify a pageSize
(max. 250) parameter.
Search results in the API response can be paginated using the pageNum
and pageSize
parameters, for example:
/lei/search?pageNum=3&pageSize=200
Most endpoints support sophisticated filter options. If applied, a subset of the data will be returned. The filtering vary as per data set and by parameters, as well as by syntax operator available for the specific endpoints. Please refer to the individual endpoints for the specific filter options available.
In general, the following operators can be used together with parameters to filter and build more specific queries:
Syntax: | Operator: | Description: |
---|---|---|
MATCH | parameter==abc | Results must be "abc" of parameter. |
NOT_MATCH | parameter==!abc | Results must not be "abc" of parameter. |
MATCH_MULTIPLE | parameter==abc,def | Results must be any one of "abc", "def", etc. of parameter. Operators 'OR' and 'AND' available. |
NOT_MATCH_MULTIPLE | parameter==!abc,def | Results must not be any one of "abc", "def", etc. of parameter. Operators 'OR' and 'AND' available. |
GREATER_THAN | parameter=>123 | Results must be more than 123. Dates can be entered in the YYYY-MM-DD format. |
GREATER_THAN_OR_EQUAL | parameter=>=123 | Results must be at least 123. Dates can be entered in the YYYY-MM-DD format. |
LESS_THAN | parameter=<123 | Results must be less than 123. Dates can be entered in the YYYY-MM-DD format. |
LESS_THAN_OR_EQUAL | parameter=<=123 | Results must be at most 123. Dates can be entered in the YYYY-MM-DD format. |
LIKE | parameter=abc | Results contain “abc” of parameter. |
NOT_LIKE | parameter=!abc | Results do not contain “abc” of parameter. |
LIKE_MULTIPLE | parameter=abc,def | Results contain any one of "abc", "def", etc. of parameter. Operators 'OR' and 'AND' available. |
NOT_LIKE_MULTIPLE | parameter=!abc,def | Results do not contain any one of "abc", "def", etc. of parameter. Operators 'OR' and 'AND' available. |
Filtering Examples:
To search for an exact value use two equal ==
signs when filtering:
/* Results must be 'Daimler AG' of parameter 'legalName' */
/lei/search?legalName==Daimler AG
If the search results should contain a certain value, use a single equal =
sign in your query:
/* Results contain 'ETF' of parameter 'legalName' */
/lei/search?legalName=ETF
If the search result should not contain a certain value, use a single equal and an exclamation =!
sign:
/* Results do not contain 'Foundation' of parameter 'legalName' */
/lei/search?legalName=!Foundation
Use comma separation ,
when filtering for multiple values of a parameter:
/* Results contain 'BlackRock' OR 'ETF' of parameter 'legalName' */
/lei/search?legalName=BlackRock,ETF
To change the operator (default is 'OR') when searching for multiple values of a parameter, attach [and]
or [or]
to the values:
/* Results contain 'BlackRock' AND 'ETF' of parameter 'legalName' */
/lei/search?legalName=BlackRock,ETF[and]
Filtering of parameters can also be combined. Use the special character &
to combine them, for example:
/* Results contain 'BlackRock' of parameter 'legalName' AND 'ACTIVE' of parameter 'entityStatus' */
/lei/search?legalName=BlackRock&entityStatus==ACTIVE
To change the operator (default is 'AND') when searching for multiple parameters, attach parameter operator
with value and
or or
to your query:
/* Results contain 'BlackRock' of parameter 'legalName' OR 'ACTIVE' of parameter 'entityStatus' */
/lei/search?legalName=BlackRock&entityStatus==ACTIVE&operator=or
Please refer to the individual endpoints for the specific filter options available
Qumundo API applies reasonable request limits to ensure stability of our service to all users. These request limits can vary based on the API-endpoint you are accessing and in some instance depending on the subscription chosen. If you reach a request limit, the response will contain a 429
code and an explanation of the limit.
HTTP Response - Error (429
):
/* Response Request Limit Error Example */
{
"status": 429,
"success": false,
"message": {
"name": "Rate limit error",
"message": "Rate limit reached! We are sorry! Number of requests reached your limit! Please retry in 120 second(s).",
"retrySecs": 120
}
}
Available Request Limits:
Daily Request Limits
If you find any issues with our API or have any questions, please contact us:
If your account includes support, you’ll find additional support options when logged in to your account.
Access the global LEI-database with multi-tag filter options on appropriate parameters. The LEI (Legal Entity Identifier) is a unique 20 digit alphanumeric code based on ISO 17442 standard assigned to legal entities. Numerous regulatory requirements around the globe either require, request or recommend the usage of LEIs. Information includes LEIs, LEI-reference data (Who is who?), LEI-relationship data (Who owns whom?) and meta data like LEI-mappings (BIC-LEI, ISIN-LEI).
Access to the global LEI database (Level 1 – Who is who?) with multi-tag filter options on appropriate parameters. The Legal Entity Identifier (LEI) is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO). It connects to key reference information that enables clear and unique identification of legal entities participating in financial transactions.
If no filtering is supplied, this request will return all LEI Level 1 records.
Pagination parameter can be used to manage large number of data items.
HTTP Request (POST
):
/* Get all LEI records */
/lei/search?
/* Get all LEI records */
{
"status": 200,
"error": null,
"record_count": 100,
"total_record_count": 1510264,
"page_number": 1,
"page_size": 100,
"total_pages": 15103,
"more_pages": true,
"records": [
{
"id": 1,
"lei": "029200013A5N6ZD0F605",
"legal_name": "AFRINVEST SECURITIES LIMITED",
"category": "",
"sector": "",
"sub_sector": "",
"other_entity_name": "AFRINVEST SECURITIES LIMITED",
"legal_line1": "27 GERRARD ROAD",
"legal_line2": "IKOYI",
"legal_line3": "",
"legal_line4": "",
"legal_city": "LAGOS",
"legal_region": "NG-LA",
"legal_country": "NG",
"legal_postal": "23401",
"hq_line1": "27 GERRARD ROAD",
"hq_line2": "IKOYI",
"hq_line3": "",
"hq_line4": "",
"hq_city": "LAGOS",
"hq_region": "NG-LA",
"hq_country": "NG",
"hq_postal": "",
"register_authority_id": "RA000469",
"register_entity_id": "RC603315",
"legal_jurisdiction": "NG",
"entity_category": "",
"legal_form_code": "8888",
"legal_form": "LIMITED",
"associated_lei": "",
"associated_entity_name": "",
"entity_status": "ACTIVE",
"entity_expiration_date": null,
"entity_expiration_reason": "",
"successor_lei": "",
"successor_entity_name": "",
"initial_registration_date": "2014-11-05T23:00:00.000Z",
"last_updated_date": "2019-11-04T23:00:00.000Z",
"registration_status": "LAPSED",
"next_renewal_date": "2019-11-04T23:00:00.000Z",
"managing_lou": "029200067A7K6CH0H586",
"validation_sources": "FULLY_CORROBORATED",
"validation_authority_id": "RA000469",
"validation_entity_id": ""
},
{
"id": 2,
"lei": "029200137F2K8AH5C573",
"legal_name": "CAPITAL ASSETS LIMITED",
"category": "",
"sector": "",
"sub_sector": "",
"other_entity_name": "CAPITAL ASSETS LIMITED",
"legal_line1": "9TH FLOOR BOOKSHOP HOUSE, 50/52 BROAD STREET",
"legal_line2": "P.O. BOX 702 LAGOS",
"legal_line3": "",
"legal_line4": "",
"legal_city": "LAGOS",
"legal_region": "NG-LA",
"legal_country": "NG",
"legal_postal": "23401",
"hq_line1": "9TH FLOOR BOOKSHOP HOUSE, 50/52 BROAD STREET",
"hq_line2": "P.O. BOX 702 LAGOS",
"hq_line3": "",
"hq_line4": "",
"hq_city": "LAGOS",
"hq_region": "NG-LA",
"hq_country": "NG",
"hq_postal": "",
"register_authority_id": "RA000469",
"register_entity_id": "RC286096",
"legal_jurisdiction": "NG",
"entity_category": "",
"legal_form_code": "8888",
"legal_form": "LIMITED",
"associated_lei": "",
"associated_entity_name": "",
"entity_status": "ACTIVE",
"entity_expiration_date": null,
"entity_expiration_reason": "",
"successor_lei": "",
"successor_entity_name": "",
"initial_registration_date": "2014-11-05T23:00:00.000Z",
"last_updated_date": "2019-11-04T23:00:00.000Z",
"registration_status": "LAPSED",
"next_renewal_date": "2019-11-04T23:00:00.000Z",
"managing_lou": "029200067A7K6CH0H586",
"validation_sources": "FULLY_CORROBORATED",
"validation_authority_id": "RA000469",
"validation_entity_id": ""
},
{
"id": 3,
"lei": "029200038B4L4ZI1E579",
"legal_name": "CAPITAL BANCORP PLC",
"category": "",
"sector": "",
"sub_sector": "",
"other_entity_name": "CAPITAL BANCORP PLC",
"legal_line1": "3RD FLOOR, UNTL BUILDING, 1, DAVIES STREET",
"legal_line2": "OFF MARINA, LAGOS. P.O.BOX 1362, MARINA",
"legal_line3": "",
"legal_line4": "",
"legal_city": "LAGOS",
"legal_region": "NG-LA",
"legal_country": "NG",
"legal_postal": "23401",
"hq_line1": "3RD FLOOR, UNTL BUILDING, 1, DAVIES STREET",
"hq_line2": "OFF MARINA, LAGOS. P.O.BOX 1362, MARINA",
"hq_line3": "",
"hq_line4": "",
"hq_city": "LAGOS",
"hq_region": "NG-LA",
"hq_country": "NG",
"hq_postal": "",
"register_authority_id": "RA000469",
"register_entity_id": "RC114135",
"legal_jurisdiction": "NG",
"entity_category": "",
"legal_form_code": "8888",
"legal_form": "LIMITED",
"associated_lei": "",
"associated_entity_name": "",
"entity_status": "ACTIVE",
"entity_expiration_date": null,
"entity_expiration_reason": "",
"successor_lei": "",
"successor_entity_name": "",
"initial_registration_date": "2014-11-05T23:00:00.000Z",
"last_updated_date": "2019-11-04T23:00:00.000Z",
"registration_status": "LAPSED",
"next_renewal_date": "2019-11-04T23:00:00.000Z",
"managing_lou": "029200067A7K6CH0H586",
"validation_sources": "FULLY_CORROBORATED",
"validation_authority_id": "RA000469",
"validation_entity_id": ""
},
...
]
}
Filter Parameters:
Parameter: | Type: | Field: | Description: |
---|---|---|---|
lei | String | lei | The ISO 17442 compatible identifier for the legal entity. |
legalName | String | legal_name | The legal name of the entity. |
entityStatus | String | entity_status | The operational and/or legal registration status of the entity. |
registrationStatus | String | registration_status | The status of the legal entity's LEI registration with the ManagingLOU. |
entityCategory | String | entity_category | Indicates (where applicable) the category of the entity identified by this LEI data record. |
legalCountry | String | legal_country | The country of the entity as recorded in the registration of the entity in its legal jurisdiction. |
legalCity | String | legal_city | The city of the entity as recorded in the registration of the entity in its legal jurisdiction. |
minInitial | date | initial_registration_date | Date/time the LEI record was created. |
maxInitial | date | initial_registration_date | Date/time the LEI record was created. |
minUpdated | date | last_update_date | Date/time the LEI record was most recently updated. |
maxUpdated | date | last_update_date | Date/time the LEI record was most recently updated. |
minRenewal | date | next_renewal_date | The next date by which the LEI registration should be renewed and re-certified by the legal entity. |
maxRenewal | date | next_renewal_date | The next date by which the LEI registration should be renewed and re-certified by the legal entity. |
legalForm | String | legal_form | The legal form of the entity, taken from the ISO Entity Legal Form (ELF) code list maintained by GLEIF. |
legalFormCode | String | legal_form_code | LegalFormEnum code maintained by ISO / GLEIF through the Entity Legal Form (ELF). |
lou | String | managing_lou | The LEI of the LOU that is responsible for administering this LEI registration. |
POST
Legal Entity Identifier (LEI):
Access to the global LEI database and filter by parameter lei
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "529900R27DL06UVNT076" */
/lei/search?lei==529900R27DL06UVNT076
/* MATCH_MULTIPLE - Results must be any one of "529900R27DL06UVNT076" OR "222100OTCOTYF8MB7L34" OR "5299004R6K796KLQIQ70" */
/lei/search?lei==529900R27DL06UVNT076,222100OTCOTYF8MB7L34,5299004R6K796KLQIQ70
POST
Legal Name:
Access to the global LEI database and filter by parameter legalName
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* LIKE - Results contain "BlackRock" */
/lei/search?legalName=BlackRock
/* LIKE_MULTIPLE - Results contain any one of "BlackRock" OR "Amundi" */
/lei/search?legalName=BlackRock,Amundi
/* LIKE_MULTIPLE (AND) - Results contain any one of "BlackRock" AND "ETF" AND "UCITS" */
/lei/search?legalName=BlackRock,ETF,UCITS[and]
POST
Entity Status:
Access to the global LEI database and filter by parameter entityStatus
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ACTIVE
INACTIVE
ANNULLED
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "ACTIVE" */
/lei/search?entityStatus==ACTIVE
/* MATCH & LIKE - Results must be "ACTIVE" AND contain "ETF" */
/lei/search?entityStatus==ACTIVE&legalName=ETF
POST
Registration Status:
Access to the global LEI database and filter by parameter registrationStatus
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ISSUED
LAPSED
DUPLICATE
RETIRED
MERGED
ANNULLED
CANCELLED
TRANSFERRED
PENDING_TRANSFER
PENDING_ARCHIVAL
PENDING_VALIDATION
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "DUPLICATE" */
/lei/search?registrationStatus==DUPLICATE
/* MATCH & LIKE - Results must be "LAPSED" AND contain "Amundi". */
/lei/search?registrationStatus==LAPSED&legalName=Amundi
POST
Entity Category:
Access to the global LEI database and filter by parameter entityCategory
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Attributes:
BRANCH
FUND
SOLE_PROPRIETOR
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "FUND" */
/lei/search?entityCategory==FUND
POST
Legal Country:
Access to the global LEI database and filter by parameter legalCountry
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ISO 3166-1 alpha-2: Learn More (Wikipedia).
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "DE" (Germany) */
/lei/search?legalCountry==DE
/* MATCH_MULTIPLE - Results must be any one of "GB" OR "US" OR "FR" or "DE" */
/lei/search?legalCountry==GB,US,FR,DE
POST
Legal City:
Access to the global LEI database and filter by parameter legalCity
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* LIKE - Results contain "London" */
/lei/search?legalCity=London
/* LIKE_MULTIPLE - Results contain any one of "London" OR "Paris" OR "Rio" OR "Berlin" */
/lei/search?legalCity=London,Paris,Rio,Berlin
POST
Initial Start Date:
Access to the global LEI database and filter by parameter minInitial
and/or maxInitial
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* GREATER_THAN_OR_EQUAL - Results must be at least "2019-01-01" */
/lei/search?minInitial=>=2019-01-01
/* GREATER_THAN_OR_EQUAL AND LESS_THAN_OR_EQUAL - Results must be at least "2019-01-01" AND at most "2019-03-31" */
/lei/search?minInitial=>=2019-01-01&maxInitial=<=2019-03-31
POST
Updated Date:
Access to the global LEI database and filter by parameter minUpdated
and/or maxUpdated
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* GREATER_THAN_OR_EQUAL - Results must be at least "2019-01-01" */
/lei/search?minUpdated=>=2019-01-01
/* GREATER_THAN_OR_EQUAL AND LESS_THAN_OR_EQUAL - Results must be at least "2019-01-01" AND at most "2019-03-31" */
/lei/search?minUpdated=>=2019-01-01&maxUpdated=<=2019-03-31
POST
Renewal Date:
Access to the global LEI database and filter by parameter minRenewal
and/or maxRenewal
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* GREATER_THAN_OR_EQUAL - Results must be at least "2019-01-01" */
/lei/search?minRenewal=>=2019-01-01
/* GREATER_THAN_OR_EQUAL AND LESS_THAN_OR_EQUAL - Results must be at least "2019-01-01" AND at most "2019-03-31" */
/lei/search?minRenewal=>=2019-01-01&maxRenewal=<=2019-03-31
POST
Legal Form:
Access to the global LEI database and filter by parameter legalForm
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results contain "Limited" */
/lei/search?legalForm=Limited
POST
Legal Form Code:
Access to the global LEI database and filter by parameter legalFormCode
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "6QQB" */
/lei/search?legalFormCode==6QQB
POST
Local Operating Unit (LOU):
Access to the global LEI database and filter by parameter lou
:
This request will return a single or multiple LEI records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "5299000J2N45DDNE4Y28" */
/lei/search?lou==5299000J2N45DDNE4Y28
Access to LEI Level 2 (Who owns whom?) relationship data of the global LEI database. If the direct and/or ultimate parents of an LEI registrant have obtained an LEI, the LEI of the parent(s) is published together with the LEI record of the child entity. LEI Level 2 provides the direct and/or ultimate relationship between the legal entities including additional relashionship meta information.
If no filtering parameters are supplied, this request will return all LEI relationshiop records.
Pagination parameter can be used to manage large number of data items.
HTTP Request (POST
):
/* Get all LEI relationship records */
/lei/rr/search?
HTTP Response - Success (200
):
/* Get all LEI relationship records */
{
"status": 200,
"error": null,
"record_count": 100,
"total_record_count": 211086,
"page_number": 1,
"page_size": 100,
"total_pages": 2111,
"more_pages": true,
"records": [
{
"id": 1,
"start_node_id": "029200396H3K1YG7D555",
"start_node_id_type": "LEI",
"end_node_id": "549300NIVXF92ZIOVW61",
"end_node_id_type": "LEI",
"relationship_type": "IS_DIRECTLY_CONSOLIDATED_BY",
"accounting_start_date": "2016-12-31T23:00:00.000Z",
"accounting_end_date": "2017-12-30T23:00:00.000Z",
"accounting_period_type": "ACCOUNTING_PERIOD",
"relationship_start_date": "2000-03-05T23:00:00.000Z",
"relationship_end_date": null,
"relationship_period_type": "RELATIONSHIP_PERIOD",
"document_filling_start": null,
"document_filling_end": null,
"document_filling_period_type": "",
"relationship_status": "ACTIVE",
"qualifier_dimension": "ACCOUNTING_STANDARD",
"qualifier_category": "IFRS",
"measurement_method": "ACCOUNTING_CONSOLIDATION",
"quantifier_amount": "99.9",
"quantifier_units": "PERCENTAGE",
"initial_registration_date": "2014-11-05T23:00:00.000Z",
"last_updated_date": "2019-11-20T23:00:00.000Z",
"registration_status": "PUBLISHED",
"next_renewal_date": "2020-11-04T23:00:00.000Z",
"managing_lou": "029200067A7K6CH0H586",
"validation_sources": "FULLY_CORROBORATED",
"validation_documents": "SUPPORTING_DOCUMENTS",
"validation_reference": "www.stanbicibtc.com"
},
{
"id": 2,
"start_node_id": "029200396H3K1YG7D555",
"start_node_id_type": "LEI",
"end_node_id": "029200388A7S7Z5I0H57",
"end_node_id_type": "LEI",
"relationship_type": "IS_ULTIMATELY_CONSOLIDATED_BY",
"accounting_start_date": "2016-12-31T23:00:00.000Z",
"accounting_end_date": "2017-12-30T23:00:00.000Z",
"accounting_period_type": "ACCOUNTING_PERIOD",
"relationship_start_date": "2007-08-31T22:00:00.000Z",
"relationship_end_date": null,
"relationship_period_type": "RELATIONSHIP_PERIOD",
"document_filling_start": null,
"document_filling_end": null,
"document_filling_period_type": "",
"relationship_status": "ACTIVE",
"qualifier_dimension": "ACCOUNTING_STANDARD",
"qualifier_category": "IFRS",
"measurement_method": "ACCOUNTING_CONSOLIDATION",
"quantifier_amount": "99",
"quantifier_units": "PERCENTAGE",
"initial_registration_date": "2014-11-05T23:00:00.000Z",
"last_updated_date": "2019-11-20T23:00:00.000Z",
"registration_status": "PUBLISHED",
"next_renewal_date": "2020-11-04T23:00:00.000Z",
"managing_lou": "029200067A7K6CH0H586",
"validation_sources": "FULLY_CORROBORATED",
"validation_documents": "SUPPORTING_DOCUMENTS",
"validation_reference": "www.stanbicibtc.com"
},
{
"id": 3,
"start_node_id": "0292001381F1R1IB5B85",
"start_node_id_type": "LEI",
"end_node_id": "029200388A7S7Z5I0H57",
"end_node_id_type": "LEI",
"relationship_type": "IS_DIRECTLY_CONSOLIDATED_BY",
"accounting_start_date": "2016-12-31T23:00:00.000Z",
"accounting_end_date": "2017-12-30T23:00:00.000Z",
"accounting_period_type": "ACCOUNTING_PERIOD",
"relationship_start_date": "2006-01-24T23:00:00.000Z",
"relationship_end_date": null,
"relationship_period_type": "RELATIONSHIP_PERIOD",
"document_filling_start": null,
"document_filling_end": null,
"document_filling_period_type": "",
"relationship_status": "ACTIVE",
"qualifier_dimension": "ACCOUNTING_STANDARD",
"qualifier_category": "IFRS",
"measurement_method": "ACCOUNTING_CONSOLIDATION",
"quantifier_amount": "99.99",
"quantifier_units": "PERCENTAGE",
"initial_registration_date": "2016-07-13T22:00:00.000Z",
"last_updated_date": "2019-08-06T22:00:00.000Z",
"registration_status": "PUBLISHED",
"next_renewal_date": "2020-07-12T22:00:00.000Z",
"managing_lou": "029200067A7K6CH0H586",
"validation_sources": "FULLY_CORROBORATED",
"validation_documents": "SUPPORTING_DOCUMENTS",
"validation_reference": "www.stanbicibtc.com"
},
...
]
}
Filter Parameters:
Parameter: | Type: | Field: | Description: |
---|---|---|---|
startNode | String | start_node_id | An LEI or ISO 17442-compatible ID for the entity at the "start" of a directional relationship. |
startNodeType | String | start_node_id_type | The type of identifier used to designate this node's entity. |
endNode | String | end_node_id | An LEI or ISO 17442-compatible ID for the entity at the "end" of a directional relationship. |
endNodeType | String | end_node_id_type | The type of identifier used to designate this node's entity. |
relationshipType | String | relationship_type | A unique code designating the specific category of a directional relationship between two legal entities. |
minAccountingStart | date | accounting_start_date | Start date indicating the accounting period covered by the most recent validation documents for this relationship. |
maxAccountingStart | date | accounting_start_date | Start date indicating the accounting period covered by the most recent validation documents for this relationship. |
minAccountingEnd | date | accounting_end_date | End date indicating the accounting period covered by the most recent validation documents for this relationship. |
maxAccountingEnd | date | accounting_end_date | End date indicating the accounting period covered by the most recent validation documents for this relationship. |
accountingPeriodType | String | ccounting_period_type | Is accounting period. |
minRelationshipStart | date | relationship_start_date | The start date for a particular period relevant to the relationship. |
maxRelationshipStart | date | relationship_start_date | The start date for a particular period relevant to the relationship. |
minRelationshipEnd | date | relationship_end_date | The end date for a particular period relevant to the relationship. |
maxRelationshipEnd | date | relationship_end_date | The end date for a particular period relevant to the relationship. |
relationshipPeriodType | String | relationship_period_type | Is relationship period. |
minDocumentStart | date | document_filling_start | Start date indicating the validity period of a regulatory filing, accounting document, or other document demonstrating the relationship's validity. |
maxDocumentStart | date | document_filling_start | Start date indicating the validity period of a regulatory filing, accounting document, or other document demonstrating the relationship's validity. |
minDocumentEnd | date | document_filling_end | End date indicating the validity period of a regulatory filing, accounting document, or other document demonstrating the relationship's validity. |
maxDocumentEnd | date | document_filling_end | End date indicating the validity period of a regulatory filing, accounting document, or other document demonstrating the relationship's validity. |
documentPeriodType | String | document_filling_period_type | Is document period. |
relationshipStatus | String | relationship_status | The status of the legal entities' relationship itself: ACTIVE or INACTIVE |
qualifierDimension | String | qualifier_dimension | The accounting standard applied to determine the definition of e.g. ultimate or direct accounting consolidating parent for the relationship. |
qualifierCategory | String | qualifier_category | Specifies the additional qualitative attributes that help to categorize the relationship. |
measurementMethod | String | measurement_method | Specifies the method of measurement (or set of rules) used to quantitatively categorize the relationship. |
minQuantifierAmount | String | quantifier_amount | Quantity measured as a decimal (positive or negative) number, using a . as the decimal point, with no spaces, and without thousand delimiters. |
maxQuantifierAmount | String | quantifier_amount | Quantity measured as a decimal (positive or negative) number, using a . as the decimal point, with no spaces, and without thousand delimiters. |
quantifierUnits | String | quantifier_units | Specifies the units, where applicable, of a measurement made on a relationship. |
minInitialRegistration | date | initial_registration_date | The date at which the relationship information was first collected by the ManagingLOU. |
maxInitialRegistration | date | initial_registration_date | The date at which the relationship information was first collected by the ManagingLOU. |
minLastUpdate | date | last_updated_date | The date at which the information was most recently updated by the ManagingLOU. |
maxLastUpdate | date | last_updated_date | The date at which the information was most recently updated by the ManagingLOU. |
registrationStatus | String | registration_status | The status of the legal entity's relationship record registration with the ManagingLOU. |
minNextRenewal | date | next_renewal_date | The next date by which the relationship information must be renewed and re-certified by the legal entity. |
maxNextRenewal | date | next_renewal_date | The next date by which the relationship information must be renewed and re-certified by the legal entity. |
managingLou | String | managing_lou | The LEI of the LOU that is responsible for administering this relationship record. |
validationSources | String | validation_sources | Level of relationship validation. |
validationDocuments | String | validation_documents | Type of source document(s) used for validating the relationship. |
validationReference | String | validation_reference | A reference to a specfic document or other source used as the basis of relationship validation for this relationship record. |
POST
Start Node:
Access to LEI relationship information and filter by parameter startNode
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "529900M7J7I20TXW8M17" */
/lei/rr/search?startNode==529900M7J7I20TXW8M17
POST
Start Node Type:
Access to LEI relationship information and filter by parameter startNodeType
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
LEI
ISO_17442_COMPATIBLE
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "LEI" */
/lei/rr/search?startNodeType==LEI
POST
End Node:
Access to LEI relationship information and filter by parameter endNode
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "529900R27DL06UVNT076" */
/lei/rr/search?endNode==529900R27DL06UVNT076
POST
End Node Type:
Access to LEI relationship information and filter by parameter endNodeType
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
LEI
ISO_17442_COMPATIBLE
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "LEI" */
/lei/rr/search?endNodeType==LEI
POST
Relationship Type:
Access to LEI relationship information and filter by parameter relationshipType
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
IS_DIRECTLY_CONSOLIDATED_BY
IS_ULTIMATELY_CONSOLIDATED_BY
IS_INTERNATIONAL_BRANCH_OF
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "IS_DIRECTLY_CONSOLIDATED_BY" */
/lei/rr/search?relationshipType==IS_DIRECTLY_CONSOLIDATED_BY
POST
Accounting Start:
Access to LEI relationship information and filter by parameter minAccountingStart
and/or maxAccountingStart
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* MATCH - Results must be at least "2019-01-01" */
/lei/rr/search?minAccountingStart=>=2019-01-01
POST
Accounting End:
Access to LEI relationship information and filter by parameter minAccountingEnd
and/or maxAccountingEnd
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* MATCH - Results must be at least "2019-01-01" */
/lei/rr/search?minAccountingEnd=>=2019-01-01
POST
Accounting Period Type:
Access to LEI relationship information and filter by parameter accountingPeriodType
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ACCOUNTING_PERIOD
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "ACCOUNTING_PERIOD" */
/lei/rr/search?accountingPeriodType==ACCOUNTING_PERIOD
POST
Relationship Start:
Access to LEI relationship information and filter by parameter minRelationshipStart
and/or maxRelationshipStart
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* MATCH - Results must be at least "2019-01-01" */
/lei/rr/search?minRelationshipStart=>=2019-01-01
POST
Relationship End:
Access to LEI relationship information and filter by parameter minRelationshipEnd
and/or maxRelationshipEnd
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* MATCH - Results must be at least "2019-01-01" */
/lei/rr/search?minRelationshipEnd=>=2019-01-01
POST
Relationship Period Type:
Access to LEI relationship information and filter by parameter relationshipPeriodType
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
RELATIONSHIP_PERIOD
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "RELATIONSHIP_PERIOD" */
/lei/rr/search?relationshipPeriodType==RELATIONSHIP_PERIOD
POST
Document Start:
Access to LEI relationship information and filter by parameter minDocumentStart
and/or maxDocumentStart
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* MATCH - Results must be at least "2019-01-01" */
/lei/rr/search?minDocumentStart=>=2019-01-01
POST
Document End:
Access to LEI relationship information and filter by parameter minDocumentEnd
and/or maxDocumentEnd
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* MATCH - Results must be at least "2019-01-01" */
/lei/rr/search?minDocumentEnd=>=2019-01-01
POST
Document Period Type:
Access to LEI relationship information and filter by parameter documentPeriodType
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
DOCUMENT_FILING_PERIOD
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "DOCUMENT_FILING_PERIOD" */
/lei/rr/search?documentPeriodType==DOCUMENT_FILING_PERIOD
POST
Relationship Status:
Access to LEI relationship information and filter by parameter relationshipStatus
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ACTIVE
INACTIVE
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "ACTIVE" */
/lei/rr/search?relationshipStatus==ACTIVE
POST
Qualifier Dimension:
Access to LEI relationship information and filter by parameter qualifierDimension
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ACCOUNTING_STANDARD
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "ACCOUNTING_STANDARD" */
/lei/rr/search?qualifierDimension==ACCOUNTING_STANDARD
POST
Qualifier Category:
Access to LEI relationship information and filter by parameter qualifierCategory
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
US_GAAP
IFRS
OTHER_ACCOUNTING_STANDARD
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "IFRS" */
/lei/rr/search?qualifierCategory==IFRS
POST
Measurement Method:
Access to LEI relationship information and filter by parameter measurementMethod
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ACCOUNTING_CONSOLIDATION
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "ACCOUNTING_CONSOLIDATION" */
/lei/rr/search?measurementMethod==ACCOUNTING_CONSOLIDATION
POST
Quantifier Amount:
Access to LEI relationship information and filter by parameter minQuantifierAmount
and/or maxQuantifierAmount
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* GREATER_THAN - Results must be greater than "95" */
/lei/rr/search?minQuantifierAmount=>95
POST
Quantifier Units:
Access to LEI relationship information and filter by parameter quantifierUnits
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
PERCENTAGE
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "PERCENTAGE" */
/lei/rr/search?quantifierUnits==PERCENTAGE
POST
Initial Registration:
Access to LEI relationship information and filter by parameter minInitialRegistration
and/or maxInitialRegistration
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* GREATER_THAN_OR_EQUAL - Results must be at least "2015-12-01" */
/lei/rr/search?minInitialRegistration=>=2015-12-01
POST
Last Update:
Access to LEI relationship information and filter by parameter minLastUpdate
and/or maxLastUpdate
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* GREATER_THAN - Results must be greater than "2019-12-01" */
/lei/rr/search?minLastUpdate=>2019-12-01
POST
Registration Status:
Access to LEI relationship information and filter by parameter registrationStatus
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
PUBLISHED
LAPSED
DUPLICATE
RETIRED
ANNULLED
TRANSFERRED
PENDING_TRANSFER
PENDING_ARCHIVAL
PENDING_VALIDATION
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "ISSUED" */
/lei/rr/search?registrationStatus==ISSUED
POST
Next Renewal:
Access to LEI relationship information and filter by parameter minNextRenewal
and/or maxNextRenewal
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
YYYY-MM-DD
Syntax Operator:
MATCH
LIKE
GREATER_THAN
GREATER_THAN_OR_EQUAL
LESS_THAN
LESS_THAN_OR_EQUAL
Example:
/* LESS_THAN_OR_EQUAL - Results must be "2019-12-01" */
/lei/rr/search?minNextRenewal=<=2019-12-01
POST
Managing Lou:
Access to LEI relationship information and filter by parameter managingLou
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "029200067A7K6CH0H58" */
/lei/rr/search?managingLou==029200067A7K6CH0H58
POST
Validation Sources:
Access to LEI relationship information and filter by parameter validationSources
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ENTITY_SUPPLIED_ONLY
PARTIALLY_CORROBORATED
FULLY_CORROBORATED
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "FULLY_CORROBORATED" */
/lei/rr/search?validationSources==FULLY_CORROBORATED
POST
Validation Documents:
Access to LEI relationship information and filter by parameter validationDocuments
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Attributes:
ACCOUNTS_FILING
REGULATORY_FILING
SUPPORTING_DOCUMENTS
CONTRACTS
OTHER_OFFICIAL_DOCUMENTS
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "SUPPORTING_DOCUMENTS" */
/lei/rr/search?validationDocuments==SUPPORTING_DOCUMENTS
POST
Validation Reference:
Access to LEI relationship information and filter by parameter validationReference
:
This request will return a single or multiple LEI relationship records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* LIKE - Results must contain "com" */
/lei/rr/search?validationReference=com
The ISIN (ISO 6166) is the recognized global standard for unique identification of financial instruments, e.g. securities. The LEI-ISIN mapping records connect key reference information that enables clear and unique identification of legal entities participating in financial transactions, e.g. the issuers of securities. Linking the issuer and issuance of securities enables firms to aggregate data which clearly shows their securities exposure in relation to an individual issuer and its related entities.
If no filtering parameters are supplied, this request will return all LEI-ISIN mapping records.
Pagination parameter can be used to manage large number of data items.
HTTP Request (POST
):
/* Get all LEI-ISIN mapping records */
/lei/isin/search?
HTTP Response - Success (200
):
/* Get all LEI-ISIN mapping records */
{
"status": 200,
"error": null,
"record_count": 100,
"total_record_count": 3407533,
"page_number": 1,
"page_size": 100,
"total_pages": 34076,
"more_pages": true,
"records": [
{
"id": 1,
"lei": "851WYGNLUQLFZBSYGB56",
"isin": "DE000CJ8D690"
},
{
"id": 2,
"lei": "XZYUUT6IYN31D9K77X08",
"isin": "DE000JP6WK40"
},
{
"id": 3,
"lei": "529900HNOAA1KXQJUQ27",
"isin": "DE000DD1UX25"
},
...
]
}
Filter Parameters:
Parameter: | Type: | Field: | Description: |
---|---|---|---|
lei | String | lei | The LEI (ISO 17442) is a compatible identifier for the legal entity. |
isin | String | isin | The ISIN (ISO 6166) is the recognized global standard for unique identification of financial instruments. |
POST
LEI:
Access LEI-ISIN mappings and filter by parameter lei
:
This request will return a single or multiple LEI-ISIN mapping records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "529900R27DL06UVNT076" */
/lei/isin/search?lei==529900R27DL06UVNT076
/* MATCH_MULTIPLE - Results must be "529900R27DL06UVNT076" OR "7LTWFZYICNSX8D621K86" OR "529900NNUPAGGOMPXZ31" */
/lei/isin/search?lei==529900R27DL06UVNT076,7LTWFZYICNSX8D621K86,529900NNUPAGGOMPXZ31
POST
ISIN:
Access to LEI-ISIN mapping records and filter by parameter isin
:
This request will return a single or multiple LEI-ISIN mapping records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "DE000A1TNJ97" */
/lei/isin/search?isin==DE000A1TNJ97
/* MATCH_MULTIPLE - Results must be "DE000A1TNJ97" OR "DE0007664039" OR "DE000DL8PXJ5" */
/lei/isin/search?isin==DE000A1TNJ97,DE0007664039,DE000DL8PXJ5
The BIC (ISO 9362) is an international standard developed by the International Organization for Standardization (ISO) for the identification of institutions within the financial services industry. The LEI-BIC mapping records will ease the process of gathering, aggregating and reconciling counterparty information based on interoperability across parallel platforms, supporting know your customer (KYC) and know your supplier (KYS) due dilligence processes.
If no filtering parameters are supplied, this request will return all LEI-BIC mapping records.
Pagination parameter can be used to manage large number of data items.
HTTP Request (POST
):
/* Get all LEI-BIC mapping records */
/lei/bic/search?
HTTP Response - Success (200
):
/* Get all LEI-BIC mapping records */
{
"status": 200,
"error": null,
"record_count": 100,
"total_record_count": 21199,
"page_number": 1,
"page_size": 100,
"total_pages": 212,
"more_pages": true,
"records": [
{
"id": 1,
"bic": "AAAJBG21XXX",
"lei": "213800PBMQ7ZZ7VG4J23"
},
{
"id": 2,
"bic": "AAALSARIXXX",
"lei": "21380017F62N8MDBAH89"
},
{
"id": 3,
"bic": "AAALSARIXXX",
"lei": "558600TQS0WENZUC5190"
},
...
]
}
Filter Parameters:
Parameter: | Type: | Field: | Description: |
---|---|---|---|
lei | String | lei | The LEI (ISO 17442) is a compatible identifier for the legal entity. |
bic | String | bic | The BIC (ISO 9362) is an international standard for the identification of institutions within the financial services industry. |
POST
LEI:
Access to LEI-BIC mapping records and filter by parameter lei
:
This request will return a single or multiple LEI-BIC mapping records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* MATCH - Results must be "529900R27DL06UVNT076" */
/lei/bic/search?lei==529900R27DL06UVNT076
/* MATCH_MULTIPLE - Results must be "529900R27DL06UVNT076" OR "5493003OZ08PS8IJMR09" */
/lei/bic/search?lei==529900R27DL06UVNT076,5493003OZ08PS8IJMR09
POST
BIC:
Access LEI-BIC mapping records and filter by parameter bic
:
This request will return a single or multiple LEI-BIC mapping records.
Pagination parameter can be used to manage large number of data items.
Syntax Operator:
MATCH
NOT_MATCH
MATCH_MULTIPLE
NOT_MATCH_MULTIPLE
LIKE
NOT_LIKE
LIKE_MULTIPLE
NOT_LIKE_MULTIPLE
Example:
/* LIKE - Results must contain "DCAGDE6S" */
/lei/bic/search?bic=DCAGDE6S
Useful / Quick Links
Legal Information