Legal entities data
Table of Contents
- 1 Getting started
- 1.1 Authorization
- 1.2 Environments
- 1.3 Endpoint
- 1.4 Request limit
- 2 Calling endpoint
- 2.1 Headers
- 2.2 Request body
- 2.2.1 Example
- 2.3 Response data
- 2.3.1 Example
- 3 Data Caching
- 4 Monitoring Beneficial Owners (Pre-development version)
- 4.1 Endpoint
- 4.2 Headers
- 4.3 Response
- 4.4 Code Examples
- 4.4.1 Example response
Getting started
This APIâs main goal is to provide detailed information about the company. API provides various information about the company such as:
Company name
Type
Address
Contacts
Representatives
Shareholders
Beneficial owners
To access this API, you need to provide the following:
OAuth2 Access Tokens in each request.
Please refer to the Authorization section to understand how to obtain the token.
Your Application-Id
If you donât have an Application-id, please contact support@ondato.com.
Authorization
Production: https://id.ondato.com/connect/token
Request to the authorization server must contain the following information:
Key | Value | Description |
---|---|---|
| <client_id> | Your ID that will be provided by Ondato. |
| <secret> | Your secret that will be provided by Ondato. |
| client_credentials | Machine-to-machine grant flow. |
| <reuqested_scopes_separated_by_space> | Access to requested resources. Will be provided by Ondato. |
Discovery endpoint: https://id.ondato.com/.well-known/openid-configuration
Authorization request example (production)
For in-depth reference see specification about authorization request and response.
curl --location --request POST 'https://id.ondato.com/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={your client_id}' \
--data-urlencode 'client_secret=secret_that_only_you_know' \
--data-urlencode 'scope=registries_api'
Environments
Environment | Swagger URL | Base URL |
---|---|---|
Sandbox  |
| |
Prod |
|
Endpoint
This API consists of the following endpoint:
post /v1/legal/company-details
- get detailed company information.
Request limit
Calling endpoint
Headers
Parameter | Type | Required | Description | |
---|---|---|---|---|
1 | Correlation-Id | string | no | A unique identifier assigned to the request. |
2 | Application-Id | string | yes | Your application Id. Please contact support@ondato.com if you donât have one. |
3 | Access token | string | yes | Described in the Authentication part |
4 | useCache | string | no | Request cached data of the company. Possible values:
Caching logic explained in the section Data Caching. |
Request body
Name | Description | Mandatory/Optional | |
---|---|---|---|
1 | country | ISO2 country code where the company is originated. Accepted values:
| MANDATORY |
2 | companyCode | Company code of the searched company. | MANDATORY |
3 | useCache | Request chached data of the company. Possible values:
Caching logic is detailed in the Data Caching section. | Optional |
4 | scopes | For Lithuanian companies data scope can be defined to return data only for selected objects. Data objects that were not selected will return Possible values (multiple values can be selected):
This parameter will have no effect on the response when requesting data for companies other than those in Lithuania. | Optional |
Example
Response data
Field | Description | Source of data | |
---|---|---|---|
1 | id | Unique Id of the response. | Â |
2 | generalInformation | Block with general information about the company. | JAR |
3 | generalInformation.code | Company code. | |
4 | generalInformation.name | Company name. | |
5 | generalInformation.registeredDate | Date when company was registered. | |
6 | generalInformation.type | Company type. | |
7 | generalInformation.status | Company status. | |
8 | generalInformation.address | Block with information about company address. | |
9 | generalInformation.address.fullAddress | Full address of the company. | |
10 | generalInformation.address.country | Country of the company's address. | |
11 | generalInformation.address.flatNumber | Flat number of the company's address. | |
12 | generalInformation.address.houseNumber | House number of the company's address. | |
13 | generalInformation.address.city | City of the company's address. | |
14 | generalInformation.address.street | Street of the company's address. | |
15 | generalInformation.address.postCode | Post code of the company's address. | |
16 | generalInformation.industry | Name of the industry company is part of. | |
17 | generalInformation.contacts | Block of company's contacts. | |
18 | generalInformation.contacts.type | Type of the contact. Example: Email. | |
19 | generalInformation.contacts.value | The contact. | |
20 | beneficialOwners | Block with information about company's beneficial owners. | JANGIS |
21 | beneficialOwners.actualBeneficialOwners | Block with actual beneficial owners. | |
22 | beneficialOwners.actualBeneficialOwners.subjectCode | Code of the beneficial owner.
| |
23 | beneficialOwners.actualBeneficialOwners.companyName | Name of the company. | |
24 | beneficialOwners.actualBeneficialOwners.fullName | Full name of the beneficial owner. | |
25 | beneficialOwners.actualBeneficialOwners.firstName | First name of the beneficial owner. | |
26 | beneficialOwners.actualBeneficialOwners.lastName | Last name of the beneficial owner. | |
27 |
| ||
28 |
| ||
29 |
| ||
30 |
| ||
31 |
| ||
32 |
| How many assets does natural or legal entity controls directly | |
33 |
| Percentage of votes that beneficial owners have | |
34 | beneficialOwners.actualBeneficialOwners.dateRegisteredFrom | Date when beneficial owner was registered. | |
35 | beneficialOwners.actualBeneficialOwners.relationshipTypes | Relationship type of the beneficial owner. It describes how beneficial owner relates to the company. | |
36 | beneficialOwners.actualBeneficialOwners.natureOfControl | Nature of control of the beneficial owner. | |
37 | beneficialOwners.actualBeneficialOwners.countryCode | Country code of beneficial owners residence country | |
38 | beneficialOwners.actualBeneficialOwners.countryName | Country of residence of the beneficial owner. | |
39 | beneficialOwners.actualBeneficialOwners.ownershipPercent | Percentage of the shares beneficial owner holds in the company. | |
40 | beneficialOwners.actualBeneficialOwners.owners | Block of higher level beneficial owners. | |
41 | shareholders | Block with information about company shareholders. | JADIS |
42 | shareholders.actualShareholders | Block with actual shareholders. | |
43 | shareholders.actualShareholders.firstName | First name of the shareholder. | |
44 | shareholders.actualShareholders.lastName | Last name of the shareholder. | |
45 | shareholders.actualShareholders.title | Name of the company. | |
46 | shareholders.actualShareholders.type | Entity type of the shareholder. Possible values are:
| |
47 | shareholders.actualShareholders.typeDescription | Type of the shareholder. Example: ,,Akcininkasâ. | |
48 | shareholders.actualShareholders.code | Code of the shareholder.
| |
49 | shareholders.actualShareholders.address | Block with information about shareholderâs address. | |
50 | shareholders.actualShareholders.address.fullAddress | Full address of the shareholder. | |
51 | shareholders.actualShareholders.address.country | Country of the shareholder's address. | |
52 | shareholders.actualShareholders.address.flatNumber | Flat number of the shareholder's address. | |
53 | shareholders.actualShareholders.address.houseNumber | House number of the shareholder's address. | |
54 | shareholders.actualShareholders.address.city | City of the shareholder's address. | |
55 | shareholders.actualShareholders.address.street | Street of the shareholder's address. | |
56 | shareholders.actualShareholders.address.postCode | Post code of the shareholder's address. | |
57 | shareholders.actualShareholders.shares | Block with information about shareholderâs shares. | |
58 | shareholders.actualShareholders.shares.typeDescription | Name of the share type. | |
59 | shareholders.actualShareholders.shares.amount | Total amount of shares shareholder have. | |
60 | shareholders.actualShareholders.shares.percent | Percentage of the shares shareholder holds in the company. | |
61 | shareholders.actualShareholders.shares.pricePerShare | Block with information about share price. | |
62 | shareholders.actualShareholders.shares.pricePerShare.value | Price for one share. | |
63 | shareholders.actualShareholders.shares.pricePerShare.currency | Currency of the share price. | |
64 | representatives | Block with information about company's representatives. | JAR |
65 | representatives.actualRepresentatives | Block with actual representatives. | |
66 | representatives.actualRepresentatives.fullName | Full name of the representative. | |
67 | representatives.actualRepresentatives.firstName | First name of the representative. | |
68 | representatives.actualRepresentatives.lastName | Last name of the shareholder. | |
69 | representatives.actualRepresentatives.title | Name of the company. | |
70 | representatives.actualRepresentatives.code | Code of the representative.
| |
71 | representatives.actualRepresentatives.birthDate | Date of birth of the representative. | |
72 | representatives.actualRepresentatives.state | Name of representativeâs country of residence. | |
73 | representatives.actualRepresentatives.position | Representativeâs position at the company. | |
74 | representatives.actualRepresentatives.address | Block with information about representativeâs address. | |
75 | representatives.actualRepresentatives.address.fullAddress | Full address of the representative. | |
76 | representatives.actualRepresentatives.address.country | Country of the representativeâs address. | |
77 | representatives.actualRepresentatives.address.flatNumber | Flat number of the representativeâs address. | |
78 | representatives.actualRepresentatives.address.houseNumber | House number of the representativeâs address. | |
79 | representatives.actualRepresentatives.address.city | City of the representativeâs address. | |
80 | representatives.actualRepresentatives.address.street | Street of the representativeâs address. | |
81 | representatives.actualRepresentatives.address.postCode | Post code of the representativeâs address. | |
82 | representatives.actualRepresentatives.type | Type of representative indicating that he/she is the head of the company. Example: âManagerâ. | |
83 | representatives.actualRepresentatives.appointedOn | Date when representative was appointed. | |
84 | representatives.actualRepresentatives.entityType | Entity type of the representative. Possible values are:
| |
85 | representatives.actualRepresentatives.representationDescriptions | The description of representative role. |
Example
Data Caching
We have implemented a data caching system for JAR, JAIDS, and JANGIS registry responses in our database. This system empowers our clients to select between receiving cached data or real-time data for a company.
Caching Mechanism
Our caching mechanism stores responses from the JAR, JAIDS, and JANGIS registries in our database. The cached data is retained for 24 hours, following which it is automatically removed.
Retrieving Cached Data
If a client requests cached company information, our first step is to check whether we have any cached data for the requested company from the JAR, JAIDS, or JANGIS registries obtained within the past 24 hours.
If we do have cached data available for the requested company, we promptly deliver it to the client.
Acquiring Actual Data
If we don't have cached data for the requested company, we will make a call to the relevant registry and obtain the latest information.
Monitoring Beneficial Owners (Pre-development version)
Our software provides a way for clients to monitor changes in the beneficial owners of companies. The process starts with the client adding a company to the monitoring list and setting the frequency of the checks. At the specified frequency, our API will call Registru centras (RC) to check for any changes in beneficial owners on a particular date. RC will return a list of companies that have had changes in beneficial owners.
Our API will then search for the company that the client is monitoring in the list returned by RC. If the company is found, an event will be generated containing information about the change in beneficial ownership.
Endpoint
To get the response of beneficial owner change you need to call this endpoint:
get
/events/vital/{companyCode}
Headers
Parameter | Type | Required | Description |
---|---|---|---|
companyCode | integer | yes | The code of the company which has changes in its beneficial owners. |
Application-Id | string | yes | Your application Id. Please contact support@ondato.com you donât have one. |
Access token | string | yes | Described in the Authentication part |
Response
Field | Type | Description |
---|---|---|
| integer | The page number of the result set |
| integer | The number of events per page |
| integer | The total number of events returned |
events. | integer | The ID of the event |
events. | string | The name of the company which has changes in its beneficial owners |
events. | integer | The code of the company which has changes in its beneficial owners |
events. | string | The type of change that occurred For beneficial owners value will be: |
events. | string | The previous value of the |
events. | string | The new value of the |
events. | string (date-time) | The date and time when the change occurred |
events. | boolean | Indicates whether the event has been reviewed or not |
events. | string | The country associated with the event |