Estonian e-Business Register (RIK) Person API

openapi: 3.2.0
info:
  title: Ariregister Rik Ee Person API
  version: 1.4.0
  description: 'Operations tagged Person across 2 of this provider''s published API definitions: ariregister-rik-ee-ar-rest-openapi.json, ariregister-rik-ee-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ar-rest.rik.ee
  description: Production (named in the provider docs at avaandmed.ariregister.rik.ee, which link https://ar-rest.rik.ee/docs)
security:
- OAuth2PasswordBearer: []
tags:
- name: Person
paths:
  /person/representationRights:
    get:
      tags:
      - Person
      summary: Get Representation Rights
      operationId: get_representation_rights
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: personFirstName
        in: query
        required: false
        schema:
          type: string
          minLength: 2
          description: First name of the related natural person
          title: Personfirstname
        description: First name of the related natural person
      - name: surnameLegalEntityName
        in: query
        required: false
        schema:
          type: string
          minLength: 2
          description: Family name or business name
          title: Surnamelegalentityname
        description: Family name or business name
      - 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: 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: false
        schema:
          type: string
          description: Personal code or Company Code
          title: Entitycode
        description: Personal code or Company Code
      - name: entityCodeCountry
        in: query
        required: false
        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: 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
          supported_versions:
          - V1
          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/RepresentationRightsResponse'
        '204':
          description: 'No Content: There is no data for your request.'
        '403':
          description: Service access denied.
        '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
      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
          supported_versions:
          - V1
          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.'
        '403':
          description: Service access denied.
        '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:
    ApiVersions:
      type: string
      enum:
      - V1
      title: ApiVersions
    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
    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
    RepresentationRightsGroup:
      properties:
        groupNumber:
          type: integer
          title: Groupnumber
          description: Group number
        persons:
          items:
            $ref: '#/components/schemas/RepresentationRightsPerson'
          type: array
          title: Persons
          description: Persons in the group
      type: object
      required:
      - groupNumber
      - persons
      title: RepresentationRightsGroup
    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
    CompanyRepresentationRights:
      properties:
        legalEntityName:
          type: string
          title: Legalentityname
          description: Company business name
        registryCode:
          type: integer
          title: Registrycode
          description: Company registration code
        representationRightSpecialConditions:
          items:
            type: string
          type: array
          title: Representationrightspecialconditions
          description: Special conditions for the right of representation
        representationRightGroups:
          items:
            $ref: '#/components/schemas/RepresentationRightsGroup'
          type: array
          title: Representationrightgroups
          description: lorem
        persons:
          items:
            $ref: '#/components/schemas/RepresentationRightsPerson'
          type: array
          title: Persons
          description: Persons with the right of representation
        legalForm:
          type: string
          title: Legalform
          description: Legal form
        legalFormAsText:
          type: string
          title: Legalformastext
          description: Legal form as text
        status:
          type: string
          title: Status
          description: State
        statusAsText:
          type: string
          title: Statusastext
          description: State as text
      type: object
      required:
      - legalEntityName
      - registryCode
      - persons
      - legalForm
      - legalFormAsText
      - status
      - statusAsText
      title: CompanyRepresentationRights
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    AcceptLanguage:
      type: string
      enum:
      - est
      - eng
      title: AcceptLanguage
    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
    RepresentationRightsPerson:
      properties:
        firstName:
          anyOf:
          - type: string
          - type: 'null'
          title: Firstname
          description: First name
        surnameLegalEntityName:
          type: string
          title: Surnamelegalentityname
          description: Family name or Business name
        entityCode:
          anyOf:
          - type: string
          - type: 'null'
          title: Entitycode
          description: Personal code or Company Code
        entityCodeCountry:
          type: string
          title: Entitycodecountry
          description: Country of the Entity Code (ISO 3166-1 alpha-3)
        entityCodeCountryAsText:
          anyOf:
          - type: string
          - type: 'null'
          title: Entitycodecountryastext
          description: Country of the Entity Code as text
        birthday:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Birthday
          description: Date of birth
        personType:
          type: string
          title: Persontype
          description: Person Type
        role:
          type: string
          title: Role
          description: Role of the person
        roleAsText:
          type: string
          title: Roleastext
          description: Role as Text
        exclusiveRightOfRepresentation:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Exclusiverightofrepresentation
          description: Existence of exclusive right of representation
      type: object
      required:
      - surnameLegalEntityName
      - entityCodeCountry
      - personType
      - role
      - roleAsText
      title: RepresentationRightsPerson
    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
        share:
          anyOf:
          - $ref: '#/components/schemas/ShareData'
          - type: 'null'
          description: Share ownership data (O, OSAN, S)
      type: object
      required:
      - role
      - roleAsText
      - type
      - surnameLegalEntityName
      - identityCode
      title: PersonRolesInfo
    RepresentationRightsResponse:
      properties:
        total:
          type: integer
          title: Total
        list:
          items:
            $ref: '#/components/schemas/CompanyRepresentationRights'
          type: array
          title: List
          description: Entrepreneurs
      type: object
      required:
      - total
      - list
      title: RepresentationRightsResponse
    APIError:
      type: integer
      enum:
      - 2001
      - 4030
      - 4041
      - 4042
      - 4043
      - 4044
      - 4045
      - 4046
      - 4047
      - 4048
      - 4049
      title: APIError
    ShareData:
      properties:
        sharePercentage:
          anyOf:
          - type: number
          - type: 'null'
          format: double
          title: Sharepercentage
          description: Share Percentage
        shareSize:
          anyOf:
          - type: number
          - type: 'null'
          format: double
          title: Sharesize
          description: Share Size
        shareCurrency:
          anyOf:
          - type: string
          - type: 'null'
          title: Sharecurrency
          description: Share currency
        shareCurrencyAsText:
          anyOf:
          - type: string
          - type: 'null'
          title: Sharecurrencyastext
          description: Share Currency as text
      type: object
      title: ShareData
  securitySchemes:
    OAuth2PasswordBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- ariregister-rik-ee-ar-rest-openapi.json
- ariregister-rik-ee-openapi.yml