Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
minLevel1
maxLevel7

...

Key

Value

Description

client_id

<client_id>

Your ID that will be provided by Ondato.

client_secret

<secret>

Your secret that will be provided by Ondato.

grant_type

client_credentials

Machine-to-machine grant flow.

scope

<reuqested_scopes_separated_by_space>

Access to requested recoursesresources. Will be provided by Ondato.

...

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.

  • For legal entity - company code;

  • For natural entity - personal code.

23

beneficialOwners.actualBeneficialOwners.companyName

Name of the company.

Info

If beneficial owner is a 🏛️ legal entity.

Otherwise field is empty and has value "null".

24

beneficialOwners.actualBeneficialOwners.fullName

Full name of the beneficial owner.

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

25

beneficialOwners.actualBeneficialOwners.firstName

First name of the beneficial owner.

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

26

beneficialOwners.actualBeneficialOwners.lastName

Last name of the beneficial owner.

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

27

dateOfBirth

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

28

documentCountryCode

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

29

documentCountryName

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

30

nationalityCountryCode

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

31

nationalityCountryName

Info

If beneficial owner is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

32

assetsControl

How many assets does natural or legal entity controls directly

33

votePercentage

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.

Info

The deepest level beneficialOwners.actualBeneficialOwners.owners blockcontains the Ultimate beneficial owner.

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.

Info

If shareholder is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

44

shareholders.actualShareholders.lastName

Last name of the shareholder.

Info

If shareholder is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

45

shareholders.actualShareholders.title

Name of the company.

Info

If shareholder is a 🏛️ legal entity.

Otherwise field is empty and has value "null".

46

shareholders.actualShareholders.type

Entity type of the shareholder.

Possible values are:

  1. NaturalEntity

  2. LegalEntity

  3. ForeignNaturalEntity

  4. ForeignLegalEntity

  5. StateMunicipality

  6. State

  7. InvestmentFund.

47

shareholders.actualShareholders.typeDescription

Type of the shareholder.

Example: ,,Akcininkas”.

48

shareholders.actualShareholders.code

Code of the shareholder.

  • For legal entity - company code;

  • For natural entity - personal code.

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.

Info

If representative is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

67

representatives.actualRepresentatives.firstName

First name of the representative.

Info

If representative is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

68

representatives.actualRepresentatives.lastName

Last name of the shareholder.

Info

If representative is a 🧑‍🦱 natural entity.

Otherwise field is empty and has value "null".

69

representatives.actualRepresentatives.title

Name of the company.

Info

If representative is a 🏛️ legal entity.

Otherwise field is empty and has value "null".

70

representatives.actualRepresentatives.code

Code of the representative.

  • For legal entity - company code;

  • For natural entity - personal code.

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:

  1. NaturalEntity

  2. LegalEntity.

85

representatives.actualRepresentatives.representationDescriptions

The description of representative role.

...