Atoka API User Reference
People package "Shares"
API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!
Available fields | Description | Data | Used by filters | Facet | Match | Stats |
|---|---|---|---|---|---|---|
| beneficialOwnerOf[] | list of companies for which this person is the beneficial owner | - | - | |||
| beneficialOwnerOf[].active | Is the company for which this person is beneficial owner of active? | true | false | - | |||
| beneficialOwnerOf[].cervedId Private field | Cerved ID of the company for which this person is beneficial owner of | int | beneficialOwnerOfCervedIds | |||
| beneficialOwnerOf[].id | Atoka ID of the company for which this person is beneficial owner of | "string" | beneficialOwnerOfIds beneficialOwnerOfIdsExclude relatedTo | |||
| beneficialOwnerOf[].legalName | legal name of the company for which this person is beneficial owner of | "string" | - | |||
| beneficialOwnerOf[].name | name of the company for which this person is beneficial owner of | "string" | - | |||
| sharesOwned[].active | is the company in which the share is held active? | true | false | - | |||
| sharesOwned[].amount | amount of the share | float | sharesOwnedAmountMin sharesOwnedAmountMax | |||
| sharesOwned[].cervedId Private field | Cerved ID (if present) of company the share is held in | int | sharesOwnedCervedIds | |||
| sharesOwned[].id | ID of the company the share is held in | "string" | sharesOwnedIds sharesOwnedIdsExclude relatedTo | |||
| 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 | sharesOwnedRatioMin sharesOwnedRatioMax | |||
| sharesOwned[].typeOfRight | type of right related to the share | "string" | sharesOwnedTypesOfRight |
Example JSON fragment for package
{"sharesOwned": [{"id": "foo", "cervedId": 42, "active": false, "name": "foo", "legalName": "foo", "ratio": 0.42, "amount": 0.42, "lastUpdate": "2015-12-24", "typeOfRight": "foo" },...],"beneficialOwnerOf": [{"id": "foo", "cervedId": 42, "active": false, "name": "foo", "legalName": "foo" },...]}