Natural entity to legal entity relations
Table of Contents
- 1 Introduction
- 2 Authentication
- 3 Environments
- 4 Endpoint
- 4.1 Request parameters
- 4.2 Request body
- 4.3 Test data
- 5 Swagger
Introduction
This Registries API endpoint returns legal entities related to a natural person based on shareholder or beneficial owner ties. Currently, only the Lithuanian registry (JADIS/JANGIS) data is available.
Authentication
An access token must be included in the request to access the API. You can obtain an access token by following the instructions provided here.
Environments
The API has two environments: Sandbox
and Production
. The base URLs and the available scopes for each environment are provided in the table below. Additionally, the Swagger URL for the API is also provided.
Environment | Swagger URL | Base URL | Scopes |
---|---|---|---|
Sandbox |
| registries_companydetails_writeonly | |
Production |
| registries_companydetails_writeonly |
Endpoint
POST /v1/legal/person-related-companies
Request parameters
Parameter type | Parameter | Data type | Required | Description |
---|---|---|---|---|
Header | Correlation-Id | string | No | A unique identifier assigned to the request. |
Header | Application-Id | string | No | Your application Id. Required if you have access to more than one application. |
Header | Access token | string | YES | Described in the Authentication part |
Query | useCache | boolean | No | Caching is described here. |
Request body
Field | Type | Description |
---|---|---|
| array | Returns the data based on the provided relation type.
|
| string | Country code of the legal entities that relation is being checked. |
| object | Details of a natural entity for which relations are being requested. |
| string | First name of a person. Required for foreign person. |
| string | Last name of a person. Required for foreign person. |
| string | National identification number of the person. Personal code (asmens kodas) in Lithuania. Required for domestic person. |
| string | Date of birth of a person in YYYY-MM-DD format. Required for foreign person. |
| string | Country code of a person in ISO 3166-1 alpha-2 format. |
Requirements listed below indicate which fields are mandatory based on the condition the natural entity is from the same country as the legal entity. If country = person.country
, then Domestic
, or else it's Foreign
.
Field | Domestic | Foreign |
---|---|---|
|
|
|
|
|
|
|
| |
|
|
|
|
|
Test data
In the Sandbox
environment, the following request body can be used to test the response body:
Domestic Natural Entity
{
"scopes": [
"All"
],
"countryCode": "LT",
"person": {
"personalCode": "100000001",
"countryCode": "LT"
}
}
Foreign Natural Entity
{
"scopes": [
"All"
],
"countryCode": "LT",
"person": {
"firstName": "Vardenis",
"lastName": "Pavardenis",
"personalCode": "100000002", // used only for mocked data reference
"dateOfBirth": "1970-12-17",
"countryCode": "EE"
}
}