Atoka API User Reference

Companies package "Shares"

Available fields
Description
Data
Used by filters
Facet
Match
beneficialOwnerOf[].active

is the beneficial owner active?

true | false -
beneficialOwnerOf[].id

Atoka ID of the beneficial owner

"string" -
beneficialOwnerOf[].legalName

legal name of the beneficial owner

"string" -
beneficialOwnerOf[].name

name of the beneficial owner

"string" -
beneficialOwners[].active

is the beneficial owner active? (available only if company=true)

true | false -
beneficialOwners[].company

is the beneficial owner a company or a person?

true | false -
beneficialOwners[].id

Atoka ID of the beneficial owner

"string" -
beneficialOwners[].legalName

legal name of the beneficial owner (available only if company=true)

"string" -
beneficialOwners[].name

name of the beneficial owner

"string" -
shareholders[].active

is the company holding the share active? (available only if company=true)

true | false -
shareholders[].amount

amount of shares owned

float -
shareholders[].company

is the subject holding the share a company or a person?

true | false -
shareholders[].id

Atoka ID of the person or company holding the share

"string" -
shareholders[].lastUpdate

last time this position was updated

date -
shareholders[].legalName

legal name of the company holding the share (available only if company=true)

"string" -
shareholders[].name

name of the person or company holding the share

"string" -
shareholders[].ratio

percentage of shares owned

float -
shareholders[].typeOfRight

type of right related to the share

"string" -
sharesOwned[].active

is the company in which the share is held active?

true | false -
sharesOwned[].amount

amount of the share

float -
sharesOwned[].id

ID of the company the share is held in

"string" -
sharesOwned[].lastUpdate

last time this share was updated

date -
sharesOwned[].legalName

legal name of the company the share is held in

"string" -
sharesOwned[].name

name of the company the share is held in

"string" -
sharesOwned[].ratio

percentage of the share

float -
sharesOwned[].typeOfRight

type of right related to the share

"string" -
Example JSON fragment for package
{ // Companies package "Shares"
"sharesOwned": [
{
"id": "string", // ID of the company the share is held in
"active": boolean, // is the company in which the share is held active?
"name": "string", // name of the company the share is held in
"legalName": "string", // legal name of the company the share is held in
"ratio": float, // percentage of the share
"amount": float, // amount of the share
"lastUpdate": "date (in YYYY-MM-DD format)", // last time this share was updated
"typeOfRight": "string" // type of right related to the share
},
...
],
"shareholders": [ // list of shares that people or other companies may hold in a company
{
"id": "string", // Atoka ID of the person or company holding the share
"company": boolean, // is the subject holding the share a company or a person?
"active": boolean, // is the company holding the share active? (available only if `company=true`)
"name": "string", // name of the person or company holding the share
"legalName": "string", // legal name of the company holding the share (available only if `company=true`)
"ratio": float, // percentage of shares owned
"amount": float, // amount of shares owned
"lastUpdate": "date (in YYYY-MM-DD format)", // last time this position was updated
"typeOfRight": "string" // type of right related to the share
},
...
],
"beneficialOwners": [ // list of beneficial owners of the company
{
"id": "string", // Atoka ID of the beneficial owner
"company": boolean, // is the beneficial owner a company or a person?
"active": boolean, // is the beneficial owner active? (available only if `company=true`)
"name": "string", // name of the beneficial owner
"legalName": "string" // legal name of the beneficial owner (available only if `company=true`)
},
...
],
"beneficialOwnerOf": [ // list of companies for which this company is the beneficial owner
{
"id": "string", // Atoka ID of the beneficial owner
"active": boolean, // is the beneficial owner active?
"name": "string", // name of the beneficial owner
"legalName": "string" // legal name of the beneficial owner
},
...
],
}