Meetod: GET /person/trustManagement
OpenAPI/Swagger: https://ar-rest.rik.ee/docs#/Person/get_trust_management
Tagastab usaldushalduste andmed ja nendega seotud isikud. Usaldushaldusi saab otsida nime või seotud füüsilise isiku andmete järgi. Tegelike kasusaajate andmete kaasamist juhib includeBeneficialOwners. Loend persons sisaldab seotud isikuid ega võrdu tegelike kasusaajate loendiga: see võib olla täidetud ka siis, kui beneficiariesTotal on 0.
Päringu parameetrid
| Parameeter |
Tüüp |
Kohustuslik |
Kirjeldus |
|---|
| trustManagementName |
string |
Valikuline |
Usaldushalduse nimi. |
| personFirstName |
string |
Valikuline |
Seotud füüsilise isiku eesnimi. |
| personSurname |
string |
Valikuline |
Seotud füüsilise isiku perekonnanimi. |
| personBirthday |
string (date) |
Valikuline |
Seotud füüsilise isiku sünnikuupäev. |
| identityCode |
string |
Valikuline |
Seotud füüsilise isiku isikukood. |
| includeBeneficialOwners |
boolean |
Valikuline |
Kas kaasata tegelike kasusaajate andmed. Väärtuse true korral on firstName, lastName ja identityCodeCountry kohustuslikud. Vaikimisi: false. |
| firstName |
string |
Tingimuslik |
Päringu tegija eesnimi. Kohustuslik, kui includeBeneficialOwners=true. |
| lastName |
string |
Tingimuslik |
Päringu tegija perekonnanimi. Kohustuslik, kui includeBeneficialOwners=true. |
| identityCodeCountry |
string |
Tingimuslik |
Päringu tegija isikukoodi riik. Kohustuslik, kui includeBeneficialOwners=true. |
| viewerIdentityCode |
string |
Valikuline |
Tegelike kasusaajate andmeid päriva isiku isikukood või välisriigi kood. |
| viewerBirthday |
string (date) |
Valikuline |
Tegelike kasusaajate andmeid päriva isiku sünnikuupäev. |
| queryReason |
string |
Valikuline |
Tegelike kasusaajate andmete pärimise põhjus. |
| connectionToCompany |
string |
Valikuline |
Seos usaldushaldusega, mille tegelike kasusaajate andmeid päritakse. |
| onlyValid |
boolean |
Valikuline |
Kuvab ainult kehtivad andmed |
| pageNumber |
integer |
Valikuline |
Tulemuste lehekülje number. Vaikimisi: 1. Vahemik: 1–100000. |
| pageSize |
integer |
Valikuline |
Tulemuste arv lehel. Vaikimisi: 100. Vahemik: 1–1000. |
Päise parameetrid
| Parameeter |
Tüüp |
Kohustuslik |
Kirjeldus |
|---|
| apiVersion |
ApiVersions |
Valikuline |
API versioon. Lubatud ja toetatud väärtus: V1. Vaikimisi: V1. |
| acceptLanguage |
AcceptLanguage |
Valikuline |
Klassifikaatorite tõlgete keel: est – eesti, eng – inglise. Vaikimisi: est. |
Vastuse skeem
TrustManagementResponse
| Väli |
Tüüp |
Kirjeldus |
|---|
| total |
integer (int64) |
Kohustuslik. Kirjete koguarv |
| list |
array[TrustManagement] |
Kohustuslik. Usaldushalduste loend |
TrustManagement
| Väli |
Tüüp |
Kirjeldus |
|---|
| trustManagementId |
integer |
Kohustuslik. Usaldushalduse sisemine ID |
| trustName |
string |
Kohustuslik. Usaldushalduse nimi Vähemalt 1 märk. |
| registrationDate |
string (date) |
Kohustuslik. Usaldushalduse registreerimise kuupäev |
| deletionDate |
string (date) | null |
Kustutamise kuupäev |
| status |
string | null |
Usaldushalduse staatus |
| statusAsText |
string | null |
Usaldushalduse staatus tekstina |
| country |
string | null |
Usaldushalduse riigikood |
| countryAsText |
string | null |
Usaldushalduse riik tekstina Vähemalt 1 märk. |
| beneficiariesTotal |
integer |
Kohustuslik. Kasusaajate koguarv |
| hiddenBeneficiariesNumber |
integer |
Kohustuslik. Peidetud tegelike kasusaajate arv |
| filedNoBeneficiaryNotice |
boolean |
Kohustuslik. Kas on esitatud lahknevusteade kasusaajate puudumise kohta |
| persons |
array[TrustManagementPerson] |
Kohustuslik. Usaldushaldusega seotud isikud |
TrustManagementPerson
| Väli |
Tüüp |
Kirjeldus |
|---|
| personInfo |
PersonRolesInfo |
Kohustuslik. Isiku andmed ja roll. |
| residenceCountry |
string | null |
Elukohariik |
| residenceCountryAsText |
string | null |
Elukohariik tekstina |
| addressCountry |
string | null |
Aadressi riik |
| addressCountryAsText |
string | null |
Aadressi riik tekstina |
| authorityMethod |
string | null |
Kontrolli teostamise viis |
| authorityMethodAsText |
string | null |
Kontrolli teostamise viis tekstina |
| beneficiaryDiscrepancyFiled |
boolean | null |
Kas kasusaaja kohta on esitatud lahknevusteade |
| startDate |
string (date-time) | null |
Alguskuupäev |
| endDate |
string (date-time) | null |
Lõppkuupäev |
PersonRolesInfo
| Väli |
Tüüp |
Kirjeldus |
|---|
| role |
string |
Kohustuslik. Isiku roll |
| roleAsText |
string |
Kohustuslik. Isiku roll tekstina |
| startDate |
string (date) | null |
Seose alguskuupäev |
| endDate |
string (date) | null |
Seose lõppkuupäev |
| type |
string |
Kohustuslik. Isiku tüüp: F – füüsiline isik, J – juriidiline isik. |
| firstName |
string | null |
Eesnimi |
| surnameLegalEntityName |
string |
Kohustuslik. Perekonnanimi või ärinimi |
| identityCode |
string | null |
Kohustuslik. Isiku- või registrikood |
| foreignCode |
string | null |
Välisriigi isikukood |
| foreignCodeCountry |
string | null |
Välisriigi isikukoodi riik |
| foreignCodeCountryAsText |
string | null |
Välisriigi isikukoodi riik tekstina |
| birthday |
string (date) | null |
Sünnikuupäev |
| share |
ShareData | null |
Osaluse andmed (rollid O, OSAN, S). |
ShareData
| Väli |
Tüüp |
Kirjeldus |
|---|
| sharePercentage |
number | null (double) |
Osaluse protsent. |
| shareSize |
number | null (double) |
Osaluse suurus. |
| shareCurrencyAsText |
string | null |
Osaluse vääring tekstina. |
CustomValidationError
| Väli |
Tüüp |
Kirjeldus |
|---|
| message |
string |
Kohustuslik. Veateade. |
| code |
APIError |
Kohustuslik. Veakood. Lubatud väärtused on APIError skeemis. |
| id |
string | null |
Kohustuslik. Vea identifikaator. |
| timestamp |
string (date-time) |
Vea ajatempel. |
HTTPValidationError
| Väli |
Tüüp |
Kirjeldus |
|---|
| detail |
array[ValidationError] |
Valideerimisvigade loend. |
ValidationError
| Väli |
Tüüp |
Kirjeldus |
|---|
| loc |
array[string | integer] |
Kohustuslik. Vigase väärtuse asukoht. |
| msg |
string |
Kohustuslik. Veateade. |
| type |
string |
Kohustuslik. Vea tüüp. |
| input |
any |
Valideeritud sisendväärtus. |
| ctx |
object |
Valideerimisvea lisateave. |
Isikute rollid
| Kood |
Kirjeldus |
|---|
| UH.HALDUR |
Usaldushaldur |
| UH.LOOJA |
Usaldushalduse või -ühenduse looja |
| UH.MUUKONTROLL |
Muud isikud, kes omavad kontrolli |
| UH.SOODUST |
Soodustatud isik |
| UH.VARASAIL |
Vara säilimist tagav ja kontrolliv isik |
Vastused
200 OK
Usaldushaldused koos seotud füüsiliste ja juriidiliste isikutega.
{
"total": 2,
"list": [
{
"trustManagementId": 81001,
"trustName": "Pilveaia usaldushaldus",
"registrationDate": "2024-05-15",
"deletionDate": null,
"status": "R",
"statusAsText": "Registreeritud",
"country": "EST",
"countryAsText": "Eesti",
"beneficiariesTotal": 0,
"hiddenBeneficiariesNumber": 0,
"filedNoBeneficiaryNotice": false,
"persons": [
{
"personInfo": {
"role": "UH.HALDUR",
"roleAsText": "Usaldushaldur",
"type": "F",
"firstName": "Mari",
"surnameLegalEntityName": "Maasikas",
"identityCode": "48503151233",
"foreignCode": null,
"foreignCodeCountry": null,
"foreignCodeCountryAsText": null,
"birthday": "1985-03-15"
},
"residenceCountry": "EST",
"residenceCountryAsText": "Eesti",
"addressCountry": null,
"addressCountryAsText": null,
"authorityMethod": null,
"authorityMethodAsText": null,
"beneficiaryDiscrepancyFiled": null,
"startDate": "2025-02-14T00:00:00Z",
"endDate": null
},
{
"personInfo": {
"role": "UH.LOOJA",
"roleAsText": "Usaldushalduse või -ühenduse looja",
"type": "F",
"firstName": "Jüri",
"surnameLegalEntityName": "Juurikas",
"identityCode": "38006201232",
"foreignCode": null,
"foreignCodeCountry": null,
"foreignCodeCountryAsText": null,
"birthday": "1980-06-20"
},
"residenceCountry": "EST",
"residenceCountryAsText": "Eesti",
"addressCountry": null,
"addressCountryAsText": null,
"authorityMethod": null,
"authorityMethodAsText": null,
"beneficiaryDiscrepancyFiled": null,
"startDate": "2025-02-14T00:00:00Z",
"endDate": null
},
{
"personInfo": {
"role": "UH.MUUKONTROLL",
"roleAsText": "Muud isikud, kes omavad kontrolli",
"type": "J",
"firstName": null,
"surnameLegalEntityName": "Pilvevara OÜ",
"identityCode": "14900012",
"foreignCode": null,
"foreignCodeCountry": null,
"foreignCodeCountryAsText": null,
"birthday": null
},
"residenceCountry": "EST",
"residenceCountryAsText": "Eesti",
"addressCountry": null,
"addressCountryAsText": null,
"authorityMethod": null,
"authorityMethodAsText": null,
"beneficiaryDiscrepancyFiled": null,
"startDate": "2025-02-14T00:00:00Z",
"endDate": null
}
]
},
{
"trustManagementId": 81002,
"trustName": "Pilveaia usaldushaldus",
"registrationDate": "2024-05-15",
"deletionDate": null,
"status": "R",
"statusAsText": "Registreeritud",
"country": "EST",
"countryAsText": "Eesti",
"beneficiariesTotal": 0,
"hiddenBeneficiariesNumber": 0,
"filedNoBeneficiaryNotice": false,
"persons": [
{
"personInfo": {
"role": "UH.SOODUST",
"roleAsText": "Soodustatud isik",
"type": "F",
"firstName": "Erik",
"surnameLegalEntityName": "Esimerkki",
"identityCode": null,
"foreignCode": "FI-EXAMPLE-001",
"foreignCodeCountry": "FIN",
"foreignCodeCountryAsText": "Soome",
"birthday": "1988-08-12"
},
"residenceCountry": "FIN",
"residenceCountryAsText": "Soome",
"addressCountry": null,
"addressCountryAsText": null,
"authorityMethod": null,
"authorityMethodAsText": null,
"beneficiaryDiscrepancyFiled": null,
"startDate": "2025-02-14T00:00:00Z",
"endDate": null
},
{
"personInfo": {
"role": "UH.VARASAIL",
"roleAsText": "Vara säilimist tagav ja kontrolliv isik",
"type": "J",
"firstName": null,
"surnameLegalEntityName": "Pilvevara OÜ",
"identityCode": "14900012",
"foreignCode": null,
"foreignCodeCountry": null,
"foreignCodeCountryAsText": null,
"birthday": null
},
"residenceCountry": "EST",
"residenceCountryAsText": "Eesti",
"addressCountry": null,
"addressCountryAsText": null,
"authorityMethod": null,
"authorityMethodAsText": null,
"beneficiaryDiscrepancyFiled": null,
"startDate": "2025-02-14T00:00:00Z",
"endDate": null
}
]
}
]
}
204 No Content
Andmeid ei leitud. Vastuse sisu puudub.
403 Forbidden
Juurdepääs teenusele keelatud. OpenAPI ei määra vastuse sisu skeemi.
404 Not Found
Vea vastuse näide. Kood 4041 on APIError loendis lubatud; selle tähendust ega seost konkreetse veaolukorraga OpenAPI ei määra.
{
"message": "Illustrative error",
"code": 4041,
"id": null
}
422 Validation Error
Valideerimisvea näide: pageSize peab olema suurem kui 0.
{
"detail": [
{
"loc": [
"query",
"pageSize"
],
"msg": "Input should be greater than 0",
"type": "greater_than",
"input": 0,
"ctx": {
"gt": 0
}
}
]
}