{"openapi":"3.1.0","info":{"title":"Arireg API","version":"1.0.39"},"paths":{"/keyLogin/":{"get":{"tags":["keyLogin"],"summary":"Key Login","operationId":"key_login_keyLogin__get","parameters":[{"name":"apiKey","in":"header","required":true,"schema":{"type":"string","description":"API Key for authentication","title":"Apikey"},"description":"API Key for authentication"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyLoginResponse"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomValidationError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/person/trustManagement":{"get":{"tags":["Person"],"summary":"Get Trust Management","operationId":"get_trust_management_person_trustManagement_get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"trustManagementName","in":"query","required":false,"schema":{"type":"string","description":"Name of the trust","title":"Trustmanagementname"},"description":"Name of the trust"},{"name":"personFirstName","in":"query","required":false,"schema":{"type":"string","description":"First name of the related natural person","title":"Personfirstname"},"description":"First name of the related natural person"},{"name":"personSurname","in":"query","required":false,"schema":{"type":"string","description":"Family name of the related natural person","title":"Personsurname"},"description":"Family name of the related natural person"},{"name":"personBirthday","in":"query","required":false,"schema":{"type":"string","format":"date","description":"Date of birth of the related natural person","title":"Personbirthday"},"description":"Date of birth of the related natural person"},{"name":"identityCode","in":"query","required":false,"schema":{"type":"string","description":"ID code of the related natural person","title":"Identitycode"},"description":"ID code of the related natural person"},{"name":"includeBeneficialOwners","in":"query","required":false,"schema":{"type":"boolean","description":"Indicates whether trust beneficial owner (uh.teks) data is requested. Requires firstName, lastName and identityCodeCountry.","default":false,"title":"Includebeneficialowners"},"description":"Indicates whether trust beneficial owner (uh.teks) data is requested. Requires firstName, lastName and identityCodeCountry."},{"name":"firstName","in":"query","required":false,"schema":{"type":"string","description":"Query person first name (required when includeBeneficialOwners=true)","title":"Firstname"},"description":"Query person first name (required when includeBeneficialOwners=true)"},{"name":"lastName","in":"query","required":false,"schema":{"type":"string","description":"Query person last name (required when includeBeneficialOwners=true)","title":"Lastname"},"description":"Query person last name (required when includeBeneficialOwners=true)"},{"name":"identityCodeCountry","in":"query","required":false,"schema":{"type":"string","description":"Query person country (required when includeBeneficialOwners=true)","title":"Identitycodecountry"},"description":"Query person country (required when includeBeneficialOwners=true)"},{"name":"viewerIdentityCode","in":"query","required":false,"schema":{"type":"string","description":"Query person id code or foreign code (the person requesting uh.teks data)","title":"Vieweridentitycode"},"description":"Query person id code or foreign code (the person requesting uh.teks data)"},{"name":"viewerBirthday","in":"query","required":false,"schema":{"type":"string","format":"date","description":"Query person birthday (the person requesting uh.teks data)","title":"Viewerbirthday"},"description":"Query person birthday (the person requesting uh.teks data)"},{"name":"queryReason","in":"query","required":false,"schema":{"type":"string","description":"Reason for querying beneficial owners data","title":"Queryreason"},"description":"Reason for querying beneficial owners data"},{"name":"connectionToCompany","in":"query","required":false,"schema":{"type":"string","description":"Connection to the trust for which beneficial owners data is being queried","title":"Connectiontocompany"},"description":"Connection to the trust for which beneficial owners data is being queried"},{"name":"onlyValid","in":"query","required":false,"schema":{"type":"boolean","description":"Display only valid data","title":"Onlyvalid"},"description":"Display only valid data"},{"name":"pageNumber","in":"query","required":false,"schema":{"type":"integer","maximum":100000,"exclusiveMinimum":0,"description":"Results Page Number. Default 1. Max 100000.","default":1,"title":"Pagenumber"},"description":"Results Page Number. Default 1. Max 100000."},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"exclusiveMinimum":0,"description":"How many results on one page are desired. Default 100. Max 1000.","default":100,"title":"Pagesize"},"description":"How many results on one page are desired. Default 100. Max 1000."},{"name":"apiVersion","in":"header","required":false,"schema":{"$ref":"#/components/schemas/ApiVersions","description":"Api version header","default":"V1"},"description":"Api version header"},{"name":"acceptLanguage","in":"header","required":false,"schema":{"$ref":"#/components/schemas/AcceptLanguage","description":"Language of translations of classifiers (est-Estonian, eng-English)","default":"est"},"description":"Language of translations of classifiers (est-Estonian, eng-English)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrustManagementResponse"}}}},"204":{"description":"No Content: There is no data for your request."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomValidationError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/company/{registryCode}/beneficialOwners":{"get":{"tags":["Company"],"summary":"Get Company Beneficial Owners","operationId":"get_company_beneficial_owners_company__registryCode__beneficialOwners_get","security":[{"OAuth2PasswordBearer":[]}],"parameters":[{"name":"registryCode","in":"path","required":true,"schema":{"type":"integer","description":"Registry code of the company","title":"Registrycode"},"description":"Registry code of the company"},{"name":"queryReason","in":"query","required":false,"schema":{"type":"string","description":"Reason for querying beneficial owners data","title":"Queryreason"},"description":"Reason for querying beneficial owners data"},{"name":"connectionToCompany","in":"query","required":false,"schema":{"type":"string","description":"Connection to the company for which beneficial owners data is being queried","title":"Connectiontocompany"},"description":"Connection to the company for which beneficial owners data is being queried"},{"name":"firstName","in":"query","required":true,"schema":{"type":"string","description":"Query person first name","title":"Firstname"},"description":"Query person first name"},{"name":"lastName","in":"query","required":true,"schema":{"type":"string","description":"Query person last name","title":"Lastname"},"description":"Query person last name"},{"name":"birthday","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Query person birthday","title":"Birthday"},"description":"Query person birthday"},{"name":"identityCode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Query person id code or foreign code","title":"Identitycode"},"description":"Query person id code or foreign code"},{"name":"identityCodeCountry","in":"query","required":true,"schema":{"type":"string","description":"Query person country","title":"Identitycodecountry"},"description":"Query person country"},{"name":"onlyValid","in":"query","required":false,"schema":{"type":"boolean","description":"Display only valid data","default":true,"title":"Onlyvalid"},"description":"Display only valid data"},{"name":"apiVersion","in":"header","required":false,"schema":{"$ref":"#/components/schemas/ApiVersions","description":"Api version header","default":"V1"},"description":"Api version header"},{"name":"acceptLanguage","in":"header","required":false,"schema":{"$ref":"#/components/schemas/AcceptLanguage","description":"Language of translations of classifiers (est-Estonian, eng-English)","default":"est"},"description":"Language of translations of classifiers (est-Estonian, eng-English)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BeneficialOwnersResponse"}}}},"204":{"description":"No Content: There is no data for your request."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomValidationError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/beneficialOwners/vip_level":{"get":{"tags":["beneficialOwners"],"summary":"Get VIP level for a physical or juridical entity","description":"Returns the VIP level for a physical or juridical entity based on the provided personal code or company code and country.\n    If permission is granted, the exact VIP level is returned. Otherwise, only VIP status is returned.","operationId":"vip_level_beneficialOwners_vip_level_get","parameters":[{"name":"personType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/PersonType","description":"Person Type: J - Juridical, P - Physical","default":"P"},"description":"Person Type: J - Juridical, P - Physical"},{"name":"entityCode","in":"query","required":true,"schema":{"type":"string","description":"Personal code or Company Code","title":"Entitycode"},"description":"Personal code or Company Code"},{"name":"entityCodeCountry","in":"query","required":true,"schema":{"type":"string","description":"Country of the Entity Code (ISO 3166-1 alpha-3)","title":"Entitycodecountry"},"description":"Country of the Entity Code (ISO 3166-1 alpha-3)"},{"name":"apiVersion","in":"header","required":false,"schema":{"$ref":"#/components/schemas/ApiVersions","description":"Api version header","default":"V1"},"description":"Api version header"},{"name":"acceptLanguage","in":"header","required":false,"schema":{"$ref":"#/components/schemas/AcceptLanguage","description":"Language of translations of classifiers (est-Estonian, eng-English)","default":"est"},"description":"Language of translations of classifiers (est-Estonian, eng-English)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BOVipLevelResponse"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomValidationError"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"APIError":{"type":"integer","enum":[2001,4030,4041,4042,4043,4044,4045,4046,4047,4048,4049],"title":"APIError"},"AcceptLanguage":{"type":"string","enum":["est","eng"],"title":"AcceptLanguage"},"ApiVersions":{"type":"string","enum":["V1"],"title":"ApiVersions"},"BOVipLevelResponse":{"properties":{"level":{"anyOf":[{"type":"string","enum":["VIP1","VIP2","VIP3"]},{"type":"string"},{"type":"null"}],"title":"Level"},"isVIP":{"type":"boolean","title":"Isvip","description":"Indicates if the entity has a VIP level"}},"type":"object","required":["level","isVIP"],"title":"BOVipLevelResponse"},"BeneficialOwnersResponse":{"properties":{"beneficiariesTotal":{"type":"integer","format":"int64","title":"Beneficiariestotal","description":"Beneficiaries in response."},"hiddenBeneficiariesNumber":{"type":"integer","format":"int64","title":"Hiddenbeneficiariesnumber","description":"Number of hidden beneficial owners"},"filedNoBeneficiaryNotice":{"type":"boolean","title":"Filednobeneficiarynotice","description":"Has a discrepancy notice of no beneficiaries been filed."},"mustSubmitBeneficialOwners":{"type":"boolean","title":"Mustsubmitbeneficialowners","description":"Whether the entity is required to submit beneficial owner information."},"beneficiary":{"items":{"$ref":"#/components/schemas/Beneficiary"},"type":"array","title":"Beneficiary","description":"Beneficiaries in response"}},"type":"object","required":["beneficiariesTotal","hiddenBeneficiariesNumber","filedNoBeneficiaryNotice","mustSubmitBeneficialOwners","beneficiary"],"title":"BeneficialOwnersResponse"},"Beneficiary":{"properties":{"person":{"$ref":"#/components/schemas/PersonInfo","description":"Person information"},"country":{"type":"string","title":"Country","description":"Country of the address"},"countryAsText":{"type":"string","title":"Countryastext","description":"Address country as text"},"authorityMethod":{"type":"string","title":"Authoritymethod","description":"Authority method"},"authorityMethodAsText":{"type":"string","title":"Authoritymethodastext","description":"Authority method as text"},"terminationType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminationtype","description":"Termination Type"},"terminationTypeAsText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Terminationtypeastext","description":"Termination type as text"},"beneficiaryDiscrepancyFiled":{"type":"boolean","title":"Beneficiarydiscrepancyfiled","description":"Whether a discrepancy notice has been filed for the beneficiary."},"recordId":{"anyOf":[{"type":"integer"},{"type":"null"}],"format":"int64","title":"Recordid","description":"ID"},"startDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Startdate","description":"Start date"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Enddate","description":"Ending date"}},"type":"object","required":["person","country","countryAsText","authorityMethod","authorityMethodAsText","beneficiaryDiscrepancyFiled"],"title":"Beneficiary"},"CustomValidationError":{"properties":{"message":{"type":"string","title":"Message"},"code":{"$ref":"#/components/schemas/APIError"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"Timestamp of the error"}},"type":"object","required":["message","code","id"],"title":"CustomValidationError"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"KeyLoginResponse":{"properties":{"access_token":{"type":"string","title":"Access Token"},"token_type":{"type":"string","title":"Token Type"}},"type":"object","required":["access_token","token_type"],"title":"KeyLoginResponse"},"PersonInfo":{"properties":{"type":{"type":"string","title":"Type","description":"Person Type"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname","description":"First name"},"surnameLegalEntityName":{"type":"string","title":"Surnamelegalentityname","description":"Family name or business name"},"identityCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identitycode","description":"ID code or registry code"},"foreignCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foreigncode","description":"Foreign ID code"},"foreignCodeCountry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foreigncodecountry","description":"Country of Foreign ID code"},"foreignCodeCountryAsText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foreigncodecountryastext","description":"Country of foreign ID code as text"},"birthday":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday","description":"Date of birth"}},"type":"object","required":["type","surnameLegalEntityName"],"title":"PersonInfo"},"PersonRolesInfo":{"properties":{"role":{"type":"string","title":"Role","description":"Person Role"},"roleAsText":{"type":"string","title":"Roleastext","description":"Person role as text"},"startDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Startdate","description":"Connection start date"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Enddate","description":"Connection end date"},"type":{"type":"string","title":"Type","description":"Person Type"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname","description":"First name"},"surnameLegalEntityName":{"type":"string","title":"Surnamelegalentityname","description":"Family name or business name"},"identityCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Identitycode","description":"ID code or registry code"},"foreignCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foreigncode","description":"Foreign ID code"},"foreignCodeCountry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foreigncodecountry","description":"Country of Foreign ID code"},"foreignCodeCountryAsText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Foreigncodecountryastext","description":"Country of foreign ID code as text"},"birthday":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Birthday","description":"Date of birth"}},"type":"object","required":["role","roleAsText","type","surnameLegalEntityName","identityCode"],"title":"PersonRolesInfo"},"PersonType":{"type":"string","enum":["J","P"],"title":"PersonType"},"TrustManagement":{"properties":{"trustManagementId":{"type":"integer","title":"Trustmanagementid","description":"Internal ID of the Trust"},"trustName":{"type":"string","minLength":1,"title":"Trustname","description":"Name of the trust"},"registrationDate":{"type":"string","format":"date","title":"Registrationdate","description":"Registration date of the trust"},"deletionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Deletiondate","description":"Date of the deletion"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Status of the trust"},"statusAsText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statusastext","description":"Status of the trust as text"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country code of the trust"},"countryAsText":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Countryastext","description":"Country of the trust as text"},"beneficiariesTotal":{"type":"integer","title":"Beneficiariestotal","description":"Total number of beneficiaries."},"hiddenBeneficiariesNumber":{"type":"integer","title":"Hiddenbeneficiariesnumber","description":"Number of hidden beneficial owners"},"filedNoBeneficiaryNotice":{"type":"boolean","title":"Filednobeneficiarynotice","description":"Has a discrepancy notice of no beneficiaries been filed."},"persons":{"items":{"$ref":"#/components/schemas/TrustManagementPerson"},"type":"array","title":"Persons","description":"Persons related to the trust"}},"type":"object","required":["trustManagementId","trustName","registrationDate","beneficiariesTotal","hiddenBeneficiariesNumber","filedNoBeneficiaryNotice","persons"],"title":"TrustManagement"},"TrustManagementPerson":{"properties":{"personInfo":{"$ref":"#/components/schemas/PersonRolesInfo"},"residenceCountry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Residencecountry","description":"Country of residence"},"residenceCountryAsText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Residencecountryastext","description":"Country of residence as text"},"addressCountry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Addresscountry","description":"Country of the address"},"addressCountryAsText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Addresscountryastext","description":"Address country as text"},"authorityMethod":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authoritymethod","description":"Authority method"},"authorityMethodAsText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authoritymethodastext","description":"Authority method as text"},"beneficiaryDiscrepancyFiled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Beneficiarydiscrepancyfiled","description":"Whether a discrepancy notice has been filed for the beneficiary."},"startDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Startdate","description":"Start date"},"endDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Enddate","description":"Ending date"}},"type":"object","required":["personInfo"],"title":"TrustManagementPerson"},"TrustManagementResponse":{"properties":{"total":{"type":"integer","format":"int64","title":"Total","description":"The total number of entities.","examples":[1]},"list":{"items":{"$ref":"#/components/schemas/TrustManagement"},"type":"array","title":"List","description":"List of Trust Managements"}},"type":"object","required":["total","list"],"title":"TrustManagementResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"OAuth2PasswordBearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"security":[{"OAuth2PasswordBearer":[]}]}