openapi: 3.0.1
info:
  title: Linkcy Api
  description: >
    # Overview


    This is the partner API from [linkcy](https://linkcy.io/). Here you can find
    our API documentation.


    LinkCy API allows you to create fully embedded banking products for your own
    company or consumers. This API is backed by

    all mandatory requirements by financial authorities. To process, information

    provided into the API must be accurate.


    # Authentication


    You can obtain a LinkCy Authorization Key by contacting our commercial team
    [here](mailto:romaric.bouxin@linkcy.io).
  contact:
    url: https://linkcy.io/#contact
  version: 1.114.5
  x-logo:
    url: https://linkcy.io/content/uploads/2022/06/logo.svg
    altText: LinkCy
servers:
  - url: https://api.sandbox.linkcy.cloud
    description: Generated server url
security:
  - Linkcy-Auth: []
tags:
  - name: Consumer
    description: >
      The consumer represents the individual partner client. It must have a
      valid phone number and be formally identified with

      a [KYC](/tag/KYC) procedure before carrying out any operation. 
paths:
  /paynovate/mvc-count/{mvcType}: {}
  /api/partner/cards/{cardId}/rules/{ruleType}:
    put:
      tags:
        - Card
      summary: Update a rule from card
      description: >-
        Update card by creating a new card rule. When creating a card rule with
        a type that already exists, it will override the previous one.


        Both partner and enduser can set a rule of the same type. The more
        restrictive one will be applied.


        This operation might require **SCA**.
      operationId: update
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: ruleType
          in: path
          required: true
          schema:
            type: string
            enum:
              - DAILY_MAX_SPEND
              - MONTHLY_MAX_SPEND
              - WEEKLY_MAX_SPEND
              - DISABLE_CONTACTLESS
              - DISABLE_ONLINE
              - DISABLE_RECURRING
              - MCC_WHITELIST
              - MCC_BLACKLIST
              - MERCHANT_WHITELIST
              - MERCHANT_BLACKLIST
              - DAY_WHITELIST
              - DAY_BLACKLIST
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardRuleUpdateDto'
        required: true
      responses:
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:28.977689674Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    delete:
      tags:
        - Card
      summary: Remove card rule
      description: |-
        remove rule from card

        This operation might require **SCA**.
      operationId: delete_2
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: ruleType
          in: path
          required: true
          schema:
            type: string
            enum:
              - DAILY_MAX_SPEND
              - MONTHLY_MAX_SPEND
              - WEEKLY_MAX_SPEND
              - DISABLE_CONTACTLESS
              - DISABLE_ONLINE
              - DISABLE_RECURRING
              - MCC_WHITELIST
              - MCC_BLACKLIST
              - MERCHANT_WHITELIST
              - MERCHANT_BLACKLIST
              - DAY_WHITELIST
              - DAY_BLACKLIST
        - name: creatorType
          in: query
          required: false
          schema:
            type: string
            enum:
              - END_USER
              - PARTNER
              - LINKCY
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      responses:
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:44.581380965Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_RULE_CREATOR_TYPE_NOT_AUTHORIZED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-rule-creator-type-not-authorized:
                  value:
                    errorCode: CARD_RULE_CREATOR_TYPE_NOT_AUTHORIZED
                    message: Can not select creator type {0} when authenticated as {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:44.580736545Z'
  /api/partner/card-profiles/{cardProfileId}/rules/{ruleType}:
    put:
      tags:
        - Card
      summary: Create a default card profile rule
      description: >-
        When creating a card with this profile, profile rules will by default be
        applied to the card.


        Any modification on a rule type will ONLY apply to new created cards.


        Any card created PRIOR to that modification will NOT be affected by it,
        and will retain all rules applied on creation.
      operationId: update_1
      parameters:
        - name: cardProfileId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: ruleType
          in: path
          required: true
          schema:
            type: string
            enum:
              - DAILY_MAX_SPEND
              - MONTHLY_MAX_SPEND
              - WEEKLY_MAX_SPEND
              - DISABLE_CONTACTLESS
              - DISABLE_ONLINE
              - DISABLE_RECURRING
              - MCC_WHITELIST
              - MCC_BLACKLIST
              - MERCHANT_WHITELIST
              - MERCHANT_BLACKLIST
              - DAY_WHITELIST
              - DAY_BLACKLIST
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardRuleUpdateDto'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_PROFILE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-profile-not-found:
                  value:
                    errorCode: CARD_PROFILE_NOT_FOUND
                    message: Card profile with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:29.269938864Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    delete:
      tags:
        - Card
      summary: Remove default card profile rule
      description: >-
        Remove a default card rule from card profile.


        This only applies to cards created AFTER default rule deletion.


        Any card created PRIOR to that modification will NOT be affected by it,
        and will retain all rules applied on creation.
      operationId: delete_3
      parameters:
        - name: cardProfileId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: ruleType
          in: path
          required: true
          schema:
            type: string
            enum:
              - DAILY_MAX_SPEND
              - MONTHLY_MAX_SPEND
              - WEEKLY_MAX_SPEND
              - DISABLE_CONTACTLESS
              - DISABLE_ONLINE
              - DISABLE_RECURRING
              - MCC_WHITELIST
              - MCC_BLACKLIST
              - MERCHANT_WHITELIST
              - MERCHANT_BLACKLIST
              - DAY_WHITELIST
              - DAY_BLACKLIST
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_PROFILE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-profile-not-found:
                  value:
                    errorCode: CARD_PROFILE_NOT_FOUND
                    message: Card profile with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:44.762826461Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/internal/partners/restrictions: {}
  /api/internal/cards/{cardId}/rules/{ruleType}: {}
  /paynovate/cards-productions: {}
  /api/partner/verifications/phone/verify:
    post:
      tags:
        - KYC
      summary: Verify phone verification code
      description: >-
        This second step allow LinkCy to verify that the phone number and
        country code provided by the consumer is valid and he controls the SIM.


        If the consumer does not provide a valid code, he will not get access to
        the KYC step which is also mandatory.


        The SMS code is a 6-digits and valid for 10 minutes and the consumer has
        5 attempts. Once the delay of the number of attempts is reached, you
        have to ask for another code by using: Send consumer verification code
        Endpoint here. 


        Note: You can simulate that step in a Sandbox environment. Code is
        always 123456.
      operationId: verifyPhone
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneVerifyRequestDto'
        required: true
      responses:
        '204':
          description: Phone was successfully verified
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INVALID_PHONE_CODE
                      - PERSON_NOT_FOUND
                      - PERSON_ID_REQUIRED
              examples:
                Invalid-phone-code:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Phone code is not valid.
                    errorCode: INVALID_PHONE_CODE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:30.656307509Z'
                Person-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Person of type {0} with id {1} was not found.
                    errorCode: PERSON_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:30.656313333Z'
                Person-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          You must either specify a person id or be
                          authenticated as CONSUMER. Current user type is {0}.
                    errorCode: PERSON_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:30.656316918Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PHONE_ALREADY_VERIFIED
                      - PHONE_CODE_HAS_EXPIRED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Phone-already-verified:
                  value:
                    errorCode: PHONE_ALREADY_VERIFIED
                    message: Phone is already verified for user {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:30.650117617Z'
                Phone-code-has-expired:
                  value:
                    errorCode: PHONE_CODE_HAS_EXPIRED
                    message: >-
                      Phone code has expired, please restart the creation
                      process.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:30.650124509Z'
  /api/partner/verifications/phone/send:
    post:
      tags:
        - KYC
      summary: Send phone verification code by sms
      description: >+
        This Endpoint allows you to send a verification code to your user by
        SMS. This code is a 6-digit code.


        If you want to personalize the Sender Name, please contact your customer
        care.


        NOTE : In Sandbox, no SMS is sent. Verification code will always be
        123456

      operationId: sendPhoneVerificationSms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneVerificationSendRequestDto'
        required: true
      responses:
        '200':
          description: Message sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneVerificationSendResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - PERSON_ID_REQUIRED
                      - PERSON_NOT_FOUND
              examples:
                Person-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          You must either specify a person id or be
                          authenticated as CONSUMER. Current user type is {0}.
                    errorCode: PERSON_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:30.756324027Z'
                Person-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Person of type {0} with id {1} was not found.
                    errorCode: PERSON_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:30.756332450Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PHONE_ALREADY_VERIFIED
                      - PHONE_CODE_STILL_ACTIVE
                      - PHONE_CODE_MUST_BE_SENT
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Phone-already-verified:
                  value:
                    errorCode: PHONE_ALREADY_VERIFIED
                    message: Phone is already verified for user {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:30.678297793Z'
                Phone-code-still-active:
                  value:
                    errorCode: PHONE_CODE_STILL_ACTIVE
                    message: Phone code for user {0} is still active.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:30.678305393Z'
                Phone-code-must-be-sent:
                  value:
                    errorCode: PHONE_CODE_MUST_BE_SENT
                    message: >-
                      Phone code must be sent, please follow the steps of
                      creation process.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:30.678310538Z'
  /api/partner/verifications/email/send:
    post:
      tags:
        - KYC
      summary: Send an email verification link by email
      description: >+
        This Endpoint allows you to send an email verification to your user. The
        user will receive a link by email in order to verify his current email.

      operationId: sendVerificationEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailVerificationSendRequestDto'
        required: true
      responses:
        '200':
          description: Verification email sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailVerificationSendResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PERSON_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Person-not-found:
                  value:
                    errorCode: PERSON_NOT_FOUND
                    message: Person of type {0} with id {1} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:30.953860860Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - EMAIL_ALREADY_VERIFIED
                      - EMAIL_MUST_NOT_BE_NULL
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Email-already-verified:
                  value:
                    errorCode: EMAIL_ALREADY_VERIFIED
                    message: Email address is already verified.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:30.950116596Z'
                Email-must-not-be-null:
                  value:
                    errorCode: EMAIL_MUST_NOT_BE_NULL
                    message: Email must not be null in order to verify it.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:30.950122528Z'
  /api/partner/verifications/address:
    post:
      tags:
        - KYC
      summary: Verify the address of an end-user
      description: >-
        This endpoint allows you to verify an end-user's address using different
        methods:

         - LINK: This method generates a URL link that the end-user can use to complete its Proof of Address (POA).

         - UPLOADED_DOCUMENT: Use this method when a POA document has already been [uploaded](#operation/documentCreate) which will be used to verify the address.

         - DELEGATED: When the address verification is delegated to the partner (property "delegatedPoa" set to "true") and the POA document has been [uploaded](#operation/documentCreate), you can use this method to update the address status to "VERIFIED".
      operationId: verifyAddress
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/AddressVerifyWithLinkRequestDto'
                - $ref: >-
                    #/components/schemas/AddressVerifyWithUploadedDocumentRequestDto
                - $ref: '#/components/schemas/DelegatedAddressVerifyRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressVerifyWithLinkResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - DOCUMENT_NOT_FOUND
              examples:
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.249482002Z'
                Document-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Document with id {0} was not found.
                    errorCode: DOCUMENT_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.249487530Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - OPERATION_NOT_ALLOWED
                      - INVALID_DOCUMENT_TYPE
                      - CANNOT_VERIFY_CORPORATE_ADDRESS_USING_UPLOADED_DOCUMENT
                      - ADDRESS_ALREADY_VERIFIED
                      - END_USER_ALREADY_HAS_PENDING_ADDRESS
                      - DELEGATED_POA_NOT_ALLOWED
                      - DOCUMENT_ADDRESS_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Operation-not-allowed:
                  value:
                    errorCode: OPERATION_NOT_ALLOWED
                    message: >-
                      This operation is not allowed by your current
                      configuration.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.167048280Z'
                Invalid-document-type:
                  value:
                    errorCode: INVALID_DOCUMENT_TYPE
                    message: Document with id {0} must have {1} type but has {2} type.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.167057183Z'
                Cannot-verify-corporate-address-using-uploaded-document:
                  value:
                    errorCode: CANNOT_VERIFY_CORPORATE_ADDRESS_USING_UPLOADED_DOCUMENT
                    message: >-
                      The endUser {0} is not a consumer and therefore his
                      address cannot be verified using an uploaded document.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.167063705Z'
                Address-already-verified:
                  value:
                    errorCode: ADDRESS_ALREADY_VERIFIED
                    message: This address has already been verified.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.167071155Z'
                End-user-already-has-pending-address:
                  value:
                    errorCode: END_USER_ALREADY_HAS_PENDING_ADDRESS
                    message: >-
                      End-user with id {0} already has an address in PENDING
                      status.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.167086901Z'
                Delegated-poa-not-allowed:
                  value:
                    errorCode: DELEGATED_POA_NOT_ALLOWED
                    message: >-
                      The partner configuration does not allow delegated address
                      verification.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.167095155Z'
                Document-address-not-found:
                  value:
                    errorCode: DOCUMENT_ADDRESS_NOT_FOUND
                    message: Document with id {0} has no linked address.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.167103209Z'
  /api/partner/transactions:
    get:
      tags:
        - Transaction
      summary: List transactions
      description: Fetch all transactions.
      operationId: list
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - CREATION_DATE
        - name: endUserId
          in: query
          description: The id of the end-user who is transaction actor (sender / receiver)
          required: false
          schema:
            type: string
            format: uuid
        - name: ledgerId
          in: query
          description: Get transactions made from or to this ledger (ledgerFrom / ledgerTo)
          required: false
          schema:
            type: string
            format: uuid
        - name: cardId
          in: query
          description: Get transactions made from this card
          required: false
          schema:
            type: string
            format: uuid
        - name: transactionTypes
          in: query
          required: false
          schema:
            type: array
            items:
              title: TransactionType
              type: string
              description: Get transactions of these transaction types
              enum:
                - CARD_AUTHORIZATION
                - CARD_CLEARING
                - SEPA_DIRECT_DEBIT
                - INTER_LEDGER
                - ACQUIRING
                - FX
                - SEPA_CREDIT_TRANSFER
                - UK_CREDIT_TRANSFER
                - UNKNOWN
        - name: paymentTypes
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: Get transactions of these payment types
              enum:
                - MONEY_TRANSFER
                - TECH_MVC_CREATION
                - TECH_TRANSACTION
                - TECH_VIRTUAL_TRANSFER
                - ACCOUNT_LOAD
                - PAYMENT
                - ACCOUNT_FUNDING
                - ACCOUNT_TRANSFER
                - ACCOUNT_VERIFICATION
                - ADJUSTMENT_CREDIT
                - ADJUSTMENT_DEBIT
                - CASH_ADVANCE
                - CARD_LOAD
                - CARD_UNLOAD
                - CHARGEBACK
                - CHECK_DEPOSIT
                - DEPOSIT
                - FEE_COLLECTION
                - ORIGINAL_CREDIT
                - PAYMENT_TRANSACTION
                - PURCHASE
                - PURCHASE_RETURN_OR_REFUND
                - PURCHASE_WITH_CASHBACK
                - QUASI_CASH
                - UNIQUE_MCC_TRANSACTION
                - WITHDRAWAL
                - TECH_CARD_SETTLEMENT
                - SCT_RECEIVE
                - SCT_INST_RECEIVE
                - SCT_SEND
                - SCT_INST_SEND
                - TECH_SCT_RETURN
                - SDD_SEND
                - SDD_RECEIVE
                - BACS_RECEIVE
                - FASTER_PAYMENT_RECEIVE
                - BACS_SEND
                - FASTER_PAYMENT_SEND
                - GLOBAL_SWIFT
                - UNKNOWN
        - name: showReleasedTransaction
          in: query
          description: >-
            Get transactions in RELEASED status (card authorization), by default
            is true
          required: false
          schema:
            type: boolean
        - name: showDeclinedTransaction
          in: query
          description: Get transactions in DECLINED and ABORTED status, by default is true
          required: false
          schema:
            type: boolean
        - name: startDate
          in: query
          description: 'Get transactions from this date, example: 2022-05-16T10:30'
          required: false
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: 'Get transactions until this date, example: 2022-05-16T10:30'
          required: false
          schema:
            type: string
            format: date-time
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: >-
                The transaction status. If empty, the query will return
                transactions for all transaction status.
              enum:
                - APPROVED
                - DECLINED
                - RELEASED
                - REVERSED
                - PENDING
                - PENDING_REVIEW
                - UNKNOWN
                - ABORTED
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoTransactionResponseDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Transaction
      summary: Create a transaction to a beneficiary
      description: |-
        Create a transaction between a ledger and a beneficiary.

        This operation might require **SCA**.
      operationId: createBeneficiaryTransaction
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficiaryTransactionCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryTransactionCreateResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                      - BENEFICIARY_NOT_FOUND
              examples:
                Ledger-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Ledger with id {0} was not found.
                    errorCode: LEDGER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.363118079Z'
                Beneficiary-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Beneficiary with id {0} was not found.
                    errorCode: BENEFICIARY_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.363124624Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_KYC_MUST_BE_VALIDATED
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - LEDGER_MUST_BE_ACTIVE
                      - LEDGER_MUST_BE_PROVISIONED
                      - BENEFICIARY_MUST_BE_ACTIVE
                      - BENEFICIARY_MUST_BE_VALID
                      - LEDGER_MUST_BE_UPGRADED
                      - TERMS_AND_CONDITIONS_NOT_ACCEPTED
                      - BENEFICIARY_NOT_COMPATIBLE
                      - LEDGER_TRANSACTION_LIMIT_REACHED
                      - LEDGER_TRANSACTION_DAILY_LIMIT_REACHED
                      - LEDGER_TRANSACTION_MONTHLY_LIMIT_REACHED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-kyc-must-be-validated:
                  value:
                    errorCode: CONSUMER_KYC_MUST_BE_VALIDATED
                    message: Consumer kyc must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359133374Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359139460Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359142917Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359146017Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359148797Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359152100Z'
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359154694Z'
                Ledger-must-be-provisioned:
                  value:
                    errorCode: LEDGER_MUST_BE_PROVISIONED
                    message: Ledger must be provisioned to perform this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359157131Z'
                Beneficiary-must-be-active:
                  value:
                    errorCode: BENEFICIARY_MUST_BE_ACTIVE
                    message: The beneficiary with id {0} is not active.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359159531Z'
                Beneficiary-must-be-valid:
                  value:
                    errorCode: BENEFICIARY_MUST_BE_VALID
                    message: >-
                      The beneficiary with id {0} is not VALID, current status
                      is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359161773Z'
                Ledger-must-be-upgraded:
                  value:
                    errorCode: LEDGER_MUST_BE_UPGRADED
                    message: Ledger must be upgraded to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359164146Z'
                Terms-and-conditions-not-accepted:
                  value:
                    errorCode: TERMS_AND_CONDITIONS_NOT_ACCEPTED
                    message: >-
                      The {0} with id {1} has not accepted the latest terms and
                      conditions.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359166800Z'
                Beneficiary-not-compatible:
                  value:
                    errorCode: BENEFICIARY_NOT_COMPATIBLE
                    message: >-
                      We can not create a transaction to a {0} beneficiary from
                      this ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359169054Z'
                Ledger-transaction-limit-reached:
                  value:
                    errorCode: LEDGER_TRANSACTION_LIMIT_REACHED
                    message: >-
                      Transaction amount cannot be bigger than the limit set by
                      its ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359171317Z'
                Ledger-transaction-daily-limit-reached:
                  value:
                    errorCode: LEDGER_TRANSACTION_DAILY_LIMIT_REACHED
                    message: >-
                      Daily transactions sum cannot be bigger than the daily
                      limit set by its ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359173798Z'
                Ledger-transaction-monthly-limit-reached:
                  value:
                    errorCode: LEDGER_TRANSACTION_MONTHLY_LIMIT_REACHED
                    message: >-
                      Monthly transactions sum cannot be bigger than the monthly
                      limit set by its ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.359176253Z'
  /api/partner/transactions/simulate:
    post:
      tags:
        - Sandbox
      summary: Simulate a transaction
      description: >
        Allows you to simulate a transaction of a specific type, useful for
        generating data in sandbox environment and therefore use transaction
        payloads before going into production.


        - Card Authorization : Simulates a transaction authorization on the
        given card.

        - Card Clearing : Simulates the clearing of the previous authorization
        using its transaction id.

        - Credit Ledger : Simulates a transaction to the given ledger. The
        amount can contain 2 decimal places and the maximum is 1000.
      operationId: simulateTransaction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimulateTransactionRequestDto'
        required: true
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                      - CARD_NOT_FOUND
                      - AUTHORIZATION_NOT_FOUND
              examples:
                Ledger-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Ledger with id {0} was not found.
                    errorCode: LEDGER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.564135518Z'
                Card-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Card {0} was not found.
                    errorCode: CARD_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.564146207Z'
                Authorization-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Authorization transaction with id {0} was not found.
                    errorCode: AUTHORIZATION_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.564154521Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_MUST_BE_ACTIVE
                      - CARD_MUST_BE_ACTIVE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.557598893Z'
                Card-must-be-active:
                  value:
                    errorCode: CARD_MUST_BE_ACTIVE
                    message: >-
                      Card with id {0} must be active in order to perform this
                      operation. Current card status is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.557609285Z'
  /api/partner/transactions/inter-ledger:
    post:
      tags:
        - Transaction
      summary: Create an inter-ledger transaction
      description: |-
        Create a transaction between ledgers of two of your end-users.

        This operation might require **SCA**.
      operationId: createInterLedgerTransaction
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InterLedgerTransactionCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterLedgerTransactionCreateResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
              examples:
                Ledger-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Ledger with id {0} was not found.
                    errorCode: LEDGER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:31.659376208Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_KYC_MUST_BE_VALIDATED
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - LEDGER_MUST_BE_ACTIVE
                      - LEDGER_MUST_BE_PROVISIONED
                      - TERMS_AND_CONDITIONS_NOT_ACCEPTED
                      - INTER_LEDGER_TRANSACTION_MUST_BE_TWO_DIFFERENT_LEDGERS
                      - LEDGER_TRANSACTION_LIMIT_REACHED
                      - LEDGER_TRANSACTION_DAILY_LIMIT_REACHED
                      - LEDGER_TRANSACTION_MONTHLY_LIMIT_REACHED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-kyc-must-be-validated:
                  value:
                    errorCode: CONSUMER_KYC_MUST_BE_VALIDATED
                    message: Consumer kyc must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589473026Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589483330Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589501871Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589509905Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589518053Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589526504Z'
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589533948Z'
                Ledger-must-be-provisioned:
                  value:
                    errorCode: LEDGER_MUST_BE_PROVISIONED
                    message: Ledger must be provisioned to perform this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589541246Z'
                Terms-and-conditions-not-accepted:
                  value:
                    errorCode: TERMS_AND_CONDITIONS_NOT_ACCEPTED
                    message: >-
                      The {0} with id {1} has not accepted the latest terms and
                      conditions.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589548705Z'
                Inter-ledger-transaction-must-be-two-different-ledgers:
                  value:
                    errorCode: INTER_LEDGER_TRANSACTION_MUST_BE_TWO_DIFFERENT_LEDGERS
                    message: >-
                      Inter ledger transaction must be done between two
                      different ledgers.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589557196Z'
                Ledger-transaction-limit-reached:
                  value:
                    errorCode: LEDGER_TRANSACTION_LIMIT_REACHED
                    message: >-
                      Transaction amount cannot be bigger than the limit set by
                      its ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589564276Z'
                Ledger-transaction-daily-limit-reached:
                  value:
                    errorCode: LEDGER_TRANSACTION_DAILY_LIMIT_REACHED
                    message: >-
                      Daily transactions sum cannot be bigger than the daily
                      limit set by its ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589571786Z'
                Ledger-transaction-monthly-limit-reached:
                  value:
                    errorCode: LEDGER_TRANSACTION_MONTHLY_LIMIT_REACHED
                    message: >-
                      Monthly transactions sum cannot be bigger than the monthly
                      limit set by its ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:31.589579062Z'
  /api/partner/transactions/direct-debit:
    post:
      tags:
        - Transaction
      summary: Create a direct debit transaction
      description: >-
        Create a SEPA Direct Debit transaction. The ledger and the mandate must
        be activated.


        If the mandate is not recurring, only one transaction will be allowed.
      operationId: createDirectDebitTransaction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitTransactionCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitTransactionCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - MANDATE_NOT_FOUND
                      - LEDGER_NOT_FOUND
                      - INVALID_DIRECT_DEBIT_TRANSACTION_DATE
              examples:
                Mandate-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Direct debit mandate with id {0} was not found.
                    errorCode: MANDATE_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:32.866811724Z'
                Ledger-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Ledger with id {0} was not found.
                    errorCode: LEDGER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:32.866820625Z'
                Invalid-direct-debit-transaction-date:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The specified date is invalid. Please choose a date
                          that is at least two days from today (J+2) and is a
                          working day (neither weekend nor public holiday).
                    errorCode: INVALID_DIRECT_DEBIT_TRANSACTION_DATE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:32.866826800Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - MANDATE_MUST_BE_ACTIVE
                      - LEDGER_MUST_BE_ACTIVE
                      - MANDATE_NOT_RECURRING
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - LEDGER_MUST_NOT_BE_VIRTUAL
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Mandate-must-be-active:
                  value:
                    errorCode: MANDATE_MUST_BE_ACTIVE
                    message: Direct debit mandate with id {0} must be validated
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858258597Z'
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858274152Z'
                Mandate-not-recurring:
                  value:
                    errorCode: MANDATE_NOT_RECURRING
                    message: >-
                      More than one transaction is not permited on a
                      non-recurring mandate
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858278945Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858283899Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858288312Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858292727Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858296620Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858300871Z'
                Ledger-must-not-be-virtual:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_VIRTUAL
                    message: Ledger must not be virtual to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.858304642Z'
  /api/partner/sms:
    post:
      tags:
        - Additional
      summary: Send SMS
      description: >-
        Send a SMS to any user. For more information about allowed characters or
        SMS length, please refer to the [twilio
        documentation](https://www.twilio.com/docs/glossary/what-sms-character-limit#:~:text=A%20single%20SMS%20message%20technically,longer%20messages%20to%20be%20sent).
      operationId: sensSMSCustom
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsSendRequestDto'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - PERSON_NOT_FOUND
              examples:
                Person-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Person of type {0} with id {1} was not found.
                    errorCode: PERSON_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:32.965197794Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SERVICE_NOT_ACTIVE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Service-not-active:
                  value:
                    errorCode: SERVICE_NOT_ACTIVE
                    message: This service is not active
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:32.961378721Z'
  /api/partner/shares:
    post:
      tags:
        - KYB
      summary: Create a share
      description: Create a new corporate-related share.
      operationId: create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_RELATED_NOT_FOUND
                      - TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                      - SHARE_PERCENTAGE_EQUALS_ZERO
              examples:
                Corporate-related-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Corporate related with id {0} was not found.
                    errorCode: CORPORATE_RELATED_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.075877410Z'
                Total-shares-percentage-is-over-100:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The shares of this entity would cause its owned
                          corporate to exceed 100% of shares ({1}%).
                    errorCode: TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.075884333Z'
                Share-percentage-equals-zero:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The share percentage can not be zero.
                    errorCode: SHARE_PERCENTAGE_EQUALS_ZERO
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.075888301Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SHARE_ALREADY_EXIST
                      - CYCLIC_SHARE_DEPENDENCY
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Share-already-exist:
                  value:
                    errorCode: SHARE_ALREADY_EXIST
                    message: >-
                      The corporate-related {0} has already share with the owned
                      corporate id {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.071614828Z'
                Cyclic-share-dependency:
                  value:
                    errorCode: CYCLIC_SHARE_DEPENDENCY
                    message: >-
                      An owned corporate-related has shares of the current
                      corporate-related which would lead to a cyclic share
                      dependency.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.071621395Z'
  /api/partner/sca/{scaDeviceId}/activate:
    post:
      tags:
        - Strong Authentication
      summary: Activate a device
      description: >-
        Activate the previously registered device in order to finalise the
        registration.
      operationId: activateDevice
      parameters:
        - name: scaDeviceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: SCA device is being activated
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SCA_DEVICE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Sca-device-not-found:
                  value:
                    errorCode: SCA_DEVICE_NOT_FOUND
                    message: The SCA device you are referring ({0}) could not be found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:33.155565156Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SCA_ACTIVATION_FAILED
                      - SCA_DEVICE_MUST_BE_AWAITING_ACTIVATION
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Sca-activation-failed:
                  value:
                    errorCode: SCA_ACTIVATION_FAILED
                    message: SCA activation failed for SCA device id {0}
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.148539632Z'
                Sca-device-must-be-awaiting-activation:
                  value:
                    errorCode: SCA_DEVICE_MUST_BE_AWAITING_ACTIVATION
                    message: >-
                      SCA device with id {0} must be awaiting activation in
                      order to be activated. Current SCA device status is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.148545959Z'
  /api/partner/sca/{endUserId}:
    post:
      tags:
        - Strong Authentication
      summary: Register a device
      description: >-
        Register a device for an end user as a second factor to enable Strong
        Customer Authentication (SCA).


        This operation might require **SCA**.
      operationId: registerDevice
      parameters:
        - name: endUserId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      responses:
        '201':
          description: SCA device registered
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScaDeviceRegistrationResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - PARTNER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                End-user-not-found:
                  value:
                    errorCode: END_USER_NOT_FOUND
                    message: End-user with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:33.167542270Z'
                Partner-not-found:
                  value:
                    errorCode: PARTNER_NOT_FOUND
                    message: Partner {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:33.167547583Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/refresh:
    post:
      tags:
        - Authentication
      summary: Log with refresh token
      description: >-
        Log into the application with a refresh token and get a new access token
        and a new refresh token.


        This operation might require **SCA**.
      operationId: login
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TokenRefreshRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenLoginResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
      security:
        - {}
  /api/partner/passwords/reset:
    post:
      tags:
        - Authentication
      summary: Initialize or reset a password
      description: >-
        Whether you want to initialize first password or reset a password, you
        should use this endpoint. Send a secret by sms to the account owner that
        can be used to change the password of the account.
      operationId: askAPasswordReset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetRequestDto'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_FORBIDDEN
              examples:
                End-user-forbidden:
                  value:
                    errorCode: END_USER_FORBIDDEN
                    message: End-user with id {0} is forbidden.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:33.362963486Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
      security:
        - {}
  /api/partner/passwords/reset/sandbox:
    post:
      tags:
        - Sandbox
      summary: Initialize or reset a password with secret in response
      description: >-
        Whether you want to initialize first password or reset a password, you
        should use this endpoint. Send a secret in response that can be used to
        change the password of the account.
      operationId: askAPasswordResetSandBox
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordResetRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PasswordResetResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/passwords/change:
    post:
      tags:
        - Authentication
      summary: Change user password
      description: Change a user password.
      operationId: changePassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PasswordChangeRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenLoginResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
      security:
        - {}
  /api/partner/mandates:
    get:
      tags:
        - Direct Debit Mandate
      summary: List direct debit mandates
      description: Fetch all direct debit mandates based on parameters.
      operationId: listMandates
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - DEBTOR_NAME
              - CREATION_DATE
        - name: endUserId
          in: query
          description: >-
            The ID of the end-user. If empty, the query will return results for
            all end-users.
          required: false
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - AWAITING_ACTIVATION
              - ACTIVATING
              - ACTIVATED
              - CANCELING
              - CANCELED
              - FAILED
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoDirectDebitMandateListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_NOT_FOUND
              examples:
                Consumer-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Consumer with id {0} was not found.
                    errorCode: CONSUMER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:43:04.662276621Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Direct Debit Mandate
      summary: Create a new direct debit mandate
      description: >-
        Create a direct debit mandate. Once created, the mandate must be
        activated in order to be effective.
      operationId: createMandate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitMandateCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitMandateCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - END_USER_ID_REQUIRED
                      - IBAN_NOT_SUPPORTED
                      - INVALID_BIC_SWIFT
                      - NOT_ALLOWED_BIC_SWIFT
                      - INVALID_EXPIRATION_DATE
              examples:
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.650904190Z'
                End-user-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Field endUserId is required when authenticated as {0}.
                    errorCode: END_USER_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.650910114Z'
                Iban-not-supported:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Iban from {0} are not supported.
                    errorCode: IBAN_NOT_SUPPORTED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.650913936Z'
                Invalid-bic-swift:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Bic or Swift is invalid.
                    errorCode: INVALID_BIC_SWIFT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.650916905Z'
                Not-allowed-bic-swift:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: This bic or swift is not allowed at Linkcy.
                    errorCode: NOT_ALLOWED_BIC_SWIFT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.650919852Z'
                Invalid-expiration-date:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The expiration date must be after {0} and before {1}.
                    errorCode: INVALID_EXPIRATION_DATE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:33.650922528Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - MANDATE_NOT_AVAILABLE_FOR_CONSUMERS
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.646720508Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.646757990Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.646762758Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.646766009Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.646769780Z'
                Mandate-not-available-for-consumers:
                  value:
                    errorCode: MANDATE_NOT_AVAILABLE_FOR_CONSUMERS
                    message: Direct debit mandate is not available yet for consumers.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.646772855Z'
  /api/partner/mandates/{mandateId}/cancel:
    post:
      tags:
        - Direct Debit Mandate
      summary: Cancel a direct debit mandate
      description: Cancel a direct debit mandate. This operation is irreversible.
      operationId: cancelMandate
      parameters:
        - name: mandateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitMandateCancelResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - MANDATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Mandate-not-found:
                  value:
                    errorCode: MANDATE_NOT_FOUND
                    message: Direct debit mandate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:33.661406889Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONFLICTING_MANDATE_STATUS
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Conflicting-mandate-status:
                  value:
                    errorCode: CONFLICTING_MANDATE_STATUS
                    message: >-
                      The current status of the mandate ({0}) does not allow
                      this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.659867019Z'
  /api/partner/mandates/{mandateId}/activate:
    post:
      tags:
        - Direct Debit Mandate
      summary: Activate a direct debit mandate
      description: >-
        Activate a direct debit mandate. You must complete debtor banking
        details before activating the mandate.
      operationId: activateMandate
      parameters:
        - name: mandateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitMandateActivateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - MANDATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Mandate-not-found:
                  value:
                    errorCode: MANDATE_NOT_FOUND
                    message: Direct debit mandate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:33.670669719Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - MISSING_MANDATE_DATA
                      - CONFLICTING_MANDATE_STATUS
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Missing-mandate-data:
                  value:
                    errorCode: MISSING_MANDATE_DATA
                    message: >-
                      A direct debit mandate cannot be activated without the
                      following data: {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.669250487Z'
                Conflicting-mandate-status:
                  value:
                    errorCode: CONFLICTING_MANDATE_STATUS
                    message: >-
                      The current status of the mandate ({0}) does not allow
                      this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.669256711Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.669260278Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.669263437Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.669266477Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.669269289Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:33.669272441Z'
  /api/partner/login:
    post:
      tags:
        - Authentication
      summary: Log into the application
      description: >-
        Log into the application with user credentials and get an access token
        and a refresh token.


        This operation might require **SCA**.
      operationId: login_1
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserPassLoginRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPassLoginResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_FORBIDDEN
              examples:
                End-user-forbidden:
                  value:
                    errorCode: END_USER_FORBIDDEN
                    message: End-user with id {0} is forbidden.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:33.768338023Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
      security:
        - {}
  /api/partner/ledgers:
    get:
      tags:
        - Ledger
      summary: List ledgers
      description: Fetch all ledger based on parameters.
      operationId: list_1
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - CREATION_DATE
        - name: endUserId
          in: query
          description: >-
            The ID of the end-user. If empty, the query will return results for
            all end-users.
          required: false
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: >-
                The ledger status. If empty, the query will return ledgers for
                all ledger status.
              enum:
                - PENDING
                - ACTIVE
                - CLOSING
                - CLOSED
                - SUSPENDED
                - FAILED
        - name: parentId
          in: query
          description: >-
            The ID of the parent ledger you want to retrieve virtual ledgers
            from. If empty, the query will return ledgers regardless of parent.
          required: false
          schema:
            type: string
            format: uuid
        - name: iban
          in: query
          required: false
          schema:
            type: string
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoPartnerLedgerListElementDto
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Ledger
      summary: Create a ledger
      description: >-
        This is the very first point to enter into the banking ecosystem. 


        You will have the possibility to choose the type and the country of the
        IBAN. Every EUR IBAN is plugged into SEPA Step 2 and SEPA Instant.


        Friendly name must be unique for each consumer.
      operationId: create_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LedgerCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LedgerCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - END_USER_ID_REQUIRED
              examples:
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:34.756208049Z'
                End-user-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Field endUserId is required when authenticated as {0}.
                    errorCode: END_USER_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:34.756264084Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_KYC_MUST_BE_VALIDATED
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - TERMS_AND_CONDITIONS_NOT_ACCEPTED
                      - FRIENDLY_NAME_ALREADY_TAKEN
                      - LEDGER_TYPE_NOT_ALLOWED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-kyc-must-be-validated:
                  value:
                    errorCode: CONSUMER_KYC_MUST_BE_VALIDATED
                    message: Consumer kyc must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697362092Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697387776Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697391706Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697395086Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697397972Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697401355Z'
                Terms-and-conditions-not-accepted:
                  value:
                    errorCode: TERMS_AND_CONDITIONS_NOT_ACCEPTED
                    message: >-
                      The {0} with id {1} has not accepted the latest terms and
                      conditions.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697404158Z'
                Friendly-name-already-taken:
                  value:
                    errorCode: FRIENDLY_NAME_ALREADY_TAKEN
                    message: '{0} with this friendly name already exists.'
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697406712Z'
                Ledger-type-not-allowed:
                  value:
                    errorCode: LEDGER_TYPE_NOT_ALLOWED
                    message: The ledger type {0} is not allowed
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.697409463Z'
  /api/partner/ledgers/{ledgerId}/upgrade:
    post:
      tags:
        - Ledger
      summary: Upgrade a ledger
      description: >-
        By upgrading a ledger, you will be able to access its account number and
        perform SEPA transactions to and from it.
      operationId: upgrade
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_NOT_FOUND
              examples:
                Consumer-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Consumer with id {0} was not found.
                    errorCode: CONSUMER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:34.766647961Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-not-found:
                  value:
                    errorCode: LEDGER_NOT_FOUND
                    message: Ledger with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:34.768042477Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_ALREADY_UPGRADED
                      - LEDGER_MUST_BE_ACTIVE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-already-upgraded:
                  value:
                    errorCode: LEDGER_ALREADY_UPGRADED
                    message: This ledger is already upgraded.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.763303956Z'
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.763310607Z'
      deprecated: true
  /api/partner/ledgers/{ledgerId}/suspensions:
    post:
      tags:
        - Ledger
      summary: Suspend a ledger
      description: >
        Suspend a ledger and all associated cards.


        blockIncomingTransaction set to "true" will prevent incoming
        transactions.


        Card will show a new rule with type LINKCY setting the transaction limit
        to 0.
      operationId: suspend
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LedgerSuspendRequestDto'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INSUFFICIENT_RIGHTS
              examples:
                Insufficient-rights:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS
                    message: >-
                      Your current authentication ({0}) does not have sufficient
                      rights to perform this operation.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:34.863184621Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-not-found:
                  value:
                    errorCode: LEDGER_NOT_FOUND
                    message: Ledger with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:34.861600353Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_MUST_NOT_BE_CLOSED
                      - LEDGER_MUST_NOT_BE_SUSPENDED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-must-not-be-closed:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_CLOSED
                    message: Ledger must not be closed to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.859912914Z'
                Ledger-must-not-be-suspended:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_SUSPENDED
                    message: Ledger must not be suspended to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.859917407Z'
  /api/partner/ledgers/{ledgerId}/close:
    post:
      tags:
        - Ledger
      summary: Close a ledger
      description: >-
        Close a ledger and all associated cards.


        All balances(totalAmount, availableAmount, reservedAmount) must be to
        **0**.  

        All transactions must be completed.
      operationId: close
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LedgerCloseRequestDto'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INSUFFICIENT_RIGHTS
              examples:
                Insufficient-rights:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS
                    message: >-
                      Your current authentication ({0}) does not have sufficient
                      rights to perform this operation.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:34.883213811Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-not-found:
                  value:
                    errorCode: LEDGER_NOT_FOUND
                    message: Ledger with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:34.881573922Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_MUST_BE_EMPTY
                      - LEDGER_MUST_NOT_BE_CLOSED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-must-be-empty:
                  value:
                    errorCode: LEDGER_MUST_BE_EMPTY
                    message: All balances of the ledger {0} must be empty.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.879476056Z'
                Ledger-must-not-be-closed:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_CLOSED
                    message: Ledger must not be closed to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:34.879480485Z'
  /api/partner/kyc:
    get:
      tags:
        - KYC
      summary: List KYC applications
      description: >-
        Fetch all KYC applications based on parameters. More options will be
        added in the near future.
      operationId: list_2
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - CREATION_DATE
              - UPDATE_DATE
        - name: personType
          in: query
          description: >-
            Type of person. If empty, the query will return KYC applications of
            all people types.
          required: false
          schema:
            type: string
            enum:
              - CONSUMER
              - CORPORATE_RELATED_PHYSICAL_PERSON
        - name: personId
          in: query
          description: >-
            The ID of the person. If empty, the query will return everyone KYC
            applications.
          required: false
          schema:
            type: string
            format: uuid
        - name: kycStatus
          in: query
          description: >-
            Search KYCs by status. If empty, the query will return KYC
            applications with any status.
          required: false
          schema:
            type: string
            enum:
              - NOT_STARTED
              - CREATED
              - PROCESSING
              - ABORTED
              - PENDING_REVIEW
              - VALIDATED
              - DECLINED
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoKycApplicationListElementDto
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - PERSON_NOT_FOUND
              examples:
                Person-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Person of type {0} with id {1} was not found.
                    errorCode: PERSON_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:43:07.158202429Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - KYC
      summary: Create a KYC for a consumer or a corporate-related person
      description: >-
        Physical users need to complete a due diligence (KYC), this step is
        mandatory to be able to use banking features. Due diligence is performed
        with the local language of your users.


        Once the field "phoneValidated" is in "true" state, you will be able to
        request a KYC for you consumer by link, SDK or if the KYC is delegated,
        you can directly provide us the results.


        BY LINK: 


        The link is valid for 720H.


        BY SDK:


        We will provide you a SDK token valid for 24H that will allow one your
        user to perform its KYC via SDK. Do not hesitate to contact us for more
        information.


        Note: We do not allow consumers to download pictures from the gallery.
      operationId: createKyc
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KycCreateRequestDto'
        required: true
      responses:
        '201':
          description: KYC successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - PERSON_NOT_FOUND
                      - PERSON_ID_REQUIRED
                      - DOCUMENT_NOT_FOUND
              examples:
                Person-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Person of type {0} with id {1} was not found.
                    errorCode: PERSON_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:35.079892362Z'
                Person-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          You must either specify a person id or be
                          authenticated as CONSUMER. Current user type is {0}.
                    errorCode: PERSON_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:35.079897083Z'
                Document-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Document with id {0} was not found.
                    errorCode: DOCUMENT_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:35.079899534Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_FORBIDDEN
                      - INSUFFICIENT_RIGHTS
              examples:
                End-user-forbidden:
                  value:
                    errorCode: END_USER_FORBIDDEN
                    message: End-user with id {0} is forbidden.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:35.081297620Z'
                Insufficient-rights:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS
                    message: >-
                      Your current authentication ({0}) does not have sufficient
                      rights to perform this operation.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:35.081301922Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PHONE_MUST_BE_VERIFIED
                      - LAST_KYC_APPLICATION_NOT_FINISHED
                      - KYC_ALREADY_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - DELEGATED_KYC_NOT_ALLOWED
                      - INVALID_DOCUMENT_TYPE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Phone-must-be-verified:
                  value:
                    errorCode: PHONE_MUST_BE_VERIFIED
                    message: Consumer's phone must be verified to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:35.074517074Z'
                Last-kyc-application-not-finished:
                  value:
                    errorCode: LAST_KYC_APPLICATION_NOT_FINISHED
                    message: >-
                      A KYC application for this consumer is still being
                      processed, please wait for it to complete before starting
                      a new one.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:35.074521857Z'
                Kyc-already-validated:
                  value:
                    errorCode: KYC_ALREADY_VALIDATED
                    message: >-
                      You cannot create a new KYC application for a user with
                      KYC already validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:35.074523964Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:35.074525927Z'
                Delegated-kyc-not-allowed:
                  value:
                    errorCode: DELEGATED_KYC_NOT_ALLOWED
                    message: The partner configuration does not allow delegated KYC.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:35.074527828Z'
                Invalid-document-type:
                  value:
                    errorCode: INVALID_DOCUMENT_TYPE
                    message: Document with id {0} must have {1} type but has {2} type.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:35.074529581Z'
  /api/partner/kyc/simulate:
    post:
      tags:
        - Sandbox
      summary: Simulate a KYC result for a consumer or a corporate-related person
      description: >-
        Simulate a KYC for a consumer or corporate related person with custom
        values.


        The missing information will be automatically populated with default
        values.
      operationId: simulateKycResult
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KycSimulateRequestDto'
        required: true
      responses:
        '201':
          description: Simulated KYC successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycSimulateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - PERSON_NOT_FOUND
                      - PERSON_ID_REQUIRED
              examples:
                Person-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Person of type {0} with id {1} was not found.
                    errorCode: PERSON_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:35.377898007Z'
                Person-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          You must either specify a person id or be
                          authenticated as CONSUMER. Current user type is {0}.
                    errorCode: PERSON_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:35.377902964Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/end-users/{endUserId}/suspensions:
    post:
      tags:
        - End-user
      summary: Suspend an end-user
      description: >
        Suspend an end-user and all associated cards.


        Card will show a new rule with type LINKCY setting the transaction limit
        to 0.
      operationId: create_2
      parameters:
        - name: endUserId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndUserSuspensionRequestDto'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INSUFFICIENT_RIGHTS
              examples:
                Insufficient-rights:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS
                    message: >-
                      Your current authentication ({0}) does not have sufficient
                      rights to perform this operation.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:35.477055361Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                End-user-not-found:
                  value:
                    errorCode: END_USER_NOT_FOUND
                    message: End-user with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:35.475184457Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - END_USER_MUST_NOT_BE_SUSPENDED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:35.473052551Z'
  /api/partner/end-users/{endUserId}/close: {}
  /api/partner/documents:
    get:
      tags:
        - Documents
      summary: List documents
      description: |-
        List the documents for a specific end-user.

         The documents will be downloaded with a dedicated endpoint.
      operationId: documentList
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - TYPE
              - FRIENDLY_NAME
              - FILENAME
              - CREATION_DATE
        - name: endUserId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - ARTICLE_OF_ASSOCIATION
              - BANK_ACCOUNT_DETAILS
              - BANK_ACCOUNT_STATEMENT
              - COMPANY_INCORPORATION
              - COMPANY_REGISTRY_EXTRACT
              - DILIGENCE_REVIEW
              - DIRECT_DEBIT_MANDATE
              - DRIVING_LICENCE
              - FAMILY_RECORD_BOOK
              - HEALTH_INSURANCE
              - IDENTITY_CARD
              - INVOICE
              - KYC_SUMMARY
              - PASSPORT
              - PAYSLIP
              - POWER_OF_ATTORNEY
              - PROOF_OF_ADDRESS
              - RESIDENCE_PERMIT
              - RESUME
              - RISK_ASSESSMENT
              - SELFIE
              - SHAREHOLDING_STRUCTURE
              - SOURCE_OF_FUNDS
              - SOURCE_OF_WEALTH_DECLARATION
              - TAX_STATEMENT
              - TRANSACTION_RECEIPT
              - UBO_REGISTRY
              - VISA
              - OTHER
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - UPLOADED
                - REQUESTED
                - DECLINED
                - VALIDATED
        - name: requested
          in: query
          required: false
          schema:
            type: boolean
        - name: transactionId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: beneficiaryId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: corporateRelatedId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: addressId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoDocumentListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Documents
      summary: Upload a document
      description: |-
        Upload a document for a specific end-user. To prevent abuse:
        - File size must be less than 5MB.
        - There is a limit of files per end-user.
      operationId: documentCreate
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DocumentUploadRequestDto_Partner'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentUploadResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INVALID_FILE_FORMAT
                      - END_USER_NOT_FOUND
                      - FRIENDLY_NAME_ALREADY_TAKEN
                      - END_USER_ID_REQUIRED
                      - DOCUMENT_TRANSACTION_ID_MANDATORY
                      - TRANSACTION_NOT_FOUND
                      - BENEFICIARY_NOT_FOUND
                      - BENEFICIARY_END_USER_MISMATCH
                      - END_USER_TYPE_HAS_NO_CORPORATE_RELATED
                      - CORPORATE_RELATED_NOT_FOUND
                      - CORPORATE_RELATED_CORPORATE_MISMATCH
                      - ADDRESS_END_USER_MISMATCH
                      - DOCUMENT_ADDRESS_ID_MANDATORY
              examples:
                Invalid-file-format:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: 'File format is not valid. Expected format: {0}'
                    errorCode: INVALID_FILE_FORMAT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660530593Z'
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660536975Z'
                Friendly-name-already-taken:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: '{0} with this friendly name already exists.'
                    errorCode: FRIENDLY_NAME_ALREADY_TAKEN
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660550120Z'
                End-user-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Field endUserId is required when authenticated as {0}.
                    errorCode: END_USER_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660552590Z'
                Document-transaction-id-mandatory:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The transactionId field is mandatory in order to
                          upload a document of type TRANSACTION_RECEIPT.
                    errorCode: DOCUMENT_TRANSACTION_ID_MANDATORY
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660555174Z'
                Transaction-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Transaction with id {0} was not found.
                    errorCode: TRANSACTION_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660557519Z'
                Beneficiary-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Beneficiary with id {0} was not found.
                    errorCode: BENEFICIARY_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660559736Z'
                Beneficiary-end-user-mismatch:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The beneficiary is not linked to the specified
                          end-user.
                    errorCode: BENEFICIARY_END_USER_MISMATCH
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660561901Z'
                End-user-type-has-no-corporate-related:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user type {0} does not have a corporate related.
                    errorCode: END_USER_TYPE_HAS_NO_CORPORATE_RELATED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660564843Z'
                Corporate-related-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Corporate related with id {0} was not found.
                    errorCode: CORPORATE_RELATED_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660566770Z'
                Corporate-related-corporate-mismatch:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The corporate related is not linked to the specified
                          corporate end-user.
                    errorCode: CORPORATE_RELATED_CORPORATE_MISMATCH
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660605414Z'
                Address-end-user-mismatch:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The address is not linked to the specified end-user.
                    errorCode: ADDRESS_END_USER_MISMATCH
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660607705Z'
                Document-address-id-mandatory:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The addressId field is mandatory in order to upload a
                          document of type PROOF_OF_ADDRESS.
                    errorCode: DOCUMENT_ADDRESS_ID_MANDATORY
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.660609724Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - DOCUMENT_LIMIT_REACHED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Document-limit-reached:
                  value:
                    errorCode: DOCUMENT_LIMIT_REACHED
                    message: >-
                      You've reached the document limit for this end-user ({0}
                      documents max).
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.657063002Z'
  /api/partner/documents/requests:
    post:
      tags:
        - Documents
      summary: Create a document request
      description: >-
        Create a document request for an end-user so they can upload the
        required document.
      operationId: documentRequestCreate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DocumentRequestCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequestCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - TRANSACTION_NOT_FOUND
                      - DOCUMENT_TRANSACTION_ID_MANDATORY
                      - BENEFICIARY_NOT_FOUND
                      - BENEFICIARY_END_USER_MISMATCH
                      - END_USER_TYPE_HAS_NO_CORPORATE_RELATED
                      - CORPORATE_RELATED_NOT_FOUND
                      - CORPORATE_RELATED_CORPORATE_MISMATCH
                      - ADDRESS_END_USER_MISMATCH
                      - DOCUMENT_ADDRESS_ID_MANDATORY
              examples:
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751953959Z'
                Transaction-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Transaction with id {0} was not found.
                    errorCode: TRANSACTION_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751959655Z'
                Document-transaction-id-mandatory:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The transactionId field is mandatory in order to
                          upload a document of type TRANSACTION_RECEIPT.
                    errorCode: DOCUMENT_TRANSACTION_ID_MANDATORY
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751962315Z'
                Beneficiary-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Beneficiary with id {0} was not found.
                    errorCode: BENEFICIARY_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751964483Z'
                Beneficiary-end-user-mismatch:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The beneficiary is not linked to the specified
                          end-user.
                    errorCode: BENEFICIARY_END_USER_MISMATCH
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751966412Z'
                End-user-type-has-no-corporate-related:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user type {0} does not have a corporate related.
                    errorCode: END_USER_TYPE_HAS_NO_CORPORATE_RELATED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751969091Z'
                Corporate-related-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Corporate related with id {0} was not found.
                    errorCode: CORPORATE_RELATED_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751971097Z'
                Corporate-related-corporate-mismatch:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The corporate related is not linked to the specified
                          corporate end-user.
                    errorCode: CORPORATE_RELATED_CORPORATE_MISMATCH
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751973017Z'
                Address-end-user-mismatch:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The address is not linked to the specified end-user.
                    errorCode: ADDRESS_END_USER_MISMATCH
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751974864Z'
                Document-address-id-mandatory:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The addressId field is mandatory in order to upload a
                          document of type PROOF_OF_ADDRESS.
                    errorCode: DOCUMENT_ADDRESS_ID_MANDATORY
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.751976733Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/crypto/wallet:
    get:
      tags:
        - Wallet
      summary: List crypto wallets
      description: Fetch all crypto wallets based on parameters.
      operationId: list_4
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - CREATION_DATE
              - UPDATE_DATE
              - FRIENDLY_NAME
        - name: endUserId
          in: query
          description: >-
            The ID of the end-user. If empty, the query will return results for
            all end-users.
          required: false
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - PENDING
              - ACTIVE
              - CLOSED
              - FAILED
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoCryptoWalletListResponseElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - END_USER_ID_REQUIRED
              examples:
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:43:11.165559818Z'
                End-user-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Field endUserId is required when authenticated as {0}.
                    errorCode: END_USER_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:43:11.165563355Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Wallet
      summary: Create a wallet
      description: Create a crypto wallet.
      operationId: create_3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CryptoWalletCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoWalletCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/crypto/transactions:
    get:
      tags:
        - Crypto Transaction
      summary: List crypto transactions
      description: Fetch all crypto transactions.
      operationId: listCryptoTransactions
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - CREATION_DATE
        - name: endUserId
          in: query
          description: The id of the end-user who is transaction actor (sender / receiver)
          required: false
          schema:
            type: string
            format: uuid
        - name: walletId
          in: query
          description: Get transactions made from or to this wallet (walletFrom / walletTo)
          required: false
          schema:
            type: string
            format: uuid
        - name: blockchainTypes
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: Get transactions of these blockchain types
              enum:
                - BITCOIN
                - ETHEREUM
                - BNB_SMART_CHAIN
        - name: paymentTypes
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: Get transactions of these payment types
              enum:
                - TOKEN_SEND
                - TOKEN_RECEIVE
        - name: showDeclinedTransaction
          in: query
          description: Get transactions in DECLINED status, by default is true
          required: false
          schema:
            type: boolean
        - name: startDate
          in: query
          description: 'Get transactions from this date, example: 2022-05-16T10:30'
          required: false
          schema:
            type: string
            format: date-time
        - name: endDate
          in: query
          description: 'Get transactions until this date, example: 2022-05-16T10:30'
          required: false
          schema:
            type: string
            format: date-time
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: >-
                The transaction status. If empty, the query will return
                transactions for all transaction status.
              enum:
                - APPROVED
                - PENDING
                - DECLINED
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoCryptoTransactionResponseDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Crypto Transaction
      summary: Send tokens to a crypto beneficiary
      description: |-
        Send tokens to a crypto beneficiary.

        This operation might require **SCA**.
      operationId: createCryptoTransaction
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CryptoTransactionCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoTransactionCreateResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CRYPTO_WALLET_NOT_FOUND
                      - CRYPTO_BENEFICIARY_NOT_FOUND
              examples:
                Crypto-wallet-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Crypto wallet with id {0} was not found.
                    errorCode: CRYPTO_WALLET_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.964655760Z'
                Crypto-beneficiary-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Crypto beneficiary with id {0} was not found.
                    errorCode: CRYPTO_BENEFICIARY_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:36.964661116Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_KYC_MUST_BE_VALIDATED
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - TERMS_AND_CONDITIONS_NOT_ACCEPTED
                      - CRYPTO_WALLET_MUST_BE_ACTIVE
                      - CRYPTO_BENEFICIARY_MUST_BE_ACTIVE
                      - CRYPTO_BENEFICIARY_MUST_BE_VALID
                      - CRYPTO_BENEFICIARY_NOT_COMPATIBLE
                      - INVALID_ASSET
                      - INSUFFICIENT_WALLET_BALANCE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-kyc-must-be-validated:
                  value:
                    errorCode: CONSUMER_KYC_MUST_BE_VALIDATED
                    message: Consumer kyc must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961526539Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961531262Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961533663Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961535622Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961537867Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961540119Z'
                Terms-and-conditions-not-accepted:
                  value:
                    errorCode: TERMS_AND_CONDITIONS_NOT_ACCEPTED
                    message: >-
                      The {0} with id {1} has not accepted the latest terms and
                      conditions.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961542112Z'
                Crypto-wallet-must-be-active:
                  value:
                    errorCode: CRYPTO_WALLET_MUST_BE_ACTIVE
                    message: Crypto wallet must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961543948Z'
                Crypto-beneficiary-must-be-active:
                  value:
                    errorCode: CRYPTO_BENEFICIARY_MUST_BE_ACTIVE
                    message: Crypto beneficiary with id {0} must be active.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961545845Z'
                Crypto-beneficiary-must-be-valid:
                  value:
                    errorCode: CRYPTO_BENEFICIARY_MUST_BE_VALID
                    message: Crypto beneficiary with id {0} must be valid.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961547536Z'
                Crypto-beneficiary-not-compatible:
                  value:
                    errorCode: CRYPTO_BENEFICIARY_NOT_COMPATIBLE
                    message: >-
                      We can not send tokens to a {0} crypto beneficiary from
                      this crypto wallet ({1}).
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961549130Z'
                Invalid-asset:
                  value:
                    errorCode: INVALID_ASSET
                    message: Asset {0} is not compatible with wallet {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961550792Z'
                Insufficient-wallet-balance:
                  value:
                    errorCode: INSUFFICIENT_WALLET_BALANCE
                    message: >-
                      The current wallet balance is inferior to the requested
                      amount.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:36.961552584Z'
  /api/partner/crypto/beneficiaries:
    get:
      tags:
        - Crypto Beneficiary
      summary: List Crypto Beneficiaries
      description: Fetch all your crypto beneficiaries.
      operationId: listCryptoBeneficiaries
      parameters:
        - name: active
          in: query
          description: >-
            Show results with only active status or non active status. Both
            statuses are shown by default.
          required: false
          schema:
            type: boolean
        - name: display
          in: query
          description: >-
            Show only display or non display beneficiaries. Both statuses are
            shown by default.
          required: false
          schema:
            type: boolean
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - NAME
              - CREATION_DATE
        - name: endUserId
          in: query
          description: >-
            The ID of the end-user. If empty, the query will return results for
            all end-users.
          required: false
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - DECLINED
              - PENDING_REVIEW
              - VALID
              - PENDING
              - NEED_ADDITIONAL_INFORMATION
        - name: blockchainType
          in: query
          required: false
          schema:
            type: string
            enum:
              - BITCOIN
              - ETHEREUM
              - BNB_SMART_CHAIN
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoCryptoBeneficiaryResponseDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Crypto Beneficiary
      summary: Add a new crypto-beneficiary
      description: |-
        Create a crypto beneficiary in order to send digital assets.

        This operation might require **SCA**.
      operationId: createCryptoBeneficiary
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CryptoBeneficiaryCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoBeneficiaryCreateResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - END_USER_ID_REQUIRED
              examples:
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:37.165114031Z'
                End-user-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Field endUserId is required when authenticated as {0}.
                    errorCode: END_USER_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:37.165118683Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_KYC_MUST_BE_VALIDATED
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-kyc-must-be-validated:
                  value:
                    errorCode: CONSUMER_KYC_MUST_BE_VALIDATED
                    message: Consumer kyc must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:37.162205743Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:37.162211794Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:37.162214707Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:37.162217095Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:37.162219240Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:37.162221802Z'
  /api/partner/corporates:
    get:
      tags:
        - Corporate
      summary: List your corporates
      description: >-
        Fetch all your corporates. More options will be added in the near
        future.
      operationId: list_5
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - UPDATE_DATE
              - CREATION_DATE
        - name: registeredName
          in: query
          required: false
          schema:
            type: string
        - name: kybStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - NOT_STARTED
                - COMPLETING
                - PENDING_VERIFICATION
                - NEED_ADDITIONAL_INFORMATION
                - DECLINED
                - VALIDATED
        - name: bankingStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - VALIDATED
                - PENDING
                - MISSING_DATA
                - BLOCKED
                - NOT_CREATED
        - name: suspensionStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - SUSPENDED
                - NOT_SUSPENDED
        - name: linkcyStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - PENDING
                - FORBIDDEN
                - MISSING_DATA
                - VALIDATED
                - LIMITED
                - CLOSING
                - CLOSED
        - name: complianceStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - PENDING
                - DECLINED
                - PENDING_REVIEW
                - VALIDATED
        - name: overallStatus
          in: query
          required: false
          schema:
            type: string
            enum:
              - ACTIVE
              - INACTIVE
        - name: emailAddress
          in: query
          required: false
          schema:
            type: string
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoCorporateListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Corporate
      summary: Create a corporate
      description: Create a new Corporate End-User who will perform banking operations.
      operationId: create_4
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorporateCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorporateCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - TOO_LONG_FIELD
                      - INVALID_TERMS_VERSION
                      - TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                      - PARTNER_NAME_REQUIRED
              examples:
                Too-long-field:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          For the field {0}, the maximum allowed size is {1} but
                          the size was {2}.
                    errorCode: TOO_LONG_FIELD
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:39.072568899Z'
                Invalid-terms-version:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Terms version does not correspond to the latest.
                    errorCode: INVALID_TERMS_VERSION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:39.072599350Z'
                Total-shares-percentage-is-over-100:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The shares of this entity would cause its owned
                          corporate to exceed 100% of shares ({1}%).
                    errorCode: TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:39.072624443Z'
                Partner-name-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Partner name is mandatory if you request as anonymous.
                    errorCode: PARTNER_NAME_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:39.072640339Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - INCORPORATION_CODE_ALREADY_TAKEN
                      - ACCOUNT_OWNER_PHONE_ALREADY_TAKEN
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Incorporation-code-already-taken:
                  value:
                    errorCode: INCORPORATION_CODE_ALREADY_TAKEN
                    message: >-
                      A corporate with the same incorporation code ({0}) and
                      incorporation country ({1}) has already been registered.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:39.062900472Z'
                Account-owner-phone-already-taken:
                  value:
                    errorCode: ACCOUNT_OWNER_PHONE_ALREADY_TAKEN
                    message: >-
                      A corporate account owner with phone +{0} {1} already
                      exists.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:39.062915214Z'
      security:
        - {}
        - Linkcy-Auth: []
  /api/partner/corporates/{corporateId}/related:
    post:
      tags:
        - KYB
      summary: Declare a corporate-related entity (person or corporate)
      description: >-
        Add a person or corporate-related to the current corporate who may be
        the account owner, a director or a UBO (shareholder with 25%+ shares
        (10% if the corporate required extended UBOs)).


        Adding all the directors and UBOs of the corporate is a mandatory step
        to complete the KYB and access all banking features.


        After adding a corporate-related person, you must provide them with a
        [KYC link](/tag/KYC#operation/createKyc).
      operationId: create_5
      parameters:
        - name: corporateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorporateRelatedCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorporateRelatedCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - >-
                        CORPORATE_RELATED_CORPORATE_MUST_BE_SHAREHOLDER_OR_DIRECTOR
                      - OWNED_CORPORATE_NOT_FOUND
                      - TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                      - MORE_THAN_ONE_SHARE_BY_OWNED_CORPORATE
              examples:
                Corporate-related-corporate-must-be-shareholder-or-director:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          To be added as a corporate-related entity, a corporate
                          must be a shareholder or a director.
                    errorCode: >-
                      CORPORATE_RELATED_CORPORATE_MUST_BE_SHAREHOLDER_OR_DIRECTOR
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.274230448Z'
                Owned-corporate-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Owned corporate with id {0} was not found.
                    errorCode: OWNED_CORPORATE_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.274237393Z'
                Total-shares-percentage-is-over-100:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The shares of this entity would cause its owned
                          corporate to exceed 100% of shares ({1}%).
                    errorCode: TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.274240659Z'
                More-than-one-share-by-owned-corporate:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          There can be only one share's information by owned
                          corporate and related corporate.
                    errorCode: MORE_THAN_ONE_SHARE_BY_OWNED_CORPORATE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.274243493Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:40.275954922Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_RELATED_CORPORATE_ALREADY_ADDED
                      - KYB_STATUS_MUST_NOT_BE_DECLINED
                      - UBO_ALREADY_EXISTING
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-related-corporate-already-added:
                  value:
                    errorCode: CORPORATE_RELATED_CORPORATE_ALREADY_ADDED
                    message: >-
                      A corporate-related corporate with the same incorporation
                      code ({0}) and incorporation country ({1}) has already
                      been added for this corporate.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.270495367Z'
                Kyb-status-must-not-be-declined:
                  value:
                    errorCode: KYB_STATUS_MUST_NOT_BE_DECLINED
                    message: >-
                      The current KYB status ({0}) of corporate with id {1} does
                      not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.270500503Z'
                Ubo-already-existing:
                  value:
                    errorCode: UBO_ALREADY_EXISTING
                    message: >-
                      You cannot add a special UBO because there is already a
                      UBO for corporate with id {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.270502821Z'
  /api/partner/corporates/{corporateId}/kyb/verification/ask:
    post:
      tags:
        - KYB
      summary: Ask a KYB verification
      description: >-
        This endpoint allows you to ask a KYB verification for a Corporate
        End-User.


        In order to use this endpoint, all its UBOs and directors must have been
        [declared](#operation/addRelated) and have completed a validated [KYC
        application](/tag/KYC#operation/createKycLink).


        After using this endpoint, a Linkcy compliance officer will verify the
        information provided and update the KYB status to one of the following
        values:

         - VALIDATED -> this corporate is now authorized to access Linkcy's banking features.

         - NEED_ADDITIONAL_INFORMATION -> Additional information is needed to validate this corporate. The description of the requested information will be displayed in the kybStatusReason field.

         - DECLINED -> this corporate violates compliance rules and is not authorized to use Linkcy's banking features.
      operationId: askKybVerification
      parameters:
        - name: corporateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: The KYB verification request was sent successfully
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:40.355871463Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/consumers:
    get:
      tags:
        - Consumer
      summary: List consumers
      description: >-
        Fetch all your consumer end-users. More options will be added in the
        near future.
      operationId: list_7
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - UPDATE_DATE
              - LAST_NAME
              - CREATION_DATE
        - name: lastName
          in: query
          required: false
          schema:
            type: string
        - name: phone
          in: query
          required: false
          schema:
            type: string
        - name: emailAddress
          in: query
          required: false
          schema:
            type: string
        - name: kycStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - NOT_STARTED
                - CREATED
                - PROCESSING
                - ABORTED
                - PENDING_REVIEW
                - VALIDATED
                - DECLINED
        - name: bankingStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - VALIDATED
                - PENDING
                - MISSING_DATA
                - BLOCKED
                - NOT_CREATED
        - name: suspensionStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - SUSPENDED
                - NOT_SUSPENDED
        - name: linkcyStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - PENDING
                - FORBIDDEN
                - MISSING_DATA
                - VALIDATED
                - LIMITED
                - CLOSING
                - CLOSED
        - name: complianceStatus
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - PENDING
                - DECLINED
                - PENDING_REVIEW
                - VALIDATED
        - name: overallStatus
          in: query
          required: false
          schema:
            type: string
            enum:
              - ACTIVE
              - INACTIVE
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoConsumerListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Consumer
      summary: Create a consumer
      description: >-
        This is the first step to create an Individual consumer. Phone object is
        mandatory to be able to go on to the next steps. You can add optional
        fields, this will help us to manage compliance triggers.


        Only a few pieces of information are asked here, most of it will be
        extracted from documents during the KYC process. By doing the Endpoint:
        Get Consumer information, you will get access to all data.


        You cannot create two consumers with the same phone number. Phone
        numbers must be unique.
      operationId: create_6
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsumerCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - TOO_LONG_FIELD
                      - INVALID_TERMS_VERSION
                      - OTHER_OCCUPATION_MUST_HAVE_A_DESCRIPTION
                      - OTHER_SOURCE_OF_FUNDS_MUST_HAVE_A_DESCRIPTION
                      - TAX_IDENTIFICATION_NUMBER_MUST_HAVE_A_COUNTRY
              examples:
                Too-long-field:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          For the field {0}, the maximum allowed size is {1} but
                          the size was {2}.
                    errorCode: TOO_LONG_FIELD
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.554213015Z'
                Invalid-terms-version:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Terms version does not correspond to the latest.
                    errorCode: INVALID_TERMS_VERSION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.554216275Z'
                Other-occupation-must-have-a-description:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The chosen occupation is 'OTHER' but no description
                          was specified.
                    errorCode: OTHER_OCCUPATION_MUST_HAVE_A_DESCRIPTION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.554218296Z'
                Other-source-of-funds-must-have-a-description:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The chosen source of funds is 'OTHER' but no
                          description was specified.
                    errorCode: OTHER_SOURCE_OF_FUNDS_MUST_HAVE_A_DESCRIPTION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.554220087Z'
                Tax-identification-number-must-have-a-country:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The tax identification number must have a country.
                    errorCode: TAX_IDENTIFICATION_NUMBER_MUST_HAVE_A_COUNTRY
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:40.554221378Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PHONE_ALREADY_TAKEN
                      - PARTNER_NAME_REQUIRED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Phone-already-taken:
                  value:
                    errorCode: PHONE_ALREADY_TAKEN
                    message: A consumer with this phone already exists.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.480174526Z'
                Partner-name-required:
                  value:
                    errorCode: PARTNER_NAME_REQUIRED
                    message: Partner name is mandatory if you request as anonymous.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.480176441Z'
      security:
        - {}
        - Linkcy-Auth: []
  /api/partner/cards:
    get:
      tags:
        - Card
      summary: List cards
      description: >-
        Fetch all cards based on parameters. More options will be added in the
        near future.
      operationId: list_8
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - CREATION_DATE
        - name: endUserId
          in: query
          description: >-
            The ID of the end-user. If empty, the query will return results for
            all end-users.
          required: false
          schema:
            type: string
            format: uuid
        - name: ledgerId
          in: query
          description: >-
            The ID of the card ledger. If empty, the query will return cards for
            all ledgers.
          required: false
          schema:
            type: string
            format: uuid
        - name: profileId
          in: query
          description: >-
            The ID of the card profile. If empty, the query will return cards
            for all profiles.
          required: false
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: >-
                The card status. If empty, the query will return cards for all
                card status.
              enum:
                - CREATING
                - AWAITING_ACTIVATION
                - ACTIVATING
                - REACTIVATING
                - ACTIVE
                - SUSPENDING
                - SUSPENDED
                - CLOSING
                - CLOSED
                - EXPIRED
                - FAILED
        - name: types
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: >-
                The card types. If empty, the query will return cards for all
                card types.
              enum:
                - PHYSICAL
                - VIRTUAL
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponseDtoCardListElementDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_NOT_FOUND
              examples:
                Consumer-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Consumer with id {0} was not found.
                    errorCode: CONSUMER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:43:21.569204106Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Card
      summary: Create a card
      description: >-
        Create a card for a specific ledger.


        Please note: when creating the first card of a ledger, if the specified
        ledger is not empty, we will have to empty it briefly in order to
        configure the card.The money will be back in the ledger within a few
        seconds.


        This operation might require **SCA**.
      operationId: create_7
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardCreateResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                      - CARD_PROFILE_NOT_ACTIVE
                      - CARD_PROFILE_NOT_FOUND
                      - CARD_PROGRAM_NOT_COMPATIBLE_END_USER
                      - DELIVERY_METHOD_REQUIRED
                      - FRIENDLY_NAME_ALREADY_TAKEN
                      - CARD_RULE_NOT_UNIQUE
                      - INVALID_DELIVERY_METHOD
                      - CARD_ORDER_NOT_COMPATIBLE_PROGRAM
              examples:
                Ledger-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Ledger with id {0} was not found.
                    errorCode: LEDGER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754012388Z'
                Card-profile-not-active:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: No active card profile with id {0} was found.
                    errorCode: CARD_PROFILE_NOT_ACTIVE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754018501Z'
                Card-profile-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Card profile with id {0} was not found.
                    errorCode: CARD_PROFILE_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754020122Z'
                Card-program-not-compatible-end-user:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          This card program is not compatible with this type of
                          user. Required {0}, got {1}.
                    errorCode: CARD_PROGRAM_NOT_COMPATIBLE_END_USER
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754022032Z'
                Delivery-method-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          A delivery method is required to create a physical
                          card.
                    errorCode: DELIVERY_METHOD_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754023429Z'
                Friendly-name-already-taken:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: '{0} with this friendly name already exists.'
                    errorCode: FRIENDLY_NAME_ALREADY_TAKEN
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754024760Z'
                Card-rule-not-unique:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Can not add two card rules of the same type.
                    errorCode: CARD_RULE_NOT_UNIQUE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754025879Z'
                Invalid-delivery-method:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          Delivery method {0} is not valid with address country
                          {1}.
                    errorCode: INVALID_DELIVERY_METHOD
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754027175Z'
                Card-order-not-compatible-program:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          This card order contains a corporate name on card,
                          which is not compatible with this type of program
                          ({0}).
                    errorCode: CARD_ORDER_NOT_COMPATIBLE_PROGRAM
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.754028526Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_KYC_MUST_BE_VALIDATED
                      - CARD_PROFILE_NOT_COMPATIBLE_PARTNER
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - CARD_PROGRAM_NOT_COMPATIBLE_LEDGER
                      - CARD_PROGRAM_NOT_COMPATIBLE_END_USER
                      - TERMS_AND_CONDITIONS_NOT_ACCEPTED
                      - LEDGER_MUST_BE_ACTIVE
                      - INVALID_CARD_PROGRAM_TYPE
                      - LEDGER_MUST_NOT_BE_SUSPENDED
                      - LEDGER_MUST_NOT_BE_VIRTUAL
                      - INVALID_CARD_PROGRAM_COUNTRY
                      - UNSUPPORTED_DELIVERY_METHOD
                      - RESERVED_BALANCE_MUST_BE_EMPTY_WHEN_CREATING_FIRST_CARD
                      - OTHER_CARD_BEING_CREATED_FOR_SAME_LEDGER
                      - CARD_MUST_BE_ACTIVE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-kyc-must-be-validated:
                  value:
                    errorCode: CONSUMER_KYC_MUST_BE_VALIDATED
                    message: Consumer kyc must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965161178Z'
                Card-profile-not-compatible-partner:
                  value:
                    errorCode: CARD_PROFILE_NOT_COMPATIBLE_PARTNER
                    message: >-
                      This card profile partner is not compatible with this
                      partner {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965172380Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965184780Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965197578Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965212937Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965250221Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965265101Z'
                Card-program-not-compatible-ledger:
                  value:
                    errorCode: CARD_PROGRAM_NOT_COMPATIBLE_LEDGER
                    message: This card program can not handle ledger type {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965279820Z'
                Card-program-not-compatible-end-user:
                  value:
                    errorCode: CARD_PROGRAM_NOT_COMPATIBLE_END_USER
                    message: >-
                      This card program is not compatible with this type of
                      user. Required {0}, got {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965295200Z'
                Terms-and-conditions-not-accepted:
                  value:
                    errorCode: TERMS_AND_CONDITIONS_NOT_ACCEPTED
                    message: >-
                      The {0} with id {1} has not accepted the latest terms and
                      conditions.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965309793Z'
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965330104Z'
                Invalid-card-program-type:
                  value:
                    errorCode: INVALID_CARD_PROGRAM_TYPE
                    message: >-
                      Unable to create card of type {0} with card program of
                      type {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965352609Z'
                Ledger-must-not-be-suspended:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_SUSPENDED
                    message: Ledger must not be suspended to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965363895Z'
                Ledger-must-not-be-virtual:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_VIRTUAL
                    message: Ledger must not be virtual to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965372794Z'
                Invalid-card-program-country:
                  value:
                    errorCode: INVALID_CARD_PROGRAM_COUNTRY
                    message: >-
                      Unable to create card for this delivery country, program
                      supported countries: {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965384698Z'
                Unsupported-delivery-method:
                  value:
                    errorCode: UNSUPPORTED_DELIVERY_METHOD
                    message: >-
                      Delivery method {0} is not supported with the current
                      partner configuration.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965397530Z'
                Reserved-balance-must-be-empty-when-creating-first-card:
                  value:
                    errorCode: RESERVED_BALANCE_MUST_BE_EMPTY_WHEN_CREATING_FIRST_CARD
                    message: >-
                      In order to create the first card, the ledger reserved
                      balance must be zero.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965411405Z'
                Other-card-being-created-for-same-ledger:
                  value:
                    errorCode: OTHER_CARD_BEING_CREATED_FOR_SAME_LEDGER
                    message: >-
                      A card is already being created for this ledger (card with
                      id {0}). Only one card can be created at a time for the
                      same ledger.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965426131Z'
                Card-must-be-active:
                  value:
                    errorCode: CARD_MUST_BE_ACTIVE
                    message: >-
                      Card with id {0} must be active in order to perform this
                      operation. Current card status is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:40.965439560Z'
  /api/partner/cards/{cardId}/suspend:
    post:
      tags:
        - Card
      summary: Suspend a card
      description: >-
        Suspend a card, all transactions on it will be blocked until it is
        reactivated.
      operationId: suspend_1
      parameters:
        - name: cardId
          in: path
          description: The card id
          required: true
          schema:
            type: string
            description: The card id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardSuspendRequestDto'
        required: true
      responses:
        '204':
          description: Card is being suspended
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - OTHER_STATUS_REASON_MUST_HAVE_A_DESCRIPTION
              examples:
                Other-status-reason-must-have-a-description:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The chosen closure reason is 'OTHER' but no
                          description was specified.
                    errorCode: OTHER_STATUS_REASON_MUST_HAVE_A_DESCRIPTION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.778974502Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:41.780511534Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_MUST_BE_ACTIVE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-must-be-active:
                  value:
                    errorCode: CARD_MUST_BE_ACTIVE
                    message: >-
                      Card with id {0} must be active in order to perform this
                      operation. Current card status is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.776059817Z'
  /api/partner/cards/{cardId}/pin/reset:
    post:
      tags:
        - Card
      summary: Reset physical card's PIN attempts
      description: |-
        Reset the number of PIN attempts for a physical card.

        This operation might require **SCA**.
      operationId: resetPinAttempts
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      responses:
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '204':
          description: Card PIN attempts are being reset
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:41.860250478Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_MUST_BE_ACTIVE
                      - CARD_MUST_BE_PHYSICAL
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-must-be-active:
                  value:
                    errorCode: CARD_MUST_BE_ACTIVE
                    message: >-
                      Card with id {0} must be active in order to perform this
                      operation. Current card status is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.857368889Z'
                Card-must-be-physical:
                  value:
                    errorCode: CARD_MUST_BE_PHYSICAL
                    message: >-
                      Card with id {0} must be physical in order to realize this
                      operation. Card type is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.857370070Z'
  /api/partner/cards/{cardId}/close:
    post:
      tags:
        - Card
      summary: Close a card
      description: Permanently close a card.
      operationId: close_2
      parameters:
        - name: cardId
          in: path
          description: The card id
          required: true
          schema:
            type: string
            description: The card id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardCloseRequestDto'
        required: true
      responses:
        '204':
          description: Card is being closed
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:41.961809393Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/cards/{cardId}/activate:
    post:
      tags:
        - Card
      summary: Activate a card
      description: >-
        When activating a card for the first time, you must retrieve its
        truncated PAN from the end-user. In Sandbox, you can retrieve the PAN
        [here](/tag/Sandbox#operation/truncatedPan).
      operationId: activate
      parameters:
        - name: cardId
          in: path
          description: The card id
          required: true
          schema:
            type: string
            description: The card id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardActivateRequestDto'
        required: true
      responses:
        '204':
          description: Card is being activated
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INVALID_PAN
              examples:
                Invalid-pan:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The given pan does not correspond to the card
                          truncated PAN.
                    errorCode: INVALID_PAN
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:41.973127112Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:42.053588346Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_MUST_BE_SUSPENDED_OR_AWAITING_ACTIVATION
                      - INSUFFICIENT_RIGHTS
                      - INVALID_PAN
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-must-be-suspended-or-awaiting-activation:
                  value:
                    errorCode: CARD_MUST_BE_SUSPENDED_OR_AWAITING_ACTIVATION
                    message: >-
                      Card with id {0} must be suspended or awaiting activation
                      in order to be activated. Current card status is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.970291604Z'
                Insufficient-rights:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS
                    message: >-
                      Your current authentication ({0}) does not have sufficient
                      rights to perform this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.970293588Z'
                Invalid-pan:
                  value:
                    errorCode: INVALID_PAN
                    message: >-
                      The given pan does not correspond to the card truncated
                      PAN.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.970294340Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.970295282Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.970296074Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.970296960Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:41.970297770Z'
  /api/partner/card-profiles:
    get:
      tags:
        - Card
      summary: List card profiles
      description: Fetch all card profiles based on parameters.
      operationId: list_9
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - NAME
        - name: userTypes
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              description: >-
                Show results with only active status or non active status. Both
                statuses are shown by default.


                If connected as end-user, this property has no effect and only
                active card profiles will be shown.
              enum:
                - CORPORATE
                - CONSUMER
        - name: ledgerTypes
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - EUR_BELGIUM
                - EUR_FRANCE
                - EUR_ESTONIA
                - EUR_LITHUANIA
                - USD_USA
                - GBP_GREAT_BRITAIN
                - EUR_BG
        - name: cardTypes
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - PHYSICAL
                - VIRTUAL
        - name: active
          in: query
          required: false
          schema:
            type: boolean
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListResponseDtoCardProfileListElementDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Card
      summary: Create a card profile
      description: Create a card profile based on a card design.
      operationId: create_8
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardProfileCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardProfileCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CARD_DESIGN_NOT_FOUND
              examples:
                Card-design-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Card design with id {0} was not found.
                    errorCode: CARD_DESIGN_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:42.163816812Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/beneficiaries:
    get:
      tags:
        - Beneficiary
      summary: List Beneficiaries
      description: Fetch all your beneficiaries.
      operationId: list_11
      parameters:
        - name: endUserId
          in: query
          description: >-
            The ID of the end-user. If empty, the query will return results for
            all end-users.
          required: false
          schema:
            type: string
            format: uuid
        - name: name
          in: query
          description: >-
            The name of the beneficiary. If empty, the query will return results
            for all beneficiaries.
          required: false
          schema:
            type: string
        - name: iban
          in: query
          description: >-
            The IBAN of the beneficiary. If empty, the query will return results
            for all beneficiaries.
          required: false
          schema:
            type: string
        - name: status
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - DECLINED
                - PENDING_REVIEW
                - VALID
                - PENDING
                - NEED_ADDITIONAL_INFORMATION
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - NAME
              - CREATION_DATE
        - name: display
          in: query
          description: >-
            Show only display or non display beneficiaries. Both statuses are
            shown by default.
          required: false
          schema:
            type: boolean
        - name: active
          in: query
          description: >-
            Show results with only active status or non active status. Both
            statuses are shown by default.
          required: false
          schema:
            type: boolean
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoBeneficiaryListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Beneficiary
      summary: Add a new beneficiary
      description: >-
        Beneficiaries are the one who will receive funds. When you add a
        beneficiary, the consumer must use the exact full name. If he adds as a
        beneficiary one of his own accounts, we must be able to detect it. It
        will simplify Strong Customer Authentication (SCA) during a transfer.


        You must fill one of the beneficiary types. BIC / SWIFT code is only
        required for IBAN. If you want to simplify transfers later, we suggest
        you add a SWIFT code for US and UK beneficiaries.


        This operation might require **SCA**.
      operationId: create_9
      parameters:
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficiaryCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryCreateResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                      - END_USER_ID_REQUIRED
                      - IBAN_NOT_SUPPORTED
                      - INVALID_BIC_SWIFT
                      - NOT_ALLOWED_BIC_SWIFT
              examples:
                End-user-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: End-user with id {0} was not found.
                    errorCode: END_USER_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:42.356528887Z'
                End-user-id-required:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Field endUserId is required when authenticated as {0}.
                    errorCode: END_USER_ID_REQUIRED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:42.356531680Z'
                Iban-not-supported:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Iban from {0} are not supported.
                    errorCode: IBAN_NOT_SUPPORTED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:42.356532930Z'
                Invalid-bic-swift:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Bic or Swift is invalid.
                    errorCode: INVALID_BIC_SWIFT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:42.356534087Z'
                Not-allowed-bic-swift:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: This bic or swift is not allowed at Linkcy.
                    errorCode: NOT_ALLOWED_BIC_SWIFT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:42.356535335Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_KYC_MUST_BE_VALIDATED
                      - CORPORATE_KYB_MUST_BE_VALIDATED
                      - LINKCY_STATUS_MUST_BE_VALIDATED
                      - END_USER_MUST_NOT_BE_SUSPENDED
                      - BANKING_STATUS_MUST_BE_VALIDATED
                      - COMPLIANCE_STATUS_MUST_BE_VALIDATED
                      - BENEFICIARY_ALREADY_EXISTS
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-kyc-must-be-validated:
                  value:
                    errorCode: CONSUMER_KYC_MUST_BE_VALIDATED
                    message: Consumer kyc must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:42.273446671Z'
                Corporate-kyb-must-be-validated:
                  value:
                    errorCode: CORPORATE_KYB_MUST_BE_VALIDATED
                    message: Corporate kyb must be validated.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:42.273447916Z'
                Linkcy-status-must-be-validated:
                  value:
                    errorCode: LINKCY_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current linkcy status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:42.273448669Z'
                End-user-must-not-be-suspended:
                  value:
                    errorCode: END_USER_MUST_NOT_BE_SUSPENDED
                    message: >-
                      End-user (with id {0}) must not be suspended to do this
                      operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:42.273449418Z'
                Banking-status-must-be-validated:
                  value:
                    errorCode: BANKING_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current banking status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:42.273450114Z'
                Compliance-status-must-be-validated:
                  value:
                    errorCode: COMPLIANCE_STATUS_MUST_BE_VALIDATED
                    message: >-
                      The current compliance status ({0}) of current end-user
                      (id={1}) does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:42.273451287Z'
                Beneficiary-already-exists:
                  value:
                    errorCode: BENEFICIARY_ALREADY_EXISTS
                    message: 'Beneficiary for this consumer already exists with id: {0}.'
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:42.273451988Z'
  /api/partner/acquiring/payment:
    post:
      tags:
        - Acquiring
      summary: Start an acquiring for a payment
      description: >-
        Initiate an acquiring transaction for a payment. For testing purposes,
        use the following fake cards: [Testing
        cards](https://linkcy.io/content/uploads/2024/03/Test_cards_acquiring_partners.pdf) 
      operationId: createPayment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentAcquiringRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcquiringCreationResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - PAYMENT_AMOUNT_MUST_NOT_BE_ZERO
              examples:
                Payment-amount-must-not-be-zero:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Payment amount should be greater than zero.
                    errorCode: PAYMENT_AMOUNT_MUST_NOT_BE_ZERO
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:43.657728530Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - EXTERNAL_CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                External-card-not-found:
                  value:
                    errorCode: EXTERNAL_CARD_NOT_FOUND
                    message: External card with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:43.658859450Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - RECURRING_MID_MUST_BE_SET
                      - EXTERNAL_CARD_MUST_BELONG_TO_END_USER
                      - EXTERNAL_CARD_EXPIRED
                      - ACQUIRING_TRANSACTION_COULD_NOT_BE_RESOLVED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Recurring-mid-must-be-set:
                  value:
                    errorCode: RECURRING_MID_MUST_BE_SET
                    message: >-
                      Recurring merchant id must be set in order to proceed with
                      direct payment or direct account load
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.654435032Z'
                External-card-must-belong-to-end-user:
                  value:
                    errorCode: EXTERNAL_CARD_MUST_BELONG_TO_END_USER
                    message: External card must belong to end-user.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.654436874Z'
                External-card-expired:
                  value:
                    errorCode: EXTERNAL_CARD_EXPIRED
                    message: External card must not be expired.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.654437730Z'
                Acquiring-transaction-could-not-be-resolved:
                  value:
                    errorCode: ACQUIRING_TRANSACTION_COULD_NOT_BE_RESOLVED
                    message: Acquiring transaction could not be resolved
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.654438681Z'
  /api/partner/acquiring/account-load:
    post:
      tags:
        - Acquiring
      summary: Start an acquiring for a top-up
      description: >-
        Initiate an acquiring transaction for an account load. For testing
        purposes, use the following fake cards: [Testing
        cards](https://linkcy.io/content/uploads/2024/03/Test_cards_acquiring_partners.pdf) 
      operationId: createAccountLoad
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountLoadAcquiringRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcquiringCreationResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - EXTERNAL_CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                External-card-not-found:
                  value:
                    errorCode: EXTERNAL_CARD_NOT_FOUND
                    message: External card with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:43.754499751Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_MUST_BE_ACTIVE
                      - LEDGER_MUST_BE_PROVISIONED
                      - LEDGER_MUST_NOT_BE_SUSPENDED
                      - LEDGER_MUST_NOT_BE_VIRTUAL
                      - ACCOUNT_LOAD_LEDGER_NOT_FOUND
                      - ACCOUNT_LOAD_INCORRECT_AMOUNT
                      - RECURRING_MID_MUST_BE_SET
                      - EXTERNAL_CARD_MUST_BELONG_TO_END_USER
                      - EXTERNAL_CARD_EXPIRED
                      - ACQUIRING_TRANSACTION_COULD_NOT_BE_RESOLVED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751582408Z'
                Ledger-must-be-provisioned:
                  value:
                    errorCode: LEDGER_MUST_BE_PROVISIONED
                    message: Ledger must be provisioned to perform this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751583938Z'
                Ledger-must-not-be-suspended:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_SUSPENDED
                    message: Ledger must not be suspended to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751585029Z'
                Ledger-must-not-be-virtual:
                  value:
                    errorCode: LEDGER_MUST_NOT_BE_VIRTUAL
                    message: Ledger must not be virtual to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751585853Z'
                Account-load-ledger-not-found:
                  value:
                    errorCode: ACCOUNT_LOAD_LEDGER_NOT_FOUND
                    message: Account Load Ledger not found for acquiring transaction.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751586721Z'
                Account-load-incorrect-amount:
                  value:
                    errorCode: ACCOUNT_LOAD_INCORRECT_AMOUNT
                    message: Account Load amount should be between {0} and {1} ({2}).
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751587530Z'
                Recurring-mid-must-be-set:
                  value:
                    errorCode: RECURRING_MID_MUST_BE_SET
                    message: >-
                      Recurring merchant id must be set in order to proceed with
                      direct payment or direct account load
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751588375Z'
                External-card-must-belong-to-end-user:
                  value:
                    errorCode: EXTERNAL_CARD_MUST_BELONG_TO_END_USER
                    message: External card must belong to end-user.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751589806Z'
                External-card-expired:
                  value:
                    errorCode: EXTERNAL_CARD_EXPIRED
                    message: External card must not be expired.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751590616Z'
                Acquiring-transaction-could-not-be-resolved:
                  value:
                    errorCode: ACQUIRING_TRANSACTION_COULD_NOT_BE_RESOLVED
                    message: Acquiring transaction could not be resolved
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.751591715Z'
  /api/partner/accounts:
    get:
      tags:
        - Partner
      summary: List user accounts
      description: List all user accounts of the specified partner.
      operationId: listAccounts
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - EMAIL
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoPartnerUserAccountListElementDto
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    post:
      tags:
        - Partner
      summary: Create user account
      description: Create a partner user account.
      operationId: createAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountCreateRequestDto'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerUserAccountCreateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - ROLE_NOT_ALLOWED
              examples:
                Role-not-allowed:
                  value:
                    errorCode: ROLE_NOT_ALLOWED
                    message: 'Can not set a role you dont have: {0}'
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:43.778840015Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - EMAIL_ALREADY_TAKEN
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Email-already-taken:
                  value:
                    errorCode: EMAIL_ALREADY_TAKEN
                    message: Username is already taken
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:43.777319519Z'
  /api/internal/transactions: {}
  /api/internal/transactions/inter-ledger: {}
  /api/internal/transactions/direct-debit: {}
  /api/internal/passwords/change: {}
  /api/internal/partners: {}
  /api/internal/login: {}
  /api/internal/ledgers/{ledgerId}/upgrade: {}
  /api/internal/ledgers/{ledgerId}/suspensions: {}
  /api/internal/ledgers/{ledgerId}/close: {}
  /api/internal/end-users/{endUserId}/onboardings: {}
  /api/internal/documents: {}
  /api/internal/card-programs: {}
  /api/internal/card-designs: {}
  /api/internal/acquiring/transactions: {}
  /api/partner:
    get:
      tags:
        - Partner
      summary: Get your information
      description: Get your configuration information as partner.
      operationId: info
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Partner
      summary: Update your information
      description: Update your configuration information as Partner.
      operationId: update_3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerUpdateRequestDto_Partner'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerUpdateResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INVALID_OTP_MESSAGE
              examples:
                Invalid-otp-message:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The OTP message must contain the following string to
                          put the OTP secret: $otp
                    errorCode: INVALID_OTP_MESSAGE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:47.356221617Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/shares/{shareId}:
    get:
      tags:
        - KYB
      summary: Get share's information
      description: Get all information of a specific share.
      operationId: info_2
      parameters:
        - name: shareId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareInfoResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SHARE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Share-not-found:
                  value:
                    errorCode: SHARE_NOT_FOUND
                    message: Share with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:03.456308945Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    delete:
      tags:
        - KYB
      summary: Delete a share
      description: Delete a corporate-related share.
      operationId: delete
      parameters:
        - name: shareId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SHARE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Share-not-found:
                  value:
                    errorCode: SHARE_NOT_FOUND
                    message: Share with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:43.370609746Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - KYB
      summary: Update a share
      description: Update information of a corporate-related share.
      operationId: update_4
      parameters:
        - name: shareId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareUpdateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                      - SHARE_PERCENTAGE_EQUALS_ZERO
              examples:
                Total-shares-percentage-is-over-100:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The shares of this entity would cause its owned
                          corporate to exceed 100% of shares ({1}%).
                    errorCode: TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:47.461721851Z'
                Share-percentage-equals-zero:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The share percentage can not be zero.
                    errorCode: SHARE_PERCENTAGE_EQUALS_ZERO
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:47.461752924Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SHARE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Share-not-found:
                  value:
                    errorCode: SHARE_NOT_FOUND
                    message: Share with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:47.466050604Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/mandates/{mandateId}:
    get:
      tags:
        - Direct Debit Mandate
      summary: Get a direct debit mandate information
      description: Get all information about a direct debit mandate using its ID.
      operationId: getMandate
      parameters:
        - name: mandateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitMandateInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - MANDATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Mandate-not-found:
                  value:
                    errorCode: MANDATE_NOT_FOUND
                    message: Direct debit mandate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:04.674608339Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Direct Debit Mandate
      summary: Update a direct debit mandate
      description: Update an existing direct debit mandate.
      operationId: updateMandate
      parameters:
        - name: mandateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DirectDebitMandateUpdateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectDebitMandateUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - IBAN_NOT_SUPPORTED
                      - INVALID_BIC_SWIFT
                      - NOT_ALLOWED_BIC_SWIFT
                      - INVALID_EXPIRATION_DATE
              examples:
                Iban-not-supported:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Iban from {0} are not supported.
                    errorCode: IBAN_NOT_SUPPORTED
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:48.386673305Z'
                Invalid-bic-swift:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Bic or Swift is invalid.
                    errorCode: INVALID_BIC_SWIFT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:48.386677995Z'
                Not-allowed-bic-swift:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: This bic or swift is not allowed at Linkcy.
                    errorCode: NOT_ALLOWED_BIC_SWIFT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:48.386679537Z'
                Invalid-expiration-date:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The expiration date must be after {0} and before {1}.
                    errorCode: INVALID_EXPIRATION_DATE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:48.386697482Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - MANDATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Mandate-not-found:
                  value:
                    errorCode: MANDATE_NOT_FOUND
                    message: Direct debit mandate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:48.388002855Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONFLICTING_MANDATE_STATUS
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Conflicting-mandate-status:
                  value:
                    errorCode: CONFLICTING_MANDATE_STATUS
                    message: >-
                      The current status of the mandate ({0}) does not allow
                      this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.383519632Z'
  /api/partner/ledgers/{ledgerId}:
    get:
      tags:
        - Ledger
      summary: Get information on a ledger
      description: Get all information about a ledger using its ID.
      operationId: info_3
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LedgerResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-not-found:
                  value:
                    errorCode: LEDGER_NOT_FOUND
                    message: Ledger with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:05.973101457Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Ledger
      summary: Update a ledger
      description: You can patch a ledger to update some information.
      operationId: update_5
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LedgerUpdateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LedgerUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-not-found:
                  value:
                    errorCode: LEDGER_NOT_FOUND
                    message: Ledger with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:48.458406877Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/crypto/beneficiaries/{cryptoBeneficiaryId}:
    get:
      tags:
        - Crypto Beneficiary
      summary: Get Information on a Crypto Beneficiary
      description: Get information on a crypto beneficiary.
      operationId: getCryptoBeneficiaryInfo
      parameters:
        - name: cryptoBeneficiaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoBeneficiaryResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CRYPTO_BENEFICIARY_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Crypto-beneficiary-not-found:
                  value:
                    errorCode: CRYPTO_BENEFICIARY_NOT_FOUND
                    message: Crypto beneficiary with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:13.869324254Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Crypto Beneficiary
      summary: Update information of a Crypto Beneficiary
      description: Update information on a crypto beneficiary.
      operationId: update_6
      parameters:
        - name: cryptoBeneficiaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CryptoBeneficiaryUpdateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoBeneficiaryUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CRYPTO_BENEFICIARY_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Crypto-beneficiary-not-found:
                  value:
                    errorCode: CRYPTO_BENEFICIARY_NOT_FOUND
                    message: Crypto beneficiary with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:48.464904354Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/corporates/{corporateId}:
    get:
      tags:
        - Corporate
      summary: Get corporate's information
      description: Get all information about a corporate using only its corporate ID.
      operationId: info_7
      parameters:
        - name: corporateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorporateInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:16.271319633Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    delete:
      tags:
        - Sandbox
      summary: Delete a corporate
      description: >-
        Delete a corporate by id. This endpoint allows you to try again the
        whole corporate creation flow.
      operationId: deleteCorporate
      parameters:
        - name: corporateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:43.655611690Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Corporate
      summary: Update a corporate
      description: >-
        You can patch a corporate to update some information. Once the KYB
        status is VALIDATED or DECLINED, you will not be able to patch new
        information except to change the account owner or the external
        identifier.
      operationId: update_7
      parameters:
        - name: corporateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorporateUpdateRequestDto_Partner'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorporateUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - TOO_LONG_FIELD
                      - INVALID_TERMS_VERSION
                      - TAX_IDENTIFICATION_NUMBER_MUST_HAVE_A_COUNTRY
              examples:
                Too-long-field:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          For the field {0}, the maximum allowed size is {1} but
                          the size was {2}.
                    errorCode: TOO_LONG_FIELD
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:48.673091376Z'
                Invalid-terms-version:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Terms version does not correspond to the latest.
                    errorCode: INVALID_TERMS_VERSION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:48.673094066Z'
                Tax-identification-number-must-have-a-country:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: The tax identification number must have a country.
                    errorCode: TAX_IDENTIFICATION_NUMBER_MUST_HAVE_A_COUNTRY
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:48.673095830Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:48.674170151Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - KYB_STATUS_MUST_NOT_BE_DECLINED
                      - INCORPORATION_CODE_ALREADY_TAKEN
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Kyb-status-must-not-be-declined:
                  value:
                    errorCode: KYB_STATUS_MUST_NOT_BE_DECLINED
                    message: >-
                      The current KYB status ({0}) of corporate with id {1} does
                      not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.669835335Z'
                Incorporation-code-already-taken:
                  value:
                    errorCode: INCORPORATION_CODE_ALREADY_TAKEN
                    message: >-
                      A corporate with the same incorporation code ({0}) and
                      incorporation country ({1}) has already been registered.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.669837250Z'
  /api/partner/corporates/{corporateId}/kyb:
    patch:
      tags:
        - Sandbox
      summary: Manually bypass a corporate's KYB status
      description: >-
        Used to update manually the KYB status of a corporate in order to try
        different use cases.
      operationId: bypassKybStatus
      parameters:
        - name: corporateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KybStatusBypassRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KybStatusBypassResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:48.781000118Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_MUST_HAVE_A_VALIDATED_DIRECTOR
                      - CORPORATE_MUST_HAVE_A_UBO
                      - MISSING_CORPORATE_RELATED_KYC
                      - CORPORATE_MUST_HAVE_A_LEGAL_TYPE
                      - CORPORATE_MUST_HAVE_AN_INCORPORATION_DATE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-must-have-a-validated-director:
                  value:
                    errorCode: CORPORATE_MUST_HAVE_A_VALIDATED_DIRECTOR
                    message: >-
                      Corporate with id {0} must have at least one director with
                      validated KYC in order to update its KYB status to
                      VALIDATED.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.775593488Z'
                Corporate-must-have-a-ubo:
                  value:
                    errorCode: CORPORATE_MUST_HAVE_A_UBO
                    message: >-
                      Corporate with id {0} must have at least one UBO in order
                      to update its KYB status to VALIDATED.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.775615273Z'
                Missing-corporate-related-kyc:
                  value:
                    errorCode: MISSING_CORPORATE_RELATED_KYC
                    message: >-
                      In order to update the KYB status to 'VALIDATED' for
                      corporate with id {0}, the following corporate related
                      persons must valid their KYC: {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.775635176Z'
                Corporate-must-have-a-legal-type:
                  value:
                    errorCode: CORPORATE_MUST_HAVE_A_LEGAL_TYPE
                    message: Corporate with id {0} must have a legal type.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.775653740Z'
                Corporate-must-have-an-incorporation-date:
                  value:
                    errorCode: CORPORATE_MUST_HAVE_AN_INCORPORATION_DATE
                    message: Corporate with id {0} must have an incorporation date.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:48.775674853Z'
  /api/partner/corporates/related/{corporateRelatedId}:
    get:
      tags:
        - KYB
      summary: Get corporate-related entity's information
      description: >-
        Get all information about a related entity of a corporate using only
        it's id.
      operationId: info_8
      parameters:
        - name: corporateRelatedId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorporateRelatedInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_RELATED_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-related-not-found:
                  value:
                    errorCode: CORPORATE_RELATED_NOT_FOUND
                    message: Corporate related with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:18.857783492Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    delete:
      tags:
        - KYB
      summary: Delete a corporate-related entity (person or corporate)
      description: >-
        Delete a corporate-related physical person or corporate whose KYB status
        is neither VALIDATED nor PENDING_VERIFICATION.
      operationId: delete_1
      parameters:
        - name: corporateRelatedId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_RELATED_NOT_FOUND
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-related-not-found:
                  value:
                    errorCode: CORPORATE_RELATED_NOT_FOUND
                    message: Corporate related with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:44.571735416Z'
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:44.571738117Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - KYB_STATUS_MUST_NOT_BE_VALIDATED
                      - CORPORATE_RELATED_HAS_DEPENDENCIES
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Kyb-status-must-not-be-validated:
                  value:
                    errorCode: KYB_STATUS_MUST_NOT_BE_VALIDATED
                    message: >-
                      The current KYB status ({0}) of corporate related with id
                      {1} does not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:44.570961936Z'
                Corporate-related-has-dependencies:
                  value:
                    errorCode: CORPORATE_RELATED_HAS_DEPENDENCIES
                    message: >-
                      The corporate related with id {0} cannot be deleted
                      because it has corporate related children.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:44.570966423Z'
    patch:
      tags:
        - KYB
      summary: Update a corporate-related entity (person or corporate)
      description: >-
        You can patch a corporate related to update some information whether
        it's a corporate or a person. Depending on the information patched, you
        will have to perform another action:


        * As a person: 

         - First name -> no actions to perform

         - Last name -> no actions to perform

         - Phone -> you will need to use Endpoint POST Send consumer verification code & validate consumer phone

         - Address : we will use our tools to check if the address is valid or not, we recommend you to ask your consumer to confirm the address once the modification is done. Address is very important to send cards. Once the card is activated, the address status will go from valid to verified.

         - Email address -> The "emailAddressVerified" status will switch to "false" you will need to use Endpoint POST Send a verification email to the consumer to verify the email address. 

        * As a corporate: 

         - Registered name -> no actions to perform

         - Incorporation code -> no actions to perform

         - Incorporation country -> no actions to perform
      operationId: update_8
      parameters:
        - name: corporateRelatedId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorporateRelatedUpdateRequestDto_Partner'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorporateRelatedUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_RELATED_ENTITY_NOT_COMPATIBLE
                      - PERSON_NOT_FOUND
                      - TOTAL_SHARES_PERCENTAGE_IS_OVER_100
              examples:
                Corporate-related-entity-not-compatible:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          Corporate related requested did not match corporate
                          related found with id {0}.
                    errorCode: CORPORATE_RELATED_ENTITY_NOT_COMPATIBLE
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:49.765527274Z'
                Person-not-found:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Person of type {0} with id {1} was not found.
                    errorCode: PERSON_NOT_FOUND
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:49.765533440Z'
                Total-shares-percentage-is-over-100:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The shares of this entity would cause its owned
                          corporate to exceed 100% of shares ({1}%).
                    errorCode: TOTAL_SHARES_PERCENTAGE_IS_OVER_100
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:49.765536024Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_RELATED_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-related-not-found:
                  value:
                    errorCode: CORPORATE_RELATED_NOT_FOUND
                    message: Corporate related with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:49.767058454Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - KYB_STATUS_MUST_NOT_BE_DECLINED
                      - UBO_ALREADY_EXISTING
                      - ACCOUNT_OWNER_PHONE_ALREADY_TAKEN
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Kyb-status-must-not-be-declined:
                  value:
                    errorCode: KYB_STATUS_MUST_NOT_BE_DECLINED
                    message: >-
                      The current KYB status ({0}) of corporate with id {1} does
                      not allow this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:49.761975168Z'
                Ubo-already-existing:
                  value:
                    errorCode: UBO_ALREADY_EXISTING
                    message: >-
                      You cannot add a special UBO because there is already a
                      UBO for corporate with id {0}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:49.761977133Z'
                Account-owner-phone-already-taken:
                  value:
                    errorCode: ACCOUNT_OWNER_PHONE_ALREADY_TAKEN
                    message: >-
                      A corporate account owner with phone +{0} {1} already
                      exists.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:49.761978672Z'
  /api/partner/consumers/{consumerId}:
    get:
      tags:
        - Consumer
      summary: Get consumer's information
      description: >-
        Get all information about one consumer by only using his consumer ID.
        You will get access to all verification statuses.
      operationId: info_10
      parameters:
        - name: consumerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-not-found:
                  value:
                    errorCode: CONSUMER_NOT_FOUND
                    message: Consumer with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:21.259169042Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    delete:
      tags:
        - Sandbox
      summary: Delete a consumer
      description: >-
        Delete a consumer by id. This endpoint allows you to try again the whole
        consumer creation flow.
      operationId: deleteConsumer
      parameters:
        - name: consumerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-not-found:
                  value:
                    errorCode: CONSUMER_NOT_FOUND
                    message: Consumer with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:44.576494237Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Consumer
      summary: Update a consumer
      description: >-
        You can patch a consumer to update some information. Depending on the
        information patched, you will have to perform another action:

         - External ID -> no action to perform

         - Phone -> you will need to use Endpoint POST Send consumer verification code & validate consumer phone

         - Address : we will use our tools to check if the address is valid or not, we recommend you to ask your consumer to confirm the address once the modification is done. Address is very important to send cards. Once the card is activated, the address status will go from valid to verified.

         - Email address -> The "emailAddressVerified" status will switch to "false" you will need to use Endpoint POST Send a verification email to the consumer to verify the email address. 

         - Source of funds -> no action to perform

         - Occupation -> no action to perform

         - Terms & Condition -> Needed if "termsAccepted" is "false".
      operationId: update_9
      parameters:
        - name: consumerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsumerUpdateRequestDto_Partner'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - TOO_LONG_FIELD
                      - INVALID_TERMS_VERSION
                      - OTHER_OCCUPATION_MUST_HAVE_A_DESCRIPTION
                      - OTHER_SOURCE_OF_FUNDS_MUST_HAVE_A_DESCRIPTION
              examples:
                Too-long-field:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          For the field {0}, the maximum allowed size is {1} but
                          the size was {2}.
                    errorCode: TOO_LONG_FIELD
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:49.879032678Z'
                Invalid-terms-version:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: Terms version does not correspond to the latest.
                    errorCode: INVALID_TERMS_VERSION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:49.879035603Z'
                Other-occupation-must-have-a-description:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The chosen occupation is 'OTHER' but no description
                          was specified.
                    errorCode: OTHER_OCCUPATION_MUST_HAVE_A_DESCRIPTION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:49.879037266Z'
                Other-source-of-funds-must-have-a-description:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          The chosen source of funds is 'OTHER' but no
                          description was specified.
                    errorCode: OTHER_SOURCE_OF_FUNDS_MUST_HAVE_A_DESCRIPTION
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:49.879038744Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INSUFFICIENT_RIGHTS_TO_UPDATE_PHONE
                      - INSUFFICIENT_RIGHTS_TO_UPDATE_PARTNER_METADATA
              examples:
                Insufficient-rights-to-update-phone:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS_TO_UPDATE_PHONE
                    message: You cannot update phone authenticated as {0}.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:49.881226326Z'
                Insufficient-rights-to-update-partner-metadata:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS_TO_UPDATE_PARTNER_METADATA
                    message: You cannot update partnerMetadata authenticated as {0}.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:49.881228622Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-not-found:
                  value:
                    errorCode: CONSUMER_NOT_FOUND
                    message: Consumer with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:49.880159566Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PHONE_ALREADY_TAKEN
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Phone-already-taken:
                  value:
                    errorCode: PHONE_ALREADY_TAKEN
                    message: A consumer with this phone already exists.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:49.876624790Z'
  /api/partner/consumers/{consumerId}/contact:
    patch:
      tags:
        - Consumer
      summary: Update a consumer contact
      description: >-
        You can patch a consumer to update some information. Depending on the
        information patched, you will have to perform another action:

         - Phone -> you will need to use Endpoint POST Send consumer verification code & validate consumer phone

         - Address : we will use our tools to check if the address is valid or not, we recommend you to ask your consumer to confirm the address once the modification is done. Address is very important to send cards. Once the card is activated, the address status will go from valid to verified.

         - Email address -> The "emailAddressVerified" status will switch to "false" you will need to use Endpoint POST Send a verification email to the consumer to verify the email address. 

        .


        This operation might require **SCA**.
      operationId: updateConsumerContact
      parameters:
        - name: consumerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsumerContactUpdateRequestDto_Partner'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerUpdateResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - TOO_LONG_FIELD
              examples:
                Too-long-field:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          For the field {0}, the maximum allowed size is {1} but
                          the size was {2}.
                    errorCode: TOO_LONG_FIELD
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:50.159448766Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INSUFFICIENT_RIGHTS_TO_UPDATE_PHONE
              examples:
                Insufficient-rights-to-update-phone:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS_TO_UPDATE_PHONE
                    message: You cannot update phone authenticated as {0}.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:50.164894839Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-not-found:
                  value:
                    errorCode: CONSUMER_NOT_FOUND
                    message: Consumer with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:50.162399320Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PHONE_ALREADY_TAKEN
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Phone-already-taken:
                  value:
                    errorCode: PHONE_ALREADY_TAKEN
                    message: A consumer with this phone already exists.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:50.070924152Z'
  /api/partner/cards/{cardId}:
    get:
      tags:
        - Card
      summary: Get card's information
      description: Get all information about a card using its ID.
      operationId: info_12
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:22.672911289Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Card
      summary: Update a card
      description: You can patch a card to update some information.
      operationId: update_10
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardUpdateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:51.019379831Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/card-profiles/{cardProfileId}:
    patch:
      tags:
        - Card
      summary: Update a card profile
      description: Patch a cardProfile.
      operationId: update_11
      parameters:
        - name: cardProfileId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CardProfileUpdateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardProfileUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_PROFILE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-profile-not-found:
                  value:
                    errorCode: CARD_PROFILE_NOT_FOUND
                    message: Card profile with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:51.058822936Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/beneficiaries/{beneficiaryId}:
    get:
      tags:
        - Beneficiary
      summary: Get beneficiary's information
      description: Get all information about a beneficiary using its ID.
      operationId: info_13
      parameters:
        - name: beneficiaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/GbpBeneficiaryInfoResponseDto'
                  - $ref: '#/components/schemas/SepaBeneficiaryInfoResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - BENEFICIARY_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Beneficiary-not-found:
                  value:
                    errorCode: BENEFICIARY_NOT_FOUND
                    message: Beneficiary with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:26.273567462Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
    patch:
      tags:
        - Beneficiary
      summary: Patch a beneficiary
      description: |-
        Patch a beneficiary.

        This operation might require **SCA**.
      operationId: patch
      parameters:
        - name: beneficiaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficiaryUpdateRequestDto_Partner'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryUpdateResponseDto_Partner'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                  - details
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  details:
                    type: array
                    items:
                      $ref: '#/components/schemas/ErrorDetail'
                  error:
                    type: string
                    default: linkcy.bad.request
                  status:
                    type: integer
                    format: int32
                    default: 400
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - CANNOT_CHANGE_BENEFICIARY_DISPLAY
                      - NOT_ALLOWED_BIC_SWIFT
              examples:
                Cannot-change-beneficiary-display:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: >-
                          You cannot change the property display with your
                          authentication level.
                    errorCode: CANNOT_CHANGE_BENEFICIARY_DISPLAY
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:51.154200645Z'
                Not-allowed-bic-swift:
                  value:
                    details:
                      - field: '{path.to.field}'
                        rejectedValue: '{rejectedValue}'
                        message: This bic or swift is not allowed at Linkcy.
                    errorCode: NOT_ALLOWED_BIC_SWIFT
                    error: linkcy.bad.request
                    status: 400
                    timestamp: '2025-12-29T11:42:51.154204038Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - BENEFICIARY_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Beneficiary-not-found:
                  value:
                    errorCode: BENEFICIARY_NOT_FOUND
                    message: Beneficiary with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:51.155905735Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/beneficiaries/{beneficiaryId}/status:
    patch:
      tags:
        - Sandbox
      summary: Bypass a beneficiary's status
      description: >-
        Allows you to manually set a beneficiary's status to VALID, useful for
        bypassing the current status if it was PENDING_REVIEW or DECLINED.
      operationId: bypassBeneficiaryStatus
      parameters:
        - name: beneficiaryId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - BENEFICIARY_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Beneficiary-not-found:
                  value:
                    errorCode: BENEFICIARY_NOT_FOUND
                    message: Beneficiary with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:51.166254445Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/accounts/{accountId}:
    patch:
      tags:
        - Partner
      summary: Update user account
      description: Update a partner user account.
      operationId: updateAccount
      parameters:
        - name: accountId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountUpdateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerUserAccountUpdateResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - ROLE_NOT_ALLOWED
              examples:
                Role-not-allowed:
                  value:
                    errorCode: ROLE_NOT_ALLOWED
                    message: 'Can not set a role you dont have: {0}'
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:42:51.180649675Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PARTNER_ACCOUNT_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Partner-account-not-found:
                  value:
                    errorCode: PARTNER_ACCOUNT_NOT_FOUND
                    message: Partner account {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:51.179594991Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/internal/transactions/{transactionId}: {}
  /api/internal/partners/{partnerId}: {}
  /api/internal/partners/{partnerId}/acquiring-configuration: {}
  /api/internal/ledgers/{ledgerId}: {}
  /api/internal/kyc/{kycId}: {}
  /api/internal/documents/{documentId}: {}
  /api/internal/crypto/beneficiaries/{cryptoBeneficiaryId}: {}
  /api/internal/corporates/{corporateId}: {}
  /api/internal/corporates/related/{corporateRelatedId}: {}
  /api/internal/consumers/{consumerId}: {}
  /api/internal/consumers/{consumerId}/contact: {}
  /api/internal/beneficiaries/{beneficiaryId}: {}
  /api/internal/accounts/{accountId}: {}
  /api/partner/webhooks:
    get:
      tags:
        - Webhook
      summary: Get your webhook portal url
      description: >-
        Get your webhook portal url. Where you can set up everything you need
        for your webhooks.
      operationId: webhookPortal
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookPortalResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/web-page/{pageId}:
    get:
      tags:
        - Web Pages
      summary: Retrieve the web html page corresponding to a previous operation.
      description: Retrieve the html web page held in our API for a specific operation
      operationId: retrieveWebPage
      parameters:
        - name: pageId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            text/html:
              schema:
                type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - RESOURCE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Resource-not-found:
                  value:
                    errorCode: RESOURCE_NOT_FOUND
                    message: The resource you are trying to access to does not exist.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:42:56.555674510Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - EXPIRED_RESOURCE
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Expired-resource:
                  value:
                    errorCode: EXPIRED_RESOURCE
                    message: The resource {0} you are trying to access to has expired.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:42:56.554627144Z'
      security:
        - {}
  /api/partner/transactions/{transactionId}:
    get:
      tags:
        - Transaction
      summary: Get transaction's information
      description: Get all information about a transaction using its ID.
      operationId: info_1
      parameters:
        - name: transactionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - TRANSACTION_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Transaction-not-found:
                  value:
                    errorCode: TRANSACTION_NOT_FOUND
                    message: Transaction with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:03.365063991Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/kyc/{kycId}:
    get:
      tags:
        - KYC
      summary: Get kyc application
      description: Get all information about a kyc.
      operationId: info_4
      parameters:
        - name: kycId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycApplicationInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - KYC_APPLICATION_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Kyc-application-not-found:
                  value:
                    errorCode: KYC_APPLICATION_NOT_FOUND
                    message: Kyc application with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:07.262423884Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/external-cards:
    get:
      tags:
        - Acquiring
      summary: List external cards
      description: Fetch all external cards based on parameters
      operationId: list_3
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - CREATION_DATE
        - name: endUserId
          in: query
          description: >-
            The ID of the end-user. If empty, the query will return results for
            all end-users.
          required: false
          schema:
            type: string
            format: uuid
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoExternalCardListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/end-users/{endUserId}/addresses:
    get:
      tags:
        - End-user
      summary: Get end-user addresses
      description: |+
        Retrieve the list of addresses associated with an end-user using its ID.

      operationId: getEndUserAddresses
      parameters:
        - name: endUserId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: addressStatus
          in: query
          required: false
          schema:
            type: string
            enum:
              - INVALID
              - VALID
              - PENDING
              - VERIFIED
              - ARCHIVED
              - DECLINED
        - name: isPrincipal
          in: query
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AddressResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - END_USER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                End-user-not-found:
                  value:
                    errorCode: END_USER_NOT_FOUND
                    message: End-user with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:08.568793010Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/documents/{documentId}:
    get:
      tags:
        - Documents
      summary: Get a document
      description: Get a document with its download link.
      operationId: documentInfo
      parameters:
        - name: documentId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - DOCUMENT_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Document-not-found:
                  value:
                    errorCode: DOCUMENT_NOT_FOUND
                    message: Document with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:09.771646402Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/documents/transaction-receipt/{transactionId}:
    get:
      tags:
        - Transaction
      summary: Get a transaction receipt
      description: >-
        Create a receipt for a transaction using its ID. File generated is in
        pdf format.
      operationId: transactionReceipt
      parameters:
        - name: transactionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateDocumentResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - TRANSACTION_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Transaction-not-found:
                  value:
                    errorCode: TRANSACTION_NOT_FOUND
                    message: Transaction with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:09.885457795Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/documents/ledger-statement/{ledgerId}:
    get:
      tags:
        - Ledger
      summary: Get a ledger statement
      operationId: ledgerStatement
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: startDate
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          required: false
          schema:
            type: string
            format: date
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateDocumentResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-not-found:
                  value:
                    errorCode: LEDGER_NOT_FOUND
                    message: Ledger with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:09.955427279Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/documents/diligence-review/{corporateId}:
    get:
      tags:
        - KYB
      summary: Get diligence review of a corporate
      operationId: diligenceReview
      parameters:
        - name: corporateId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateDocumentResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-not-found:
                  value:
                    errorCode: CORPORATE_NOT_FOUND
                    message: Corporate with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:10.058372354Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/documents/bank-details/{ledgerId}:
    get:
      tags:
        - Ledger
      summary: Get banking details from ledger
      operationId: bankingDetails
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateDocumentResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-not-found:
                  value:
                    errorCode: LEDGER_NOT_FOUND
                    message: Ledger with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:10.158604202Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - LEDGER_MUST_BE_ACTIVE
                      - UNSUPPORTED_IBAN_FORMAT
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Ledger-must-be-active:
                  value:
                    errorCode: LEDGER_MUST_BE_ACTIVE
                    message: Ledger must be active to do this operation.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:10.156121730Z'
                Unsupported-iban-format:
                  value:
                    errorCode: UNSUPPORTED_IBAN_FORMAT
                    message: >-
                      Iban format not supported for ledger {0}. Contact your
                      customer care.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:10.156126880Z'
  /api/partner/docs/terms:
    get:
      tags:
        - Additional
      summary: Get terms and conditions
      description: >-
        Signing Terms & Conditions is mandatory to be able to use banking
        features. We mandate you as a Partner to perform this action.


        To do this, you can download the last of version of the TCs directly
        from our APIs! By default, the language is English, but if you need a
        specific language, feel free to ask your customer care!


        Once TCs are updated, the field "termsAccepted" will change into the
        "false" state and you will need to use this Endpoint to get the last
        version. Then, you will have to PATCH your end-users
        ([CONSUMER](/tag/Consumer#operation/update_2)/[CORPORATE](/tag/Corporate#operation/update_1))
        each time they sign the last versions.
      operationId: info_5
      parameters:
        - name: termsAndConditionsInfoRequestDto
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/TermsAndConditionsInfoRequestDto'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsAndConditionsInfoResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
      security:
        - {}
  /api/partner/crypto/wallet/{walletId}:
    get:
      tags:
        - Wallet
      summary: Get a crypto wallet
      description: Get all information about a crypto wallet using its ID.
      operationId: info_6
      parameters:
        - name: walletId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: verifiedContractsOnly
          in: query
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoWalletGetResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CRYPTO_WALLET_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Crypto-wallet-not-found:
                  value:
                    errorCode: CRYPTO_WALLET_NOT_FOUND
                    message: Crypto wallet with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:12.368594006Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/crypto/transactions/{cryptoTransactionId}:
    get:
      tags:
        - Crypto Transaction
      summary: Get crypto transaction's information
      description: Get all information about a crypto transaction using its ID.
      operationId: getCryptoTransactionInfo
      parameters:
        - name: cryptoTransactionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CryptoTransactionResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CRYPTO_TRANSACTION_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Crypto-transaction-not-found:
                  value:
                    errorCode: CRYPTO_TRANSACTION_NOT_FOUND
                    message: Crypto transaction with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:12.778798222Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/corporates/related:
    get:
      tags:
        - KYB
      summary: Get corporate-related entities list
      description: Get access to the information of all related entities of a corporate.
      operationId: list_6
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - UPDATE_DATE
              - CREATION_DATE
        - name: ownedCorporateRelatedId
          in: query
          description: >-
            Parameter to get only the shareholders of this specified
            corporate-related corporate.
          required: false
          schema:
            type: string
            format: uuid
        - name: layer
          in: query
          description: >-
            Parameter allowing to obtain the associated entities on a specific
            layer of the corporate.
          required: false
          schema:
            type: integer
            format: int32
        - name: corporateId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoCorporateRelatedListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_RELATED_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-related-not-found:
                  value:
                    errorCode: CORPORATE_RELATED_NOT_FOUND
                    message: Corporate related with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:17.459916294Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/corporates/external/{externalId}:
    get:
      tags:
        - Corporate
      summary: Get corporate's information given its external id
      description: Get all information about a corporate using only its external ID.
      operationId: info_9
      parameters:
        - name: externalId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CorporateInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CORPORATE_FROM_EXTERNAL_ID_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Corporate-from-external-id-not-found:
                  value:
                    errorCode: CORPORATE_FROM_EXTERNAL_ID_NOT_FOUND
                    message: Corporate with external id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:18.963715851Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/consumers/external/{externalId}:
    get:
      tags:
        - Consumer
      summary: Get consumer's information given its external id
      description: >-
        Get all information about one consumer using only his external ID. You
        will get access to all verification statuses.
      operationId: info_11
      parameters:
        - name: externalId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerInfoResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CONSUMER_FROM_EXTERNAL_ID_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Consumer-from-external-id-not-found:
                  value:
                    errorCode: CONSUMER_FROM_EXTERNAL_ID_NOT_FOUND
                    message: Consumer with external id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:21.356563003Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/cards/{cardId}/pin:
    get:
      tags:
        - Card
      summary: Get a physical card's PIN
      description: |-
        Get the PIN code of a card.

        This operation might require **SCA**.
      operationId: pin
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardPinGetResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:22.771747972Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_MUST_BE_ACTIVE
                      - CARD_MUST_BE_PHYSICAL
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-must-be-active:
                  value:
                    errorCode: CARD_MUST_BE_ACTIVE
                    message: >-
                      Card with id {0} must be active in order to perform this
                      operation. Current card status is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:22.768881683Z'
                Card-must-be-physical:
                  value:
                    errorCode: CARD_MUST_BE_PHYSICAL
                    message: >-
                      Card with id {0} must be physical in order to realize this
                      operation. Card type is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:22.768894511Z'
  /api/partner/cards/{cardId}/pan:
    get:
      tags:
        - Sandbox
      summary: Get a card truncated PAN
      description: >-
        Used to get the truncated PAN of a card (that you will not receive) in
        order to activate it.
      operationId: truncatedPan
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-not-found:
                  value:
                    errorCode: CARD_NOT_FOUND
                    message: Card {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:23.914671494Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - CARD_MUST_BE_PHYSICAL
                      - CARD_STILL_CREATING
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Card-must-be-physical:
                  value:
                    errorCode: CARD_MUST_BE_PHYSICAL
                    message: >-
                      Card with id {0} must be physical in order to realize this
                      operation. Card type is {1}.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:23.913879779Z'
                Card-still-creating:
                  value:
                    errorCode: CARD_STILL_CREATING
                    message: >-
                      Card with id {0} is still being created and therefore this
                      operation is not yet available.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:23.913880972Z'
  /api/partner/cards/{cardId}/pan/credentials:
    get:
      tags:
        - Card
      summary: Get PAN credentials
      description: >-
        Get temporary PAN credentials for this card.


        Credentials are valid for 60 seconds, after which you will need to
        request new credentials again.


        This operation might require **SCA**.
      operationId: getPanCredentials
      parameters:
        - name: cardId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: Linkcy-SCA-Strategy
          in: header
          description: >+
            The strategy to use when a SCA is required:

            <details>

            <summary>More information:</summary>


            - `PUSH_NOTIFICATION`: will send a notification if the SCA is
            required.

            - `DATA_SIGNING`: Linkcy-SCA-Signature header must contain signature
            provided by PowerAuth Mobile SDK on registered device.

            - `BY_PASS`: Sandbox only - will ignore any SCA if used.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 409 Conflict
                  - `SCA_REQUIRED`: The operation you are trying to do requires SCA, current strategy {0}.
            </details>

          required: false
          schema:
            type: string
            default: PUSH_NOTIFICATION
            enum:
              - PUSH_NOTIFICATION
              - DATA_SIGNING
              - BY_PASS
        - name: Linkcy-SCA-Signature
          in: header
          description: >+
            The signature that needs to be validated, it is generated from data
            signing.


            <details>

            <summary>More information:</summary>


            - Signature will be verified against wultra.

            - Operation will be denied if signature is not valide.

            - Avoid creating multiple signature at same time for the same
            registration.

            - Signature TTL is 30 sec.

            </details>


            <details>
              <summary>Error Codes</summary>

              - 401 Forbidden
                  - `SCA_SIGNATURE_DOES_NOT_MATCH`: The sca signature provided doesn't match the one required for this operation
              - 404 Not Found
                  - `NO_ACTIVE_SCA_DEVICE_FOUND`: No active SCA device could be found.
              - 409 Conflict
                  - `SCA_DEVICE_NOT_VALID`: The device cannot be used to sign this data.
                  - `SCA_SIGNATURE_FORMAT_INVALID`: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
                  - `SCA_SIGNATURE_MISSING`: The signature required for data signing SCA strategy is missing.
              - 500 Internal Server Error
                  - `SCA_UNEXPECTED_ERROR`: Unable to perform SCA operation
            </details>

          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CardPanCredentialsGetResponseDto'
        '202':
          description: Waiting SCA
          content:
            application/json:
              schema:
                required:
                  - scaDeviceId
                  - scaId
                  - ttl
                type: object
                properties:
                  scaId:
                    type: string
                    description: The id of the SCA operation.
                    format: uuid
                  joinCode:
                    type: string
                    description: The join code if strategy is JOIN_CODE.
                    format: uuid
                  ttl:
                    type: object
                    properties:
                      seconds:
                        type: integer
                        format: int64
                      zero:
                        type: boolean
                      nano:
                        type: integer
                        format: int32
                      negative:
                        type: boolean
                      positive:
                        type: boolean
                      units:
                        type: array
                        items:
                          type: object
                          properties:
                            durationEstimated:
                              type: boolean
                            timeBased:
                              type: boolean
                            dateBased:
                              type: boolean
                  scaDeviceId:
                    type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - OPERATION_NOT_ALLOWED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Operation-not-allowed:
                  value:
                    errorCode: OPERATION_NOT_ALLOWED
                    message: >-
                      This operation is not allowed by your current
                      configuration.
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:23.962116054Z'
  /api/partner/cards/{cardId}/pan-cvv: {}
  /api/partner/card-designs:
    get:
      tags:
        - Card
      summary: List card designs
      description: Fetch all card designs based on parameters.
      operationId: list_10
      parameters:
        - name: sortAttribute
          in: query
          required: false
          schema:
            type: string
            enum:
              - FRIENDLY_NAME
        - name: scheme
          in: query
          required: false
          schema:
            type: string
            enum:
              - MASTERCARD
              - VISA
        - name: ledgerType
          in: query
          required: false
          schema:
            type: string
            enum:
              - EUR_BELGIUM
              - EUR_FRANCE
              - EUR_ESTONIA
              - EUR_LITHUANIA
              - USD_USA
              - GBP_GREAT_BRITAIN
              - EUR_BG
        - name: cardType
          in: query
          required: false
          schema:
            type: string
            enum:
              - PHYSICAL
              - VIRTUAL
        - name: userType
          in: query
          required: false
          schema:
            type: string
            enum:
              - CORPORATE
              - CONSUMER
        - name: pageSize
          in: query
          description: The size of the page to be returned.
          required: false
          schema:
            maximum: 100
            type: integer
            format: int32
        - name: page
          in: query
          description: The page number.
          required: false
          schema:
            maximum: 500
            minimum: 0
            type: integer
            format: int32
        - name: sortDirection
          in: query
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListResponseDtoCardDesignListElementDto_Partner
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/bic/{iban}:
    get:
      tags:
        - Additional
      summary: Get bic information from an iban
      description: Get BIC information for a given IBAN.
      operationId: getBicFromIban
      parameters:
        - name: iban
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BicInfoResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - BIC_CODES_NOT_FOUND
                      - INVALID_IBAN
                      - IBAN_NOT_SUPPORTED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Bic-codes-not-found:
                  value:
                    errorCode: BIC_CODES_NOT_FOUND
                    message: No bicCodes found for this iban.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:25.157591602Z'
                Invalid-iban:
                  value:
                    errorCode: INVALID_IBAN
                    message: Iban from {0} is not valid.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:25.157594112Z'
                Iban-not-supported:
                  value:
                    errorCode: IBAN_NOT_SUPPORTED
                    message: Iban from {0} are not supported.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:25.157605973Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/acquiring/transactions/{transactionId}:
    get:
      tags:
        - Acquiring
      summary: Get acquiring transaction information
      description: Get all information about an acquiring transaction using its ID.
      operationId: acquiringInfo
      parameters:
        - name: transactionId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponseDto_Partner'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - TRANSACTION_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Transaction-not-found:
                  value:
                    errorCode: TRANSACTION_NOT_FOUND
                    message: Transaction with id {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:27.575361859Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/acquiring-configuration:
    get:
      tags:
        - Partner
      summary: Get your acquiring configuration
      description: Get your acquiring configuration information.
      operationId: getAcquiringConfiguration
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerAcquiringConfigurationDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - PARTNER_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Partner-not-found:
                  value:
                    errorCode: PARTNER_NOT_FOUND
                    message: Partner {0} was not found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:27.660098820Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/internal/phone: {}
  /api/internal/mandates: {}
  /api/internal/mandates/{mandateId}: {}
  /api/internal/ledgers: {}
  /api/internal/kyc: {}
  /api/internal/external-cards: {}
  /api/internal/documents/risk-assessment/{endUserId}: {}
  /api/internal/crypto/wallet: {}
  /api/internal/crypto/wallet/{walletId}: {}
  /api/internal/crypto/transactions: {}
  /api/internal/crypto/transactions/{cryptoTransactionId}: {}
  /api/internal/crypto/beneficiaries: {}
  /api/internal/corporates: {}
  /api/internal/corporates/related: {}
  /api/internal/consumers: {}
  /api/internal/cards: {}
  /api/internal/cards/{cardId}: {}
  /api/internal/card-profiles: {}
  /api/internal/beneficiaries: {}
  /api/internal/accounts: {}
  /api/partner/sca/{scaDeviceId}:
    delete:
      tags:
        - Strong Authentication
      summary: Delete a device
      description: >-
        Delete the registration of an end-user device.


        This operation is restricted to partner bearer tokens and should not be
        exposed directly to end-users.
      operationId: deleteDevice
      parameters:
        - name: scaDeviceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '204':
          description: SCA device deleted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenErrorInfo'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SCA_DEVICE_NOT_FOUND
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.not.found
                  status:
                    type: integer
                    format: int32
                    default: 404
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Sca-device-not-found:
                  value:
                    errorCode: SCA_DEVICE_NOT_FOUND
                    message: The SCA device you are referring ({0}) could not be found.
                    error: linkcy.not.found
                    status: 404
                    timestamp: '2025-12-29T11:43:43.381735176Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                  - error
                  - errorCode
                  - message
                  - status
                  - timestamp
                type: object
                properties:
                  errorCode:
                    type: string
                    enum:
                      - SCA_DELETION_FAILED
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.conflict
                  status:
                    type: integer
                    format: int32
                    default: 409
                  timestamp:
                    type: string
                    format: date-time
              examples:
                Sca-deletion-failed:
                  value:
                    errorCode: SCA_DELETION_FAILED
                    message: SCA deletion failed for SCA device id {0}
                    error: linkcy.conflict
                    status: 409
                    timestamp: '2025-12-29T11:43:43.380371271Z'
  /api/partner/ledgers/{ledgerId}/suspensions/{operator}:
    delete:
      tags:
        - Ledger
      summary: Unsuspend a ledger
      description: Unsuspend a ledger and all associated cards.
      operationId: unsuspend
      parameters:
        - name: ledgerId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: operator
          in: path
          required: true
          schema:
            title: Operator
            type: string
            enum:
              - END_USER
              - PARTNER
              - LINKCY
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INSUFFICIENT_RIGHTS
              examples:
                Insufficient-rights:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS
                    message: >-
                      Your current authentication ({0}) does not have sufficient
                      rights to perform this operation.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:43:43.555370248Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/partner/end-users/{endUserId}/suspensions/{operator}:
    delete:
      tags:
        - End-user
      summary: Unsuspend an end-user
      description: >-
        Unsuspend an end-user, this operation will also delete the card rules
        that were created by this suspension.
      operationId: unsuspend_1
      parameters:
        - name: endUserId
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: operator
          in: path
          required: true
          schema:
            title: Operator
            type: string
            enum:
              - END_USER
              - PARTNER
              - LINKCY
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorInfo'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorInfo'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                required:
                  - error
                  - status
                  - timestamp
                type: object
                properties:
                  message:
                    type: string
                  error:
                    type: string
                    default: linkcy.forbidden
                  status:
                    type: integer
                    format: int32
                    default: 403
                  timestamp:
                    type: string
                    format: date-time
                  errorCode:
                    type: string
                    enum:
                      - INSUFFICIENT_RIGHTS
              examples:
                Insufficient-rights:
                  value:
                    errorCode: INSUFFICIENT_RIGHTS
                    message: >-
                      Your current authentication ({0}) does not have sufficient
                      rights to perform this operation.
                    error: linkcy.forbidden
                    status: 403
                    timestamp: '2025-12-29T11:43:43.568032029Z'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictErrorInfo'
  /api/internal/phone/{phone}: {}
  /api/internal/partners/restrictions/{restrictionId}: {}
  /api/internal/ledgers/{ledgerId}/suspensions/{operator}: {}
  /api/internal/end-users/{endUserId}: {}
components:
  schemas:
    ForbiddenErrorInfo:
      required:
        - error
        - status
        - timestamp
      type: object
      properties:
        status:
          type: integer
          format: int32
          default: 403
        error:
          type: string
          default: linkcy.forbidden
        message:
          type: string
        timestamp:
          type: string
          format: date-time
    BadRequestErrorInfo:
      required:
        - details
        - error
        - status
        - timestamp
      type: object
      properties:
        status:
          type: integer
          format: int32
          default: 400
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        error:
          type: string
          default: linkcy.bad.request
        timestamp:
          type: string
          format: date-time
    ErrorDetail:
      required:
        - field
        - message
        - rejectedValue
      type: object
      properties:
        field:
          type: string
          example: name
        rejectedValue:
          type: string
          example: John Doe 56
        message:
          type: string
          example: Name must contains only letters
    UnauthorizedErrorInfo:
      required:
        - error
        - status
        - timestamp
      type: object
      properties:
        message:
          type: string
        error:
          type: string
          default: linkcy.unauthorized
        status:
          type: integer
          format: int32
          default: 401
        timestamp:
          type: string
          format: date-time
    ConflictErrorInfo:
      required:
        - error
        - errorCode
        - status
        - timestamp
      type: object
      properties:
        status:
          type: integer
          format: int32
          default: 409
        errorCode:
          type: string
        error:
          type: string
          default: linkcy.conflict
        message:
          type: string
        timestamp:
          type: string
          format: date-time
    PaynovateRemainingMvcCountResetRequestDto:
      required:
        - remainingMvcResetValue
      type: object
      properties:
        remainingMvcResetValue:
          type: integer
          format: int32
    CardRuleUpdateDto:
      type: object
      properties:
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        creatorType:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
      anyOf:
        - $ref: '#/components/schemas/SpendLimitRuleUpdateDto'
        - $ref: '#/components/schemas/PaymentDisableRuleUpdateDto'
        - $ref: '#/components/schemas/MerchantsMultipleTargetsUpdateRuleDto'
        - $ref: '#/components/schemas/MccMultipleTargetsRuleUpdateDto'
        - $ref: '#/components/schemas/DaysMultipleTargetsRuleUpdateDto'
    DaysMultipleTargetsRuleUpdateDto:
      required:
        - days
      type: object
      properties:
        days:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
              - SUNDAY
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        creatorType:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    MccMultipleTargetsRuleUpdateDto:
      required:
        - merchantCategoryCodes
      type: object
      properties:
        merchantCategoryCodes:
          uniqueItems: true
          type: array
          items:
            type: string
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        creatorType:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    MerchantsMultipleTargetsUpdateRuleDto:
      required:
        - merchants
      type: object
      properties:
        merchants:
          uniqueItems: true
          type: array
          items:
            type: string
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        creatorType:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    PaymentDisableRuleUpdateDto:
      type: object
      properties:
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        creatorType:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    SpendLimitRuleUpdateDto:
      required:
        - value
      type: object
      properties:
        value:
          maximum: 999999999
          minimum: 1
          type: integer
          format: int64
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        creatorType:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    InternalOperationRestrictionCreateRequestDto:
      required:
        - operation
        - partnerId
        - type
        - userType
      type: object
      properties:
        partnerId:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - INTERDICTION
        userType:
          type: string
          description: The type of user affected.
          enum:
            - ANONYMOUS
            - CONSUMER
            - CORPORATE
            - PARTNER
        operation:
          type: string
          description: The operation to restrict.
          enum:
            - ACCOUNT_CREATE
            - ACCOUNT_LIST
            - ACCOUNT_UPDATE
            - INTERNAL_ACCOUNT_UPDATE
            - INTERNAL_ACCOUNT_LIST
            - BANKING_DETAILS_DOCUMENT_EXPORT
            - BENEFICIARY_CREATE
            - BENEFICIARY_INFO
            - BENEFICIARY_LIST
            - BENEFICIARY_UPDATE
            - BENEFICIARY_BYPASS_STATUS
            - INTERNAL_BENEFICIARY_INFO
            - INTERNAL_BENEFICIARY_LIST
            - INTERNAL_BENEFICIARY_UPDATE
            - DIRECT_DEBIT_MANDATE_CREATE
            - DIRECT_DEBIT_MANDATE_UPDATE
            - DIRECT_DEBIT_MANDATE_ACTIVATE
            - DIRECT_DEBIT_MANDATE_CANCEL
            - DIRECT_DEBIT_MANDATE_LIST
            - DIRECT_DEBIT_MANDATE_INFO
            - INTERNAL_DIRECT_DEBIT_MANDATE_LIST
            - INTERNAL_DIRECT_DEBIT_MANDATE_INFO
            - CARD_ACTIVATE
            - CARD_CLOSE
            - CARD_CREATE
            - CARD_UPDATE
            - CARD_DESIGN_LIST
            - INTERNAL_CARD_DESIGN_LIST
            - CARD_INFO
            - CARD_LIST
            - CARD_PAN_CREDENTIALS
            - CARD_PIN
            - CARD_PAN_AND_CVV
            - CARD_SUSPEND
            - CARD_RESET_PIN_ATTEMPTS
            - CARD_PROFILE_CREATE
            - CARD_PROFILE_LIST
            - CARD_PROFILE_RULE_DELETE
            - CARD_PROFILE_RULE_UPDATE
            - CARD_PROFILE_UPDATE
            - INTERNAL_CARD_PROFILE_LIST
            - CARD_RULE_DELETE
            - CARD_RULE_UPDATE
            - CARD_TRUNCATED_PAN
            - INTERNAL_CARD_INFO
            - INTERNAL_CARD_LIST
            - INTERNAL_CARD_PROGRAM_LIST
            - INTERNAL_CARD_RULE_DELETE
            - INTERNAL_CARD_RULE_UPDATE
            - EXTERNAL_CARD_LIST
            - I_EXTERNAL_CARD_LIST
            - CONSUMER_CREATE
            - CONSUMER_INFO
            - CONSUMER_LIST
            - CONSUMER_UPDATE
            - CONSUMER_CONTACT_UPDATE
            - CONSUMER_DELETE
            - INTERNAL_CONSUMER_INFO
            - INTERNAL_CONSUMER_UPDATE
            - INTERNAL_CONSUMER_CONTACT_UPDATE
            - CORPORATE_CREATE
            - CORPORATE_INFO
            - CORPORATE_LIST
            - CORPORATE_UPDATE
            - CORPORATE_DELETE
            - CORPORATE_RELATED_CREATE
            - CORPORATE_RELATED_DELETE
            - CORPORATE_RELATED_INFO
            - CORPORATE_RELATED_LIST
            - CORPORATE_RELATED_UPDATE
            - KYB_VERIFICATION_ASK
            - CORPORATE_BYPASS_KYB
            - INTERNAL_CORPORATE_INFO
            - INTERNAL_CORPORATE_UPDATE
            - INTERNAL_CORPORATE_RELATED_INFO
            - INTERNAL_CORPORATE_RELATED_LIST
            - INTERNAL_CORPORATE_RELATED_UPDATE
            - INTERNAL_OPERATION_RESTRICTION_CREATE
            - INTERNAL_OPERATION_RESTRICTION_DELETE
            - INTERNAL_OPERATION_RESTRICTION_LIST
            - DOCUMENT_REQUEST_CREATE
            - DOCUMENT_CREATE
            - DOCUMENT_INFO
            - DOCUMENT_LIST
            - DILIGENCE_REVIEW_DOCUMENT_EXPORT
            - RISK_ASSESSMENT_DOCUMENT_EXPORT
            - TRANSACTION_RECEIPT_DOCUMENT_EXPORT
            - INTERNAL_DOCUMENT_CREATE
            - INTERNAL_DOCUMENT_LIST
            - INTERNAL_DOCUMENT_UPDATE
            - INTERNAL_DOCUMENT_DELETE
            - EMAIL_VERIFICATION_CREATE
            - CONSUMER_EMAIL_CHECK
            - END_USER_SUSPEND
            - I_END_USER_CLOSE
            - END_USER_UNSUSPEND
            - I_END_USER_DELETE
            - END_USER_ADDRESSES_LIST
            - END_USER_ONBOARD
            - GET_ID_WEBHOOK_VERIFIED
            - GET_ID_WEBHOOK_CREATED
            - WULTRA_REGISTRATION_WEBHOOK_UPDATE
            - KYC_CREATE
            - KYC_LIST
            - KYC_SIMULATE
            - KYC_INFO
            - INTERNAL_KYC_LIST
            - INTERNAL_KYC_UPDATE
            - INTERNAL_KYC_INFO
            - LEDGER_CLOSE
            - LEDGER_CREATE
            - LEDGER_UPDATE
            - LEDGER_STATEMENT_DOCUMENT_EXPORT
            - LEDGER_SUSPEND
            - LEDGER_UNSUSPEND
            - LEDGER_INFO
            - LEDGER_LIST
            - LEDGER_UPGRADE
            - INTERNAL_LEDGER_UPDATE
            - INTERNAL_LEDGER_INFO
            - INTERNAL_LEDGER_LIST
            - INTERNAL_LEDGER_UPGRADE
            - INTERNAL_LEDGER_CLOSE
            - INTERNAL_LEDGER_SUSPEND
            - INTERNAL_LEDGER_UNSUSPEND
            - GET_BIC_FROM_IBAN
            - INTERNAL_BLOCKED_PHONE_LIST
            - INTERNAL_PHONE_BLOCK_DELETE
            - PARTNER_INFO
            - PARTNER_UPDATE
            - INTERNAL_PARTNER_CREATE
            - INTERNAL_PARTNER_INFO
            - INTERNAL_PARTNER_LIST
            - INTERNAL_PARTNER_UPDATE
            - INTERNAL_PARTNER_DELETE
            - PARTNER_ACQUIRING_CONFIGURATION_INFO
            - INTERNAL_PARTNER_ACQUIRING_CONFIGURATION_INFO
            - INTERNAL_PARTNER_ACQUIRING_CONFIGURATION_UPDATE
            - PHONE_VERIFICATION_SEND
            - PHONE_VERIFICATION_VERIFY
            - SMS_SEND
            - ADDRESS_VERIFY
            - SCA_DEVICE_CREATE
            - SCA_DEVICE_ACTIVATE
            - SCA_DEVICE_DELETE
            - SHARE_INFO
            - SHARE_CREATE
            - SHARE_UPDATE
            - SHARE_DELETE
            - TERMS_AND_CONDITIONS_INFO
            - TRANSACTION_INFO
            - TRANSACTION_LIST
            - TRANSACTION_INTER_LEDGER
            - TRANSACTION_TO_BENEFICIARY
            - TRANSACTION_DIRECT_DEBIT
            - TRANSACTION_SIMULATE
            - INTERNAL_TRANSACTION_INFO
            - INTERNAL_TRANSACTION_LIST
            - INTERNAL_TRANSACTION_UPDATE
            - INTERNAL_TRANSACTION_INTER_LEDGER
            - INTERNAL_TRANSACTION_TO_BENEFICIARY
            - INTERNAL_TRANSACTION_DIRECT_DEBIT
            - ACQUIRING_CREATE_ACCOUNT_LOAD
            - ACQUIRING_CREATE_PAYMENT
            - USER_LOGIN
            - USER_CHANGE_PASSWORD
            - USER_REFRESH_LOGIN
            - USER_RESET_PASSWORD
            - WEB_PAGE_RETRIEVE
            - WEBHOOK_PORTAL
            - CRYPTO_WALLET_CREATE
            - CRYPTO_WALLET_LIST
            - CRYPTO_WALLET_INFO
            - INTERNAL_CRYPTO_WALLET_LIST
            - INTERNAL_CRYPTO_WALLET_INFO
            - CRYPTO_BENEFICIARY_CREATE
            - CRYPTO_BENEFICIARY_LIST
            - CRYPTO_BENEFICIARY_UPDATE
            - CRYPTO_BENEFICIARY_INFO
            - INTERNAL_CRYPTO_BENEFICIARY_LIST
            - INTERNAL_CRYPTO_BENEFICIARY_INFO
            - INTERNAL_CRYPTO_BENEFICIARY_UPDATE
            - CRYPTO_TRANSACTION_LIST
            - INTERNAL_CRYPTO_TRANSACTION_LIST
            - CRYPTO_TRANSACTION_CREATE
            - CRYPTO_TRANSACTION_INFO
            - INTERNAL_CRYPTO_TRANSACTION_INFO
            - UNKNOWN
    InternalOperationRestrictionCreateResponseDto:
      required:
        - id
        - partnerId
      type: object
      properties:
        id:
          type: string
          description: The new restriction identifier.
          format: uuid
        partnerId:
          type: string
          format: uuid
    IdemiaCardsProductionInfoImportRequestDto:
      required:
        - file
      type: object
      properties:
        file:
          type: string
          format: binary
    IdemiaCardsProductionInfoImportResponseDto:
      required:
        - tokensNotFound
        - updatedCardsIds
      type: object
      properties:
        updatedCardsIds:
          type: array
          items:
            type: string
            format: uuid
        tokensNotFound:
          type: array
          items:
            type: string
    ConsumerPhoneVerifyRequestDto:
      title: For Consumer.
      required:
        - code
      type: object
      properties:
        consumerId:
          type: string
          description: |-
            The id of the verified consumer.

            Mandatory if not authenticated as consumer.
          format: uuid
        code:
          pattern: ^[0-9]{6}$
          type: string
          description: |-
            The code received by the consumer. 

            In play environment code is always 123456.
    CorporatePhoneVerifyRequestDto:
      title: For Corporate Related.
      required:
        - code
        - relatedPhysicalPersonId
      type: object
      properties:
        relatedPhysicalPersonId:
          type: string
          description: The id of the verified corporate-related person.
          format: uuid
        code:
          pattern: ^[0-9]{6}$
          type: string
          description: |-
            The code received by the consumer. 

            In play environment code is always 123456.
    PhoneVerifyRequestDto:
      required:
        - code
      type: object
      properties:
        code:
          pattern: ^[0-9]{6}$
          type: string
          description: |-
            The code received by the consumer. 

            In play environment code is always 123456.
      anyOf:
        - $ref: '#/components/schemas/ConsumerPhoneVerifyRequestDto'
        - $ref: '#/components/schemas/CorporatePhoneVerifyRequestDto'
    ConsumerPhoneVerificationSendRequestDto:
      title: For Consumer.
      type: object
      properties:
        consumerId:
          type: string
          description: |-
            Id of the consumer verifying.

            Mandatory if not authenticated as consumer.
          format: uuid
    CorporatePhoneVerificationSendRequestDto:
      title: For Corporate Related.
      required:
        - relatedPhysicalPersonId
      type: object
      properties:
        relatedPhysicalPersonId:
          type: string
          description: Id of the corporate-related person verifying.
          format: uuid
    PhoneVerificationSendRequestDto:
      type: object
      anyOf:
        - $ref: '#/components/schemas/ConsumerPhoneVerificationSendRequestDto'
        - $ref: '#/components/schemas/CorporatePhoneVerificationSendRequestDto'
    PhoneVerificationSendResponseDto:
      required:
        - ttl
      type: object
      properties:
        ttl:
          type: string
          description: The phone verification code time to live duration in ISO 8601.
          default: PT10M
    EmailVerificationSendConsumerRequestDto:
      title: For Consumer.
      type: object
      properties:
        consumerId:
          type: string
          description: >-
            Id of the consumer verifying its email (Will be ignored and deducted
            from current authenticated user if end-user).
          format: uuid
        emailSubject:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            Subject of the verification email, by default is '[{partnerName}]
            Please verify your email address'.
          example: '[{partnerName}] Please verify your email'
        urlOnSuccess:
          type: string
          description: Redirect url on email verified.
          example: https://google.com
        urlOnFailure:
          type: string
          description: Redirect url on email verification failed.
          example: https://google.com
    EmailVerificationSendRelatedPhysicalPersonRequestDto:
      title: For Corporate Related.
      required:
        - relatedPhysicalPersonId
      type: object
      properties:
        relatedPhysicalPersonId:
          type: string
          description: Id of the corporate-related person verifying its email.
          format: uuid
        emailSubject:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            Subject of the verification email, by default is '[{partnerName}]
            Please verify your email address'.
          example: '[{partnerName}] Please verify your email'
        urlOnSuccess:
          type: string
          description: Redirect url on email verified.
          example: https://google.com
        urlOnFailure:
          type: string
          description: Redirect url on email verification failed.
          example: https://google.com
    EmailVerificationSendRequestDto:
      type: object
      properties:
        urlOnSuccess:
          type: string
          description: Redirect url on email verified.
          example: https://google.com
        urlOnFailure:
          type: string
          description: Redirect url on email verification failed.
          example: https://google.com
        emailSubject:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            Subject of the verification email, by default is '[{partnerName}]
            Please verify your email address'.
          example: '[{partnerName}] Please verify your email'
      anyOf:
        - $ref: '#/components/schemas/EmailVerificationSendConsumerRequestDto'
        - $ref: >-
            #/components/schemas/EmailVerificationSendRelatedPhysicalPersonRequestDto
    EmailVerificationSendResponseDto:
      required:
        - ttl
      type: object
      properties:
        ttl:
          type: string
          description: The email verification link time to live duration in ISO 8601.
          default: PT48H
    AddressVerifyRequestDto:
      required:
        - type
      type: object
      properties:
        type:
          type: string
      discriminator:
        propertyName: type
    AddressVerifyWithLinkRequestDto:
      title: Address verification with link
      required:
        - addressId
        - ttl
        - type
      type: object
      allOf:
        - $ref: '#/components/schemas/AddressVerifyRequestDto'
        - type: object
          properties:
            addressId:
              type: string
              format: uuid
            type:
              type: string
              enum:
                - LINK
            ttl:
              type: string
              description: >-
                Time-to-live (TTL) duration before the link expires .


                Supports ISO 8601 duration format (e.g., 'PT1800S' for 1800
                seconds, 'PT5M' for 5 minutes, 'P7D' for 7 days).
              example: PT8H6M12.345S
    AddressVerifyWithUploadedDocumentRequestDto:
      title: Address verification with uploaded document
      required:
        - documentId
        - type
      type: object
      allOf:
        - $ref: '#/components/schemas/AddressVerifyRequestDto'
        - type: object
          properties:
            documentId:
              type: string
              format: uuid
            type:
              type: string
              enum:
                - UPLOADED_DOCUMENT
    DelegatedAddressVerifyRequestDto:
      title: Address verification delegated
      required:
        - documentId
        - type
      type: object
      allOf:
        - $ref: '#/components/schemas/AddressVerifyRequestDto'
        - type: object
          properties:
            documentId:
              type: string
              format: uuid
            type:
              type: string
              enum:
                - DELEGATED
    AddressVerifyWithLinkResponseDto:
      required:
        - ttl
        - url
      type: object
      properties:
        url:
          type: string
        ttl:
          type: string
          example: PT8H6M12.345S
    BeneficiaryTransactionCreateRequestDto:
      required:
        - amount
        - beneficiaryId
        - ledgerFromId
      type: object
      properties:
        amount:
          type: number
        beneficiaryId:
          type: string
          format: uuid
        ledgerFromId:
          type: string
          format: uuid
        reference:
          maxLength: 60
          minLength: 0
          pattern: ^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$
          type: string
          description: >-
            Reference of the transaction. If null, default reference will be
            'Transfer'.
        allowFastPayment:
          type: boolean
          description: >-
            If for any reason you do **not** want want to allow fast payment,
            (ie: want to use EU_SEPA_STEP2 over EU_SEPA_INSTANT), you can set
            this field to `false`. In sandbox, GBP transactions are always in
            fast payment and EUR transactions are always in normal payment.
          default: true
        allowInterLedger:
          type: boolean
          description: >-
            If Linkcy detect a possible inter-ledger operation, Linkcy
            automatically perform this inter-ledger operation. However, if you
            do **not** want to, you can set this field to `false`
          default: true
    BeneficiaryTransactionCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CardAuthorizationSimulateTransactionRequestDto:
      required:
        - amount
        - cardId
      type: object
      properties:
        amount:
          type: number
        cardId:
          type: string
          format: uuid
        merchantName:
          type: string
        merchantCity:
          type: string
        merchantCountry:
          type: string
        merchantId:
          type: string
        merchantCategoryCode:
          type: string
    CardClearingSimulateTransactionRequestDto:
      required:
        - originalAuthorizationId
      type: object
      properties:
        originalAuthorizationId:
          type: string
          format: uuid
    SctReceiveSimulateTransactionRequestDto:
      required:
        - amount
        - ledgerId
      type: object
      properties:
        amount:
          type: number
        ledgerId:
          type: string
          format: uuid
        reference:
          type: string
    SimulateTransactionRequestDto:
      type: object
      anyOf:
        - $ref: '#/components/schemas/CardAuthorizationSimulateTransactionRequestDto'
        - $ref: '#/components/schemas/CardClearingSimulateTransactionRequestDto'
        - $ref: '#/components/schemas/SctReceiveSimulateTransactionRequestDto'
    InterLedgerTransactionCreateRequestDto:
      required:
        - amount
        - ledgerFromId
        - ledgerToId
      type: object
      properties:
        ledgerFromId:
          type: string
          format: uuid
        ledgerToId:
          type: string
          format: uuid
        amount:
          type: number
        reference:
          maxLength: 60
          minLength: 0
          pattern: ^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$
          type: string
          description: >-
            Reference of the transaction. If null, default reference will be
            'Transfer'.
    InterLedgerTransactionCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    DirectDebitTransactionCreateRequestDto:
      required:
        - amount
        - date
        - ledgerToId
        - mandateId
        - reference
      type: object
      properties:
        mandateId:
          type: string
          format: uuid
        ledgerToId:
          type: string
          format: uuid
        date:
          type: string
          description: >-
            The date on which the direct debit must be executed. Cannot be
            earlier than D+2 and must be a working day (neither weekend nor
            public holiday).
          format: date
        amount:
          type: number
        reference:
          maxLength: 60
          minLength: 0
          pattern: ^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$
          type: string
          description: >-
            Reference of the transaction. If null, default reference will be
            'Transfer'.
    DirectDebitTransactionCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ConsumerSmsSendRequestDto:
      required:
        - consumerId
        - message
      type: object
      properties:
        consumerId:
          type: string
          format: uuid
        message:
          type: string
    RelatedPhysicalPersonSmsSendRequestDto:
      required:
        - message
        - relatedPhysicalPersonId
      type: object
      properties:
        relatedPhysicalPersonId:
          type: string
          format: uuid
        message:
          type: string
    SmsSendRequestDto:
      required:
        - message
      type: object
      properties:
        message:
          type: string
      anyOf:
        - $ref: '#/components/schemas/ConsumerSmsSendRequestDto'
        - $ref: '#/components/schemas/RelatedPhysicalPersonSmsSendRequestDto'
    DirectShareCreateRequestDto:
      required:
        - corporateRelatedId
        - percentage
      type: object
      properties:
        corporateRelatedId:
          type: string
          format: uuid
        percentage:
          maximum: 100
          minimum: 0
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
    IndirectShareCreateRequestDto:
      required:
        - corporateRelatedId
        - ownedCorporateId
        - percentage
      type: object
      properties:
        corporateRelatedId:
          type: string
          format: uuid
        percentage:
          maximum: 100
          minimum: 0
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
        ownedCorporateId:
          type: string
          description: Identifier of the corporate in which he holds shares.
          format: uuid
    ShareCreateRequestDto:
      required:
        - corporateRelatedId
        - percentage
      type: object
      properties:
        percentage:
          maximum: 100
          minimum: 0
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
        corporateRelatedId:
          type: string
          format: uuid
      description: >-
        Must be filled in if the owner is UBO (shareholder with 25%+ shares or
        10%+ shares if the corporate must provide extended UBOs).
      anyOf:
        - $ref: '#/components/schemas/DirectShareCreateRequestDto'
        - $ref: '#/components/schemas/IndirectShareCreateRequestDto'
    ShareCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ScaDeviceRegistrationResponseDto:
      required:
        - activationCode
        - activationCodeSignature
        - activationQrCodeData
        - scaDeviceId
      type: object
      properties:
        scaDeviceId:
          type: string
          format: uuid
        activationQrCodeData:
          type: string
        activationCode:
          type: string
        activationCodeSignature:
          type: string
    TokenRefreshRequestDto:
      required:
        - refreshToken
      type: object
      properties:
        refreshToken:
          type: string
    TokenLoginResponseDto:
      title: Token
      required:
        - refreshToken
        - token
      type: object
      properties:
        token:
          type: string
        refreshToken:
          type: string
        endUserId:
          type: string
          description: >-
            If you are logging in as consumer or corporate, return the end-user
            ID.
          format: uuid
    AccountOwnerPasswordResetRequestDto:
      title: For Corporate Account Owner
      required:
        - accountOwnerPhone
        - partnerName
      type: object
      properties:
        accountOwnerPhone:
          pattern: ^[0-9]{2,17}$
          type: string
          description: >-
            The complete account owner's phone, including country code. Must not
            contain +.
          example: '33123456789'
        partnerName:
          type: string
    ConsumerPasswordResetRequestDto:
      title: For Consumer
      required:
        - consumerPhone
        - partnerName
      type: object
      properties:
        consumerPhone:
          pattern: ^[0-9]{2,17}$
          type: string
          description: >-
            The complete consumer's phone, including country code. Must not
            contain +.
          example: '33123456789'
        partnerName:
          type: string
    PasswordResetRequestDto:
      required:
        - partnerName
      type: object
      properties:
        partnerName:
          type: string
      anyOf:
        - $ref: '#/components/schemas/ConsumerPasswordResetRequestDto'
        - $ref: '#/components/schemas/AccountOwnerPasswordResetRequestDto'
    PasswordResetResponseDto:
      required:
        - passwordChangeSecret
      type: object
      properties:
        passwordChangeSecret:
          type: string
    AccountOwnerPasswordChangeWithPasswordRequestDto:
      title: With current password for corporate account owner
      required:
        - accountOwnerPhone
        - currentPassword
        - newPassword
        - partnerName
      type: object
      properties:
        accountOwnerPhone:
          pattern: ^[0-9]{2,17}$
          type: string
          description: >-
            The complete consumer's phone, including country code. Must not
            contain +.
          example: '33123456789'
        partnerName:
          type: string
        currentPassword:
          type: string
        newPassword:
          maxLength: 2147483647
          minLength: 6
          type: string
    ConsumerPasswordChangeWithPasswordRequestDto:
      title: With current password for consumer
      required:
        - consumerPhone
        - currentPassword
        - newPassword
        - partnerName
      type: object
      properties:
        consumerPhone:
          pattern: ^[0-9]{2,17}$
          type: string
          description: >-
            The complete consumer's phone, including country code. Must not
            contain +.
          example: '33123456789'
        partnerName:
          type: string
        currentPassword:
          type: string
        newPassword:
          maxLength: 2147483647
          minLength: 6
          type: string
    PasswordChangeRequestDto:
      required:
        - newPassword
      type: object
      properties:
        newPassword:
          maxLength: 2147483647
          minLength: 6
          type: string
      anyOf:
        - $ref: '#/components/schemas/PasswordChangeWithSecretRequestDto'
        - $ref: '#/components/schemas/ConsumerPasswordChangeWithPasswordRequestDto'
        - $ref: >-
            #/components/schemas/AccountOwnerPasswordChangeWithPasswordRequestDto
    PasswordChangeWithSecretRequestDto:
      title: With secret
      required:
        - newPassword
        - passwordChangeSecret
      type: object
      properties:
        passwordChangeSecret:
          type: string
        newPassword:
          maxLength: 2147483647
          minLength: 6
          type: string
    DebtorBankingDetails:
      type: object
      anyOf:
        - $ref: '#/components/schemas/SepaDebtorBankingDetails'
    DebtorCreateRequestDto:
      required:
        - name
        - type
      type: object
      properties:
        type:
          type: string
          description: Describe if the debtor is a person or a company.
          enum:
            - PERSON
            - COMPANY
        name:
          maxLength: 511
          minLength: 3
          type: string
          description: >-
            Complete name of the person (firstName middleName lastName) or name
            of the company.
          example: John Michael Doe
        bankingDetails:
          $ref: '#/components/schemas/DebtorBankingDetails'
      description: The information on the debtor.
    DirectDebitMandateCreateRequestDto:
      required:
        - debtor
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        debtor:
          $ref: '#/components/schemas/DebtorCreateRequestDto'
        recurring:
          type: boolean
          description: >-
            If true, the mandate will be used for recurring payments. By default
            is false.
        expirationDate:
          type: string
          description: >-
            The expiration date of the mandate. By default is 5 years from
            today.
          format: date
    SepaDebtorBankingDetails:
      required:
        - bic
        - iban
      type: object
      properties:
        iban:
          type: string
          description: Must be a valid iban format following the standard ISO_13616.
        bic:
          type: string
          description: Must be a valid bic following the standard ISO_9362.
    DirectDebitMandateCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    DirectDebitMandateCancelResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    DirectDebitMandateActivateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    AccountOwnerUserPassLoginRequestDto:
      title: Corporate Account Owner Login
      required:
        - accountOwnerPhone
        - partnerName
        - password
      type: object
      properties:
        accountOwnerPhone:
          pattern: ^[0-9]{2,17}$
          type: string
          description: >-
            The complete account owner's phone, including country code. Must not
            contain +.
          example: '33123456789'
        partnerName:
          type: string
        password:
          type: string
    ConsumerUserPassLoginRequestDto:
      title: Consumer Login
      required:
        - consumerPhone
        - partnerName
        - password
      type: object
      properties:
        consumerPhone:
          pattern: ^[0-9]{2,17}$
          type: string
          description: >-
            The complete consumer's phone, including country code. Must not
            contain +.
          example: '33123456789'
        partnerName:
          type: string
        password:
          type: string
    PartnerUserPassLoginRequestDto:
      title: Partner Login
      required:
        - partnerName
        - password
        - username
      type: object
      properties:
        username:
          type: string
        partnerName:
          type: string
        password:
          type: string
    UserPassLoginRequestDto:
      required:
        - password
      type: object
      properties:
        password:
          type: string
      anyOf:
        - $ref: '#/components/schemas/ConsumerUserPassLoginRequestDto'
        - $ref: '#/components/schemas/AccountOwnerUserPassLoginRequestDto'
        - $ref: '#/components/schemas/PartnerUserPassLoginRequestDto'
    UserPassChangeLoginResponseDto:
      title: Password Change Required
      required:
        - passwordChangeSecret
      type: object
      properties:
        passwordChangeSecret:
          type: string
      description: >-
        Sometimes for security reason, linkcy can force a user to change his
        password.


        You would then receive this payload. The secret can be used to change
        the password on the endpoint meant for that purpose.
    UserPassLoginResponseDto:
      type: object
      anyOf:
        - $ref: '#/components/schemas/TokenLoginResponseDto'
        - $ref: '#/components/schemas/UserPassChangeLoginResponseDto'
    ClassicLedgerCreateRequestDto:
      required:
        - type
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        type:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_BG
        autoUpgrade:
          type: boolean
          description: If true, this ledger will be automatically upgraded once activated.
        limits:
          $ref: '#/components/schemas/LedgerLimitsRequestDto'
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
    LedgerCreateRequestDto:
      type: object
      properties:
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
      anyOf:
        - $ref: '#/components/schemas/ClassicLedgerCreateRequestDto'
        - $ref: '#/components/schemas/VirtualLedgerCreateRequestDto'
    LedgerLimitsRequestDto:
      type: object
      properties:
        ddTransactionLimit:
          type: number
          description: >-
            Direct debit transaction limit. If null, it will take the default
            value defined in the partner configuration.
        ddMonthlyLimit:
          type: number
          description: >-
            Direct Debit Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
        transactionLimit:
          type: number
          description: >-
            Transaction Limit. If null, it will take the default value defined
            in the partner configuration.
        transactionDailyLimit:
          type: number
          description: >-
            Transaction Daily Limit. If null, it will take the default value
            defined in the partner configuration.
        transactionMonthlyLimit:
          type: number
          description: >-
            Transaction Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
    VirtualLedgerCreateRequestDto:
      required:
        - parentLedgerId
      type: object
      properties:
        parentLedgerId:
          type: string
          format: uuid
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
    LedgerCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    LedgerSuspendRequestDto:
      required:
        - blockIncomingTransaction
        - reason
      type: object
      properties:
        operator:
          title: Operator
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        reason:
          type: string
        blockIncomingTransaction:
          type: boolean
    LedgerCloseRequestDto:
      required:
        - operator
      type: object
      properties:
        operator:
          title: Operator
          type: string
          description: Description of reason if 'OTHER' was chosen.
          default: END_USER
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        reason:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of reason if 'OTHER' was chosen.
    ConsumerKycCreateRequestDto:
      required:
        - kycConfiguration
      type: object
      properties:
        consumerId:
          type: string
          description: >-
            Id of the consumer doing the KYC (Will be ignored and deducted from
            current authenticated user if end-user).
          format: uuid
        kycConfiguration:
          $ref: '#/components/schemas/KycCreateConfigurationRequestDto'
    DefaultKycCreateConfigurationRequestDto:
      required:
        - accessType
      type: object
      properties:
        accessType:
          type: string
          enum:
            - LINK
            - SDK
        urlOnComplete:
          type: string
          description: Callback url on KYC completed (only for LINK access type).
          example: https://google.com
        urlOnFailure:
          type: string
          description: Callback url on KYC failed (only for LINK access type).
          example: https://google.com
      description: Default KYC
    KycCreateConfigurationRequestDto:
      type: object
      anyOf:
        - $ref: '#/components/schemas/DefaultKycCreateConfigurationRequestDto'
    KycCreateRequestDto:
      required:
        - kycConfiguration
      type: object
      properties:
        kycConfiguration:
          $ref: '#/components/schemas/KycCreateConfigurationRequestDto'
      anyOf:
        - $ref: '#/components/schemas/ConsumerKycCreateRequestDto'
        - $ref: '#/components/schemas/RelatedPhysicalPersonKycCreateRequestDto'
    RelatedPhysicalPersonKycCreateRequestDto:
      required:
        - kycConfiguration
        - relatedPhysicalPersonId
      type: object
      properties:
        relatedPhysicalPersonId:
          type: string
          description: Id of the corporate-related person doing the KYC.
          format: uuid
        kycConfiguration:
          $ref: '#/components/schemas/KycCreateConfigurationRequestDto'
    DelegatedKycCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
      description: Id and basic information of the created KYC.
    KycCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
      anyOf:
        - $ref: '#/components/schemas/KycSdkTokenCreateResponseDto'
        - $ref: '#/components/schemas/KycLinkCreateResponseDto'
        - $ref: '#/components/schemas/DelegatedKycCreateResponseDto'
    KycLinkCreateResponseDto:
      required:
        - id
        - ttl
        - url
      type: object
      properties:
        id:
          type: string
          description: The identifier of the created KYC application.
          format: uuid
        url:
          type: string
          description: KYC validation url.
        ttl:
          type: string
          description: The KYC link time to live duration in ISO 8601.
          example: PT8H6M12.345S
          default: PT720H
      description: Id and basic information of the created KYC.
    KycSdkTokenCreateResponseDto:
      required:
        - flowName
        - id
        - kycApiUrl
        - token
        - ttl
      type: object
      properties:
        id:
          type: string
          description: >-
            The identifier of the KYC application created. When making a request
            with the KYC SDK: you will need to add this ID in the 'externalId'
            payload field (in 'metadata').
          format: uuid
        token:
          type: string
          description: >-
            The KYC SDK JWT that you will need to use to authorize your request
            with the KYC SDK.
        kycApiUrl:
          type: string
          description: >-
            The base URL you will need to use to create your request with the
            KYC SDK.
        flowName:
          type: string
          description: >-
            The KYC flow name you will need to use to create your request with
            the KYC SDK.
        ttl:
          type: string
          description: The KYC SDK token time to live duration in ISO 8601.
          example: PT8H6M12.345S
          default: PT24H
      description: Id and basic information of the created KYC.
    EuropeanAddressRequestDto:
      title: EuropeanAddressRequest
      required:
        - city
        - isoCountryCode
        - postalCode
        - street
      type: object
      properties:
        isoCountryCode:
          title: European Country Code
          type: string
          enum:
            - AUT
            - AND
            - BEL
            - BGR
            - CHE
            - CYP
            - CZE
            - DEU
            - DNK
            - ESP
            - EST
            - FIN
            - FRA
            - GBR
            - GRC
            - HRV
            - HUN
            - IRL
            - ISL
            - ITA
            - LIE
            - LTU
            - LUX
            - LVA
            - MLT
            - MCO
            - NLD
            - NOR
            - POL
            - PRT
            - ROU
            - SVN
            - SVK
            - SWE
        city:
          maxLength: 255
          minLength: 0
          type: string
        postalCode:
          maxLength: 10
          minLength: 0
          type: string
        street:
          maxLength: 511
          minLength: 0
          type: string
        number:
          maxLength: 255
          minLength: 0
          type: string
        refinement:
          maxLength: 35
          minLength: 0
          type: string
        stateOrProvince:
          maxLength: 255
          minLength: 0
          type: string
        bypassVerification:
          type: boolean
          description: >-
            If true, the address will be saved as described in the request
            without any auto-verification and the status will be INVALID until a
            POA is provided.


            By default is false.
    KycSimulateConsumerRequestDto:
      title: ConsumerKycSimulateRequest
      required:
        - kycStatus
      type: object
      properties:
        consumerId:
          type: string
          description: >-
            Id of the consumer doing the KYC (Will be ignored and deducted from
            current authenticated user if consumer)
          format: uuid
        kycStatus:
          type: string
          description: The new KYC status
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - PENDING_REVIEW
            - ABORTED
            - VALIDATED
            - DECLINED
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        middleName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthDate:
          type: string
          format: date
        emailAddress:
          type: string
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        onboardingIpAddress:
          type: string
    KycSimulateCorporateRelatedPhysicalPersonRequestDto:
      title: CorporateRelatedKycSimulateRequest
      required:
        - kycStatus
        - relatedPhysicalPersonId
      type: object
      properties:
        relatedPhysicalPersonId:
          type: string
          description: Id of the corporate-related person doing the KYC
          format: uuid
        kycStatus:
          type: string
          description: The new KYC status
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - PENDING_REVIEW
            - ABORTED
            - VALIDATED
            - DECLINED
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        middleName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthDate:
          type: string
          format: date
        emailAddress:
          type: string
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        onboardingIpAddress:
          type: string
    KycSimulateRequestDto:
      required:
        - kycStatus
      type: object
      properties:
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        middleName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        emailAddress:
          type: string
        kycStatus:
          type: string
          description: The new KYC status
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - PENDING_REVIEW
            - ABORTED
            - VALIDATED
            - DECLINED
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        birthDate:
          type: string
          format: date
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        onboardingIpAddress:
          type: string
      anyOf:
        - $ref: '#/components/schemas/KycSimulateConsumerRequestDto'
        - $ref: >-
            #/components/schemas/KycSimulateCorporateRelatedPhysicalPersonRequestDto
    KycSimulateConsumerResponseDto:
      title: ConsumerKycSimulateResponse
      required:
        - consumerId
        - kycApplicationId
      type: object
      properties:
        kycApplicationId:
          type: string
          format: uuid
        consumerId:
          type: string
          description: Id of the consumer doing the KYC
          format: uuid
    KycSimulateCorporateRelatedPhysicalPersonResponseDto:
      title: CorporateRelatedKycSimulateResponse
      required:
        - kycApplicationId
        - relatedPhysicalPersonId
      type: object
      properties:
        kycApplicationId:
          type: string
          format: uuid
        relatedPhysicalPersonId:
          type: string
          description: Id of the corporate-related person doing the KYC
          format: uuid
    KycSimulateResponseDto:
      required:
        - kycApplicationId
      type: object
      properties:
        kycApplicationId:
          type: string
          format: uuid
      anyOf:
        - $ref: '#/components/schemas/KycSimulateConsumerResponseDto'
        - $ref: >-
            #/components/schemas/KycSimulateCorporateRelatedPhysicalPersonResponseDto
    EndUserSuspensionRequestDto:
      required:
        - reason
      type: object
      properties:
        operator:
          title: Operator
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        reason:
          type: string
    EndUserCloseRequestDto:
      required:
        - reason
      type: object
      properties:
        reason:
          type: string
    DocumentUploadRequestDto_Partner:
      title: DocumentUploadRequest
      required:
        - file
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        type:
          title: DocumentType
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        documentId:
          type: string
          description: >-
            Use this field if the document you want to upload was requested
            (status REQUESTED).


            Note: you do not need to fill endUserId and type fields when you
            upload a requested document.
          format: uuid
        transactionId:
          type: string
          description: >-
            ID of the transaction if the document is a TRANSACTION_RECEIPT or
            any document related to a transaction.
          format: uuid
        beneficiaryId:
          type: string
          description: ID of the beneficiary associated with the document.
          format: uuid
        addressId:
          type: string
          description: ID of the address associated with the document.
          format: uuid
        corporateRelatedId:
          type: string
          description: ID of the corporate related associated with the document.
          format: uuid
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        file:
          type: string
          format: binary
      description: >-
        Upload a document. The document can be uploaded directly or for a
        document in REQUESTED status.
    DocumentUploadResponseDto_Partner:
      title: DocumentUploadResponse
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    DocumentRequestCreateRequestDto:
      title: DocumentRequestCreateRequest
      required:
        - endUserId
        - type
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        type:
          title: DocumentType
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        note:
          type: string
        transactionId:
          type: string
          description: >-
            ID of the transaction if the document is a TRANSACTION_RECEIPT or
            any document related to a transaction.
          format: uuid
        beneficiaryId:
          type: string
          format: uuid
        corporateRelatedId:
          type: string
          format: uuid
        addressId:
          type: string
          format: uuid
    DocumentRequestCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CryptoWalletCreateRequestDto:
      required:
        - blockchain
        - friendlyName
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        friendlyName:
          maxLength: 90
          minLength: 0
          type: string
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
    CryptoWalletCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CryptoTransactionCreateRequestDto:
      required:
        - amount
        - asset
        - beneficiaryId
        - walletFromId
      type: object
      properties:
        beneficiaryId:
          type: string
          format: uuid
        walletFromId:
          type: string
          format: uuid
        reference:
          maxLength: 60
          minLength: 0
          pattern: ^[.'a-zA-ZÀ-ÿ0-9,? ]*$
          type: string
        asset:
          type: string
          description: >-
            The symbol of the asset to be sent. For example, 'SepoliaETH' for
            Sepolia Ethereum.
          example: ETH
        contract:
          type: string
        amount:
          type: number
          description: >-
            Amount in the smallest fraction. (example: for 1 ETH, amount should
            be 1000000000000000000)
    CryptoTransactionCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CryptoBeneficiaryCreateRequestDto:
      required:
        - name
        - type
        - walletDetails
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        type:
          type: string
          description: Describe if the beneficiary is a person or a company.
          enum:
            - PERSON
            - COMPANY
        name:
          maxLength: 511
          minLength: 3
          type: string
          description: >-
            Complete name of the person (firstName middleName lastName) or name
            of the company.
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
          description: Friendly name given to the beneficiary.
        display:
          type: boolean
          description: >-
            Display (or not) the beneficiary to the end-user (unusable by
            end-user).
        walletDetails:
          $ref: '#/components/schemas/WalletDetails'
    WalletDetails:
      required:
        - address
        - blockchain
        - type
      type: object
      properties:
        address:
          type: string
          description: Counterparty wallet address.
        blockchain:
          type: string
          description: >-
            Counterparty wallet blockchain. The enumeration is the same as the
            one in Create Wallet endpoint because you can only create
            transactions on the same blockchain as the wallet sender.
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        type:
          type: string
          enum:
            - CUSTODIAL
            - NON_CUSTODIAL
        provider:
          type: string
          description: Optional, used only for CUSTODIAL wallets.
    CryptoBeneficiaryCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    AccountOwnerInfo:
      required:
        - firstName
        - isDirector
        - lastName
        - phone
      type: object
      properties:
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        isDirector:
          type: boolean
          description: Indicates if the owner is also a director.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        directSharesPercentage:
          maximum: 100
          minimum: 0
          type: number
          format: float
        address:
          $ref: '#/components/schemas/WorldwideAddressRequestDto'
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        emailAddress:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneRequestDto'
      description: >-
        Information of the person who will manage this corporate end-user
        account.
    AustriaLegalType:
      required:
        - austriaValue
      type: object
      properties:
        austriaValue:
          type: string
          enum:
            - AT_AKTIENGESELLSCHAFT_AG
            - AT_EINGETRAGENES_EINZELUNTERNEHMEN_EU
            - AT_EUROPEAN_BUSINESS_ENTITIES
            - AT_GENOSSENSCHAFT_GEN
            - AT_GESELLSCHAFT_DES_BURGERLICHEN_RECHTS_GESBR
            - AT_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - AT_KOMMANDITERWERBSGESELLSCHAFT_KEG
            - AT_KOMMANDITGESELLSCHAFT_KG
            - AT_OFFENE_ERWERBSGESELLSCHAFT_OEG
            - AT_OFFENE_GESELLSCHAFT_OG
            - AT_PRIVATSTIFTUNG
            - AT_STILLE_GESELLSCHAFT_STG
            - AT_VEREIN
    BelgiumLegalType:
      required:
        - belgiumValue
      type: object
      properties:
        belgiumValue:
          type: string
          enum:
            - BE_ASSOCIATION_SANS_BUT_LUCRATIF_ASBL
            - BE_BESLOTEN_VENNOOTSCHAP_BV
            - BE_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_BVBA
            - BE_COMMANDITAIRE_VENNOOTSCHAP_OP_AANDELEN_COMMVA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_CVBA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_ONBEPERKTE_AANSPRAKELIJKHEID_CVOA
            - BE_ECONOMISCH_SAMENWERKINGSVERBAND_ESV
            - BE_EENMANSZAAK
            - >-
              BE_EENPERSOONS_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_EBVBA
            - BE_ENTREPRISE_INDIVIDUELLE
            - BE_FEITELIJKE_VERENIGING
            - BE_FONDATION_DUTILITE_PUBLIQUE
            - BE_FONDATION_PRIVEE
            - BE_GEWONE_COMMANDITAIRE_VENNOOTSCHAP_COMMV
            - BE_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - BE_NAAMLOZE_VENNOOTSCHAP_NV
            - BE_PRIVATE_STICHTING
            - BE_SOCIETE_ANONYME_SA
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_ILLIMITEE_SCRI
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_LIMITEE_SCRL
            - BE_SOCIETE_DE_FAIT
            - BE_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - BE_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - BE_SOCIETE_EN_NOM_COLLECTIF_SN
            - BE_SOCIETE_EN_PARTICIPATION_SEP
            - BE_SOCIETE_INTERNE
            - BE_SOCIETE_MOMENTANEE
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_SPRL
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_UNIPERSONNELLE_SPRLU
            - BE_STICHTING_VAN_OPENBAAR_NUT
            - BE_STILLE_HANDELSVENNOOTSCHAP
            - BE_TIJDELIJKE_HANDELSVENNOOTSCHAP
            - BE_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - BE_VEREINIGUNG_OHNE_GEWINNERZIELUNGSABSICHT_VOG
            - BE_VERENIGING_IN_DEELNEMING
            - BE_VERENIGING_ZONDER_WINSTOOGMERK_VZW
    BulgariaLegalType:
      required:
        - bulgariaValue
      type: object
      properties:
        bulgariaValue:
          type: string
          enum:
            - BG_AKTSIONERNO_DRUJESTVO_AD
            - >-
              BG_AKTSIONERNO_DRUZHESTVO_SUS_SPETSIALNA_INVESTITSIONNA_TSEL_ADSITZ
            - BG_DRUJESTVO_S_OGRANICHENA_OTGOVORNOST_OOD
            - BG_EDNOLICHEN_TURGOVETZ_ET
            - BG_EDNOLICHNO_AKTSIONERNO_DRUZHESTVO_EAD
            - BG_EDNOLICHNO_DRUZHESTVO_S_OGRANICHENA_OTGOVORNOST_EOOD
            - BG_KOMANDITNO_DRUZHESTVO_KD
            - BG_KOMANDITNO_DRUZHESTVO_S_AKTZII_KDA
            - BG_SUBIRATELNO_DRUZHESTVO_SD
    CorporateApiLegalType:
      type: object
      anyOf:
        - $ref: '#/components/schemas/AustriaLegalType'
        - $ref: '#/components/schemas/BelgiumLegalType'
        - $ref: '#/components/schemas/BulgariaLegalType'
        - $ref: '#/components/schemas/SwitzerlandLegalType'
        - $ref: '#/components/schemas/CyprusLegalType'
        - $ref: '#/components/schemas/CzechiaLegalType'
        - $ref: '#/components/schemas/GermanyLegalType'
        - $ref: '#/components/schemas/DenmarkLegalType'
        - $ref: '#/components/schemas/EstoniaLegalType'
        - $ref: '#/components/schemas/SpainLegalType'
        - $ref: '#/components/schemas/FinlandLegalType'
        - $ref: '#/components/schemas/FranceLegalType'
        - $ref: '#/components/schemas/MonacoLegalType'
        - $ref: '#/components/schemas/UnitedKingdomLegalType'
        - $ref: '#/components/schemas/GreeceLegalType'
        - $ref: '#/components/schemas/CroatiaLegalType'
        - $ref: '#/components/schemas/HungaryLegalType'
        - $ref: '#/components/schemas/IrelandLegalType'
        - $ref: '#/components/schemas/IcelandLegalType'
        - $ref: '#/components/schemas/ItalyLegalType'
        - $ref: '#/components/schemas/LiechtensteinLegalType'
        - $ref: '#/components/schemas/LithuaniaLegalType'
        - $ref: '#/components/schemas/LuxembourgLegalType'
        - $ref: '#/components/schemas/LatviaLegalType'
        - $ref: '#/components/schemas/MaltaLegalType'
        - $ref: '#/components/schemas/NetherlandsLegalType'
        - $ref: '#/components/schemas/NorwayLegalType'
        - $ref: '#/components/schemas/PolandLegalType'
        - $ref: '#/components/schemas/PortugalLegalType'
        - $ref: '#/components/schemas/RomaniaLegalType'
        - $ref: '#/components/schemas/SwedenLegalType'
        - $ref: '#/components/schemas/SloveniaLegalType'
        - $ref: '#/components/schemas/SlovakiaLegalType'
    CorporateCreateRequestDto:
      required:
        - accountOwnerInfo
        - incorporationCode
        - incorporationCountry
        - industry
        - registeredAddress
        - registeredName
      type: object
      properties:
        partnerName:
          type: string
          description: >-
            The partnerName, mandatory if you create a corporate as anonymous.
            Ignored if requesting as a partner.
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate to a
            user in your system.
        registeredName:
          maxLength: 255
          minLength: 0
          type: string
          description: The official corporate name. Must only contains Latin-1 characters.
        tradeName:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The name used for business if there is one. Must only contains
            Latin-1 characters.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        incorporationDate:
          type: string
          description: The date the corporate was officially registered.
          format: date
        legalType:
          $ref: '#/components/schemas/CorporateApiLegalType'
        website:
          maxLength: 511
          minLength: 0
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        vatNumber:
          type: string
          description: The corporate VAT number.
        registeredAddress:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        businessAddress:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        financialInformationRequestDto:
          $ref: '#/components/schemas/CorporateFinancialInformationRequestDto'
        employeesRange:
          type: string
          description: Range of the number of employees working for the corporate.
          enum:
            - BTW_1_AND_10
            - BTW_11_AND_50
            - MORE_THAN_50
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        lastTermsAccepted:
          type: string
          description: >-
            The version of the terms and conditions signed by the corporate
            account owner.
          example: '1.0'
        accountOwnerInfo:
          $ref: '#/components/schemas/AccountOwnerInfo'
        metadata:
          $ref: '#/components/schemas/JsonNode'
      description: The information needed to create a new corporate.
    CorporateFinancialInformationRequestDto:
      title: FinancialInformation
      required:
        - currency
        - expectedMonthlyIncomingTransferFrequency
        - expectedMonthlyIncomingVolume
        - expectedMonthlyOutgoingVolume
        - monthlyNetIncome
      type: object
      properties:
        currency:
          type: string
          description: The currency used for the expected monthly expenses.
          enum:
            - EUR
            - USD
            - GBP
        monthlyNetIncome:
          type: string
          description: The net financial revenue expected every month
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingVolume:
          type: string
          description: >-
            The amount of money you expect to receive with this account every
            month.
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyOutgoingVolume:
          type: string
          description: >-
            The amount of money you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          description: >-
            The frequency at which you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    CroatiaLegalType:
      required:
        - croatiaValue
      type: object
      properties:
        croatiaValue:
          type: string
          enum:
            - HR_DIONICKO_DRUSTVO_DD
            - HR_DOMACA_RADINOST_AND_SPOREDNO_ZANIMANJE
            - HR_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_DOO
            - HR_GOSPODARSKO_INTERESNO_UDRUZENJE_GIU
            - HR_JAVNO_TRGOVACKO_DRUSTVO_JTD
            - HR_JEDNOSTAVNO_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_JDOO
            - HR_KOMANDITNO_DRUSTVO_KD
            - HR_OBITELJSKO_POLJOPRIVREDNO_GOSPODARSTVO_OPG
            - HR_OBRT
            - HR_ORTAKLUK
            - HR_SLOBODNA_DJELATNOST
            - HR_ZADRUGA
    CyprusLegalType:
      required:
        - cyprusValue
      type: object
      properties:
        cyprusValue:
          type: string
          enum:
            - CY_PRIVATE_LIMITED_COMPANY_LTD
            - CY_PUBLIC_LIMITED_COMPANY_PLC
            - CY_COMPANY_LIMITED_BY_GUARANTEE
            - CY_GENERAL_PARTNERSHIP
            - CY_LIMITED_PARTNERSHIP
            - CY_SOLO_PROPRIETORSHIP
    CzechiaLegalType:
      required:
        - czechiaValue
      type: object
      properties:
        czechiaValue:
          type: string
          enum:
            - CZ_AKCIOVA_SPOLECNOST_AS
            - CZ_KOMANDITNI_SPOLECNOST_KS
            - CZ_OBECNE_PROSPESNA_SPOLECNOST_OPS
            - CZ_PRISPEVKOVA_ORGANIZACE
            - CZ_SPOLECNOST_S_RUCENIM_OMEZENYM_SRO
            - CZ_STATNI_PODNIK_SP
            - CZ_VEREJNA_OBCHODNI_SPOLECNOST_VOS
            - CZ_ZAPSANY_SPOLEK_ZS
            - CZ_ZIVNOST
    DenmarkLegalType:
      required:
        - denmarkValue
      type: object
      properties:
        denmarkValue:
          type: string
          enum:
            - DK_AKTIESELSKAB_A_S
            - DK_ANDELSSELSKAB_MED_BEGRAENSET_ANSVAR_AMBA
            - DK_ANPARTSSELSKAB_APS
            - DK_ENKELTMANDSVIRKSOMHED
            - DK_ERHVERVSDRIVENDE_FOND
            - DK_FORENING
            - DK_FORENING_MED_BEGRAENSET_ANSVAR_FMBA
            - DK_GENSIDIGT_SELSKAB_G_S
            - DK_INTERESSENTSKAB_I_S
            - DK_IVAERKSAETTERSELSKAB_IVS
            - DK_KOMMANDITSELSKAB_K_S
            - DK_PARTNERSELSKAB_OR_KOMMANDITAKTIESELSKAB_P_S
            - DK_PARTSREDERI
            - DK_SELSKAB_MED_BEGRAENSET_ANSVAR_SMBA
    EstoniaLegalType:
      required:
        - estoniaValue
      type: object
      properties:
        estoniaValue:
          type: string
          enum:
            - EE_AKTSIASELTS_AS
            - EE_FUUSILISEST_ISIKUST_ETTEVOTJA_FIE
            - EE_MITTETULUNDUSUHING_MTU
            - EE_OSAUHING_OU
            - EE_TAISUHING_TU
            - EE_TULUNDUSUHISTU
            - EE_USALDUSUHING_UU
    FinlandLegalType:
      required:
        - finlandValue
      type: object
      properties:
        finlandValue:
          type: string
          enum:
            - FI_ASUNTO_OSAKEYHTIO
            - FI_AVOIN_YHTIO_AY
            - FI_EUROOPPALAINEN_TALOUDELLINEN_ETUYHTYMA_EEIG
            - FI_EUROOPPAOSUUSKUNTA_SCE
            - FI_EUROOPPAYHTIO_SE
            - FI_JULKINEN_KESKINAINEN_VAKUUTUSYHTIO_JY
            - FI_JULKINEN_OSAKEYHTIO_OYJ
            - FI_KESKINAINEN_KIINTEISTOOSAKEYHTIO
            - FI_KESKINAINEN_VAKUUTUSYHTIO
            - FI_KESKIVEDENKORKEUDEN_MUUTTAMISTA_VARTEN_PERUSTETTU_YHTEISO
            - FI_KOMMANDIITTIYHTIO_KY
            - FI_KUNNALLINEN_LIIKELAITOS
            - FI_LAIVAISANNISTOYHTIO
            - FI_OJITUSYHTEISO
            - FI_OSAKASKUNTA
            - FI_OSAKEYHTIO_OY
            - FI_OSUUSKUNTA_OSK
            - FI_PALISKUNTA
            - FI_REKISTEROITY_PUOLUE_RP
            - FI_REKISTEROITY_YHDISTYS_RY
            - FI_SAANNOSTELY_YHTEISO
            - FI_SAASTOPANKKI
            - FI_SAATIO_RS
            - FI_TIEKUNTA
            - FI_TOIMINIMI_TMI
            - FI_UITTOYHTEISO
            - FI_USKONNOLLINEN_YHDYSKUNTA
            - FI_VALTION_LIIKELAITOS
            - FI_VESIOIKEUDELLINEN_YHTEISO_BODIES_OF_WATER
            - FI_VOLUNTARY_ASSOCIATIONS_CHARTERED_BY_STATUTE_LAW
            - FI_YHTEISALUE
            - FI_YHTEISMETSA
    FranceLegalType:
      required:
        - franceValue
      type: object
      properties:
        franceValue:
          type: string
          enum:
            - FR_ASSOCIATION_DECLAREE
            - FR_ASSOCIATION_NON_DECLAREE
            - FR_AUTO_ENTREPRENEUR
            - FR_ENTREPRISE_INDIVIDUELLE_ENTREPRISE_EN_NOM_PERSONNEL_EI
            - FR_ENTREPRISE_UNIPERSONNELLE_A_RESPONSABILITE_LIMITEE_EURL
            - FR_FOND_COMMUN_DE_PLACEMENT_FCP
            - FR_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - FR_PROFESSION_LIBERAL
            - FR_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - FR_SOCIETE_ANONYME_SA
            - FR_SOCIETES_DEXERCICE_LIBERAL
            - FR_SOCIETE_COOPERATIVE_DE_PRODUCTION_SCOP
            - FR_SOCIETE_DECONOMIE_MIXTE_SEM
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - FR_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - FR_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - FR_SOCIETE_EN_NOM_COLLECTIF_SNC
            - FR_SOCIETE_EN_PARTICIPATION_SEP
            - FR_SOCIETE_PAR_ACTIONS_SIMPLIFIEE_SAS
            - FR_SOCIETE_CIVILE_IMMOBILIERE_SCI
            - FR_U_UNIPERSONNELLE_SAS_SASU
    GermanyLegalType:
      required:
        - germanyValue
      type: object
      properties:
        germanyValue:
          type: string
          enum:
            - DE_AKTIENGESELLSCHAFT_AG
            - DE_ALTRECHTLICHER_VEREIN_RECHTSFAHIGER_VEREIN_RV
            - DE_ANSTALT_DES_OFFENTLICHEN_RECHTS
            - DE_EINGETRAGENER_KAUFMANN_EINGETRAGENE_KAUFFRAU_EK_EKFM_EKFR
            - DE_EINGETRAGENER_VEREIN_EV
            - DE_EINGETRAGENE_GENOSSENSCHAFT_EG
            - DE_EINZELUNTERNEHMEN
            - DE_GESELLSCHAFT_BURGERLICHEN_RECHTS_BGB_GESELLSCHAFT_GBR
            - DE_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - DE_KOMMANDITGESELLSCHAFT_AUF_AKTIEN_KGAA
            - DE_KOMMANDITGESELLSCHAFT_KG
            - DE_NICHT_EINGETRAGENER_VEREI
            - DE_OFFENE_HANDELSGESELLSCHAFT_OHG
            - DE_PARTENREEDEREI
            - >-
              DE_PARTNERSCHAFTSGESELLSCHAFT_MIT_BESCHRANKTER_BERUFSHAFTUNG_PARTGMBBH
            - DE_PARTNERSCHAFTSGESELLSCHAFT_PARTG
            - DE_STIFTUNG
            - DE_STIFTUNG_DES_OFFENTLICHEN_RECHTS
            - DE_UNTERNEHMERGESELLSCHAFT_UG
            - DE_WIRTSCHAFTLICHER_VEREIN
    GreeceLegalType:
      required:
        - greeceValue
      type: object
      properties:
        greeceValue:
          type: string
          enum:
            - GR_ANONIMI_ETERIA_AE
            - GR_ANONIMI_VIOMIHANIKI_EMBORIKI_ETERIA_AVEE
            - GR_ETERIA_PERIORISMENIS_EUTHINIS_EPE
            - GR_ETERORITHMI_ETERIA_EE
            - GR_IDIOTIKI_KEFALEOUHIKI_ETERIA_IKE
            - GR_MONOPROSOPI_ETERIA_PERIORISMENIS_EUTHINIS_MEPE
            - GR_OMORITHMI_ETERIA_OE
            - GR_OMORITHMI_VIOMIHANIKI_EMBORIKI_ETERIA_OVEE
    HungaryLegalType:
      required:
        - hungaryValue
      type: object
      properties:
        hungaryValue:
          type: string
          enum:
            - HU_BETETI_TARSASAG_BT
            - HU_EGYENI_CEG_EC
            - HU_EGYENI_VALLALKOZO_EV
            - HU_EGYESULES
            - HU_KORLATOLT_FELELOSSEGU_TARSASAG_KFT
            - HU_KOZHASZNU_TARSASAG_KHT
            - HU_KOZKERESETI_TARSASAG_KKT
            - HU_KOZOS_VALLALAT_KV
            - HU_NYILVANOSAN_MUKODO_RESZVENYTARSASAG_NYRT
            - HU_RESZVENYTARSASAG_RT
            - HU_SZOVETKEZET_SZOV
            - HU_ZARTKOZUEN_MUKODO_RESZVENYTARSASAG_ZRT
    IcelandLegalType:
      required:
        - icelandValue
      type: object
      properties:
        icelandValue:
          type: string
          enum:
            - IS_EINKAHLUTAFELAG_EHF
            - IS_EINSTAKLINGSFYRIRTAEKI
            - IS_HLUTAFELAG_HF
            - IS_OPINBERT_HLUTAFELAG_OHF
            - IS_SAMEIGNARFELAG_SF
            - IS_SAMLAGSFELAG
            - IS_SAMVINNUFELAG
            - IS_SJALFSEIGNARSTOFNUN
    IrelandLegalType:
      required:
        - irelandValue
      type: object
      properties:
        irelandValue:
          type: string
          enum:
            - IE_A_PUBLIC_LIMITED_COMPANY
            - IE_COMPANY_LIMITED_BY_GUARANTEE_HAVING_A_SHARE_CAPITAL
            - IE_COMPANY_LIMITED_BY_GUARANTEE_NOT_HAVING_A_SHARE_CAPITAL
            - IE_PRIVATE_COMPANY_LIMITED_BY_SHARES
            - IE_SINGLE_MEMBER_COMPANY
            - >-
              IE_UNDERTAKINGS_FOR_COLLECTIVE_INVESTMENT_IN_TRANSFERABLE_SECURITIES_UCITS
            - IE_UNLIMITED_COMPANY
    ItalyLegalType:
      required:
        - italyValue
      type: object
      properties:
        italyValue:
          type: string
          enum:
            - IT_ARTIGIANO
            - IT_IMPRENDITORE
            - IT_LAVORATORE_AUTONOMO
            - IT_LIBERO_PROFESSIONISTA
            - IT_SOCIETA_A_RESPONSABILITA_LIMITATA_SRL
            - IT_SOCIETA_COOPERATIVA_A_RESPONSABILITA_LIMITATA_SCRL
            - IT_SOCIETA_IN_ACCOMANDITA_PER_AZIONI_SAPA
            - IT_SOCIETA_IN_ACCOMANDITA_SEMPLICE_SAS
            - IT_SOCIETA_IN_NOME_COLLETTIVO_SNC
            - IT_SOCIETA_PER_AZIONI_SPA
            - IT_SOCIETA_SEMPLICE_SS
    JsonNode:
      type: object
      description: |-
        A custom field to save data.

        This field's size is limited to 3000 characters.
    LatviaLegalType:
      required:
        - latviaValue
      type: object
      properties:
        latviaValue:
          type: string
          enum:
            - LV_AKCIJU_SABIEDRIBA_AS
            - LV_ARZEMJU_KOMERSANTA_FILIALE_AKF
            - LV_BEZPELNAS_ORGANIZACIJA_BO
            - LV_INDIVIDUALAIS_KOMERSANTS_IK
            - LV_KOMANDITSABIEDRIBA_KS
            - LV_PILNSABIEDRIBA_PS
            - LV_SABIEDRIBA_AR_IEROBEZOTU_ATBILDIBU_SIA
    LiechtensteinLegalType:
      required:
        - liechtensteinValue
      type: object
      properties:
        liechtensteinValue:
          type: string
          enum:
            - LI_AKTIENGESELLSCHAFT_AG
            - LI_ANSTALT
            - LI_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - LI_STIFTUNG
            - LI_TREUHANDSC_TREUUNTERNEHMEN_HAFT
    LithuaniaLegalType:
      required:
        - lithuaniaValue
      type: object
      properties:
        lithuaniaValue:
          type: string
          enum:
            - LT_AKCINE_BENDROVE_AB
            - LT_INDIVIDUALI_IMONE_II
            - LT_INDIVIDUALI_VEIKLA
            - LT_KOMANDITINE_UKINE_BENDRIJA_KUB
            - LT_MAZOJI_BENDRIJA_MB
            - LT_TIKROJI_UKINE_BENDRIJA_TUB
            - LT_UZDAROJI_AKCINE_BENDROVE_UAB
            - LT_VIESOJI_ISTAIGA_VSI
    LuxembourgLegalType:
      required:
        - luxembourgValue
      type: object
      properties:
        luxembourgValue:
          type: string
          enum:
            - LU_SOCIETE_ANONYME_SA
            - LU_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - LU_SOCIETE_EN_COMMANDITE_SIMPLE_SECS
    MaltaLegalType:
      required:
        - maltaValue
      type: object
      properties:
        maltaValue:
          type: string
          enum:
            - MT_PRIVATE_LIMITED_COMPANY
            - MT_PUBLIC_LIABILITY_COMPANY
            - MT_PARTNERSHIP_EN_NOM_COLLECTIF
            - MT_PARTNERSHIP_EN_COMMANDITE
            - MT_LIMITED_LIABILITY_COMPANY_LLC
            - MT_BRANCHES_OF_OVERSEA_COMPANIES
            - MT_GENERAL_PARTNERSHIPS
            - MT_LIMITED_PARTNERSHIPS
    MonacoLegalType:
      required:
        - monacoValue
      type: object
      properties:
        monacoValue:
          type: string
          enum:
            - MC_ASSOCIATION
            - MC_FONDATION
            - MC_SOCIETE_ANONYME_MONEGASQUE_SAM
            - MC_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - MC_SOCIETE_EN_NOM_COLLECTIF_SNC
            - MC_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - MC_ENTREPRISE_INDIVIDUELLE_EI
            - MC_SUCCURSALE
            - MC_SOCIETE_CIVILE_IMMOBILIERE_SCI
    NetherlandsLegalType:
      required:
        - netherlandsValue
      type: object
      properties:
        netherlandsValue:
          type: string
          enum:
            - NL_BEPERKTE_AANSPRAKELIJKHEID_BA
            - NL_BESLOTEN_VENNOOTSCHAP_BV
            - NL_COMMANDITAIRE_VENNOOTSCHAP_CV
            - NL_COOPERATIE
            - NL_EENMANSZAAK
            - NL_MAATSCHAP_MTS
            - NL_NAAMLOZE_VENNOOTSCHAP_NV
            - NL_ONDERLINGE_WAARBORGMAATSCHAPPIJ
            - NL_STICHTING
            - NL_UITSLUITING_VAN_AANSPRAKELIJKHEID_UA
            - NL_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - NL_WETTELIJKE_AANSPRAKELIJKHEID_WA
    NorwayLegalType:
      required:
        - norwayValue
      type: object
      properties:
        norwayValue:
          type: string
          enum:
            - NO_AKSJESELSKAP_AS
            - NO_ALLMENNAKSJESELSKAP_ASA
            - NO_ANSVARLIG_SELSKAP_ANS
            - NO_BORETTSLAG_BL
            - NO_ENKELTPERSONFORETAK
            - NO_FYLKESKOMMUNALT_FORETAK_FKF
            - NO_HELSEFORETAK_HF
            - NO_INTERKOMMUNALT_SELSKAP_IKS
            - NO_KOMMANDITTSELSKAP_KS
            - NO_KOMMUNALT_FORETAK_KF
            - NO_NORSKREGISTRERT_UTENLANDSK_FORETAK_NUF
            - NO_REGIONALT_HELSEFORETAK_RHF
            - NO_SELSKAP_MED_BEGRENSET_ANSVAR_BA
            - NO_SELSKAP_MED_DELT_ANSVAR_DA
            - NO_SPAREBANK_SAVINGS_BANK
            - NO_STATE_COUNTY_OR_MUNICIPAL_AGENCY_ETAT
            - NO_STATSFORETAK_SF
            - NO_STIFTELSE
    PhoneRequestDto:
      required:
        - countryCode
        - number
      type: object
      properties:
        countryCode:
          type: string
          example: '33'
        number:
          pattern: ^[0-9]{1,14}$
          type: string
    PolandLegalType:
      required:
        - polandValue
      type: object
      properties:
        polandValue:
          type: string
          enum:
            - PL_JEDNOOSOBOWA_DZIALALNOSC_GOSPODARCZA
            - PL_PRZEDSIEBIORSTWO_PANSTWOWE
            - PL_SPOLDZIELNIA
            - PL_SPOLKA_AKCYJNA_SA
            - PL_SPOLKA_CYWILNA_SC
            - PL_SPOLKA_JAWNA_SPJ
            - PL_SPOLKA_KOMANDYTOWA_SPK
            - PL_SPOLKA_KOMANDYTOWO_AKCYJNA_SKA
            - PL_SPOLKA_PARTNERSKA_SPP
            - PL_SPOLKA_Z_OGRANICZONA_ODPOWIEDZIALNOSCIA_SP_Z_OO
    PortugalLegalType:
      required:
        - portugaValue
      type: object
      properties:
        portugaValue:
          type: string
          enum:
            - PT_COOPERATIVA_DE_RESPONSABILIDADE_LIMITADA_CRL
            - PT_LIMITADA_LDA
            - PT_SOCIEDADE_ABERTA_SA
            - PT_SOCIEDADE_FECHADA_SF
            - PT_SOCIEDADE_GESTORA_DE_PARTICIPACOES_SOCIAIS_SGPS
    RomaniaLegalType:
      required:
        - romaniaValue
      type: object
      properties:
        romaniaValue:
          type: string
          enum:
            - RO_ORGANIZATIE_NON_GUVERNAMENTALA_ONG
            - RO_PERSOANA_FIZICA_AUTORIZATA_PFA
            - >-
              RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_CU_PROPRIETAR_UNIC_SRL_CU_PROPRIETAR_UNIC
            - RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATEA_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATEA_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATEA_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATEA_PE_ACTIUNI_SA
            - RO_SOCIETATE_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATE_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATE_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATE_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATE_PE_ACTIUNI_SA
    SlovakiaLegalType:
      required:
        - slovakiaValue
      type: object
      properties:
        slovakiaValue:
          type: string
          enum:
            - SK_AKCIOVA_SPOLOCNOST_AS
            - SK_DRUZSTVO
            - SK_KOMANDITNA_SPOLOCNOST_KS
            - SK_SPOLOCNOST_S_RUCENIM_OBMEDZENYM_SRO
            - SK_VEREJNA_OBCHODNA_SPOLOCNOST_VOS
            - SK_ZIVNOST
    SloveniaLegalType:
      required:
        - sloveniaValue
      type: object
      properties:
        sloveniaValue:
          type: string
          enum:
            - SI_DELNISKA_DRUZBA_DD
            - SI_DRUZBA_Z_NEOMEJENO_ODGOVORNOSTJO_DNO
            - SI_DRUZBA_Z_OMEJENO_ODGOVORNOSTJO_DOO
            - SI_KOMANDITNA_DRUZBA_KD
            - SI_SAMOSTOJNI_PODJETNIK_SP
    SpainLegalType:
      required:
        - spainValue
      type: object
      properties:
        spainValue:
          type: string
          enum:
            - ES_SOCIEDAD_ANONIMA_DEPORTIVA_SAD
            - ES_SOCIEDAD_ANONIMA_SA
            - ES_SOCIEDAD_CIVIL_PRIVADA_SCP
            - ES_SOCIEDAD_COLECTIVA_SC
            - ES_SOCIEDAD_COMANDITARIA_SCRA
            - ES_SOCIEDAD_COOPERATIVA_SCOOP
            - ES_SOCIEDAD_LIMITADA_LABORAL_SLL
            - ES_SOCIEDAD_LIMITADA_NUEVA_EMPRESA_SLNE
            - ES_SOCIEDAD_LIMITADA_SL
    SwedenLegalType:
      required:
        - swedenValue
      type: object
      properties:
        swedenValue:
          type: string
          enum:
            - SE_AKTIEBOLAG_AB
            - SE_BOSTADSRATTSFORENING
            - SE_EKONOMISK_FORENING_EK_FOR
            - SE_ENKELT_BOLAG
            - SE_ENSKILD_FIRMA
            - SE_HANDELSBOLAG_HB
            - SE_HYRESRATTSFORENING
            - SE_IDEELL_FORENING
            - SE_KOMMANDITBOLAG_KB
            - SE_KOOPERATIV
            - SE_PUBLIKT_AKTIEBOLAG_AB_PUBL
            - SE_STIFTELSE
    SwitzerlandLegalType:
      required:
        - switzerlandValue
      type: object
      properties:
        switzerlandValue:
          type: string
          enum:
            - CH_AKTIENGESELLSCHAFT_AG
            - CH_ASSOCIATION
            - CH_ASSOCIAZIONE
            - CH_DITTA_INDIVIDUALE
            - CH_EINFACHE_GESELLSCHAFT_EG
            - CH_EINZELUNTERNEHMEN
            - CH_ENTREPRISE_INDIVIDUELLE
            - CH_FONDATION
            - CH_FONDAZIONE
            - CH_GENOSSENSCHAFT
            - CH_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - CH_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - CH_GRUPPO_DI_INTERESSE_ECONOMICO
            - CH_INVESTMENTGESELLSCHAFT_MIT_FESTEM_KAPITAL
            - CH_INVESTMENTGESELLSCHAFT_MIT_VARIABLEM_KAPITALS
            - CH_INVESTMENT_FUND
            - CH_KOLLEKTIVGESELLSCHAFT_KOLG
            - CH_KOMMANDITAKTIENGESELLSCHAFT_KOMAG
            - CH_KOMMANDITGESELLSCHAFT_KG
            - CH_RAISON_INDIVIDUELLE_RI
            - CH_SOCIETA_ANONIMA_SA
            - CH_SOCIETA_A_GARANZIA_LIMITATA_SAGL
            - CH_SOCIETA_COOPERATIVA
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_FISSO_SICAF
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_VARIABILE_SICAV
            - CH_SOCIETA_IN_ACCOMANDITA
            - CH_SOCIETA_IN_ACCOMANDITA_PER_AZIONI
            - CH_SOCIETA_IN_NOME_COLLETTIVO
            - CH_SOCIETA_SEMPLICE
            - CH_SOCIETE_ANONYME_SA
            - CH_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - CH_SOCIETE_COOPERATIVE
            - CH_SOCIETE_COOPERATIVE_SCOOP
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE_SICAF
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - CH_SOCIETE_EN_COMMANDITE
            - CH_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - CH_SOCIETE_EN_COMMANDITE_SC
            - CH_SOCIETE_EN_NOM_COLLECTIF
            - CH_SOCIETE_EN_NOM_COLLECTIF_SNC
            - CH_SOCIETE_SIMPLE
            - CH_STIFTUNG
            - CH_SUCCURSALE
            - CH_VEREIN
            - CH_WIRTSCHAFTLICHE_INTERESSENGEMEINSCHAFT_WIG
            - CH_ZWEIGNIEDERLASSUNG
    UnitedKingdomLegalType:
      required:
        - unitedKingdomValue
      type: object
      properties:
        unitedKingdomValue:
          type: string
          enum:
            - GB_CHARITABLE_INCORPORATED_ORGANISATION_CIO
            - GB_COMMUNITY_INTEREST_COMPANY_CIC
            - GB_GENERAL_PARTNERSHIP
            - GB_INDUSTRIAL_AND_PROVIDENT_SOCIETY
            - GB_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - GB_LIMITED_PARTNERSHIP_LP
            - GB_PRIVATE_COMPANY_LIMITED_BY_GUARANTEE_LTD
            - GB_PRIVATE_COMPANY_LIMITED_BY_SHARES_LTD
            - GB_PUBLIC_LIMITED_COMPANY_PLC
            - GB_SOLE_PROPRIETORSHIP
            - GB_UNLIMITED_COMPANY
    WorldwideAddressRequestDto:
      title: WorldwideAddressRequest
      required:
        - city
        - isoCountryCode
        - postalCode
        - street
      type: object
      properties:
        isoCountryCode:
          title: Worldwide Country Code
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        city:
          maxLength: 255
          minLength: 0
          type: string
        postalCode:
          maxLength: 10
          minLength: 0
          type: string
        street:
          maxLength: 511
          minLength: 0
          type: string
        number:
          maxLength: 255
          minLength: 0
          type: string
        refinement:
          maxLength: 35
          minLength: 0
          type: string
        stateOrProvince:
          maxLength: 255
          minLength: 0
          type: string
        bypassVerification:
          type: boolean
          description: >-
            If true, the address will be saved as described in the request
            without any auto-verification and the status will be INVALID until a
            POA is provided.


            By default is false.
    CorporateCreateResponseDto:
      required:
        - accountOwnerId
        - corporateId
      type: object
      properties:
        corporateId:
          type: string
          description: The new corporate identifier.
          format: uuid
        accountOwnerId:
          type: string
          description: The account owner identifier.
          format: uuid
    CorporateRelatedCorporateInfoDto:
      required:
        - incorporationCode
        - incorporationCountry
        - registeredName
      type: object
      properties:
        registeredName:
          maxLength: 255
          minLength: 0
          type: string
          description: The official corporate name.
        tradeName:
          maxLength: 255
          minLength: 0
          type: string
          description: The name used for business if there is one.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        website:
          maxLength: 511
          minLength: 0
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        registeredAddress:
          $ref: '#/components/schemas/WorldwideAddressRequestDto'
    CorporateRelatedCreateRequestDto:
      required:
        - info
        - isDirector
        - sharesInfo
      type: object
      properties:
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        sharesInfo:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ShareDataDto'
        info:
          $ref: '#/components/schemas/CorporateRelatedInfoDto'
    CorporateRelatedInfoDto:
      type: object
      description: Information about this corporate-related entity.
      anyOf:
        - $ref: '#/components/schemas/CorporateRelatedPhysicalPersonInfoDto'
        - $ref: '#/components/schemas/CorporateRelatedCorporateInfoDto'
    CorporateRelatedPhysicalPersonInfoDto:
      required:
        - firstName
        - lastName
      type: object
      properties:
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        address:
          $ref: '#/components/schemas/WorldwideAddressRequestDto'
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        emailAddress:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneRequestDto'
        isSpecialUbo:
          type: boolean
          description: >-
            Indicates whether this person was designated UBO because no
            shareholder holds the percentage of shares required to become one.
    DirectShareDataDto:
      title: Direct Share
      required:
        - percentage
      type: object
      properties:
        percentage:
          maximum: 100
          minimum: 0
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
    IndirectShareDataDto:
      title: Indirect Share
      required:
        - ownedCorporateId
        - percentage
      type: object
      properties:
        percentage:
          maximum: 100
          minimum: 0
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
        ownedCorporateId:
          type: string
          description: Identifier of the corporate in which he holds shares.
          format: uuid
    ShareDataDto:
      required:
        - percentage
      type: object
      properties:
        percentage:
          maximum: 100
          minimum: 0
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
      description: >-
        Must be filled in if the owner is UBO (shareholder with 25%+ shares or
        10%+ shares if the corporate must provide extended UBOs).
      anyOf:
        - $ref: '#/components/schemas/DirectShareDataDto'
        - $ref: '#/components/schemas/IndirectShareDataDto'
    CorporateRelatedCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ConsumerCreateRequestDto:
      required:
        - phone
      type: object
      properties:
        partnerName:
          type: string
          description: >-
            The partnerName, mandatory if you create a consumer as anonymous.
            Ignored if requesting as a partner.
        firstName:
          type: string
          description: >-
            The first name of the user to create. Must only contains Latin-1
            characters.
        middleName:
          type: string
          description: >-
            The middle name of the user to create. Must only contains Latin-1
            characters.
        lastName:
          type: string
          description: >-
            The last name of the user to create. Must only contains Latin-1
            characters.
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this consumer to a user
            in your system.
        phone:
          $ref: '#/components/schemas/PhoneRequestDto'
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        emailAddress:
          type: string
        sourceOfFunds:
          type: string
          enum:
            - COMPENSATION_PAYOUT
            - COMPANY_PROFITS
            - COMPANY_SALE
            - DIVIDEND_PAYMENTS
            - DIVORCE_SETTLEMENT
            - FIXED_DEPOSITS
            - GIFT
            - INHERITANCE
            - INSURANCE_PAYOUT
            - LOAN
            - LOTTERY_OR_GAMBLING_WIN
            - RETIREMENT_INCOME
            - SALE_OF_INVESTMENT
            - SALE_OF_PROPERTY
            - SAVINGS_FROM_SALARY
            - OTHER
        otherSourceOfFunds:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of source of funds if 'OTHER' was chosen.
        occupation:
          type: string
          description: >-
            The consumer usual or principal work or business as a means of
            earning a living.
          enum:
            - BUSINESS_OWNER
            - CLERGY
            - CRAFTSMAN
            - ENGINEER
            - EXECUTIVE
            - FARMER
            - FREELANCE
            - LIBERAL_PROFESSION
            - POLITICIAN
            - PROFESSOR
            - PUBLIC_SERVANT
            - RETIRED
            - SHOPKEEPER
            - STUDENT
            - UNEMPLOYED
            - WORKER
            - OTHER
        otherOccupation:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of occupation if 'OTHER' was chosen.
        occupationSector:
          type: string
          description: The consumer usual or principal work or business sector.
          enum:
            - ACCOUNTING_AUDIT
            - E_MONEY_SERVICES
            - CURRENCY_EXCHANGE
            - TRADES_ON_OTC_MARKET
            - PRECIOUS_METALS_OR_STONES
            - PAWNSHOPS
            - CROSS_BORDER_CASH_OR_PRECIOUS_MATERIALS
            - MINING_EXTRACTIVE_INDUSTRIES
            - ENERGY
            - TRADE_IN_PETROL_PRODUCTS
            - TRADE_IN_MEDICINES
            - REAL_ESTATE
            - CONSTRUCTION_REPAIR
            - CONSULTANCY_LEGAL
            - FREELANCE
            - NON_PROFIT_LEGAL_ENTITIES
            - CRYPTOCURRENCIES
            - GAMING
            - GAMBLING
            - EU_FUNDS_UTILIZATION
            - ADULT
            - HIGH_VALUE_ASSET_DEALER
            - BANKING_LENDING
            - INSURANCE_SECURITY
            - TRANSPORTATION_AND_LOGISTICS
            - MANUFACTURING
            - UTILITIES_AND_INFRASTRUCTURE
            - TRADE_IN_FOOD_PRODUCT
            - WHOLESALE
            - REPAIR_OF_MOTOR_VEHICLES
            - SOCIAL_WORK_ACTIVITIES
            - AUTO_AVIATION
            - COURIER_POST_SERVICES
            - AGRICULTURE_FORESTRY_AND_FISHING
            - OTHER_TRADE_AND_SALES
            - TRAVEL_TOURISM
            - INFORMATION_AND_COMMUNICATION
            - PR_MARKETING
            - EDUCATION
            - INFORMATIONAL_TECHNOLOGIES
            - PUBLIC_AND_DEFENCE_SECTOR
            - HEALTH_CARE_MEDICAL_SERVICES
            - ART_ENTERTAINMENT_SPORT
            - ADMINISTRATIVE_OFFICE_BUSINESS_ACTIVITIES
            - HOSPITALITY_AND_LEISURE
            - SCIENTIFIC_AND_TECHNICAL_ACTIVITIES
            - OTHER
        isUsPerson:
          type: boolean
          description: If the consumer is a specified us person. Default value is false.
        lastTermsAccepted:
          type: string
          description: The version of the terms and conditions signed by the consumer.
          example: '1.0'
        taxIdentificationNumber:
          maxLength: 255
          minLength: 0
          type: string
        taxCountry:
          type: string
          enum:
            - AUT
            - AND
            - BEL
            - BGR
            - CHE
            - CYP
            - CZE
            - DEU
            - DNK
            - ESP
            - EST
            - FIN
            - FRA
            - GBR
            - GRC
            - HRV
            - HUN
            - IRL
            - ISL
            - ITA
            - LIE
            - LTU
            - LUX
            - LVA
            - MLT
            - MCO
            - NLD
            - NOR
            - POL
            - PRT
            - ROU
            - SVN
            - SVK
            - SWE
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        financialInformation:
          $ref: '#/components/schemas/ConsumerFinancialInformationRequestDto'
        metadata:
          title: Metadata
          type: object
          additionalProperties:
            title: Metadata
            type: object
            description: |-
              A custom field to save data.

              This field's size is limited to 3000 characters.
          description: |-
            A custom field to save data.

            This field's size is limited to 3000 characters.
      description: The information needed to create a new consumer.
    ConsumerFinancialInformationRequestDto:
      required:
        - currency
        - expectedMonthlyIncomingTransferFrequency
        - expectedMonthlyIncomingVolume
        - expectedMonthlyOutgoingVolume
        - monthlyNetIncome
      type: object
      properties:
        monthlyNetIncome:
          type: string
          description: The net financial revenue expected every month
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        currency:
          type: string
          description: The currency used for the expected monthly expenses.
          enum:
            - EUR
            - USD
            - GBP
        expectedMonthlyIncomingVolume:
          type: string
          description: >-
            The amount of money you expect to receive with this account every
            month.
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyOutgoingVolume:
          type: string
          description: >-
            The amount of money you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          description: >-
            The frequency at which you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    ConsumerCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: The new consumer identifier.
          format: uuid
    CardCreateRequestDto:
      required:
        - ledgerId
        - profileId
      type: object
      properties:
        ledgerId:
          type: string
          format: uuid
        profileId:
          type: string
          description: The card profile id. Must be an active card profile.
          format: uuid
        nameOnCard:
          pattern: ^[A-Z\s]{1,21}$
          type: string
          description: >-
            The name that will be printed on the card : Consumer name for
            consumer cards or corporate name for Corporate cards.


            Can only contain ISO basic Latin alphabet and can be up to 21
            characters long including spaces.
          default: '"FIRSTNAME LASTNAME" or "CORPORATE NAME"'
        cardholderNameOnCard:
          pattern: ^[A-Z0-9\s]{1,21}$
          type: string
          description: >-
            Cardholder Name printed on card for corporate card. Can only contain
            ISO basic Latin alphabet, numbers and can be up to 21 characters
            long including spaces.


            This name is only available when the card profile has a corporate
            card program.
          default: CORPORATE NAME
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        rules:
          type: array
          description: >-
            You can add rules when creating a card. You can only send one rule
            by type in the list.


            As a partner, this rules take priority over the rules set in the
            profile
          items:
            $ref: '#/components/schemas/CardRuleDto'
      anyOf:
        - $ref: '#/components/schemas/PhysicalCardCreateRequestDto'
        - $ref: '#/components/schemas/VirtualCardCreateRequestDto'
    CardRuleDto:
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
      description: >-
        You can add rules when creating a card. You can only send one rule by
        type in the list.


        As a partner, this rules take priority over the rules set in the profile
      anyOf:
        - $ref: '#/components/schemas/SpendLimitRuleDto'
        - $ref: '#/components/schemas/PaymentDisableRuleDto'
        - $ref: '#/components/schemas/MerchantsMultipleTargetsRuleDto'
        - $ref: '#/components/schemas/MccMultipleTargetsRuleDto'
        - $ref: '#/components/schemas/DaysMultipleTargetsRuleDto'
    DaysMultipleTargetsRuleDto:
      required:
        - days
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
        days:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - MONDAY
              - TUESDAY
              - WEDNESDAY
              - THURSDAY
              - FRIDAY
              - SATURDAY
              - SUNDAY
    MccMultipleTargetsRuleDto:
      required:
        - merchantCategoryCodes
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
        merchantCategoryCodes:
          uniqueItems: true
          type: array
          items:
            type: string
    MerchantsMultipleTargetsRuleDto:
      required:
        - merchants
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
        merchants:
          uniqueItems: true
          type: array
          items:
            type: string
    PaymentDisableRuleDto:
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
    PhysicalCardCreateRequestDto:
      required:
        - deliveryMethod
        - ledgerId
        - profileId
      type: object
      properties:
        deliveryMethod:
          type: string
          enum:
            - FRENCH_MAIL
            - FRENCH_MAIL_TRACKING
            - INTERNATIONAL_MAIL
        ledgerId:
          type: string
          format: uuid
        profileId:
          type: string
          format: uuid
        nameOnCard:
          pattern: ^[A-Z\s]{1,21}$
          type: string
        cardholderNameOnCard:
          pattern: ^[A-Z0-9\s]{1,21}$
          type: string
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        rules:
          type: array
          description: >-
            You can add rules when creating a card. You can only send one rule
            by type in the list.


            As a partner, this rules take priority over the rules set in the
            profile
          items:
            $ref: '#/components/schemas/CardRuleDto'
    SpendLimitRuleDto:
      required:
        - type
        - value
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        value:
          maximum: 999999999
          minimum: 1
          type: integer
          format: int64
        name:
          type: string
    VirtualCardCreateRequestDto:
      required:
        - ledgerId
        - profileId
      type: object
      properties:
        ledgerId:
          type: string
          format: uuid
        profileId:
          type: string
          format: uuid
        nameOnCard:
          pattern: ^[A-Z\s]{1,21}$
          type: string
        cardholderNameOnCard:
          pattern: ^[A-Z0-9\s]{1,21}$
          type: string
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        rules:
          type: array
          description: >-
            You can add rules when creating a card. You can only send one rule
            by type in the list.


            As a partner, this rules take priority over the rules set in the
            profile
          items:
            $ref: '#/components/schemas/CardRuleDto'
    CardCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CardSuspendRequestDto:
      required:
        - operator
      type: object
      properties:
        operator:
          title: Operator
          type: string
          description: The entity initiating this operation.
          default: END_USER
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        reason:
          type: string
          description: Optional reason of the card suspension.
          enum:
            - STOLEN
            - LOST
            - DAMAGED
            - OTHER
        otherReason:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of reason if 'OTHER' was chosen.
    CardCloseRequestDto:
      required:
        - operator
        - reason
      type: object
      properties:
        operator:
          title: Operator
          type: string
          description: The entity initiating this operation.
          default: END_USER
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        reason:
          type: string
          enum:
            - STOLEN
            - LOST
            - DAMAGED
            - OTHER
        otherReason:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of reason if 'OTHER' was chosen.
    CardActivateRequestDto:
      type: object
      properties:
        truncatedPan:
          pattern: ^[0-9]{4}$
          type: string
          description: >-
            Last 4 digits of the card. This value is only available when the
            card has been received by the end-user.
          example: '1111'
    CardProfileCreateRequestDto:
      required:
        - cardDesignId
        - name
      type: object
      properties:
        name:
          type: string
        cardDesignId:
          type: string
          description: >-
            The card design identifier on which the new card profile will be
            based.
          format: uuid
        active:
          type: boolean
          description: >-
            When active, end-users are able to see this profile and create card
            with it.


            When disabled, it can not be used to create new cards anymore.
    CardProfileCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    BankingDetails:
      type: object
      anyOf:
        - $ref: '#/components/schemas/SepaBankingDetails'
        - $ref: '#/components/schemas/GbpBankingDetails'
        - $ref: '#/components/schemas/UsdBankingDetails'
    BeneficiaryCreateRequestDto:
      required:
        - bankingDetails
        - name
        - type
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        type:
          type: string
          description: Describe if the beneficiary is a person or a company.
          enum:
            - PERSON
            - COMPANY
        name:
          type: string
          description: >-
            Complete name of the person (firstName middleName lastName) or name
            of the company.
          example: John Michael Doe
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
          description: Friendly name given to the beneficiary.
        bankingDetails:
          $ref: '#/components/schemas/BankingDetails'
        display:
          type: boolean
          description: >-
            Display (or not) the beneficiary to the end-user (unusable by
            end-user).
        active:
          type: boolean
          description: Activate (or not) the beneficiary. Default value is true.
    GbpBankingDetails:
      required:
        - accountNumber
        - sortCode
      type: object
      properties:
        sortCode:
          pattern: ^[0-9]{6}$
          type: string
        accountNumber:
          pattern: ^[0-9]{8}$
          type: string
    SepaBankingDetails:
      required:
        - bic
        - iban
      type: object
      properties:
        iban:
          type: string
          description: Must be a valid iban format following the standard ISO_13616.
        bic:
          type: string
          description: Must be a valid bic following the standard ISO_9362.
    UsdBankingDetails:
      required:
        - abaCode
        - accountNumber
      type: object
      properties:
        abaCode:
          type: string
        accountNumber:
          type: string
        swift:
          type: string
    BeneficiaryCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    PaymentAcquiringRequestDto:
      required:
        - amount
      type: object
      properties:
        amount:
          type: number
        endUserId:
          type: string
          format: uuid
        redirectUrl:
          type: string
          description: >-
            Browser will load this URL once payment is completed and can be used
            to continue the payment journey. 


            The redirectUrl must be fully qualified for HTTP POST requests.
        reference:
          type: string
        storeCard:
          type: boolean
          description: >-
            Needs to be set to true in order to register external card.
            Mandatory if amount is zero
        externalCardId:
          type: string
          description: Id of the external card (required to start a direct payment/top-up).
          format: uuid
    AcquiringCreationResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: Id of the created acquiring transaction
          format: uuid
        webPage:
          $ref: '#/components/schemas/Download'
    Download:
      required:
        - ttl
        - url
      type: object
      properties:
        ttl:
          type: string
          example: PT8H6M12.345S
        url:
          type: string
    AccountLoadAcquiringRequestDto:
      required:
        - amount
        - targetLedgerId
      type: object
      properties:
        amount:
          type: number
        targetLedgerId:
          type: string
          description: Identifies the ledger that will be topped up
          format: uuid
        redirectUrl:
          type: string
          description: >-
            Browser will load this URL once payment is completed and can be used
            to continue the payment journey. 


            The redirectUrl must be fully qualified for HTTP POST requests.
        reference:
          type: string
        storeCard:
          type: boolean
          description: >-
            Needs to be set to true in order to register external card.
            Mandatory if amount is zero
        endUserId:
          type: string
          format: uuid
        externalCardId:
          type: string
          description: Id of the external card (required to start a direct payment/top-up).
          format: uuid
    AccountCreateRequestDto:
      type: object
      anyOf:
        - $ref: '#/components/schemas/PartnerUserAccountCreateRequestDto'
    PartnerUserAccountCreateRequestDto:
      title: Partner user account
      required:
        - email
        - roles
      type: object
      properties:
        email:
          type: string
        roles:
          uniqueItems: true
          type: array
          description: >-
            List of roles to give to the created user. Connected user can only
            give roles present in its JWT.
          items:
            title: LinkcyRole
            type: string
            description: >-
              List of roles to give to the created user. Connected user can only
              give roles present in its JWT.
            enum:
              - ACCOUNT_CREATE
              - BANKING_DETAILS_DOCUMENT_EXPORT
              - BENEFICIARY_CREATE
              - BENEFICIARY_INFO
              - BENEFICIARY_LIST
              - BENEFICIARY_UPDATE
              - DIRECT_DEBIT_MANDATE_CREATE
              - DIRECT_DEBIT_MANDATE_UPDATE
              - DIRECT_DEBIT_MANDATE_ACTIVATE
              - DIRECT_DEBIT_MANDATE_CANCEL
              - DIRECT_DEBIT_MANDATE_LIST
              - DIRECT_DEBIT_MANDATE_INFO
              - CARD_ACTIVATE
              - CARD_CLOSE
              - CARD_CREATE
              - CARD_UPDATE
              - CARD_DESIGN_LIST
              - CARD_INFO
              - CARD_LIST
              - CARD_PAN_CREDENTIALS
              - CARD_PIN
              - CARD_PAN_AND_CVV
              - CARD_RENEW
              - CARD_SUSPEND
              - CARD_RESET_PIN_ATTEMPTS
              - CARD_PROFILE_CREATE
              - CARD_PROFILE_LIST
              - CARD_PROFILE_RULE_DELETE
              - CARD_PROFILE_RULE_UPDATE
              - CARD_PROFILE_UPDATE
              - CARD_RULE_DELETE
              - CARD_RULE_UPDATE
              - EXTERNAL_CARD_LIST
              - CONSUMER_CREATE
              - CONSUMER_INFO
              - CONSUMER_LIST
              - CONSUMER_UPDATE
              - CONSUMER_CONTACT_UPDATE
              - CORPORATE_CREATE
              - CORPORATE_INFO
              - CORPORATE_LIST
              - CORPORATE_UPDATE
              - CORPORATE_RELATED_CREATE
              - CORPORATE_RELATED_DELETE
              - CORPORATE_RELATED_INFO
              - CORPORATE_RELATED_LIST
              - CORPORATE_RELATED_UPDATE
              - KYB_VERIFICATION_ASK
              - DOCUMENT_REQUEST_CREATE
              - DOCUMENT_CREATE
              - DOCUMENT_INFO
              - DOCUMENT_LIST
              - DILIGENCE_REVIEW_DOCUMENT_EXPORT
              - TRANSACTION_RECEIPT_DOCUMENT_EXPORT
              - END_USER_SUSPEND
              - END_USER_UNSUSPEND
              - END_USER_ADDRESSES_LIST
              - KYC_CREATE
              - KYC_LIST
              - KYC_INFO
              - LEDGER_CLOSE
              - LEDGER_CREATE
              - LEDGER_UPDATE
              - LEDGER_STATEMENT_DOCUMENT_EXPORT
              - LEDGER_SUSPEND
              - LEDGER_UNSUSPEND
              - LEDGER_INFO
              - LEDGER_LIST
              - LEDGER_UPGRADE
              - BIC_FROM_IBAN_GET
              - PARTNER_INFO
              - PARTNER_UPDATE
              - PARTNER_ACQUIRING_CONFIGURATION_INFO
              - PHONE_VERIFICATION_SEND
              - PHONE_VERIFICATION_VERIFY
              - SMS_SEND
              - EMAIL_VERIFICATION_CREATE
              - ADDRESS_VERIFY
              - SCA_DEVICE_CREATE
              - SCA_DEVICE_ACTIVATE
              - SCA_DEVICE_UPDATE
              - SCA_DEVICE_RESET
              - SHARE_INFO
              - SHARE_CREATE
              - SHARE_UPDATE
              - SHARE_DELETE
              - ACQUIRING_ACCOUNT_LOAD_CREATE
              - ACQUIRING_PAYMENT_CREATE
              - ACQUIRING_TRANSACTION_INFO
              - TRANSACTION_INFO
              - TRANSACTION_LIST
              - INTER_LEDGER_TRANSACTION_CREATE
              - DIRECT_DEBIT_TRANSACTION_CREATE
              - BENEFICIARY_TRANSACTION_CREATE
              - WEBHOOK_PORTAL
              - CRYPTO_WALLET_CREATE
              - CRYPTO_WALLET_LIST
              - CRYPTO_WALLET_INFO
              - CRYPTO_BENEFICIARY_CREATE
              - CRYPTO_BENEFICIARY_LIST
              - CRYPTO_BENEFICIARY_INFO
              - CRYPTO_BENEFICIARY_UPDATE
              - CRYPTO_TRANSACTION_CREATE
              - CRYPTO_TRANSACTION_LIST
              - CRYPTO_TRANSACTION_INFO
    PartnerUserAccountCreateResponseDto:
      required:
        - id
        - otp
      type: object
      properties:
        id:
          type: string
          format: uuid
        otp:
          type: string
    InternalAdminPasswordChangeWithPasswordRequestDto:
      title: With current password for Linkcy admin
      required:
        - adminName
        - currentPassword
        - newPassword
      type: object
      properties:
        adminName:
          type: string
        currentPassword:
          type: string
        newPassword:
          maxLength: 2147483647
          minLength: 6
          type: string
    ComplianceScoring:
      type: object
      properties:
        receivingSendingFundsRisk:
          title: RiskLevels
          type: string
          description: >-
            The risk level depending on the countries that would send funds to
            or receive funds from the said account.
          enum:
            - LOW
            - HIGH
        jointAccount:
          type: boolean
          description: If this partner can open joint account for this end-user.
        fraudHistory:
          type: boolean
          description: Is there any record of fraud history.
        natureOfPaymentRisk:
          type: string
          description: >-
            The risk level depending on the persons/entities that would send
            funds to or receive funds from the said account.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        paymentStructureRisk:
          type: string
          description: >-
            The risk level depending on the typologies of payments the account
            will perform.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        riskAssessment:
          type: string
        cryptoRelated:
          type: boolean
      description: >-
        The different compliance scoring info. If null, it will take the default
        values.
    ContactInformation:
      type: object
      properties:
        adminEmail:
          type: string
        billingEmail:
          type: string
        commercialEmail:
          type: string
        techEmail:
          type: string
        complianceEmail:
          type: string
    InternalPartnerCreateRequestDto:
      required:
        - cbs
        - docOnlyVerificationFlow
        - fullKycVerificationFlow
        - name
      type: object
      properties:
        name:
          type: string
          description: Partner name is mandatory for creation, and it must be unique.
        displayName:
          type: string
          description: Name display on documents.
        logoUrl:
          type: string
          description: Url that provides the logo.
        fullKycVerificationFlow:
          type: string
        docOnlyVerificationFlow:
          type: string
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        emailProperties:
          $ref: '#/components/schemas/InternalPartnerEmailPropertiesRequestDto'
        twilioVerificationSid:
          type: string
          description: Used in phone verification for end-user.
        twilioMessagingSid:
          type: string
          description: Used to send sms.
        complianceScoring:
          $ref: '#/components/schemas/ComplianceScoring'
        consumerOtpMessage:
          type: string
          description: >-
            Message that will be displayed when requesting a OTP message. You
            must include the following place holder: "$otp" where you want to
            display the OTP secret.


            If not set, the default message is: "Your {partnerName} secret to
            change your password is: {secret} If you are not at the origin of
            this message, you can ignore it."
        corporateOtpMessage:
          type: string
          description: >-
            Message that will be displayed when requesting a OTP message. You
            must include the following place holder: "$otp" where you want to
            display the OTP secret.


            If not set, the default message is: "Your {partnerName} secret to
            change your password is: {secret} If you are not at the origin of
            this message, you can ignore it."
        contactInformation:
          $ref: '#/components/schemas/ContactInformation'
        delegatedPhoneVerification:
          type: boolean
          description: If true, phone numbers will automatically be considered verified.
        delegatedPoa:
          type: boolean
          description: If true, address could be verified without Linkcy Verification.
        delegatedSca:
          type: boolean
          description: If true, SCA can be bypassed even for end-users.
        delegatedKyc:
          type: boolean
          description: If true, KYC can be provided by your system.
        showKycFiles:
          type: boolean
          description: >-
            If true, the partner may see KYC files in an end-user's document
            list..
        mvcOnFirstLedger:
          type: boolean
          description: >-
            If true, an associated MVC (for banking cards) will also be created
            the first time an end-user creates a ledger. By default is false.
        limits:
          $ref: '#/components/schemas/PartnerLimitsRequestDto'
        cbs:
          type: string
          description: The Core Banking System (CBS) associated with this partner
          enum:
            - RAILSR
            - PAYNOVATE
            - PAYNETICS
    InternalPartnerEmailPropertiesRequestDto:
      type: object
      properties:
        senderEmailAddress:
          type: string
        senderEmailName:
          type: string
        emailVerificationTemplateId:
          type: string
      description: Sender information for email verifications.
    PartnerDefaultLedgerLimitsRequestDto:
      title: Partner Default Ledger Limits
      type: object
      properties:
        transactionLimit:
          type: number
          description: >-
            Transaction Limit. If null, it will take the default value defined
            in the partner configuration.
        transactionDailyLimit:
          type: number
          description: >-
            Transaction Daily Limit. If null, it will take the default value
            defined in the partner configuration.
        transactionMonthlyLimit:
          type: number
          description: >-
            Transaction Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
        ddTransactionLimit:
          type: number
          description: >-
            Direct debit transaction limit. If null, it will take the default
            value defined in the partner configuration.
        ddMonthlyLimit:
          type: number
          description: >-
            Direct Debit Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
      description: Configuration of the default ledger limits for this partner.
    PartnerDefaultLimitedStatusLimitsRequestDto:
      title: Partner Default limited status Limits
      required:
        - limitedStatusTransactionLimit
        - limitedStatusTransactionLimitInterval
      type: object
      properties:
        limitedStatusTransactionLimit:
          type: number
          description: >-
            Defines the maximum transaction amount allowed for end-users with a
            limited status. For example, if set to 500, the user cannot exceed
            500 euros in transactions within the defined period.
        limitedStatusTransactionLimitInterval:
          type: integer
          description: >-
            Defines the time window (in days) for which the limited status
            transaction limit applies. If set to 0, the limit applies from the
            user's account creation. For example, if set to 10, the transaction
            limit is evaluated over a rolling 10-day period.
          format: int32
      description: >-
        Default transaction limit configuration for end-users with limited
        status for this partner
    PartnerDefaultSctInstLimitsRequestDto:
      title: Partner Default SEPA Credit Transfer Instant Limits
      type: object
      properties:
        sctInstLimit:
          type: number
          description: >-
            Transaction limit for SEPA Instant Credit Transfer (SCT Inst). If
            null, the default value defined in the partner configuration will be
            used.
        sctInstDailyLimit:
          type: number
          description: >-
            Daily Transaction limit for SEPA Instant Credit Transfer (SCT Inst).
            If null, it will take the default value defined in the partner
            configuration.
        sctInstWeeklyLimit:
          type: number
          description: >-
            Weekly Transaction Limit for SEPA Instant Credit Transfer (SCT
            Inst). If null, it will take the default value defined in the
            partner configuration.
      description: >-
        Configuration of the default transaction limit for SEPA Instant Credit
        Transfer (SCT Inst) for this partner.
    PartnerLimitsRequestDto:
      type: object
      properties:
        ledger:
          $ref: '#/components/schemas/PartnerDefaultLedgerLimitsRequestDto'
        sctInst:
          $ref: '#/components/schemas/PartnerDefaultSctInstLimitsRequestDto'
        limitedStatus:
          $ref: '#/components/schemas/PartnerDefaultLimitedStatusLimitsRequestDto'
      description: Configuration of limits.
    InternalPartnerCreateResponseDto:
      required:
        - id
        - partnerName
        - password
        - userName
      type: object
      properties:
        id:
          type: string
          format: uuid
        partnerName:
          type: string
        password:
          type: string
          description: >-
            Initial password you must communicate to the partner that will allow
            him to configure his final password.
        userName:
          type: string
    InternalAdminPassLoginRequestDto:
      title: Linkcy Login
      required:
        - adminName
        - password
      type: object
      properties:
        adminName:
          type: string
        password:
          type: string
    EndUserCompliance:
      title: Compliance
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - PENDING
            - DECLINED
            - PENDING_REVIEW
            - VALIDATED
        reason:
          type: string
        internalReason:
          type: string
    EndUserOnboardRequestDto:
      type: object
      properties:
        manualComplianceStatus:
          $ref: '#/components/schemas/EndUserCompliance'
    DocumentUploadRequestDto_Internal:
      title: DocumentUploadRequest
      required:
        - file
      type: object
      properties:
        endUserId:
          type: string
          description: >-
            The id of the end-user, can be a consumer or corporate. Mandatory if
            not authenticated as end-user.
          format: uuid
        type:
          title: DocumentType
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        documentId:
          type: string
          description: >-
            Use this field if the document you want to upload was requested
            (status REQUESTED).


            Note: you do not need to fill endUserId and type fields when you
            upload a requested document.
          format: uuid
        transactionId:
          type: string
          description: >-
            ID of the transaction if the document is a TRANSACTION_RECEIPT or
            any document related to a transaction.
          format: uuid
        beneficiaryId:
          type: string
          description: ID of the beneficiary associated with the document.
          format: uuid
        addressId:
          type: string
          description: ID of the address associated with the document.
          format: uuid
        corporateRelatedId:
          type: string
          description: ID of the corporate related associated with the document.
          format: uuid
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        file:
          type: string
          format: binary
      description: >-
        Upload a document. The document can be uploaded directly or for a
        document in REQUESTED status.
    DocumentUploadResponseDto_Internal:
      title: DocumentUploadResponse
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    PartnerShortInfoResponseDto_Internal:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    CardProgramCreateRequestDto:
      required:
        - cardType
        - cbsProducts
        - friendlyName
        - ledgerType
        - partnerId
        - scheme
        - userType
      type: object
      properties:
        partnerId:
          type: string
          format: uuid
        cbsProducts:
          uniqueItems: true
          type: array
          description: The cbs card products to associate with this card program.
          items:
            $ref: '#/components/schemas/Cbs Product'
        scheme:
          type: string
          enum:
            - MASTERCARD
            - VISA
        cardType:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        userType:
          type: string
          enum:
            - CORPORATE
            - CONSUMER
        ledgerType:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_ESTONIA
            - EUR_LITHUANIA
            - USD_USA
            - GBP_GREAT_BRITAIN
            - EUR_BG
        friendlyName:
          type: string
    Cbs Product:
      required:
        - countryCode
        - program
      type: object
      properties:
        program:
          type: string
        countryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
      description: The cbs card products to associate with this card program.
    CardProgramCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: Id of the card program.
          format: uuid
    CardDesignCreateRequestDto:
      required:
        - cardProgramId
        - friendlyName
      type: object
      properties:
        friendlyName:
          type: string
        cardProgramId:
          type: string
          format: uuid
        manufacturerDesignId:
          type: string
        manufacturerPackageId:
          type: string
        manufacturerPrintImageId:
          maxLength: 70
          minLength: 0
          type: string
    CardDesignCreateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    AcquiringTransactionsImportRequestDto:
      required:
        - csvFile
      type: object
      properties:
        csvFile:
          type: string
          format: binary
    AcquiringTransactionsImportResponseDto:
      required:
        - ignoredLines
        - updatedTransactionsIds
      type: object
      properties:
        updatedTransactionsIds:
          type: array
          items:
            type: string
            format: uuid
        ignoredLines:
          type: array
          items:
            type: integer
            format: int32
    ContactInformation_Partner:
      type: object
      properties:
        adminEmail:
          type: string
        billingEmail:
          type: string
        commercialEmail:
          type: string
        techEmail:
          type: string
        complianceEmail:
          type: string
    EuropeanAddressRequestDto_Partner:
      title: EuropeanAddressRequest
      required:
        - city
        - isoCountryCode
        - postalCode
        - street
      type: object
      properties:
        isoCountryCode:
          title: European Country Code
          type: string
          enum:
            - AUT
            - AND
            - BEL
            - BGR
            - CHE
            - CYP
            - CZE
            - DEU
            - DNK
            - ESP
            - EST
            - FIN
            - FRA
            - GBR
            - GRC
            - HRV
            - HUN
            - IRL
            - ISL
            - ITA
            - LIE
            - LTU
            - LUX
            - LVA
            - MLT
            - MCO
            - NLD
            - NOR
            - POL
            - PRT
            - ROU
            - SVN
            - SVK
            - SWE
        city:
          maxLength: 255
          minLength: 0
          type: string
        postalCode:
          maxLength: 10
          minLength: 0
          type: string
        street:
          maxLength: 511
          minLength: 0
          type: string
        number:
          maxLength: 255
          minLength: 0
          type: string
        refinement:
          maxLength: 35
          minLength: 0
          type: string
        stateOrProvince:
          maxLength: 255
          minLength: 0
          type: string
        bypassVerification:
          type: boolean
          description: >-
            If true, the address will be saved as described in the request
            without any auto-verification and the status will be INVALID until a
            POA is provided.


            By default is false.
      description: Address that will be used on the bank statements of your users.
    PartnerUpdateRequestDto_Partner:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto_Partner'
        consumerOtpMessage:
          type: string
          description: >-
            Message that will be displayed when requesting a OTP message. You
            must include the following place holder: "$otp" where you want to
            display the OTP secret.


            If not set, the default message is: "Your {partnerName} secret to
            change your password is: {secret} If you are not at the origin of
            this message, you can ignore it."
        corporateOtpMessage:
          type: string
          description: >-
            Message that will be displayed when requesting a OTP message. You
            must include the following place holder: "$otp" where you want to
            display the OTP secret.


            If not set, the default message is: "Your {partnerName} secret to
            change your password is: {secret} If you are not at the origin of
            this message, you can ignore it."
        displayName:
          type: string
          description: Name display on documents.
        logoUrl:
          type: string
          description: Url that provides the logo.
        contactInformation:
          $ref: '#/components/schemas/ContactInformation_Partner'
      description: The information to update a partner.
    PartnerUpdateResponseDto_Partner:
      required:
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        updateDate:
          type: string
          format: date-time
    ShareUpdateRequestDto:
      required:
        - percentage
      type: object
      properties:
        percentage:
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
    ShareUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    DebtorUpdateRequestDto:
      type: object
      properties:
        bankingDetails:
          $ref: '#/components/schemas/DebtorBankingDetails'
      description: The information on the debtor.
    DirectDebitMandateUpdateRequestDto:
      type: object
      properties:
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        debtor:
          $ref: '#/components/schemas/DebtorUpdateRequestDto'
        recurring:
          type: boolean
          description: >-
            If true, the mandate will be used for recurring payments. By default
            is false.
        expirationDate:
          type: string
          format: date
    DirectDebitMandateUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    LedgerUpdateRequestDto:
      type: object
      properties:
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        parentLedgerId:
          type: string
          format: uuid
        limits:
          $ref: '#/components/schemas/LedgerLimitsRequestDto'
    LedgerUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CryptoBeneficiaryUpdateRequestDto:
      type: object
      properties:
        active:
          type: boolean
        display:
          type: boolean
        friendlyName:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - DECLINED
            - PENDING_REVIEW
            - VALID
            - PENDING
            - NEED_ADDITIONAL_INFORMATION
    CryptoBeneficiaryUpdateResponseDto:
      required:
        - cryptoBeneficiaryId
      type: object
      properties:
        cryptoBeneficiaryId:
          type: string
          format: uuid
    AustriaLegalType_Partner:
      required:
        - austriaValue
      type: object
      properties:
        austriaValue:
          type: string
          enum:
            - AT_AKTIENGESELLSCHAFT_AG
            - AT_EINGETRAGENES_EINZELUNTERNEHMEN_EU
            - AT_EUROPEAN_BUSINESS_ENTITIES
            - AT_GENOSSENSCHAFT_GEN
            - AT_GESELLSCHAFT_DES_BURGERLICHEN_RECHTS_GESBR
            - AT_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - AT_KOMMANDITERWERBSGESELLSCHAFT_KEG
            - AT_KOMMANDITGESELLSCHAFT_KG
            - AT_OFFENE_ERWERBSGESELLSCHAFT_OEG
            - AT_OFFENE_GESELLSCHAFT_OG
            - AT_PRIVATSTIFTUNG
            - AT_STILLE_GESELLSCHAFT_STG
            - AT_VEREIN
    BelgiumLegalType_Partner:
      required:
        - belgiumValue
      type: object
      properties:
        belgiumValue:
          type: string
          enum:
            - BE_ASSOCIATION_SANS_BUT_LUCRATIF_ASBL
            - BE_BESLOTEN_VENNOOTSCHAP_BV
            - BE_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_BVBA
            - BE_COMMANDITAIRE_VENNOOTSCHAP_OP_AANDELEN_COMMVA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_CVBA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_ONBEPERKTE_AANSPRAKELIJKHEID_CVOA
            - BE_ECONOMISCH_SAMENWERKINGSVERBAND_ESV
            - BE_EENMANSZAAK
            - >-
              BE_EENPERSOONS_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_EBVBA
            - BE_ENTREPRISE_INDIVIDUELLE
            - BE_FEITELIJKE_VERENIGING
            - BE_FONDATION_DUTILITE_PUBLIQUE
            - BE_FONDATION_PRIVEE
            - BE_GEWONE_COMMANDITAIRE_VENNOOTSCHAP_COMMV
            - BE_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - BE_NAAMLOZE_VENNOOTSCHAP_NV
            - BE_PRIVATE_STICHTING
            - BE_SOCIETE_ANONYME_SA
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_ILLIMITEE_SCRI
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_LIMITEE_SCRL
            - BE_SOCIETE_DE_FAIT
            - BE_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - BE_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - BE_SOCIETE_EN_NOM_COLLECTIF_SN
            - BE_SOCIETE_EN_PARTICIPATION_SEP
            - BE_SOCIETE_INTERNE
            - BE_SOCIETE_MOMENTANEE
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_SPRL
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_UNIPERSONNELLE_SPRLU
            - BE_STICHTING_VAN_OPENBAAR_NUT
            - BE_STILLE_HANDELSVENNOOTSCHAP
            - BE_TIJDELIJKE_HANDELSVENNOOTSCHAP
            - BE_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - BE_VEREINIGUNG_OHNE_GEWINNERZIELUNGSABSICHT_VOG
            - BE_VERENIGING_IN_DEELNEMING
            - BE_VERENIGING_ZONDER_WINSTOOGMERK_VZW
    BulgariaLegalType_Partner:
      required:
        - bulgariaValue
      type: object
      properties:
        bulgariaValue:
          type: string
          enum:
            - BG_AKTSIONERNO_DRUJESTVO_AD
            - >-
              BG_AKTSIONERNO_DRUZHESTVO_SUS_SPETSIALNA_INVESTITSIONNA_TSEL_ADSITZ
            - BG_DRUJESTVO_S_OGRANICHENA_OTGOVORNOST_OOD
            - BG_EDNOLICHEN_TURGOVETZ_ET
            - BG_EDNOLICHNO_AKTSIONERNO_DRUZHESTVO_EAD
            - BG_EDNOLICHNO_DRUZHESTVO_S_OGRANICHENA_OTGOVORNOST_EOOD
            - BG_KOMANDITNO_DRUZHESTVO_KD
            - BG_KOMANDITNO_DRUZHESTVO_S_AKTZII_KDA
            - BG_SUBIRATELNO_DRUZHESTVO_SD
    CorporateApiLegalType_Partner:
      type: object
      anyOf:
        - $ref: '#/components/schemas/AustriaLegalType_Partner'
        - $ref: '#/components/schemas/BelgiumLegalType_Partner'
        - $ref: '#/components/schemas/BulgariaLegalType_Partner'
        - $ref: '#/components/schemas/SwitzerlandLegalType_Partner'
        - $ref: '#/components/schemas/CyprusLegalType_Partner'
        - $ref: '#/components/schemas/CzechiaLegalType_Partner'
        - $ref: '#/components/schemas/GermanyLegalType_Partner'
        - $ref: '#/components/schemas/DenmarkLegalType_Partner'
        - $ref: '#/components/schemas/EstoniaLegalType_Partner'
        - $ref: '#/components/schemas/SpainLegalType_Partner'
        - $ref: '#/components/schemas/FinlandLegalType_Partner'
        - $ref: '#/components/schemas/FranceLegalType_Partner'
        - $ref: '#/components/schemas/MonacoLegalType_Partner'
        - $ref: '#/components/schemas/UnitedKingdomLegalType_Partner'
        - $ref: '#/components/schemas/GreeceLegalType_Partner'
        - $ref: '#/components/schemas/CroatiaLegalType_Partner'
        - $ref: '#/components/schemas/HungaryLegalType_Partner'
        - $ref: '#/components/schemas/IrelandLegalType_Partner'
        - $ref: '#/components/schemas/IcelandLegalType_Partner'
        - $ref: '#/components/schemas/ItalyLegalType_Partner'
        - $ref: '#/components/schemas/LiechtensteinLegalType_Partner'
        - $ref: '#/components/schemas/LithuaniaLegalType_Partner'
        - $ref: '#/components/schemas/LuxembourgLegalType_Partner'
        - $ref: '#/components/schemas/LatviaLegalType_Partner'
        - $ref: '#/components/schemas/MaltaLegalType_Partner'
        - $ref: '#/components/schemas/NetherlandsLegalType_Partner'
        - $ref: '#/components/schemas/NorwayLegalType_Partner'
        - $ref: '#/components/schemas/PolandLegalType_Partner'
        - $ref: '#/components/schemas/PortugalLegalType_Partner'
        - $ref: '#/components/schemas/RomaniaLegalType_Partner'
        - $ref: '#/components/schemas/SwedenLegalType_Partner'
        - $ref: '#/components/schemas/SloveniaLegalType_Partner'
        - $ref: '#/components/schemas/SlovakiaLegalType_Partner'
    CorporateFinancialInformationRequestDto_Partner:
      title: FinancialInformation
      required:
        - currency
        - expectedMonthlyIncomingTransferFrequency
        - expectedMonthlyIncomingVolume
        - expectedMonthlyOutgoingVolume
        - monthlyNetIncome
      type: object
      properties:
        currency:
          type: string
          description: The currency used for the expected monthly expenses.
          enum:
            - EUR
            - USD
            - GBP
        monthlyNetIncome:
          type: string
          description: The net financial revenue expected every month
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingVolume:
          type: string
          description: >-
            The amount of money you expect to receive with this account every
            month.
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyOutgoingVolume:
          type: string
          description: >-
            The amount of money you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          description: >-
            The frequency at which you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    CorporateUpdateRequestDto_Partner:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate to a
            user in your system.
        registeredName:
          maxLength: 255
          minLength: 0
          type: string
          description: The official corporate name. Must only contains Latin-1 characters.
        tradeName:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The name used for business if there is one. Must only contains
            Latin-1 characters.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        incorporationDate:
          type: string
          description: The date the corporate was officially registered.
          format: date
        legalType:
          $ref: '#/components/schemas/CorporateApiLegalType_Partner'
        website:
          maxLength: 511
          minLength: 0
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        vatNumber:
          type: string
          description: The corporate VAT number.
        registeredAddress:
          $ref: '#/components/schemas/EuropeanAddressRequestDto_Partner'
        businessAddress:
          $ref: '#/components/schemas/EuropeanAddressRequestDto_Partner'
        financialInformationRequestDto:
          $ref: '#/components/schemas/CorporateFinancialInformationRequestDto_Partner'
        employeesRange:
          type: string
          description: The number of employees working for the corporate.
          enum:
            - BTW_1_AND_10
            - BTW_11_AND_50
            - MORE_THAN_50
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        lastTermsAccepted:
          type: string
          description: >-
            The version of the terms and conditions signed by the corporate
            account owner.
          example: '1.0'
        userMetadata:
          title: User metadata
          type: object
          additionalProperties:
            title: User metadata
            type: object
            description: |-
              A custom field to save data.

              This field's size is limited to 3000 characters.
          description: |-
            A custom field to save data.

            This field's size is limited to 3000 characters.
        partnerMetadata:
          title: Partner metadata
          type: object
          additionalProperties:
            title: Partner metadata
            type: object
            description: >-
              A custom field to save data that cannot be modified by the
              end-user.


              This field's size is limited to 3000 characters.


              Note: if you are authenticated as end-user, trying to update this
              field will result in a Forbidden Error.
          description: >-
            A custom field to save data that cannot be modified by the end-user.


            This field's size is limited to 3000 characters.


            Note: if you are authenticated as end-user, trying to update this
            field will result in a Forbidden Error.
      description: The information to update a corporate.
    CroatiaLegalType_Partner:
      required:
        - croatiaValue
      type: object
      properties:
        croatiaValue:
          type: string
          enum:
            - HR_DIONICKO_DRUSTVO_DD
            - HR_DOMACA_RADINOST_AND_SPOREDNO_ZANIMANJE
            - HR_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_DOO
            - HR_GOSPODARSKO_INTERESNO_UDRUZENJE_GIU
            - HR_JAVNO_TRGOVACKO_DRUSTVO_JTD
            - HR_JEDNOSTAVNO_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_JDOO
            - HR_KOMANDITNO_DRUSTVO_KD
            - HR_OBITELJSKO_POLJOPRIVREDNO_GOSPODARSTVO_OPG
            - HR_OBRT
            - HR_ORTAKLUK
            - HR_SLOBODNA_DJELATNOST
            - HR_ZADRUGA
    CyprusLegalType_Partner:
      required:
        - cyprusValue
      type: object
      properties:
        cyprusValue:
          type: string
          enum:
            - CY_PRIVATE_LIMITED_COMPANY_LTD
            - CY_PUBLIC_LIMITED_COMPANY_PLC
            - CY_COMPANY_LIMITED_BY_GUARANTEE
            - CY_GENERAL_PARTNERSHIP
            - CY_LIMITED_PARTNERSHIP
            - CY_SOLO_PROPRIETORSHIP
    CzechiaLegalType_Partner:
      required:
        - czechiaValue
      type: object
      properties:
        czechiaValue:
          type: string
          enum:
            - CZ_AKCIOVA_SPOLECNOST_AS
            - CZ_KOMANDITNI_SPOLECNOST_KS
            - CZ_OBECNE_PROSPESNA_SPOLECNOST_OPS
            - CZ_PRISPEVKOVA_ORGANIZACE
            - CZ_SPOLECNOST_S_RUCENIM_OMEZENYM_SRO
            - CZ_STATNI_PODNIK_SP
            - CZ_VEREJNA_OBCHODNI_SPOLECNOST_VOS
            - CZ_ZAPSANY_SPOLEK_ZS
            - CZ_ZIVNOST
    DenmarkLegalType_Partner:
      required:
        - denmarkValue
      type: object
      properties:
        denmarkValue:
          type: string
          enum:
            - DK_AKTIESELSKAB_A_S
            - DK_ANDELSSELSKAB_MED_BEGRAENSET_ANSVAR_AMBA
            - DK_ANPARTSSELSKAB_APS
            - DK_ENKELTMANDSVIRKSOMHED
            - DK_ERHVERVSDRIVENDE_FOND
            - DK_FORENING
            - DK_FORENING_MED_BEGRAENSET_ANSVAR_FMBA
            - DK_GENSIDIGT_SELSKAB_G_S
            - DK_INTERESSENTSKAB_I_S
            - DK_IVAERKSAETTERSELSKAB_IVS
            - DK_KOMMANDITSELSKAB_K_S
            - DK_PARTNERSELSKAB_OR_KOMMANDITAKTIESELSKAB_P_S
            - DK_PARTSREDERI
            - DK_SELSKAB_MED_BEGRAENSET_ANSVAR_SMBA
    EstoniaLegalType_Partner:
      required:
        - estoniaValue
      type: object
      properties:
        estoniaValue:
          type: string
          enum:
            - EE_AKTSIASELTS_AS
            - EE_FUUSILISEST_ISIKUST_ETTEVOTJA_FIE
            - EE_MITTETULUNDUSUHING_MTU
            - EE_OSAUHING_OU
            - EE_TAISUHING_TU
            - EE_TULUNDUSUHISTU
            - EE_USALDUSUHING_UU
    FinlandLegalType_Partner:
      required:
        - finlandValue
      type: object
      properties:
        finlandValue:
          type: string
          enum:
            - FI_ASUNTO_OSAKEYHTIO
            - FI_AVOIN_YHTIO_AY
            - FI_EUROOPPALAINEN_TALOUDELLINEN_ETUYHTYMA_EEIG
            - FI_EUROOPPAOSUUSKUNTA_SCE
            - FI_EUROOPPAYHTIO_SE
            - FI_JULKINEN_KESKINAINEN_VAKUUTUSYHTIO_JY
            - FI_JULKINEN_OSAKEYHTIO_OYJ
            - FI_KESKINAINEN_KIINTEISTOOSAKEYHTIO
            - FI_KESKINAINEN_VAKUUTUSYHTIO
            - FI_KESKIVEDENKORKEUDEN_MUUTTAMISTA_VARTEN_PERUSTETTU_YHTEISO
            - FI_KOMMANDIITTIYHTIO_KY
            - FI_KUNNALLINEN_LIIKELAITOS
            - FI_LAIVAISANNISTOYHTIO
            - FI_OJITUSYHTEISO
            - FI_OSAKASKUNTA
            - FI_OSAKEYHTIO_OY
            - FI_OSUUSKUNTA_OSK
            - FI_PALISKUNTA
            - FI_REKISTEROITY_PUOLUE_RP
            - FI_REKISTEROITY_YHDISTYS_RY
            - FI_SAANNOSTELY_YHTEISO
            - FI_SAASTOPANKKI
            - FI_SAATIO_RS
            - FI_TIEKUNTA
            - FI_TOIMINIMI_TMI
            - FI_UITTOYHTEISO
            - FI_USKONNOLLINEN_YHDYSKUNTA
            - FI_VALTION_LIIKELAITOS
            - FI_VESIOIKEUDELLINEN_YHTEISO_BODIES_OF_WATER
            - FI_VOLUNTARY_ASSOCIATIONS_CHARTERED_BY_STATUTE_LAW
            - FI_YHTEISALUE
            - FI_YHTEISMETSA
    FranceLegalType_Partner:
      required:
        - franceValue
      type: object
      properties:
        franceValue:
          type: string
          enum:
            - FR_ASSOCIATION_DECLAREE
            - FR_ASSOCIATION_NON_DECLAREE
            - FR_AUTO_ENTREPRENEUR
            - FR_ENTREPRISE_INDIVIDUELLE_ENTREPRISE_EN_NOM_PERSONNEL_EI
            - FR_ENTREPRISE_UNIPERSONNELLE_A_RESPONSABILITE_LIMITEE_EURL
            - FR_FOND_COMMUN_DE_PLACEMENT_FCP
            - FR_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - FR_PROFESSION_LIBERAL
            - FR_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - FR_SOCIETE_ANONYME_SA
            - FR_SOCIETES_DEXERCICE_LIBERAL
            - FR_SOCIETE_COOPERATIVE_DE_PRODUCTION_SCOP
            - FR_SOCIETE_DECONOMIE_MIXTE_SEM
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - FR_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - FR_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - FR_SOCIETE_EN_NOM_COLLECTIF_SNC
            - FR_SOCIETE_EN_PARTICIPATION_SEP
            - FR_SOCIETE_PAR_ACTIONS_SIMPLIFIEE_SAS
            - FR_SOCIETE_CIVILE_IMMOBILIERE_SCI
            - FR_U_UNIPERSONNELLE_SAS_SASU
    GermanyLegalType_Partner:
      required:
        - germanyValue
      type: object
      properties:
        germanyValue:
          type: string
          enum:
            - DE_AKTIENGESELLSCHAFT_AG
            - DE_ALTRECHTLICHER_VEREIN_RECHTSFAHIGER_VEREIN_RV
            - DE_ANSTALT_DES_OFFENTLICHEN_RECHTS
            - DE_EINGETRAGENER_KAUFMANN_EINGETRAGENE_KAUFFRAU_EK_EKFM_EKFR
            - DE_EINGETRAGENER_VEREIN_EV
            - DE_EINGETRAGENE_GENOSSENSCHAFT_EG
            - DE_EINZELUNTERNEHMEN
            - DE_GESELLSCHAFT_BURGERLICHEN_RECHTS_BGB_GESELLSCHAFT_GBR
            - DE_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - DE_KOMMANDITGESELLSCHAFT_AUF_AKTIEN_KGAA
            - DE_KOMMANDITGESELLSCHAFT_KG
            - DE_NICHT_EINGETRAGENER_VEREI
            - DE_OFFENE_HANDELSGESELLSCHAFT_OHG
            - DE_PARTENREEDEREI
            - >-
              DE_PARTNERSCHAFTSGESELLSCHAFT_MIT_BESCHRANKTER_BERUFSHAFTUNG_PARTGMBBH
            - DE_PARTNERSCHAFTSGESELLSCHAFT_PARTG
            - DE_STIFTUNG
            - DE_STIFTUNG_DES_OFFENTLICHEN_RECHTS
            - DE_UNTERNEHMERGESELLSCHAFT_UG
            - DE_WIRTSCHAFTLICHER_VEREIN
    GreeceLegalType_Partner:
      required:
        - greeceValue
      type: object
      properties:
        greeceValue:
          type: string
          enum:
            - GR_ANONIMI_ETERIA_AE
            - GR_ANONIMI_VIOMIHANIKI_EMBORIKI_ETERIA_AVEE
            - GR_ETERIA_PERIORISMENIS_EUTHINIS_EPE
            - GR_ETERORITHMI_ETERIA_EE
            - GR_IDIOTIKI_KEFALEOUHIKI_ETERIA_IKE
            - GR_MONOPROSOPI_ETERIA_PERIORISMENIS_EUTHINIS_MEPE
            - GR_OMORITHMI_ETERIA_OE
            - GR_OMORITHMI_VIOMIHANIKI_EMBORIKI_ETERIA_OVEE
    HungaryLegalType_Partner:
      required:
        - hungaryValue
      type: object
      properties:
        hungaryValue:
          type: string
          enum:
            - HU_BETETI_TARSASAG_BT
            - HU_EGYENI_CEG_EC
            - HU_EGYENI_VALLALKOZO_EV
            - HU_EGYESULES
            - HU_KORLATOLT_FELELOSSEGU_TARSASAG_KFT
            - HU_KOZHASZNU_TARSASAG_KHT
            - HU_KOZKERESETI_TARSASAG_KKT
            - HU_KOZOS_VALLALAT_KV
            - HU_NYILVANOSAN_MUKODO_RESZVENYTARSASAG_NYRT
            - HU_RESZVENYTARSASAG_RT
            - HU_SZOVETKEZET_SZOV
            - HU_ZARTKOZUEN_MUKODO_RESZVENYTARSASAG_ZRT
    IcelandLegalType_Partner:
      required:
        - icelandValue
      type: object
      properties:
        icelandValue:
          type: string
          enum:
            - IS_EINKAHLUTAFELAG_EHF
            - IS_EINSTAKLINGSFYRIRTAEKI
            - IS_HLUTAFELAG_HF
            - IS_OPINBERT_HLUTAFELAG_OHF
            - IS_SAMEIGNARFELAG_SF
            - IS_SAMLAGSFELAG
            - IS_SAMVINNUFELAG
            - IS_SJALFSEIGNARSTOFNUN
    IrelandLegalType_Partner:
      required:
        - irelandValue
      type: object
      properties:
        irelandValue:
          type: string
          enum:
            - IE_A_PUBLIC_LIMITED_COMPANY
            - IE_COMPANY_LIMITED_BY_GUARANTEE_HAVING_A_SHARE_CAPITAL
            - IE_COMPANY_LIMITED_BY_GUARANTEE_NOT_HAVING_A_SHARE_CAPITAL
            - IE_PRIVATE_COMPANY_LIMITED_BY_SHARES
            - IE_SINGLE_MEMBER_COMPANY
            - >-
              IE_UNDERTAKINGS_FOR_COLLECTIVE_INVESTMENT_IN_TRANSFERABLE_SECURITIES_UCITS
            - IE_UNLIMITED_COMPANY
    ItalyLegalType_Partner:
      required:
        - italyValue
      type: object
      properties:
        italyValue:
          type: string
          enum:
            - IT_ARTIGIANO
            - IT_IMPRENDITORE
            - IT_LAVORATORE_AUTONOMO
            - IT_LIBERO_PROFESSIONISTA
            - IT_SOCIETA_A_RESPONSABILITA_LIMITATA_SRL
            - IT_SOCIETA_COOPERATIVA_A_RESPONSABILITA_LIMITATA_SCRL
            - IT_SOCIETA_IN_ACCOMANDITA_PER_AZIONI_SAPA
            - IT_SOCIETA_IN_ACCOMANDITA_SEMPLICE_SAS
            - IT_SOCIETA_IN_NOME_COLLETTIVO_SNC
            - IT_SOCIETA_PER_AZIONI_SPA
            - IT_SOCIETA_SEMPLICE_SS
    LatviaLegalType_Partner:
      required:
        - latviaValue
      type: object
      properties:
        latviaValue:
          type: string
          enum:
            - LV_AKCIJU_SABIEDRIBA_AS
            - LV_ARZEMJU_KOMERSANTA_FILIALE_AKF
            - LV_BEZPELNAS_ORGANIZACIJA_BO
            - LV_INDIVIDUALAIS_KOMERSANTS_IK
            - LV_KOMANDITSABIEDRIBA_KS
            - LV_PILNSABIEDRIBA_PS
            - LV_SABIEDRIBA_AR_IEROBEZOTU_ATBILDIBU_SIA
    LiechtensteinLegalType_Partner:
      required:
        - liechtensteinValue
      type: object
      properties:
        liechtensteinValue:
          type: string
          enum:
            - LI_AKTIENGESELLSCHAFT_AG
            - LI_ANSTALT
            - LI_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - LI_STIFTUNG
            - LI_TREUHANDSC_TREUUNTERNEHMEN_HAFT
    LithuaniaLegalType_Partner:
      required:
        - lithuaniaValue
      type: object
      properties:
        lithuaniaValue:
          type: string
          enum:
            - LT_AKCINE_BENDROVE_AB
            - LT_INDIVIDUALI_IMONE_II
            - LT_INDIVIDUALI_VEIKLA
            - LT_KOMANDITINE_UKINE_BENDRIJA_KUB
            - LT_MAZOJI_BENDRIJA_MB
            - LT_TIKROJI_UKINE_BENDRIJA_TUB
            - LT_UZDAROJI_AKCINE_BENDROVE_UAB
            - LT_VIESOJI_ISTAIGA_VSI
    LuxembourgLegalType_Partner:
      required:
        - luxembourgValue
      type: object
      properties:
        luxembourgValue:
          type: string
          enum:
            - LU_SOCIETE_ANONYME_SA
            - LU_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - LU_SOCIETE_EN_COMMANDITE_SIMPLE_SECS
    MaltaLegalType_Partner:
      required:
        - maltaValue
      type: object
      properties:
        maltaValue:
          type: string
          enum:
            - MT_PRIVATE_LIMITED_COMPANY
            - MT_PUBLIC_LIABILITY_COMPANY
            - MT_PARTNERSHIP_EN_NOM_COLLECTIF
            - MT_PARTNERSHIP_EN_COMMANDITE
            - MT_LIMITED_LIABILITY_COMPANY_LLC
            - MT_BRANCHES_OF_OVERSEA_COMPANIES
            - MT_GENERAL_PARTNERSHIPS
            - MT_LIMITED_PARTNERSHIPS
    MonacoLegalType_Partner:
      required:
        - monacoValue
      type: object
      properties:
        monacoValue:
          type: string
          enum:
            - MC_ASSOCIATION
            - MC_FONDATION
            - MC_SOCIETE_ANONYME_MONEGASQUE_SAM
            - MC_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - MC_SOCIETE_EN_NOM_COLLECTIF_SNC
            - MC_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - MC_ENTREPRISE_INDIVIDUELLE_EI
            - MC_SUCCURSALE
            - MC_SOCIETE_CIVILE_IMMOBILIERE_SCI
    NetherlandsLegalType_Partner:
      required:
        - netherlandsValue
      type: object
      properties:
        netherlandsValue:
          type: string
          enum:
            - NL_BEPERKTE_AANSPRAKELIJKHEID_BA
            - NL_BESLOTEN_VENNOOTSCHAP_BV
            - NL_COMMANDITAIRE_VENNOOTSCHAP_CV
            - NL_COOPERATIE
            - NL_EENMANSZAAK
            - NL_MAATSCHAP_MTS
            - NL_NAAMLOZE_VENNOOTSCHAP_NV
            - NL_ONDERLINGE_WAARBORGMAATSCHAPPIJ
            - NL_STICHTING
            - NL_UITSLUITING_VAN_AANSPRAKELIJKHEID_UA
            - NL_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - NL_WETTELIJKE_AANSPRAKELIJKHEID_WA
    NorwayLegalType_Partner:
      required:
        - norwayValue
      type: object
      properties:
        norwayValue:
          type: string
          enum:
            - NO_AKSJESELSKAP_AS
            - NO_ALLMENNAKSJESELSKAP_ASA
            - NO_ANSVARLIG_SELSKAP_ANS
            - NO_BORETTSLAG_BL
            - NO_ENKELTPERSONFORETAK
            - NO_FYLKESKOMMUNALT_FORETAK_FKF
            - NO_HELSEFORETAK_HF
            - NO_INTERKOMMUNALT_SELSKAP_IKS
            - NO_KOMMANDITTSELSKAP_KS
            - NO_KOMMUNALT_FORETAK_KF
            - NO_NORSKREGISTRERT_UTENLANDSK_FORETAK_NUF
            - NO_REGIONALT_HELSEFORETAK_RHF
            - NO_SELSKAP_MED_BEGRENSET_ANSVAR_BA
            - NO_SELSKAP_MED_DELT_ANSVAR_DA
            - NO_SPAREBANK_SAVINGS_BANK
            - NO_STATE_COUNTY_OR_MUNICIPAL_AGENCY_ETAT
            - NO_STATSFORETAK_SF
            - NO_STIFTELSE
    PolandLegalType_Partner:
      required:
        - polandValue
      type: object
      properties:
        polandValue:
          type: string
          enum:
            - PL_JEDNOOSOBOWA_DZIALALNOSC_GOSPODARCZA
            - PL_PRZEDSIEBIORSTWO_PANSTWOWE
            - PL_SPOLDZIELNIA
            - PL_SPOLKA_AKCYJNA_SA
            - PL_SPOLKA_CYWILNA_SC
            - PL_SPOLKA_JAWNA_SPJ
            - PL_SPOLKA_KOMANDYTOWA_SPK
            - PL_SPOLKA_KOMANDYTOWO_AKCYJNA_SKA
            - PL_SPOLKA_PARTNERSKA_SPP
            - PL_SPOLKA_Z_OGRANICZONA_ODPOWIEDZIALNOSCIA_SP_Z_OO
    PortugalLegalType_Partner:
      required:
        - portugaValue
      type: object
      properties:
        portugaValue:
          type: string
          enum:
            - PT_COOPERATIVA_DE_RESPONSABILIDADE_LIMITADA_CRL
            - PT_LIMITADA_LDA
            - PT_SOCIEDADE_ABERTA_SA
            - PT_SOCIEDADE_FECHADA_SF
            - PT_SOCIEDADE_GESTORA_DE_PARTICIPACOES_SOCIAIS_SGPS
    RomaniaLegalType_Partner:
      required:
        - romaniaValue
      type: object
      properties:
        romaniaValue:
          type: string
          enum:
            - RO_ORGANIZATIE_NON_GUVERNAMENTALA_ONG
            - RO_PERSOANA_FIZICA_AUTORIZATA_PFA
            - >-
              RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_CU_PROPRIETAR_UNIC_SRL_CU_PROPRIETAR_UNIC
            - RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATEA_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATEA_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATEA_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATEA_PE_ACTIUNI_SA
            - RO_SOCIETATE_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATE_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATE_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATE_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATE_PE_ACTIUNI_SA
    SlovakiaLegalType_Partner:
      required:
        - slovakiaValue
      type: object
      properties:
        slovakiaValue:
          type: string
          enum:
            - SK_AKCIOVA_SPOLOCNOST_AS
            - SK_DRUZSTVO
            - SK_KOMANDITNA_SPOLOCNOST_KS
            - SK_SPOLOCNOST_S_RUCENIM_OBMEDZENYM_SRO
            - SK_VEREJNA_OBCHODNA_SPOLOCNOST_VOS
            - SK_ZIVNOST
    SloveniaLegalType_Partner:
      required:
        - sloveniaValue
      type: object
      properties:
        sloveniaValue:
          type: string
          enum:
            - SI_DELNISKA_DRUZBA_DD
            - SI_DRUZBA_Z_NEOMEJENO_ODGOVORNOSTJO_DNO
            - SI_DRUZBA_Z_OMEJENO_ODGOVORNOSTJO_DOO
            - SI_KOMANDITNA_DRUZBA_KD
            - SI_SAMOSTOJNI_PODJETNIK_SP
    SpainLegalType_Partner:
      required:
        - spainValue
      type: object
      properties:
        spainValue:
          type: string
          enum:
            - ES_SOCIEDAD_ANONIMA_DEPORTIVA_SAD
            - ES_SOCIEDAD_ANONIMA_SA
            - ES_SOCIEDAD_CIVIL_PRIVADA_SCP
            - ES_SOCIEDAD_COLECTIVA_SC
            - ES_SOCIEDAD_COMANDITARIA_SCRA
            - ES_SOCIEDAD_COOPERATIVA_SCOOP
            - ES_SOCIEDAD_LIMITADA_LABORAL_SLL
            - ES_SOCIEDAD_LIMITADA_NUEVA_EMPRESA_SLNE
            - ES_SOCIEDAD_LIMITADA_SL
    SwedenLegalType_Partner:
      required:
        - swedenValue
      type: object
      properties:
        swedenValue:
          type: string
          enum:
            - SE_AKTIEBOLAG_AB
            - SE_BOSTADSRATTSFORENING
            - SE_EKONOMISK_FORENING_EK_FOR
            - SE_ENKELT_BOLAG
            - SE_ENSKILD_FIRMA
            - SE_HANDELSBOLAG_HB
            - SE_HYRESRATTSFORENING
            - SE_IDEELL_FORENING
            - SE_KOMMANDITBOLAG_KB
            - SE_KOOPERATIV
            - SE_PUBLIKT_AKTIEBOLAG_AB_PUBL
            - SE_STIFTELSE
    SwitzerlandLegalType_Partner:
      required:
        - switzerlandValue
      type: object
      properties:
        switzerlandValue:
          type: string
          enum:
            - CH_AKTIENGESELLSCHAFT_AG
            - CH_ASSOCIATION
            - CH_ASSOCIAZIONE
            - CH_DITTA_INDIVIDUALE
            - CH_EINFACHE_GESELLSCHAFT_EG
            - CH_EINZELUNTERNEHMEN
            - CH_ENTREPRISE_INDIVIDUELLE
            - CH_FONDATION
            - CH_FONDAZIONE
            - CH_GENOSSENSCHAFT
            - CH_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - CH_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - CH_GRUPPO_DI_INTERESSE_ECONOMICO
            - CH_INVESTMENTGESELLSCHAFT_MIT_FESTEM_KAPITAL
            - CH_INVESTMENTGESELLSCHAFT_MIT_VARIABLEM_KAPITALS
            - CH_INVESTMENT_FUND
            - CH_KOLLEKTIVGESELLSCHAFT_KOLG
            - CH_KOMMANDITAKTIENGESELLSCHAFT_KOMAG
            - CH_KOMMANDITGESELLSCHAFT_KG
            - CH_RAISON_INDIVIDUELLE_RI
            - CH_SOCIETA_ANONIMA_SA
            - CH_SOCIETA_A_GARANZIA_LIMITATA_SAGL
            - CH_SOCIETA_COOPERATIVA
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_FISSO_SICAF
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_VARIABILE_SICAV
            - CH_SOCIETA_IN_ACCOMANDITA
            - CH_SOCIETA_IN_ACCOMANDITA_PER_AZIONI
            - CH_SOCIETA_IN_NOME_COLLETTIVO
            - CH_SOCIETA_SEMPLICE
            - CH_SOCIETE_ANONYME_SA
            - CH_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - CH_SOCIETE_COOPERATIVE
            - CH_SOCIETE_COOPERATIVE_SCOOP
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE_SICAF
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - CH_SOCIETE_EN_COMMANDITE
            - CH_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - CH_SOCIETE_EN_COMMANDITE_SC
            - CH_SOCIETE_EN_NOM_COLLECTIF
            - CH_SOCIETE_EN_NOM_COLLECTIF_SNC
            - CH_SOCIETE_SIMPLE
            - CH_STIFTUNG
            - CH_SUCCURSALE
            - CH_VEREIN
            - CH_WIRTSCHAFTLICHE_INTERESSENGEMEINSCHAFT_WIG
            - CH_ZWEIGNIEDERLASSUNG
    UnitedKingdomLegalType_Partner:
      required:
        - unitedKingdomValue
      type: object
      properties:
        unitedKingdomValue:
          type: string
          enum:
            - GB_CHARITABLE_INCORPORATED_ORGANISATION_CIO
            - GB_COMMUNITY_INTEREST_COMPANY_CIC
            - GB_GENERAL_PARTNERSHIP
            - GB_INDUSTRIAL_AND_PROVIDENT_SOCIETY
            - GB_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - GB_LIMITED_PARTNERSHIP_LP
            - GB_PRIVATE_COMPANY_LIMITED_BY_GUARANTEE_LTD
            - GB_PRIVATE_COMPANY_LIMITED_BY_SHARES_LTD
            - GB_PUBLIC_LIMITED_COMPANY_PLC
            - GB_SOLE_PROPRIETORSHIP
            - GB_UNLIMITED_COMPANY
    CorporateUpdateResponseDto:
      required:
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          description: Identifier of the updated corporate.
          format: uuid
        updateDate:
          type: string
          format: date-time
    KybStatusBypassRequestDto:
      required:
        - kybStatus
      type: object
      properties:
        kybStatus:
          type: string
          description: The new KYB status
          enum:
            - NOT_STARTED
            - COMPLETING
            - PENDING_VERIFICATION
            - NEED_ADDITIONAL_INFORMATION
            - DECLINED
            - VALIDATED
        bypassCompliance:
          type: boolean
          description: >-
            If set to true, compliance status will be directly set to VALIDATED
            without verifications. By default is true.
    KybStatusBypassResponseDto:
      required:
        - corporateId
      type: object
      properties:
        corporateId:
          type: string
          description: Identifier of the updated corporate
          format: uuid
    CorporateRelatedCorporateUpdateRequestDto_Partner:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate related
            to a user in your system.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        registeredName:
          maxLength: 255
          minLength: 0
          type: string
          description: The official corporate name.
        tradeName:
          maxLength: 255
          minLength: 0
          type: string
          description: The name used for business if there is one.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        website:
          maxLength: 511
          minLength: 0
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        registeredAddress:
          $ref: '#/components/schemas/WorldwideAddressRequestDto_Partner'
    CorporateRelatedPhysicalPersonUpdateRequestDto_Partner:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate related
            to a user in your system.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        middleName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        address:
          $ref: '#/components/schemas/WorldwideAddressRequestDto_Partner'
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        emailAddress:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneRequestDto_Partner'
        isSpecialUbo:
          type: boolean
          description: >-
            Indicates whether this person was designated UBO because no
            shareholder holds the percentage of shares required to become one.
    CorporateRelatedUpdateRequestDto_Partner:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate related
            to a user in your system.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
      description: The information to update a corporate related.
      anyOf:
        - $ref: >-
            #/components/schemas/CorporateRelatedPhysicalPersonUpdateRequestDto_Partner
        - $ref: >-
            #/components/schemas/CorporateRelatedCorporateUpdateRequestDto_Partner
    PhoneRequestDto_Partner:
      required:
        - countryCode
        - number
      type: object
      properties:
        countryCode:
          type: string
          example: '33'
        number:
          pattern: ^[0-9]{1,14}$
          type: string
      description: >-
        Update the phone of this corporate related person. Note: if you wish to
        change the phone of an account owner, please contact us.
    WorldwideAddressRequestDto_Partner:
      title: WorldwideAddressRequest
      required:
        - city
        - isoCountryCode
        - postalCode
        - street
      type: object
      properties:
        isoCountryCode:
          title: Worldwide Country Code
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        city:
          maxLength: 255
          minLength: 0
          type: string
        postalCode:
          maxLength: 10
          minLength: 0
          type: string
        street:
          maxLength: 511
          minLength: 0
          type: string
        number:
          maxLength: 255
          minLength: 0
          type: string
        refinement:
          maxLength: 35
          minLength: 0
          type: string
        stateOrProvince:
          maxLength: 255
          minLength: 0
          type: string
        bypassVerification:
          type: boolean
          description: >-
            If true, the address will be saved as described in the request
            without any auto-verification and the status will be INVALID until a
            POA is provided.


            By default is false.
    CorporateRelatedUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ConsumerFinancialInformationRequestDto_Partner:
      required:
        - currency
        - expectedMonthlyIncomingTransferFrequency
        - expectedMonthlyIncomingVolume
        - expectedMonthlyOutgoingVolume
        - monthlyNetIncome
      type: object
      properties:
        monthlyNetIncome:
          type: string
          description: The net financial revenue expected every month
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        currency:
          type: string
          description: The currency used for the expected monthly expenses.
          enum:
            - EUR
            - USD
            - GBP
        expectedMonthlyIncomingVolume:
          type: string
          description: >-
            The amount of money you expect to receive with this account every
            month.
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyOutgoingVolume:
          type: string
          description: >-
            The amount of money you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          description: >-
            The frequency at which you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    ConsumerUpdateRequestDto_Partner:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this consumer to a user
            in your system.
        sourceOfFunds:
          type: string
          enum:
            - COMPENSATION_PAYOUT
            - COMPANY_PROFITS
            - COMPANY_SALE
            - DIVIDEND_PAYMENTS
            - DIVORCE_SETTLEMENT
            - FIXED_DEPOSITS
            - GIFT
            - INHERITANCE
            - INSURANCE_PAYOUT
            - LOAN
            - LOTTERY_OR_GAMBLING_WIN
            - RETIREMENT_INCOME
            - SALE_OF_INVESTMENT
            - SALE_OF_PROPERTY
            - SAVINGS_FROM_SALARY
            - OTHER
        otherSourceOfFunds:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of source of funds if 'OTHER' was chosen.
        occupation:
          type: string
          description: >-
            The consumer usual or principal work or business as a means of
            earning a living.
          enum:
            - BUSINESS_OWNER
            - CLERGY
            - CRAFTSMAN
            - ENGINEER
            - EXECUTIVE
            - FARMER
            - FREELANCE
            - LIBERAL_PROFESSION
            - POLITICIAN
            - PROFESSOR
            - PUBLIC_SERVANT
            - RETIRED
            - SHOPKEEPER
            - STUDENT
            - UNEMPLOYED
            - WORKER
            - OTHER
        otherOccupation:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of occupation if 'OTHER' was chosen.
        occupationSector:
          type: string
          description: The consumer usual or principal work or business sector.
          enum:
            - ACCOUNTING_AUDIT
            - E_MONEY_SERVICES
            - CURRENCY_EXCHANGE
            - TRADES_ON_OTC_MARKET
            - PRECIOUS_METALS_OR_STONES
            - PAWNSHOPS
            - CROSS_BORDER_CASH_OR_PRECIOUS_MATERIALS
            - MINING_EXTRACTIVE_INDUSTRIES
            - ENERGY
            - TRADE_IN_PETROL_PRODUCTS
            - TRADE_IN_MEDICINES
            - REAL_ESTATE
            - CONSTRUCTION_REPAIR
            - CONSULTANCY_LEGAL
            - FREELANCE
            - NON_PROFIT_LEGAL_ENTITIES
            - CRYPTOCURRENCIES
            - GAMING
            - GAMBLING
            - EU_FUNDS_UTILIZATION
            - ADULT
            - HIGH_VALUE_ASSET_DEALER
            - BANKING_LENDING
            - INSURANCE_SECURITY
            - TRANSPORTATION_AND_LOGISTICS
            - MANUFACTURING
            - UTILITIES_AND_INFRASTRUCTURE
            - TRADE_IN_FOOD_PRODUCT
            - WHOLESALE
            - REPAIR_OF_MOTOR_VEHICLES
            - SOCIAL_WORK_ACTIVITIES
            - AUTO_AVIATION
            - COURIER_POST_SERVICES
            - AGRICULTURE_FORESTRY_AND_FISHING
            - OTHER_TRADE_AND_SALES
            - TRAVEL_TOURISM
            - INFORMATION_AND_COMMUNICATION
            - PR_MARKETING
            - EDUCATION
            - INFORMATIONAL_TECHNOLOGIES
            - PUBLIC_AND_DEFENCE_SECTOR
            - HEALTH_CARE_MEDICAL_SERVICES
            - ART_ENTERTAINMENT_SPORT
            - ADMINISTRATIVE_OFFICE_BUSINESS_ACTIVITIES
            - HOSPITALITY_AND_LEISURE
            - SCIENTIFIC_AND_TECHNICAL_ACTIVITIES
            - OTHER
        isUsPerson:
          type: boolean
          description: If the consumer is a specified us person. Default value is false.
        lastTermsAccepted:
          type: string
          description: The version of the terms and conditions signed by the consumer.
          example: '1.0'
        taxIdentificationNumber:
          maxLength: 255
          minLength: 0
          type: string
        taxCountry:
          type: string
          enum:
            - AUT
            - AND
            - BEL
            - BGR
            - CHE
            - CYP
            - CZE
            - DEU
            - DNK
            - ESP
            - EST
            - FIN
            - FRA
            - GBR
            - GRC
            - HRV
            - HUN
            - IRL
            - ISL
            - ITA
            - LIE
            - LTU
            - LUX
            - LVA
            - MLT
            - MCO
            - NLD
            - NOR
            - POL
            - PRT
            - ROU
            - SVN
            - SVK
            - SWE
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        financialInformationRequestDto:
          $ref: '#/components/schemas/ConsumerFinancialInformationRequestDto_Partner'
        userMetadata:
          title: User metadata
          type: object
          additionalProperties:
            title: User metadata
            type: object
            description: |-
              A custom field to save data.

              This field's size is limited to 3000 characters.
          description: |-
            A custom field to save data.

            This field's size is limited to 3000 characters.
        partnerMetadata:
          title: Partner metadata
          type: object
          additionalProperties:
            title: Partner metadata
            type: object
            description: >-
              A custom field to save data that cannot be modified by the
              end-user.


              This field's size is limited to 3000 characters.


              Note: if you are authenticated as end-user, trying to update this
              field will result in a Forbidden Error.
          description: >-
            A custom field to save data that cannot be modified by the end-user.


            This field's size is limited to 3000 characters.


            Note: if you are authenticated as end-user, trying to update this
            field will result in a Forbidden Error.
      description: The information to update a consumer.
    ConsumerUpdateResponseDto:
      required:
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        updateDate:
          type: string
          format: date-time
    ConsumerContactUpdateRequestDto_Partner:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto_Partner'
        emailAddress:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneRequestDto_Partner'
      description: >-
        The information to update a consumer contact (address, phone, email
        only).
    CardUpdateRequestDto:
      type: object
      properties:
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        phone:
          $ref: '#/components/schemas/PhoneRequestDto'
    CardUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CardProfileUpdateRequestDto:
      type: object
      properties:
        active:
          type: boolean
          description: >-
            When active, end-users are able to see this profile and create card
            with it.


            When disabled, it can not be used to create new cards anymore.
    CardProfileUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    BeneficiaryUpdateRequestDto_Partner:
      type: object
      properties:
        active:
          type: boolean
          description: Activate (or not) the beneficiary. Default value is true.
        display:
          type: boolean
          description: >-
            Display (or not) the beneficiary to the end-user (unusable by
            end-user).
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
    BeneficiaryUpdateResponseDto_Partner:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    BeneficiaryUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    AccountUpdateRequestDto:
      type: object
      anyOf:
        - $ref: '#/components/schemas/PartnerUserAccountUpdateRequestDto'
    PartnerUserAccountUpdateRequestDto:
      title: Partner user account
      required:
        - roles
      type: object
      properties:
        roles:
          uniqueItems: true
          type: array
          description: >-
            List of roles to give to the created user. Connected user can only
            give roles present in its JWT.
          items:
            title: LinkcyRole
            type: string
            description: >-
              List of roles to give to the created user. Connected user can only
              give roles present in its JWT.
            enum:
              - ACCOUNT_CREATE
              - BANKING_DETAILS_DOCUMENT_EXPORT
              - BENEFICIARY_CREATE
              - BENEFICIARY_INFO
              - BENEFICIARY_LIST
              - BENEFICIARY_UPDATE
              - DIRECT_DEBIT_MANDATE_CREATE
              - DIRECT_DEBIT_MANDATE_UPDATE
              - DIRECT_DEBIT_MANDATE_ACTIVATE
              - DIRECT_DEBIT_MANDATE_CANCEL
              - DIRECT_DEBIT_MANDATE_LIST
              - DIRECT_DEBIT_MANDATE_INFO
              - CARD_ACTIVATE
              - CARD_CLOSE
              - CARD_CREATE
              - CARD_UPDATE
              - CARD_DESIGN_LIST
              - CARD_INFO
              - CARD_LIST
              - CARD_PAN_CREDENTIALS
              - CARD_PIN
              - CARD_PAN_AND_CVV
              - CARD_RENEW
              - CARD_SUSPEND
              - CARD_RESET_PIN_ATTEMPTS
              - CARD_PROFILE_CREATE
              - CARD_PROFILE_LIST
              - CARD_PROFILE_RULE_DELETE
              - CARD_PROFILE_RULE_UPDATE
              - CARD_PROFILE_UPDATE
              - CARD_RULE_DELETE
              - CARD_RULE_UPDATE
              - EXTERNAL_CARD_LIST
              - CONSUMER_CREATE
              - CONSUMER_INFO
              - CONSUMER_LIST
              - CONSUMER_UPDATE
              - CONSUMER_CONTACT_UPDATE
              - CORPORATE_CREATE
              - CORPORATE_INFO
              - CORPORATE_LIST
              - CORPORATE_UPDATE
              - CORPORATE_RELATED_CREATE
              - CORPORATE_RELATED_DELETE
              - CORPORATE_RELATED_INFO
              - CORPORATE_RELATED_LIST
              - CORPORATE_RELATED_UPDATE
              - KYB_VERIFICATION_ASK
              - DOCUMENT_REQUEST_CREATE
              - DOCUMENT_CREATE
              - DOCUMENT_INFO
              - DOCUMENT_LIST
              - DILIGENCE_REVIEW_DOCUMENT_EXPORT
              - TRANSACTION_RECEIPT_DOCUMENT_EXPORT
              - END_USER_SUSPEND
              - END_USER_UNSUSPEND
              - END_USER_ADDRESSES_LIST
              - KYC_CREATE
              - KYC_LIST
              - KYC_INFO
              - LEDGER_CLOSE
              - LEDGER_CREATE
              - LEDGER_UPDATE
              - LEDGER_STATEMENT_DOCUMENT_EXPORT
              - LEDGER_SUSPEND
              - LEDGER_UNSUSPEND
              - LEDGER_INFO
              - LEDGER_LIST
              - LEDGER_UPGRADE
              - BIC_FROM_IBAN_GET
              - PARTNER_INFO
              - PARTNER_UPDATE
              - PARTNER_ACQUIRING_CONFIGURATION_INFO
              - PHONE_VERIFICATION_SEND
              - PHONE_VERIFICATION_VERIFY
              - SMS_SEND
              - EMAIL_VERIFICATION_CREATE
              - ADDRESS_VERIFY
              - SCA_DEVICE_CREATE
              - SCA_DEVICE_ACTIVATE
              - SCA_DEVICE_UPDATE
              - SCA_DEVICE_RESET
              - SHARE_INFO
              - SHARE_CREATE
              - SHARE_UPDATE
              - SHARE_DELETE
              - ACQUIRING_ACCOUNT_LOAD_CREATE
              - ACQUIRING_PAYMENT_CREATE
              - ACQUIRING_TRANSACTION_INFO
              - TRANSACTION_INFO
              - TRANSACTION_LIST
              - INTER_LEDGER_TRANSACTION_CREATE
              - DIRECT_DEBIT_TRANSACTION_CREATE
              - BENEFICIARY_TRANSACTION_CREATE
              - WEBHOOK_PORTAL
              - CRYPTO_WALLET_CREATE
              - CRYPTO_WALLET_LIST
              - CRYPTO_WALLET_INFO
              - CRYPTO_BENEFICIARY_CREATE
              - CRYPTO_BENEFICIARY_LIST
              - CRYPTO_BENEFICIARY_INFO
              - CRYPTO_BENEFICIARY_UPDATE
              - CRYPTO_TRANSACTION_CREATE
              - CRYPTO_TRANSACTION_LIST
              - CRYPTO_TRANSACTION_INFO
    PartnerUserAccountUpdateResponseDto:
      required:
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        updateDate:
          type: string
          format: date-time
    InternalTransactionStatusUpdateRequestDto:
      required:
        - status
      type: object
      properties:
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
    InternalTransactionStatusUpdateResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ComplianceScoringUpdateDto:
      type: object
      properties:
        receivingSendingFundsRisk:
          title: RiskLevels
          type: string
          description: >-
            The risk level depending on the countries that would send funds to
            or receive funds from the said account.
          enum:
            - LOW
            - HIGH
        jointAccount:
          type: boolean
          description: If this partner can open joint account for this end-user.
        fraudHistory:
          type: boolean
          description: Is there any record of fraud history.
        natureOfPaymentRisk:
          type: string
          description: >-
            The risk level depending on the persons/entities that would send
            funds to or receive funds from the said account.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        paymentStructureRisk:
          type: string
          description: >-
            The risk level depending on the typologies of payments the account
            will perform.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        cryptoRelated:
          type: boolean
    InternalPartnerUpdateRequestDto:
      type: object
      properties:
        displayName:
          type: string
        logoUrl:
          type: string
        fullKycVerificationFlow:
          type: string
        docOnlyVerificationFlow:
          type: string
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto'
        emailProperties:
          $ref: '#/components/schemas/InternalPartnerEmailPropertiesRequestDto'
        twilioVerificationSid:
          type: string
          description: Used in phone verification for end-user.
        twilioMessagingSid:
          type: string
          description: Used to send sms.
        complianceScoring:
          $ref: '#/components/schemas/ComplianceScoringUpdateDto'
        consumerOtpMessage:
          type: string
          description: >-
            Message that will be displayed when requesting a OTP message. You
            must include the following place holder: "$otp" where you want to
            display the OTP secret.


            If not set, the default message is: "Your {partnerName} secret to
            change your password is: {secret} If you are not at the origin of
            this message, you can ignore it."
        corporateOtpMessage:
          type: string
          description: >-
            Message that will be displayed when requesting a OTP message. You
            must include the following place holder: "$otp" where you want to
            display the OTP secret.


            If not set, the default message is: "Your {partnerName} secret to
            change your password is: {secret} If you are not at the origin of
            this message, you can ignore it."
        contactInformation:
          $ref: '#/components/schemas/ContactInformation'
        delegatedPhoneVerification:
          type: boolean
          description: If true, phone numbers will automatically be considered verified.
        delegatedPoa:
          type: boolean
          description: If true, address could be verified without Linkcy Verification.
        delegatedSca:
          type: boolean
          description: If true, SCA can be bypassed even for end-users.
        delegatedKyc:
          type: boolean
          description: If true, KYC can be provided by your system.
        showKycFiles:
          type: boolean
          description: >-
            If true, the partner may see KYC files in an end-user's document
            list..
        mvcOnFirstLedger:
          type: boolean
          description: >-
            If true, an associated MVC (for banking cards) will also be created
            the first time an end-user creates a ledger. By default is false.
        wultraAppId:
          type: string
          description: >-
            Wultra Mobile SDK AppId required for SCA registration and data
            signing
        limits:
          $ref: '#/components/schemas/PartnerLimitsRequestDto'
    InternalPartnerUpdateResponseDto:
      required:
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        updateDate:
          type: string
          format: date-time
    PartnerAcquiringConfigurationDto:
      title: Partner Acquiring Configuration
      type: object
      properties:
        saleMerchantId:
          type: string
        recurringSaleMerchantId:
          type: string
        loadMerchantId:
          type: string
        recurringLoadMerchantId:
          type: string
        saleLedgerId:
          type: string
          format: uuid
        loadLedgerId:
          type: string
          format: uuid
        loadRateFee:
          type: number
        customPageUrl:
          type: string
        loadFlatFee:
          type: number
        minLoad:
          type: number
        maxLoad:
          type: number
    PartnerAcquiringConfigurationUpdateResponseDto:
      required:
        - partnerId
      type: object
      properties:
        partnerId:
          type: string
          format: uuid
        updateDate:
          type: string
          format: date-time
    IdentityDocumentUpdate:
      type: object
      properties:
        lastName:
          type: string
        firstName:
          type: string
        middleName:
          type: string
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthDate:
          type: string
          format: date
        documentNumber:
          type: string
        countryOfIssue:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        issueDate:
          type: string
          format: date
        expiryDate:
          type: string
          format: date
        birthPlace:
          type: string
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
    InternalKycApplicationUpdateRequestDto:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/Kyc'
        link:
          type: string
        platformId:
          type: string
        identityDocument:
          $ref: '#/components/schemas/IdentityDocumentUpdate'
        onboardingCity:
          type: string
        onboardingCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
    Kyc:
      title: Kyc
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        reason:
          type: string
        internalReason:
          type: string
    InternalKycApplicationUpdateResponseDto:
      required:
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        updateDate:
          type: string
          format: date-time
    InternalDocumentUpdateRequestDto:
      title: DocumentUpdateRequest
      type: object
      properties:
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        type:
          title: DocumentType
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        uploadedToCbs:
          type: boolean
          description: >-
            Indicates if the document has been uploaded to the CBS (If updated
            to true, it will be automatically uploaded to the CBS).
        status:
          type: string
          enum:
            - UPLOADED
            - REQUESTED
            - DECLINED
            - VALIDATED
        note:
          type: string
    InternalDocumentUpdateResponseDto:
      title: DocumentUpdateResponse
      required:
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        updateDate:
          type: string
          format: date-time
    AustriaLegalType_Internal:
      required:
        - austriaValue
      type: object
      properties:
        austriaValue:
          type: string
          enum:
            - AT_AKTIENGESELLSCHAFT_AG
            - AT_EINGETRAGENES_EINZELUNTERNEHMEN_EU
            - AT_EUROPEAN_BUSINESS_ENTITIES
            - AT_GENOSSENSCHAFT_GEN
            - AT_GESELLSCHAFT_DES_BURGERLICHEN_RECHTS_GESBR
            - AT_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - AT_KOMMANDITERWERBSGESELLSCHAFT_KEG
            - AT_KOMMANDITGESELLSCHAFT_KG
            - AT_OFFENE_ERWERBSGESELLSCHAFT_OEG
            - AT_OFFENE_GESELLSCHAFT_OG
            - AT_PRIVATSTIFTUNG
            - AT_STILLE_GESELLSCHAFT_STG
            - AT_VEREIN
    BelgiumLegalType_Internal:
      required:
        - belgiumValue
      type: object
      properties:
        belgiumValue:
          type: string
          enum:
            - BE_ASSOCIATION_SANS_BUT_LUCRATIF_ASBL
            - BE_BESLOTEN_VENNOOTSCHAP_BV
            - BE_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_BVBA
            - BE_COMMANDITAIRE_VENNOOTSCHAP_OP_AANDELEN_COMMVA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_CVBA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_ONBEPERKTE_AANSPRAKELIJKHEID_CVOA
            - BE_ECONOMISCH_SAMENWERKINGSVERBAND_ESV
            - BE_EENMANSZAAK
            - >-
              BE_EENPERSOONS_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_EBVBA
            - BE_ENTREPRISE_INDIVIDUELLE
            - BE_FEITELIJKE_VERENIGING
            - BE_FONDATION_DUTILITE_PUBLIQUE
            - BE_FONDATION_PRIVEE
            - BE_GEWONE_COMMANDITAIRE_VENNOOTSCHAP_COMMV
            - BE_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - BE_NAAMLOZE_VENNOOTSCHAP_NV
            - BE_PRIVATE_STICHTING
            - BE_SOCIETE_ANONYME_SA
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_ILLIMITEE_SCRI
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_LIMITEE_SCRL
            - BE_SOCIETE_DE_FAIT
            - BE_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - BE_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - BE_SOCIETE_EN_NOM_COLLECTIF_SN
            - BE_SOCIETE_EN_PARTICIPATION_SEP
            - BE_SOCIETE_INTERNE
            - BE_SOCIETE_MOMENTANEE
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_SPRL
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_UNIPERSONNELLE_SPRLU
            - BE_STICHTING_VAN_OPENBAAR_NUT
            - BE_STILLE_HANDELSVENNOOTSCHAP
            - BE_TIJDELIJKE_HANDELSVENNOOTSCHAP
            - BE_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - BE_VEREINIGUNG_OHNE_GEWINNERZIELUNGSABSICHT_VOG
            - BE_VERENIGING_IN_DEELNEMING
            - BE_VERENIGING_ZONDER_WINSTOOGMERK_VZW
    BulgariaLegalType_Internal:
      required:
        - bulgariaValue
      type: object
      properties:
        bulgariaValue:
          type: string
          enum:
            - BG_AKTSIONERNO_DRUJESTVO_AD
            - >-
              BG_AKTSIONERNO_DRUZHESTVO_SUS_SPETSIALNA_INVESTITSIONNA_TSEL_ADSITZ
            - BG_DRUJESTVO_S_OGRANICHENA_OTGOVORNOST_OOD
            - BG_EDNOLICHEN_TURGOVETZ_ET
            - BG_EDNOLICHNO_AKTSIONERNO_DRUZHESTVO_EAD
            - BG_EDNOLICHNO_DRUZHESTVO_S_OGRANICHENA_OTGOVORNOST_EOOD
            - BG_KOMANDITNO_DRUZHESTVO_KD
            - BG_KOMANDITNO_DRUZHESTVO_S_AKTZII_KDA
            - BG_SUBIRATELNO_DRUZHESTVO_SD
    ComplianceScoringUpdateDto_Internal:
      type: object
      properties:
        receivingSendingFundsRisk:
          title: RiskLevels
          type: string
          description: >-
            The risk level depending on the countries that would send funds to
            or receive funds from the said account.
          enum:
            - LOW
            - HIGH
        jointAccount:
          type: boolean
          description: If this partner can open joint account for this end-user.
        fraudHistory:
          type: boolean
          description: Is there any record of fraud history.
        natureOfPaymentRisk:
          type: string
          description: >-
            The risk level depending on the persons/entities that would send
            funds to or receive funds from the said account.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        paymentStructureRisk:
          type: string
          description: >-
            The risk level depending on the typologies of payments the account
            will perform.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        cryptoRelated:
          type: boolean
    CorporateApiLegalType_Internal:
      type: object
      anyOf:
        - $ref: '#/components/schemas/AustriaLegalType_Internal'
        - $ref: '#/components/schemas/BelgiumLegalType_Internal'
        - $ref: '#/components/schemas/BulgariaLegalType_Internal'
        - $ref: '#/components/schemas/SwitzerlandLegalType_Internal'
        - $ref: '#/components/schemas/CyprusLegalType_Internal'
        - $ref: '#/components/schemas/CzechiaLegalType_Internal'
        - $ref: '#/components/schemas/GermanyLegalType_Internal'
        - $ref: '#/components/schemas/DenmarkLegalType_Internal'
        - $ref: '#/components/schemas/EstoniaLegalType_Internal'
        - $ref: '#/components/schemas/SpainLegalType_Internal'
        - $ref: '#/components/schemas/FinlandLegalType_Internal'
        - $ref: '#/components/schemas/FranceLegalType_Internal'
        - $ref: '#/components/schemas/MonacoLegalType_Internal'
        - $ref: '#/components/schemas/UnitedKingdomLegalType_Internal'
        - $ref: '#/components/schemas/GreeceLegalType_Internal'
        - $ref: '#/components/schemas/CroatiaLegalType_Internal'
        - $ref: '#/components/schemas/HungaryLegalType_Internal'
        - $ref: '#/components/schemas/IrelandLegalType_Internal'
        - $ref: '#/components/schemas/IcelandLegalType_Internal'
        - $ref: '#/components/schemas/ItalyLegalType_Internal'
        - $ref: '#/components/schemas/LiechtensteinLegalType_Internal'
        - $ref: '#/components/schemas/LithuaniaLegalType_Internal'
        - $ref: '#/components/schemas/LuxembourgLegalType_Internal'
        - $ref: '#/components/schemas/LatviaLegalType_Internal'
        - $ref: '#/components/schemas/MaltaLegalType_Internal'
        - $ref: '#/components/schemas/NetherlandsLegalType_Internal'
        - $ref: '#/components/schemas/NorwayLegalType_Internal'
        - $ref: '#/components/schemas/PolandLegalType_Internal'
        - $ref: '#/components/schemas/PortugalLegalType_Internal'
        - $ref: '#/components/schemas/RomaniaLegalType_Internal'
        - $ref: '#/components/schemas/SwedenLegalType_Internal'
        - $ref: '#/components/schemas/SloveniaLegalType_Internal'
        - $ref: '#/components/schemas/SlovakiaLegalType_Internal'
    CorporateFinancialInformationRequestDto_Internal:
      title: FinancialInformation
      required:
        - currency
        - expectedMonthlyIncomingTransferFrequency
        - expectedMonthlyIncomingVolume
        - expectedMonthlyOutgoingVolume
        - monthlyNetIncome
      type: object
      properties:
        currency:
          type: string
          description: The currency used for the expected monthly expenses.
          enum:
            - EUR
            - USD
            - GBP
        monthlyNetIncome:
          type: string
          description: The net financial revenue expected every month
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingVolume:
          type: string
          description: >-
            The amount of money you expect to receive with this account every
            month.
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyOutgoingVolume:
          type: string
          description: >-
            The amount of money you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          description: >-
            The frequency at which you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    CorporateUpdateRequestDto_Internal:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate to a
            user in your system.
        registeredName:
          maxLength: 255
          minLength: 0
          type: string
          description: The official corporate name. Must only contains Latin-1 characters.
        tradeName:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The name used for business if there is one. Must only contains
            Latin-1 characters.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        incorporationDate:
          type: string
          description: The date the corporate was officially registered.
          format: date
        legalType:
          $ref: '#/components/schemas/CorporateApiLegalType_Internal'
        website:
          maxLength: 511
          minLength: 0
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        vatNumber:
          type: string
          description: The corporate VAT number.
        registeredAddress:
          $ref: '#/components/schemas/EuropeanAddressRequestDto_Internal'
        businessAddress:
          $ref: '#/components/schemas/EuropeanAddressRequestDto_Internal'
        financialInformationRequestDto:
          $ref: >-
            #/components/schemas/CorporateFinancialInformationRequestDto_Internal
        employeesRange:
          type: string
          description: The number of employees working for the corporate.
          enum:
            - BTW_1_AND_10
            - BTW_11_AND_50
            - MORE_THAN_50
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        lastTermsAccepted:
          type: string
          description: >-
            The version of the terms and conditions signed by the corporate
            account owner.
          example: '1.0'
        isExtendedUbos:
          type: boolean
          description: >-
            When this option is activated, related persons become UBO from 10%
            of the shares instead of 25%.
        externalNotes:
          type: string
          description: Public additional information concerning this entity.
        internalNotes:
          type: string
          description: Private additional information concerning this entity.
        userMetadata:
          title: User metadata
          type: object
          additionalProperties:
            title: User metadata
            type: object
            description: |-
              A custom field to save data.

              This field's size is limited to 3000 characters.
          description: |-
            A custom field to save data.

            This field's size is limited to 3000 characters.
        partnerMetadata:
          title: Partner metadata
          type: object
          additionalProperties:
            title: Partner metadata
            type: object
            description: >-
              A custom field to save data that cannot be modified by the
              end-user.


              This field's size is limited to 3000 characters.


              Note: if you are authenticated as end-user, trying to update this
              field will result in a Forbidden Error.
          description: >-
            A custom field to save data that cannot be modified by the end-user.


            This field's size is limited to 3000 characters.


            Note: if you are authenticated as end-user, trying to update this
            field will result in a Forbidden Error.
        complianceScoring:
          $ref: '#/components/schemas/ComplianceScoringUpdateDto_Internal'
        kybStatus:
          $ref: '#/components/schemas/KybRequest_Internal'
        linkcyStatus:
          $ref: '#/components/schemas/EndUserLinkcy_Internal'
        complianceStatus:
          $ref: '#/components/schemas/EndUserCompliance_Internal'
      description: The information to update a corporate.
    CroatiaLegalType_Internal:
      required:
        - croatiaValue
      type: object
      properties:
        croatiaValue:
          type: string
          enum:
            - HR_DIONICKO_DRUSTVO_DD
            - HR_DOMACA_RADINOST_AND_SPOREDNO_ZANIMANJE
            - HR_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_DOO
            - HR_GOSPODARSKO_INTERESNO_UDRUZENJE_GIU
            - HR_JAVNO_TRGOVACKO_DRUSTVO_JTD
            - HR_JEDNOSTAVNO_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_JDOO
            - HR_KOMANDITNO_DRUSTVO_KD
            - HR_OBITELJSKO_POLJOPRIVREDNO_GOSPODARSTVO_OPG
            - HR_OBRT
            - HR_ORTAKLUK
            - HR_SLOBODNA_DJELATNOST
            - HR_ZADRUGA
    CyprusLegalType_Internal:
      required:
        - cyprusValue
      type: object
      properties:
        cyprusValue:
          type: string
          enum:
            - CY_PRIVATE_LIMITED_COMPANY_LTD
            - CY_PUBLIC_LIMITED_COMPANY_PLC
            - CY_COMPANY_LIMITED_BY_GUARANTEE
            - CY_GENERAL_PARTNERSHIP
            - CY_LIMITED_PARTNERSHIP
            - CY_SOLO_PROPRIETORSHIP
    CzechiaLegalType_Internal:
      required:
        - czechiaValue
      type: object
      properties:
        czechiaValue:
          type: string
          enum:
            - CZ_AKCIOVA_SPOLECNOST_AS
            - CZ_KOMANDITNI_SPOLECNOST_KS
            - CZ_OBECNE_PROSPESNA_SPOLECNOST_OPS
            - CZ_PRISPEVKOVA_ORGANIZACE
            - CZ_SPOLECNOST_S_RUCENIM_OMEZENYM_SRO
            - CZ_STATNI_PODNIK_SP
            - CZ_VEREJNA_OBCHODNI_SPOLECNOST_VOS
            - CZ_ZAPSANY_SPOLEK_ZS
            - CZ_ZIVNOST
    DenmarkLegalType_Internal:
      required:
        - denmarkValue
      type: object
      properties:
        denmarkValue:
          type: string
          enum:
            - DK_AKTIESELSKAB_A_S
            - DK_ANDELSSELSKAB_MED_BEGRAENSET_ANSVAR_AMBA
            - DK_ANPARTSSELSKAB_APS
            - DK_ENKELTMANDSVIRKSOMHED
            - DK_ERHVERVSDRIVENDE_FOND
            - DK_FORENING
            - DK_FORENING_MED_BEGRAENSET_ANSVAR_FMBA
            - DK_GENSIDIGT_SELSKAB_G_S
            - DK_INTERESSENTSKAB_I_S
            - DK_IVAERKSAETTERSELSKAB_IVS
            - DK_KOMMANDITSELSKAB_K_S
            - DK_PARTNERSELSKAB_OR_KOMMANDITAKTIESELSKAB_P_S
            - DK_PARTSREDERI
            - DK_SELSKAB_MED_BEGRAENSET_ANSVAR_SMBA
    EndUserCompliance_Internal:
      title: Compliance
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - PENDING
            - DECLINED
            - PENDING_REVIEW
            - VALIDATED
        reason:
          type: string
        internalReason:
          type: string
    EndUserLinkcy_Internal:
      title: Linkcy
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - PENDING
            - FORBIDDEN
            - MISSING_DATA
            - VALIDATED
            - LIMITED
            - CLOSING
            - CLOSED
        reason:
          type: string
    EstoniaLegalType_Internal:
      required:
        - estoniaValue
      type: object
      properties:
        estoniaValue:
          type: string
          enum:
            - EE_AKTSIASELTS_AS
            - EE_FUUSILISEST_ISIKUST_ETTEVOTJA_FIE
            - EE_MITTETULUNDUSUHING_MTU
            - EE_OSAUHING_OU
            - EE_TAISUHING_TU
            - EE_TULUNDUSUHISTU
            - EE_USALDUSUHING_UU
    EuropeanAddressRequestDto_Internal:
      title: EuropeanAddressRequest
      required:
        - city
        - isoCountryCode
        - postalCode
        - street
      type: object
      properties:
        isoCountryCode:
          title: European Country Code
          type: string
          enum:
            - AUT
            - AND
            - BEL
            - BGR
            - CHE
            - CYP
            - CZE
            - DEU
            - DNK
            - ESP
            - EST
            - FIN
            - FRA
            - GBR
            - GRC
            - HRV
            - HUN
            - IRL
            - ISL
            - ITA
            - LIE
            - LTU
            - LUX
            - LVA
            - MLT
            - MCO
            - NLD
            - NOR
            - POL
            - PRT
            - ROU
            - SVN
            - SVK
            - SWE
        city:
          maxLength: 255
          minLength: 0
          type: string
        postalCode:
          maxLength: 10
          minLength: 0
          type: string
        street:
          maxLength: 511
          minLength: 0
          type: string
        number:
          maxLength: 255
          minLength: 0
          type: string
        refinement:
          maxLength: 35
          minLength: 0
          type: string
        stateOrProvince:
          maxLength: 255
          minLength: 0
          type: string
        bypassVerification:
          type: boolean
          description: >-
            If true, the address will be saved as described in the request
            without any auto-verification and the status will be INVALID until a
            POA is provided.


            By default is false.
    FinlandLegalType_Internal:
      required:
        - finlandValue
      type: object
      properties:
        finlandValue:
          type: string
          enum:
            - FI_ASUNTO_OSAKEYHTIO
            - FI_AVOIN_YHTIO_AY
            - FI_EUROOPPALAINEN_TALOUDELLINEN_ETUYHTYMA_EEIG
            - FI_EUROOPPAOSUUSKUNTA_SCE
            - FI_EUROOPPAYHTIO_SE
            - FI_JULKINEN_KESKINAINEN_VAKUUTUSYHTIO_JY
            - FI_JULKINEN_OSAKEYHTIO_OYJ
            - FI_KESKINAINEN_KIINTEISTOOSAKEYHTIO
            - FI_KESKINAINEN_VAKUUTUSYHTIO
            - FI_KESKIVEDENKORKEUDEN_MUUTTAMISTA_VARTEN_PERUSTETTU_YHTEISO
            - FI_KOMMANDIITTIYHTIO_KY
            - FI_KUNNALLINEN_LIIKELAITOS
            - FI_LAIVAISANNISTOYHTIO
            - FI_OJITUSYHTEISO
            - FI_OSAKASKUNTA
            - FI_OSAKEYHTIO_OY
            - FI_OSUUSKUNTA_OSK
            - FI_PALISKUNTA
            - FI_REKISTEROITY_PUOLUE_RP
            - FI_REKISTEROITY_YHDISTYS_RY
            - FI_SAANNOSTELY_YHTEISO
            - FI_SAASTOPANKKI
            - FI_SAATIO_RS
            - FI_TIEKUNTA
            - FI_TOIMINIMI_TMI
            - FI_UITTOYHTEISO
            - FI_USKONNOLLINEN_YHDYSKUNTA
            - FI_VALTION_LIIKELAITOS
            - FI_VESIOIKEUDELLINEN_YHTEISO_BODIES_OF_WATER
            - FI_VOLUNTARY_ASSOCIATIONS_CHARTERED_BY_STATUTE_LAW
            - FI_YHTEISALUE
            - FI_YHTEISMETSA
    FranceLegalType_Internal:
      required:
        - franceValue
      type: object
      properties:
        franceValue:
          type: string
          enum:
            - FR_ASSOCIATION_DECLAREE
            - FR_ASSOCIATION_NON_DECLAREE
            - FR_AUTO_ENTREPRENEUR
            - FR_ENTREPRISE_INDIVIDUELLE_ENTREPRISE_EN_NOM_PERSONNEL_EI
            - FR_ENTREPRISE_UNIPERSONNELLE_A_RESPONSABILITE_LIMITEE_EURL
            - FR_FOND_COMMUN_DE_PLACEMENT_FCP
            - FR_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - FR_PROFESSION_LIBERAL
            - FR_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - FR_SOCIETE_ANONYME_SA
            - FR_SOCIETES_DEXERCICE_LIBERAL
            - FR_SOCIETE_COOPERATIVE_DE_PRODUCTION_SCOP
            - FR_SOCIETE_DECONOMIE_MIXTE_SEM
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - FR_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - FR_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - FR_SOCIETE_EN_NOM_COLLECTIF_SNC
            - FR_SOCIETE_EN_PARTICIPATION_SEP
            - FR_SOCIETE_PAR_ACTIONS_SIMPLIFIEE_SAS
            - FR_SOCIETE_CIVILE_IMMOBILIERE_SCI
            - FR_U_UNIPERSONNELLE_SAS_SASU
    GermanyLegalType_Internal:
      required:
        - germanyValue
      type: object
      properties:
        germanyValue:
          type: string
          enum:
            - DE_AKTIENGESELLSCHAFT_AG
            - DE_ALTRECHTLICHER_VEREIN_RECHTSFAHIGER_VEREIN_RV
            - DE_ANSTALT_DES_OFFENTLICHEN_RECHTS
            - DE_EINGETRAGENER_KAUFMANN_EINGETRAGENE_KAUFFRAU_EK_EKFM_EKFR
            - DE_EINGETRAGENER_VEREIN_EV
            - DE_EINGETRAGENE_GENOSSENSCHAFT_EG
            - DE_EINZELUNTERNEHMEN
            - DE_GESELLSCHAFT_BURGERLICHEN_RECHTS_BGB_GESELLSCHAFT_GBR
            - DE_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - DE_KOMMANDITGESELLSCHAFT_AUF_AKTIEN_KGAA
            - DE_KOMMANDITGESELLSCHAFT_KG
            - DE_NICHT_EINGETRAGENER_VEREI
            - DE_OFFENE_HANDELSGESELLSCHAFT_OHG
            - DE_PARTENREEDEREI
            - >-
              DE_PARTNERSCHAFTSGESELLSCHAFT_MIT_BESCHRANKTER_BERUFSHAFTUNG_PARTGMBBH
            - DE_PARTNERSCHAFTSGESELLSCHAFT_PARTG
            - DE_STIFTUNG
            - DE_STIFTUNG_DES_OFFENTLICHEN_RECHTS
            - DE_UNTERNEHMERGESELLSCHAFT_UG
            - DE_WIRTSCHAFTLICHER_VEREIN
    GreeceLegalType_Internal:
      required:
        - greeceValue
      type: object
      properties:
        greeceValue:
          type: string
          enum:
            - GR_ANONIMI_ETERIA_AE
            - GR_ANONIMI_VIOMIHANIKI_EMBORIKI_ETERIA_AVEE
            - GR_ETERIA_PERIORISMENIS_EUTHINIS_EPE
            - GR_ETERORITHMI_ETERIA_EE
            - GR_IDIOTIKI_KEFALEOUHIKI_ETERIA_IKE
            - GR_MONOPROSOPI_ETERIA_PERIORISMENIS_EUTHINIS_MEPE
            - GR_OMORITHMI_ETERIA_OE
            - GR_OMORITHMI_VIOMIHANIKI_EMBORIKI_ETERIA_OVEE
    HungaryLegalType_Internal:
      required:
        - hungaryValue
      type: object
      properties:
        hungaryValue:
          type: string
          enum:
            - HU_BETETI_TARSASAG_BT
            - HU_EGYENI_CEG_EC
            - HU_EGYENI_VALLALKOZO_EV
            - HU_EGYESULES
            - HU_KORLATOLT_FELELOSSEGU_TARSASAG_KFT
            - HU_KOZHASZNU_TARSASAG_KHT
            - HU_KOZKERESETI_TARSASAG_KKT
            - HU_KOZOS_VALLALAT_KV
            - HU_NYILVANOSAN_MUKODO_RESZVENYTARSASAG_NYRT
            - HU_RESZVENYTARSASAG_RT
            - HU_SZOVETKEZET_SZOV
            - HU_ZARTKOZUEN_MUKODO_RESZVENYTARSASAG_ZRT
    IcelandLegalType_Internal:
      required:
        - icelandValue
      type: object
      properties:
        icelandValue:
          type: string
          enum:
            - IS_EINKAHLUTAFELAG_EHF
            - IS_EINSTAKLINGSFYRIRTAEKI
            - IS_HLUTAFELAG_HF
            - IS_OPINBERT_HLUTAFELAG_OHF
            - IS_SAMEIGNARFELAG_SF
            - IS_SAMLAGSFELAG
            - IS_SAMVINNUFELAG
            - IS_SJALFSEIGNARSTOFNUN
    IrelandLegalType_Internal:
      required:
        - irelandValue
      type: object
      properties:
        irelandValue:
          type: string
          enum:
            - IE_A_PUBLIC_LIMITED_COMPANY
            - IE_COMPANY_LIMITED_BY_GUARANTEE_HAVING_A_SHARE_CAPITAL
            - IE_COMPANY_LIMITED_BY_GUARANTEE_NOT_HAVING_A_SHARE_CAPITAL
            - IE_PRIVATE_COMPANY_LIMITED_BY_SHARES
            - IE_SINGLE_MEMBER_COMPANY
            - >-
              IE_UNDERTAKINGS_FOR_COLLECTIVE_INVESTMENT_IN_TRANSFERABLE_SECURITIES_UCITS
            - IE_UNLIMITED_COMPANY
    ItalyLegalType_Internal:
      required:
        - italyValue
      type: object
      properties:
        italyValue:
          type: string
          enum:
            - IT_ARTIGIANO
            - IT_IMPRENDITORE
            - IT_LAVORATORE_AUTONOMO
            - IT_LIBERO_PROFESSIONISTA
            - IT_SOCIETA_A_RESPONSABILITA_LIMITATA_SRL
            - IT_SOCIETA_COOPERATIVA_A_RESPONSABILITA_LIMITATA_SCRL
            - IT_SOCIETA_IN_ACCOMANDITA_PER_AZIONI_SAPA
            - IT_SOCIETA_IN_ACCOMANDITA_SEMPLICE_SAS
            - IT_SOCIETA_IN_NOME_COLLETTIVO_SNC
            - IT_SOCIETA_PER_AZIONI_SPA
            - IT_SOCIETA_SEMPLICE_SS
    KybRequest_Internal:
      title: Kyb
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - COMPLETING
            - PENDING_VERIFICATION
            - NEED_ADDITIONAL_INFORMATION
            - DECLINED
            - VALIDATED
        reason:
          type: string
        internalReason:
          type: string
    LatviaLegalType_Internal:
      required:
        - latviaValue
      type: object
      properties:
        latviaValue:
          type: string
          enum:
            - LV_AKCIJU_SABIEDRIBA_AS
            - LV_ARZEMJU_KOMERSANTA_FILIALE_AKF
            - LV_BEZPELNAS_ORGANIZACIJA_BO
            - LV_INDIVIDUALAIS_KOMERSANTS_IK
            - LV_KOMANDITSABIEDRIBA_KS
            - LV_PILNSABIEDRIBA_PS
            - LV_SABIEDRIBA_AR_IEROBEZOTU_ATBILDIBU_SIA
    LiechtensteinLegalType_Internal:
      required:
        - liechtensteinValue
      type: object
      properties:
        liechtensteinValue:
          type: string
          enum:
            - LI_AKTIENGESELLSCHAFT_AG
            - LI_ANSTALT
            - LI_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - LI_STIFTUNG
            - LI_TREUHANDSC_TREUUNTERNEHMEN_HAFT
    LithuaniaLegalType_Internal:
      required:
        - lithuaniaValue
      type: object
      properties:
        lithuaniaValue:
          type: string
          enum:
            - LT_AKCINE_BENDROVE_AB
            - LT_INDIVIDUALI_IMONE_II
            - LT_INDIVIDUALI_VEIKLA
            - LT_KOMANDITINE_UKINE_BENDRIJA_KUB
            - LT_MAZOJI_BENDRIJA_MB
            - LT_TIKROJI_UKINE_BENDRIJA_TUB
            - LT_UZDAROJI_AKCINE_BENDROVE_UAB
            - LT_VIESOJI_ISTAIGA_VSI
    LuxembourgLegalType_Internal:
      required:
        - luxembourgValue
      type: object
      properties:
        luxembourgValue:
          type: string
          enum:
            - LU_SOCIETE_ANONYME_SA
            - LU_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - LU_SOCIETE_EN_COMMANDITE_SIMPLE_SECS
    MaltaLegalType_Internal:
      required:
        - maltaValue
      type: object
      properties:
        maltaValue:
          type: string
          enum:
            - MT_PRIVATE_LIMITED_COMPANY
            - MT_PUBLIC_LIABILITY_COMPANY
            - MT_PARTNERSHIP_EN_NOM_COLLECTIF
            - MT_PARTNERSHIP_EN_COMMANDITE
            - MT_LIMITED_LIABILITY_COMPANY_LLC
            - MT_BRANCHES_OF_OVERSEA_COMPANIES
            - MT_GENERAL_PARTNERSHIPS
            - MT_LIMITED_PARTNERSHIPS
    MonacoLegalType_Internal:
      required:
        - monacoValue
      type: object
      properties:
        monacoValue:
          type: string
          enum:
            - MC_ASSOCIATION
            - MC_FONDATION
            - MC_SOCIETE_ANONYME_MONEGASQUE_SAM
            - MC_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - MC_SOCIETE_EN_NOM_COLLECTIF_SNC
            - MC_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - MC_ENTREPRISE_INDIVIDUELLE_EI
            - MC_SUCCURSALE
            - MC_SOCIETE_CIVILE_IMMOBILIERE_SCI
    NetherlandsLegalType_Internal:
      required:
        - netherlandsValue
      type: object
      properties:
        netherlandsValue:
          type: string
          enum:
            - NL_BEPERKTE_AANSPRAKELIJKHEID_BA
            - NL_BESLOTEN_VENNOOTSCHAP_BV
            - NL_COMMANDITAIRE_VENNOOTSCHAP_CV
            - NL_COOPERATIE
            - NL_EENMANSZAAK
            - NL_MAATSCHAP_MTS
            - NL_NAAMLOZE_VENNOOTSCHAP_NV
            - NL_ONDERLINGE_WAARBORGMAATSCHAPPIJ
            - NL_STICHTING
            - NL_UITSLUITING_VAN_AANSPRAKELIJKHEID_UA
            - NL_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - NL_WETTELIJKE_AANSPRAKELIJKHEID_WA
    NorwayLegalType_Internal:
      required:
        - norwayValue
      type: object
      properties:
        norwayValue:
          type: string
          enum:
            - NO_AKSJESELSKAP_AS
            - NO_ALLMENNAKSJESELSKAP_ASA
            - NO_ANSVARLIG_SELSKAP_ANS
            - NO_BORETTSLAG_BL
            - NO_ENKELTPERSONFORETAK
            - NO_FYLKESKOMMUNALT_FORETAK_FKF
            - NO_HELSEFORETAK_HF
            - NO_INTERKOMMUNALT_SELSKAP_IKS
            - NO_KOMMANDITTSELSKAP_KS
            - NO_KOMMUNALT_FORETAK_KF
            - NO_NORSKREGISTRERT_UTENLANDSK_FORETAK_NUF
            - NO_REGIONALT_HELSEFORETAK_RHF
            - NO_SELSKAP_MED_BEGRENSET_ANSVAR_BA
            - NO_SELSKAP_MED_DELT_ANSVAR_DA
            - NO_SPAREBANK_SAVINGS_BANK
            - NO_STATE_COUNTY_OR_MUNICIPAL_AGENCY_ETAT
            - NO_STATSFORETAK_SF
            - NO_STIFTELSE
    PolandLegalType_Internal:
      required:
        - polandValue
      type: object
      properties:
        polandValue:
          type: string
          enum:
            - PL_JEDNOOSOBOWA_DZIALALNOSC_GOSPODARCZA
            - PL_PRZEDSIEBIORSTWO_PANSTWOWE
            - PL_SPOLDZIELNIA
            - PL_SPOLKA_AKCYJNA_SA
            - PL_SPOLKA_CYWILNA_SC
            - PL_SPOLKA_JAWNA_SPJ
            - PL_SPOLKA_KOMANDYTOWA_SPK
            - PL_SPOLKA_KOMANDYTOWO_AKCYJNA_SKA
            - PL_SPOLKA_PARTNERSKA_SPP
            - PL_SPOLKA_Z_OGRANICZONA_ODPOWIEDZIALNOSCIA_SP_Z_OO
    PortugalLegalType_Internal:
      required:
        - portugaValue
      type: object
      properties:
        portugaValue:
          type: string
          enum:
            - PT_COOPERATIVA_DE_RESPONSABILIDADE_LIMITADA_CRL
            - PT_LIMITADA_LDA
            - PT_SOCIEDADE_ABERTA_SA
            - PT_SOCIEDADE_FECHADA_SF
            - PT_SOCIEDADE_GESTORA_DE_PARTICIPACOES_SOCIAIS_SGPS
    RomaniaLegalType_Internal:
      required:
        - romaniaValue
      type: object
      properties:
        romaniaValue:
          type: string
          enum:
            - RO_ORGANIZATIE_NON_GUVERNAMENTALA_ONG
            - RO_PERSOANA_FIZICA_AUTORIZATA_PFA
            - >-
              RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_CU_PROPRIETAR_UNIC_SRL_CU_PROPRIETAR_UNIC
            - RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATEA_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATEA_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATEA_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATEA_PE_ACTIUNI_SA
            - RO_SOCIETATE_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATE_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATE_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATE_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATE_PE_ACTIUNI_SA
    SlovakiaLegalType_Internal:
      required:
        - slovakiaValue
      type: object
      properties:
        slovakiaValue:
          type: string
          enum:
            - SK_AKCIOVA_SPOLOCNOST_AS
            - SK_DRUZSTVO
            - SK_KOMANDITNA_SPOLOCNOST_KS
            - SK_SPOLOCNOST_S_RUCENIM_OBMEDZENYM_SRO
            - SK_VEREJNA_OBCHODNA_SPOLOCNOST_VOS
            - SK_ZIVNOST
    SloveniaLegalType_Internal:
      required:
        - sloveniaValue
      type: object
      properties:
        sloveniaValue:
          type: string
          enum:
            - SI_DELNISKA_DRUZBA_DD
            - SI_DRUZBA_Z_NEOMEJENO_ODGOVORNOSTJO_DNO
            - SI_DRUZBA_Z_OMEJENO_ODGOVORNOSTJO_DOO
            - SI_KOMANDITNA_DRUZBA_KD
            - SI_SAMOSTOJNI_PODJETNIK_SP
    SpainLegalType_Internal:
      required:
        - spainValue
      type: object
      properties:
        spainValue:
          type: string
          enum:
            - ES_SOCIEDAD_ANONIMA_DEPORTIVA_SAD
            - ES_SOCIEDAD_ANONIMA_SA
            - ES_SOCIEDAD_CIVIL_PRIVADA_SCP
            - ES_SOCIEDAD_COLECTIVA_SC
            - ES_SOCIEDAD_COMANDITARIA_SCRA
            - ES_SOCIEDAD_COOPERATIVA_SCOOP
            - ES_SOCIEDAD_LIMITADA_LABORAL_SLL
            - ES_SOCIEDAD_LIMITADA_NUEVA_EMPRESA_SLNE
            - ES_SOCIEDAD_LIMITADA_SL
    SwedenLegalType_Internal:
      required:
        - swedenValue
      type: object
      properties:
        swedenValue:
          type: string
          enum:
            - SE_AKTIEBOLAG_AB
            - SE_BOSTADSRATTSFORENING
            - SE_EKONOMISK_FORENING_EK_FOR
            - SE_ENKELT_BOLAG
            - SE_ENSKILD_FIRMA
            - SE_HANDELSBOLAG_HB
            - SE_HYRESRATTSFORENING
            - SE_IDEELL_FORENING
            - SE_KOMMANDITBOLAG_KB
            - SE_KOOPERATIV
            - SE_PUBLIKT_AKTIEBOLAG_AB_PUBL
            - SE_STIFTELSE
    SwitzerlandLegalType_Internal:
      required:
        - switzerlandValue
      type: object
      properties:
        switzerlandValue:
          type: string
          enum:
            - CH_AKTIENGESELLSCHAFT_AG
            - CH_ASSOCIATION
            - CH_ASSOCIAZIONE
            - CH_DITTA_INDIVIDUALE
            - CH_EINFACHE_GESELLSCHAFT_EG
            - CH_EINZELUNTERNEHMEN
            - CH_ENTREPRISE_INDIVIDUELLE
            - CH_FONDATION
            - CH_FONDAZIONE
            - CH_GENOSSENSCHAFT
            - CH_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - CH_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - CH_GRUPPO_DI_INTERESSE_ECONOMICO
            - CH_INVESTMENTGESELLSCHAFT_MIT_FESTEM_KAPITAL
            - CH_INVESTMENTGESELLSCHAFT_MIT_VARIABLEM_KAPITALS
            - CH_INVESTMENT_FUND
            - CH_KOLLEKTIVGESELLSCHAFT_KOLG
            - CH_KOMMANDITAKTIENGESELLSCHAFT_KOMAG
            - CH_KOMMANDITGESELLSCHAFT_KG
            - CH_RAISON_INDIVIDUELLE_RI
            - CH_SOCIETA_ANONIMA_SA
            - CH_SOCIETA_A_GARANZIA_LIMITATA_SAGL
            - CH_SOCIETA_COOPERATIVA
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_FISSO_SICAF
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_VARIABILE_SICAV
            - CH_SOCIETA_IN_ACCOMANDITA
            - CH_SOCIETA_IN_ACCOMANDITA_PER_AZIONI
            - CH_SOCIETA_IN_NOME_COLLETTIVO
            - CH_SOCIETA_SEMPLICE
            - CH_SOCIETE_ANONYME_SA
            - CH_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - CH_SOCIETE_COOPERATIVE
            - CH_SOCIETE_COOPERATIVE_SCOOP
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE_SICAF
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - CH_SOCIETE_EN_COMMANDITE
            - CH_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - CH_SOCIETE_EN_COMMANDITE_SC
            - CH_SOCIETE_EN_NOM_COLLECTIF
            - CH_SOCIETE_EN_NOM_COLLECTIF_SNC
            - CH_SOCIETE_SIMPLE
            - CH_STIFTUNG
            - CH_SUCCURSALE
            - CH_VEREIN
            - CH_WIRTSCHAFTLICHE_INTERESSENGEMEINSCHAFT_WIG
            - CH_ZWEIGNIEDERLASSUNG
    UnitedKingdomLegalType_Internal:
      required:
        - unitedKingdomValue
      type: object
      properties:
        unitedKingdomValue:
          type: string
          enum:
            - GB_CHARITABLE_INCORPORATED_ORGANISATION_CIO
            - GB_COMMUNITY_INTEREST_COMPANY_CIC
            - GB_GENERAL_PARTNERSHIP
            - GB_INDUSTRIAL_AND_PROVIDENT_SOCIETY
            - GB_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - GB_LIMITED_PARTNERSHIP_LP
            - GB_PRIVATE_COMPANY_LIMITED_BY_GUARANTEE_LTD
            - GB_PRIVATE_COMPANY_LIMITED_BY_SHARES_LTD
            - GB_PUBLIC_LIMITED_COMPANY_PLC
            - GB_SOLE_PROPRIETORSHIP
            - GB_UNLIMITED_COMPANY
    CorporateRelatedCorporateUpdateRequestDto_Internal:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate related
            to a user in your system.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        registeredName:
          maxLength: 255
          minLength: 0
          type: string
          description: The official corporate name.
        tradeName:
          maxLength: 255
          minLength: 0
          type: string
          description: The name used for business if there is one.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          maxLength: 255
          minLength: 0
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        website:
          maxLength: 511
          minLength: 0
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        registeredAddress:
          $ref: '#/components/schemas/WorldwideAddressRequestDto_Internal'
        externalNotes:
          type: string
          description: Public additional information concerning this entity.
        internalNotes:
          type: string
          description: Private additional information concerning this entity.
    CorporateRelatedPhysicalPersonUpdateRequestDto_Internal:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate related
            to a user in your system.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        firstName:
          maxLength: 255
          minLength: 0
          type: string
        middleName:
          maxLength: 255
          minLength: 0
          type: string
        lastName:
          maxLength: 255
          minLength: 0
          type: string
        address:
          $ref: '#/components/schemas/WorldwideAddressRequestDto_Internal'
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        emailAddress:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneRequestDto_Internal'
        isSpecialUbo:
          type: boolean
          description: >-
            Indicates whether this person was designated UBO because no
            shareholder holds the percentage of shares required to become one.
        externalNotes:
          type: string
          description: Public additional information concerning this entity.
        internalNotes:
          type: string
          description: Private additional information concerning this entity.
        kycType:
          type: string
          enum:
            - FULL_KYC
            - DOC_ONLY
            - NOT_REQUIRED
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        birthDate:
          type: string
          format: date
        isPep:
          type: boolean
    CorporateRelatedUpdateRequestDto_Internal:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this corporate related
            to a user in your system.
        externalNotes:
          type: string
          description: Public additional information concerning this entity.
        internalNotes:
          type: string
          description: Private additional information concerning this entity.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
      description: The information to update a corporate related.
      anyOf:
        - $ref: >-
            #/components/schemas/CorporateRelatedPhysicalPersonUpdateRequestDto_Internal
        - $ref: >-
            #/components/schemas/CorporateRelatedCorporateUpdateRequestDto_Internal
    PhoneRequestDto_Internal:
      required:
        - countryCode
        - number
      type: object
      properties:
        countryCode:
          type: string
          example: '33'
        number:
          pattern: ^[0-9]{1,14}$
          type: string
      description: >-
        Update the phone of this corporate related person. Note: if you wish to
        change the phone of an account owner, please contact us.
    WorldwideAddressRequestDto_Internal:
      title: WorldwideAddressRequest
      required:
        - city
        - isoCountryCode
        - postalCode
        - street
      type: object
      properties:
        isoCountryCode:
          title: Worldwide Country Code
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        city:
          maxLength: 255
          minLength: 0
          type: string
        postalCode:
          maxLength: 10
          minLength: 0
          type: string
        street:
          maxLength: 511
          minLength: 0
          type: string
        number:
          maxLength: 255
          minLength: 0
          type: string
        refinement:
          maxLength: 35
          minLength: 0
          type: string
        stateOrProvince:
          maxLength: 255
          minLength: 0
          type: string
        bypassVerification:
          type: boolean
          description: >-
            If true, the address will be saved as described in the request
            without any auto-verification and the status will be INVALID until a
            POA is provided.


            By default is false.
    ConsumerFinancialInformationRequestDto_Internal:
      required:
        - currency
        - expectedMonthlyIncomingTransferFrequency
        - expectedMonthlyIncomingVolume
        - expectedMonthlyOutgoingVolume
        - monthlyNetIncome
      type: object
      properties:
        monthlyNetIncome:
          type: string
          description: The net financial revenue expected every month
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        currency:
          type: string
          description: The currency used for the expected monthly expenses.
          enum:
            - EUR
            - USD
            - GBP
        expectedMonthlyIncomingVolume:
          type: string
          description: >-
            The amount of money you expect to receive with this account every
            month.
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyOutgoingVolume:
          type: string
          description: >-
            The amount of money you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          description: >-
            The frequency at which you expect to spend with this account every
            month.
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    ConsumerUpdateRequestDto_Internal:
      type: object
      properties:
        externalId:
          maxLength: 511
          minLength: 0
          type: string
          description: >-
            A unique identifier that you can use to link this consumer to a user
            in your system.
        sourceOfFunds:
          type: string
          enum:
            - COMPENSATION_PAYOUT
            - COMPANY_PROFITS
            - COMPANY_SALE
            - DIVIDEND_PAYMENTS
            - DIVORCE_SETTLEMENT
            - FIXED_DEPOSITS
            - GIFT
            - INHERITANCE
            - INSURANCE_PAYOUT
            - LOAN
            - LOTTERY_OR_GAMBLING_WIN
            - RETIREMENT_INCOME
            - SALE_OF_INVESTMENT
            - SALE_OF_PROPERTY
            - SAVINGS_FROM_SALARY
            - OTHER
        otherSourceOfFunds:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of source of funds if 'OTHER' was chosen.
        occupation:
          type: string
          description: >-
            The consumer usual or principal work or business as a means of
            earning a living.
          enum:
            - BUSINESS_OWNER
            - CLERGY
            - CRAFTSMAN
            - ENGINEER
            - EXECUTIVE
            - FARMER
            - FREELANCE
            - LIBERAL_PROFESSION
            - POLITICIAN
            - PROFESSOR
            - PUBLIC_SERVANT
            - RETIRED
            - SHOPKEEPER
            - STUDENT
            - UNEMPLOYED
            - WORKER
            - OTHER
        otherOccupation:
          maxLength: 511
          minLength: 0
          type: string
          description: Description of occupation if 'OTHER' was chosen.
        occupationSector:
          type: string
          description: The consumer usual or principal work or business sector.
          enum:
            - ACCOUNTING_AUDIT
            - E_MONEY_SERVICES
            - CURRENCY_EXCHANGE
            - TRADES_ON_OTC_MARKET
            - PRECIOUS_METALS_OR_STONES
            - PAWNSHOPS
            - CROSS_BORDER_CASH_OR_PRECIOUS_MATERIALS
            - MINING_EXTRACTIVE_INDUSTRIES
            - ENERGY
            - TRADE_IN_PETROL_PRODUCTS
            - TRADE_IN_MEDICINES
            - REAL_ESTATE
            - CONSTRUCTION_REPAIR
            - CONSULTANCY_LEGAL
            - FREELANCE
            - NON_PROFIT_LEGAL_ENTITIES
            - CRYPTOCURRENCIES
            - GAMING
            - GAMBLING
            - EU_FUNDS_UTILIZATION
            - ADULT
            - HIGH_VALUE_ASSET_DEALER
            - BANKING_LENDING
            - INSURANCE_SECURITY
            - TRANSPORTATION_AND_LOGISTICS
            - MANUFACTURING
            - UTILITIES_AND_INFRASTRUCTURE
            - TRADE_IN_FOOD_PRODUCT
            - WHOLESALE
            - REPAIR_OF_MOTOR_VEHICLES
            - SOCIAL_WORK_ACTIVITIES
            - AUTO_AVIATION
            - COURIER_POST_SERVICES
            - AGRICULTURE_FORESTRY_AND_FISHING
            - OTHER_TRADE_AND_SALES
            - TRAVEL_TOURISM
            - INFORMATION_AND_COMMUNICATION
            - PR_MARKETING
            - EDUCATION
            - INFORMATIONAL_TECHNOLOGIES
            - PUBLIC_AND_DEFENCE_SECTOR
            - HEALTH_CARE_MEDICAL_SERVICES
            - ART_ENTERTAINMENT_SPORT
            - ADMINISTRATIVE_OFFICE_BUSINESS_ACTIVITIES
            - HOSPITALITY_AND_LEISURE
            - SCIENTIFIC_AND_TECHNICAL_ACTIVITIES
            - OTHER
        isUsPerson:
          type: boolean
          description: If the consumer is a specified us person. Default value is false.
        lastTermsAccepted:
          type: string
          description: The version of the terms and conditions signed by the consumer.
          example: '1.0'
        taxIdentificationNumber:
          maxLength: 255
          minLength: 0
          type: string
        taxCountry:
          type: string
          enum:
            - AUT
            - AND
            - BEL
            - BGR
            - CHE
            - CYP
            - CZE
            - DEU
            - DNK
            - ESP
            - EST
            - FIN
            - FRA
            - GBR
            - GRC
            - HRV
            - HUN
            - IRL
            - ISL
            - ITA
            - LIE
            - LTU
            - LUX
            - LVA
            - MLT
            - MCO
            - NLD
            - NOR
            - POL
            - PRT
            - ROU
            - SVN
            - SVK
            - SWE
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        financialInformationRequestDto:
          $ref: '#/components/schemas/ConsumerFinancialInformationRequestDto_Internal'
        userMetadata:
          title: User metadata
          type: object
          additionalProperties:
            title: User metadata
            type: object
            description: |-
              A custom field to save data.

              This field's size is limited to 3000 characters.
          description: |-
            A custom field to save data.

            This field's size is limited to 3000 characters.
        partnerMetadata:
          title: Partner metadata
          type: object
          additionalProperties:
            title: Partner metadata
            type: object
            description: >-
              A custom field to save data that cannot be modified by the
              end-user.


              This field's size is limited to 3000 characters.


              Note: if you are authenticated as end-user, trying to update this
              field will result in a Forbidden Error.
          description: >-
            A custom field to save data that cannot be modified by the end-user.


            This field's size is limited to 3000 characters.


            Note: if you are authenticated as end-user, trying to update this
            field will result in a Forbidden Error.
        externalNotes:
          type: string
        internalNotes:
          type: string
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        emailAddressVerified:
          type: boolean
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        birthDate:
          type: string
          format: date
        isPep:
          type: boolean
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        complianceScoring:
          $ref: '#/components/schemas/ComplianceScoringUpdateDto_Internal'
        linkcyStatus:
          $ref: '#/components/schemas/EndUserLinkcy_Internal'
        complianceStatus:
          $ref: '#/components/schemas/EndUserCompliance_Internal'
      description: The information to update a consumer.
    ConsumerContactUpdateRequestDto_Internal:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/EuropeanAddressRequestDto_Internal'
        emailAddress:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneRequestDto_Internal'
        phoneVerified:
          type: boolean
      description: >-
        The information to update a consumer contact (address, phone, email
        only).
    BeneficiaryUpdateRequestDto_Internal:
      type: object
      properties:
        active:
          type: boolean
          description: Activate (or not) the beneficiary. Default value is true.
        display:
          type: boolean
          description: >-
            Display (or not) the beneficiary to the end-user (unusable by
            end-user).
        friendlyName:
          maxLength: 255
          minLength: 1
          type: string
        name:
          maxLength: 70
          minLength: 3
          type: string
        status:
          type: string
          enum:
            - DECLINED
            - PENDING_REVIEW
            - VALID
            - PENDING
            - NEED_ADDITIONAL_INFORMATION
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        iban:
          type: string
        bicOrSwift:
          type: string
        accountNumber:
          pattern: ^[0-9]{6}$
          type: string
        sortCode:
          pattern: ^[0-9]{8}$
          type: string
    BeneficiaryUpdateResponseDto_Internal:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    PaynovateMvcCountResponseDto:
      required:
        - alertThreshold
        - remainingMvcCount
        - totalMvcCount
      type: object
      properties:
        totalMvcCount:
          type: integer
          format: int32
        remainingMvcCount:
          type: integer
          format: int32
        alertThreshold:
          type: integer
          format: int32
    AddressResponseDto_Partner:
      required:
        - city
        - id
        - isoCountryCode
        - status
      type: object
      properties:
        id:
          type: string
          format: uuid
        isoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        city:
          type: string
        postalCode:
          type: string
        street:
          type: string
        number:
          type: string
        refinement:
          type: string
        stateOrProvince:
          type: string
        status:
          type: string
          enum:
            - INVALID
            - VALID
            - PENDING
            - VERIFIED
            - ARCHIVED
            - DECLINED
      description: Address used on the bank statements of your users.
    EmailProperties_Partner:
      type: object
      properties:
        senderEmailAddress:
          type: string
          description: Email address used to send emails on your behalf.
        senderEmailName:
          type: string
          description: Name used to send emails on your behalf.
    PartnerDefaultLedgerLimitsResponseDto_Partner:
      title: Partner Default Ledger Limits
      required:
        - ddMonthlyLimit
        - ddTransactionLimit
        - transactionDailyLimit
        - transactionLimit
        - transactionMonthlyLimit
      type: object
      properties:
        transactionLimit:
          type: number
        transactionDailyLimit:
          type: number
        transactionMonthlyLimit:
          type: number
        ddTransactionLimit:
          type: number
        ddMonthlyLimit:
          type: number
      description: Configuration of the default ledger limits for this partner.
    PartnerDefaultLimitedStatusLimitsResponseDto_Partner:
      title: Partner Default limited status Limits
      required:
        - limitedStatusTransactionLimit
        - limitedStatusTransactionLimitInterval
      type: object
      properties:
        limitedStatusTransactionLimit:
          type: number
        limitedStatusTransactionLimitInterval:
          type: integer
          format: int32
      description: >-
        Default transaction limit configuration for end-users with limited
        status for this partner
    PartnerDefaultSctInstLimitsResponseDto_Partner:
      title: Partner Default SEPA Credit Transfer Instant Limits
      type: object
      properties:
        sctInstLimit:
          type: number
        sctInstDailyLimit:
          type: number
        sctInstWeeklyLimit:
          type: number
      description: >-
        Configuration of the default transaction limit for SEPA Instant Credit
        Transfer (SCT Inst) for this partner.
    PartnerInfoResponseDto_Partner:
      required:
        - contactInformation
        - creationDate
        - limits
        - name
        - updateDate
      type: object
      properties:
        name:
          type: string
        displayName:
          type: string
          description: Name display on documents.
        logoUrl:
          type: string
          description: Url that provides the logo.
        address:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        consumerOtpMessage:
          type: string
          description: Message displayed when requesting a OTP message.
        corporateOtpMessage:
          type: string
          description: Message displayed when requesting a OTP message.
        emailProperties:
          $ref: '#/components/schemas/EmailProperties_Partner'
        contactInformation:
          $ref: '#/components/schemas/ContactInformation_Partner'
        limits:
          $ref: '#/components/schemas/PartnerLimitsResponseDto_Partner'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
      description: Your information as Partner.
    PartnerLimitsResponseDto_Partner:
      type: object
      properties:
        ledger:
          $ref: '#/components/schemas/PartnerDefaultLedgerLimitsResponseDto_Partner'
        sctInst:
          $ref: '#/components/schemas/PartnerDefaultSctInstLimitsResponseDto_Partner'
        limitedStatus:
          $ref: >-
            #/components/schemas/PartnerDefaultLimitedStatusLimitsResponseDto_Partner
      description: Configuration of limits.
    WebhookPortalResponseDto:
      required:
        - url
      type: object
      properties:
        url:
          type: string
    AcquiringDetailsResponseDto_Partner:
      title: Acquiring details
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        cardHolderName:
          type: string
        cardIssuer:
          type: string
        cardType:
          type: string
        cardScheme:
          type: string
        cardIssuerCountryCode:
          type: string
        cardTruncPan:
          type: string
        threeDsCheck:
          type: string
        targetLedgerId:
          type: string
          format: uuid
        loadTransactionId:
          type: string
          format: uuid
        paymentMethod:
          type: string
    AcquiringTransactionFeesDto_Partner:
      type: object
      properties:
        acquiringCommission:
          type: string
        merchantCharge:
          type: string
        schemeFee:
          type: string
        interchangeFee:
          type: string
        partnerFee:
          type: number
    AcquiringTransactionInformationResponseDto_Partner:
      title: Transaction Information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        note:
          type: string
        clearingDate:
          type: string
          format: date-time
        paymentDate:
          type: string
          format: date
        reference:
          type: string
    AcquiringTransactionResponseDto_Partner:
      title: Acquiring
      required:
        - amount
        - creationDate
        - currency
        - details
        - id
        - information
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - ACQUIRING
        paymentType:
          type: string
          enum:
            - ACCOUNT_LOAD
            - PAYMENT
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: >-
            #/components/schemas/AcquiringTransactionInformationResponseDto_Partner
        sender:
          $ref: '#/components/schemas/TransactionActorResponseDto_Partner'
        receiver:
          $ref: '#/components/schemas/TransactionActorResponseDto_Partner'
        details:
          $ref: '#/components/schemas/AcquiringDetailsResponseDto_Partner'
        netAmount:
          type: number
        fees:
          $ref: '#/components/schemas/AcquiringTransactionFeesDto_Partner'
    CardTransactionActorResponseDto_Partner:
      title: Card Actor
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
        cardId:
          type: string
          format: uuid
        cardFriendlyName:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
    CardTransactionCardDetailsResponseDto_Partner:
      title: Card Details
      required:
        - auth3dsMethod
        - cardPresent
        - deviceFormFactor
        - holderPresent
        - inputMethod
        - terminalAttendance
        - token
        - truncatedPan
      type: object
      properties:
        truncatedPan:
          type: string
        token:
          type: string
        terminalAttendance:
          type: string
          enum:
            - ATTENDED
            - UNATTENDED
            - UNKNOWN
            - NO_TERMINAL_USED
        holderPresent:
          type: string
          enum:
            - NOT_PRESENT_STANDING_AUTH_OR_RECURRING_TRANSACTION
            - NOT_PRESENT_INSTALLMENT_TRANSACTION
            - UNKNOWN
            - PRESENT
            - NOT_PRESENT_E_COMMERCE
            - NOT_PRESENT_MAIL_ORDER
            - NOT_PRESENT_UNSPECIFIED
            - NOT_PRESENT_TELEPHONE_ORDER
        cardPresent:
          type: string
          enum:
            - UNKNOWN
            - PRESENT
            - NOT_PRESENT
        deviceFormFactor:
          type: string
          enum:
            - TABLET
            - JEWELRY
            - STICKER
            - MOBILE_PHONE
            - MOBILE_PHONE_OR_TABLET
            - WRISTBAND
            - UNKNOWN
            - MINI_CARD
            - CLOTHING_OR_APPAREL
            - MOBILE_TAG_CASE_OR_SLEEVE
            - FASHION_ACCESSORY
            - DOMESTIC_APPLICATION
            - NON_CARD
            - CARD
            - FOB_OR_KEY_FOB
            - WATCH
            - VEHICLE
            - PERSONAL_COMPUTER_OR_LAPTOP
            - MEDIA_OR_GAMING_DEVICE
        inputMethod:
          type: string
          enum:
            - EMV_CONTACT
            - UNSPECIFIED
            - E_COMMERCE_WITH_EMV
            - BARCODE
            - KEY_ENTERED_BY_ACQUIRER
            - MAGNETIC_STRIPE
            - E_COMMERCE
            - MAGNETIC_STRIPE_CONTACTLESS
            - QR_CODE
            - EMV_CONTACTLESS
            - MANUAL
            - OCR
            - KEY_ENTERED
            - ACCOUNT_DATA_ON_FILE
            - MICR_READER
            - UNKNOWN
        auth3dsMethod:
          type: string
          enum:
            - AUTHENTICATED_BY_ACS
            - AUTHENTICATED_BY_MASTERCARD_IDCX
            - AUTHENTICATED_WITH_UNKNOWN_METHOD
            - DELEGATED
            - FRICTIONLESS_FLOW
            - FRICTIONLESS_FLOW_RISK_BASED_AUTHENTICATION_REVIEW
            - KNOWLEDGE_BASED_AUTHENTICATION
            - NONE
            - OTHER_AUTHENTICATION_METHOD
            - OTP_VIA_APP_METHOD
            - OTP_VIA_OTHER_METHOD
            - OUT_OF_BAND_WITH_APP_LOGIN_METHOD
            - OUT_OF_BAND_WITH_BIOMETRIC_METHOD
            - OUT_OF_BAND_WITH_OTHER_METHOD
            - PASSWORD
            - PKI
            - PUSH_CONFIRMATION
            - SECRET_KEY
            - SERVER_RESPONDING
            - UNKNOWN_AUTHENTICATION_METHOD
            - UNKNOWN_OR_NOT_APPLICABLE
            - UNRECOGNISED
            - UNRECOGNIZED_AUTHENTICATION_METHOD
    CardTransactionInformationResponseDto_Partner:
      title: Card Transaction Information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - REFER_TO_CARD_ISSUER
            - INVALID_MERCHANT
            - DO_NOT_HONOUR
            - INVALID_AMOUNT
            - INVALID_CARD_NUMBER
            - EXPIRED_CARD
            - LOST_CARD
            - STOLEN_CARD
            - ACCOUNT_CLOSED
            - INSUFFICIENT_FUNDS
            - INCORRECT_PIN
            - TRANSACTION_NOT_PERMITTED_TO_ENDUSER
            - TRANSACTION_NOT_PERMITTED_TO_TERMINAL
            - SUSPECTED_FRAUD
            - RESTRICTED_CARD
            - SECURITY_VIOLATION
            - EXCEEDS_LIMIT
            - EXCEEDS_WITHDRAWAL_LIMIT
            - EXCEEDS_WITHDRAWAL_FREQUENCY_LIMIT
            - VERIFICATION_DATA_FAILED
            - CARDHOLDER_TO_CONTACT_ISSUER
            - PIN_TRIES_EXCEEDED
            - CARD_NOT_ACTIVE
            - ISSUER_OR_SWITCH_INOPERATIVE
            - UNABLE_TO_ROUTE_TRANSACTION
            - LAW_VIOLATION
            - SYSTEM_MALFUNCTION
            - STRONG_CUSTOMER_CARD_BASED_AUTHENTICATION_REQUIRED
            - STRONG_CUSTOMER_NON_CARD_BASED_AUTHENTICATION_REQUIRED
            - DECLINE_FOR_CVV2_FAILURE
            - UNKNOWN
        note:
          type: string
        originalTransaction:
          $ref: '#/components/schemas/LinkedTransactionDto_Partner'
        clearingTransaction:
          $ref: '#/components/schemas/LinkedTransactionDto_Partner'
        acquirerReferenceData:
          type: string
        interchangeFeeAmount:
          type: number
        interchangeFeeCurrency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        clearingDate:
          type: string
          format: date-time
    CardTransactionResponseDto_Partner:
      title: Card
      required:
        - amount
        - creationDate
        - currency
        - direction
        - id
        - information
        - merchant
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - CARD_AUTHORIZATION
            - CARD_CLEARING
        paymentType:
          type: string
          enum:
            - ACCOUNT_FUNDING
            - ACCOUNT_TRANSFER
            - ACCOUNT_VERIFICATION
            - ADJUSTMENT_CREDIT
            - ADJUSTMENT_DEBIT
            - CASH_ADVANCE
            - CHARGEBACK
            - CHECK_DEPOSIT
            - DEPOSIT
            - FEE_COLLECTION
            - ORIGINAL_CREDIT
            - PAYMENT_TRANSACTION
            - PURCHASE
            - PURCHASE_RETURN_OR_REFUND
            - PURCHASE_WITH_CASHBACK
            - QUASI_CASH
            - UNIQUE_MCC_TRANSACTION
            - WITHDRAWAL
            - UNKNOWN
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/CardTransactionInformationResponseDto_Partner'
        sender:
          $ref: '#/components/schemas/CardTransactionActorResponseDto_Partner'
        receiver:
          $ref: '#/components/schemas/CardTransactionActorResponseDto_Partner'
        merchant:
          $ref: '#/components/schemas/TransactionMerchantResponseDto_Partner'
        cardDetails:
          $ref: '#/components/schemas/CardTransactionCardDetailsResponseDto_Partner'
        direction:
          type: string
          enum:
            - DEBIT
            - CREDIT
    InterLedgerTransactionInformationResponseDto_Partner:
      title: Transaction Information
      required:
        - clearingDate
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        note:
          type: string
        clearingDate:
          type: string
          format: date-time
        reference:
          type: string
    InterLedgerTransactionResponseDto_Partner:
      title: Inter-Ledger
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - INTER_LEDGER
        paymentType:
          type: string
          enum:
            - MONEY_TRANSFER
            - ACCOUNT_LOAD
            - TECH_MVC_CREATION
            - TECH_TRANSACTION
            - TECH_VIRTUAL_TRANSFER
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: >-
            #/components/schemas/InterLedgerTransactionInformationResponseDto_Partner
        sender:
          $ref: '#/components/schemas/TransactionActorResponseDto_Partner'
        receiver:
          $ref: '#/components/schemas/TransactionActorResponseDto_Partner'
    LinkedTransactionDto_Partner:
      required:
        - date
      type: object
      properties:
        id:
          type: string
          format: uuid
        date:
          type: string
          format: date-time
      description: >-
        For card authorization, you get the transaction id and date of the
        corresponding card clearing.
    ListResponseDtoTransactionResponseDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/TransactionResponseDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    OtherTransactionInformationResponseDto_Partner:
      title: Other Transaction Information
      required:
        - clearingDate
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        clearingDate:
          type: string
          format: date-time
        note:
          type: string
    OtherTransactionResponseDto_Partner:
      title: Other
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - FX
            - UNKNOWN
        paymentType:
          type: string
          enum:
            - GLOBAL_SWIFT
            - UNKNOWN
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/OtherTransactionInformationResponseDto_Partner'
        sender:
          $ref: '#/components/schemas/TransactionActorResponseDto_Partner'
        receiver:
          $ref: '#/components/schemas/TransactionActorResponseDto_Partner'
    SepaTransactionActorDetailsResponseDto_Partner:
      title: Sepa Actor
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        bic:
          type: string
        iban:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
    SepaTransactionInformationResponseDto_Partner:
      title: Sepa Credit Transaction Information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
        - sequence
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        note:
          type: string
        clearingDate:
          type: string
          format: date-time
        reference:
          type: string
        sequence:
          type: string
          enum:
            - FIRST
            - RECURRING
            - FINAL
            - ONE_OFF
            - NONE
    SepaTransactionReceiverResponseDto_Partner:
      title: Sepa Receiver
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        bic:
          type: string
        iban:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
        beneficiaryId:
          type: string
          format: uuid
        originalName:
          type: string
    SepaTransactionResponseDto_Partner:
      title: SEPA
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - SEPA_CREDIT_TRANSFER
            - SEPA_DIRECT_DEBIT
        paymentType:
          type: string
          enum:
            - SCT_RECEIVE
            - SCT_INST_RECEIVE
            - SCT_SEND
            - SCT_INST_SEND
            - SDD_SEND
            - SDD_RECEIVE
            - TECH_CARD_SETTLEMENT
            - TECH_SCT_RETURN
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/SepaTransactionInformationResponseDto_Partner'
        sender:
          $ref: '#/components/schemas/SepaTransactionActorDetailsResponseDto_Partner'
        receiver:
          $ref: '#/components/schemas/SepaTransactionReceiverResponseDto_Partner'
    TransactionActorResponseDto_Partner:
      title: Transaction Actor
      type: object
      properties:
        ledgerFriendlyName:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        ledgerId:
          type: string
          format: uuid
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
    TransactionMerchantResponseDto_Partner:
      title: Card Transaction Merchant
      required:
        - acquirerId
        - categoryCode
        - city
        - country
        - description
        - id
        - name
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        city:
          type: string
        country:
          type: string
        categoryCode:
          type: string
        description:
          type: string
        acquirerId:
          type: string
    TransactionResponseDto_Partner:
      required:
        - creationDate
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
        creationDate:
          type: string
          format: date-time
      anyOf:
        - $ref: '#/components/schemas/InterLedgerTransactionResponseDto_Partner'
        - $ref: '#/components/schemas/SepaTransactionResponseDto_Partner'
        - $ref: '#/components/schemas/CardTransactionResponseDto_Partner'
        - $ref: '#/components/schemas/UkTransactionResponseDto_Partner'
        - $ref: '#/components/schemas/OtherTransactionResponseDto_Partner'
        - $ref: '#/components/schemas/AcquiringTransactionResponseDto_Partner'
    UkTransactionInformationResponseDto_Partner:
      title: UK transaction information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        clearingDate:
          type: string
          format: date-time
        reference:
          type: string
        note:
          type: string
    UkTransactionReceiverResponseDto_Partner:
      title: UK Receiver
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        sortCode:
          type: string
        accountNumber:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
        beneficiaryId:
          type: string
          format: uuid
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
    UkTransactionResponseDto_Partner:
      title: UK
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          title: UK Transaction Type
          type: string
          enum:
            - UK_CREDIT_TRANSFER
        paymentType:
          title: Uk Payment Type
          type: string
          enum:
            - BACS_RECEIVE
            - FASTER_PAYMENT_RECEIVE
            - BACS_SEND
            - FASTER_PAYMENT_SEND
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/UkTransactionInformationResponseDto_Partner'
        sender:
          $ref: '#/components/schemas/UkTransactionSenderResponseDto_Partner'
        receiver:
          $ref: '#/components/schemas/UkTransactionReceiverResponseDto_Partner'
    UkTransactionSenderResponseDto_Partner:
      title: UK Sender
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        sortCode:
          type: string
        accountNumber:
          type: string
        bic:
          type: string
        iban:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
    CorporateRelatedCorporateShortInfoResponseDto:
      required:
        - id
        - registeredName
      type: object
      allOf:
        - $ref: '#/components/schemas/CorporateRelatedShortInfoResponseDto'
        - type: object
          properties:
            tradeName:
              type: string
            registeredName:
              type: string
    CorporateRelatedPhysicalShortInfoResponseDto:
      required:
        - id
      type: object
      allOf:
        - $ref: '#/components/schemas/CorporateRelatedShortInfoResponseDto'
        - type: object
          properties:
            firstName:
              type: string
            lastName:
              type: string
    CorporateRelatedShortInfoResponseDto:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ShareInfoResponseDto:
      required:
        - corporateRelated
        - directSharesPercentage
        - finalSharesPercentage
        - id
        - layer
      type: object
      properties:
        id:
          type: string
          format: uuid
        ownedCorporate:
          $ref: '#/components/schemas/CorporateRelatedCorporateShortInfoResponseDto'
        corporateRelated:
          oneOf:
            - $ref: >-
                #/components/schemas/CorporateRelatedCorporateShortInfoResponseDto
            - $ref: >-
                #/components/schemas/CorporateRelatedPhysicalShortInfoResponseDto
        directSharesPercentage:
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
        finalSharesPercentage:
          type: number
          description: Percentage of the corporate end-user held.
          format: float
        layer:
          type: integer
          description: Identifier of the corporate in which he holds shares.
          format: int32
    DebtorBankingDetails_Partner:
      type: object
      anyOf:
        - $ref: '#/components/schemas/SepaDebtorBankingDetails_Partner'
    DebtorInfoResponseDto_Partner:
      required:
        - name
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        name:
          type: string
        bankingDetails:
          $ref: '#/components/schemas/DebtorBankingDetails_Partner'
        ledgerId:
          type: string
          description: >-
            Sometimes the debtor account can correspond to a ledger that you
            manage, in this case, we would send you the corresponding id.
          format: uuid
    DirectDebitMandateListElementDto_Partner:
      required:
        - creationDate
        - debtor
        - endUserId
        - id
        - status
        - uniqueReference
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        uniqueReference:
          type: string
        endUserId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - AWAITING_ACTIVATION
            - ACTIVATING
            - ACTIVATED
            - CANCELING
            - CANCELED
            - FAILED
        friendlyName:
          type: string
        debtor:
          $ref: '#/components/schemas/DebtorInfoResponseDto_Partner'
        recurring:
          type: boolean
        expirationDate:
          type: string
          format: date
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
    ListResponseDtoDirectDebitMandateListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/DirectDebitMandateListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    SepaDebtorBankingDetails_Partner:
      required:
        - bic
        - iban
      type: object
      properties:
        iban:
          type: string
          description: Must be a valid iban format following the standard ISO_13616.
        bic:
          type: string
          description: Must be a valid bic following the standard ISO_9362.
    DirectDebitMandateInfoResponseDto_Partner:
      required:
        - creationDate
        - debtor
        - endUserId
        - id
        - status
        - uniqueReference
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        uniqueReference:
          type: string
        endUserId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - AWAITING_ACTIVATION
            - ACTIVATING
            - ACTIVATED
            - CANCELING
            - CANCELED
            - FAILED
        friendlyName:
          type: string
        debtor:
          $ref: '#/components/schemas/DebtorInfoResponseDto_Partner'
        recurring:
          type: boolean
        expirationDate:
          type: string
          format: date
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
    EndUserIdResponseDto:
      title: End-user
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ListResponseDtoPartnerLedgerListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/PartnerLedgerListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    PartnerLedgerListElementDto:
      required:
        - country
        - creationDate
        - currency
        - endUser
        - id
        - isUpgraded
        - status
      type: object
      properties:
        isUpgraded:
          type: boolean
        id:
          type: string
          format: uuid
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        parentId:
          type: string
          description: The id of the parent ledger if this ledger is virtual
          format: uuid
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        friendlyName:
          type: string
        endUser:
          $ref: '#/components/schemas/EndUserIdResponseDto'
        creationDate:
          type: string
          format: date-time
    ClassicLedgerInfoResponseDto_Partner:
      required:
        - availableAmount
        - country
        - creationDate
        - currency
        - endUserId
        - id
        - isUpgraded
        - limits
        - reservedAmount
        - status
        - suspensionsInformation
        - totalAmount
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUserId:
          type: string
          format: uuid
        friendlyName:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        totalAmount:
          type: number
        availableAmount:
          type: number
        reservedAmount:
          type: number
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        isUpgraded:
          type: boolean
          description: >-
            When inactive, no external banking information will be returned.
            Assign an account number to enable the fields.
        iban:
          type: string
        bicOrSwift:
          type: string
        accountNumber:
          type: string
        sortCode:
          type: string
        routingNumber:
          type: string
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/LedgerSuspensionInfoDto_Partner'
        limits:
          $ref: '#/components/schemas/LedgerLimitsWithUsageResponseDto_Partner'
        closeInformation:
          $ref: '#/components/schemas/LedgerCloseInfoDto_Partner'
    LedgerCloseInfoDto_Partner:
      required:
        - date
        - operator
      type: object
      properties:
        date:
          type: string
          format: date-time
        reason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    LedgerLimitsWithUsageResponseDto_Partner:
      required:
        - ddMonthlyLimit
        - ddMonthlyLimitUsed
        - ddTransactionLimit
        - transactionDailyLimit
        - transactionDailyLimitUsed
        - transactionLimit
        - transactionMonthlyLimit
        - transactionMonthlyLimitUsed
      type: object
      properties:
        ddTransactionLimit:
          type: number
          description: >-
            Direct debit transaction limit. If null, it will take the default
            value defined in the partner configuration.
        ddMonthlyLimit:
          type: number
          description: >-
            Direct Debit Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
        ddMonthlyLimitUsed:
          type: number
        transactionLimit:
          type: number
          description: >-
            Transaction Limit. If null, it will take the default value defined
            in the partner configuration.
        transactionDailyLimit:
          type: number
          description: >-
            Transaction Daily Limit. If null, it will take the default value
            defined in the partner configuration.
        transactionDailyLimitUsed:
          type: number
        transactionMonthlyLimit:
          type: number
          description: >-
            Transaction Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
        transactionMonthlyLimitUsed:
          type: number
    LedgerResponseDto_Partner:
      required:
        - country
        - creationDate
        - currency
        - endUserId
        - id
        - limits
        - status
        - suspensionsInformation
        - updateDate
      type: object
      properties:
        closeInformation:
          $ref: '#/components/schemas/LedgerCloseInfoDto_Partner'
        id:
          type: string
          format: uuid
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        friendlyName:
          type: string
        endUserId:
          type: string
          format: uuid
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        accountNumber:
          type: string
        sortCode:
          type: string
        iban:
          type: string
        bicOrSwift:
          type: string
        routingNumber:
          type: string
        limits:
          $ref: '#/components/schemas/LedgerLimitsWithUsageResponseDto_Partner'
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/LedgerSuspensionInfoDto_Partner'
      anyOf:
        - $ref: '#/components/schemas/ClassicLedgerInfoResponseDto_Partner'
        - $ref: '#/components/schemas/VirtualLedgerInfoResponseDto_Partner'
    LedgerSuspensionInfoDto_Partner:
      required:
        - date
        - operator
      type: object
      properties:
        date:
          type: string
          format: date-time
        reason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    VirtualLedgerInfoResponseDto_Partner:
      required:
        - country
        - creationDate
        - currency
        - endUserId
        - id
        - limits
        - parentId
        - status
        - suspensionsInformation
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        parentId:
          type: string
          description: The id of the parent ledger if this ledger is virtual
          format: uuid
        endUserId:
          type: string
          format: uuid
        friendlyName:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        iban:
          type: string
        bicOrSwift:
          type: string
        accountNumber:
          type: string
        sortCode:
          type: string
        routingNumber:
          type: string
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/LedgerSuspensionInfoDto_Partner'
        limits:
          $ref: '#/components/schemas/LedgerLimitsWithUsageResponseDto_Partner'
        closeInformation:
          $ref: '#/components/schemas/LedgerCloseInfoDto_Partner'
    AddressResponseDto:
      required:
        - city
        - id
        - isoCountryCode
        - status
      type: object
      properties:
        id:
          type: string
          format: uuid
        isoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        city:
          type: string
        postalCode:
          type: string
        street:
          type: string
        number:
          type: string
        refinement:
          type: string
        stateOrProvince:
          type: string
        status:
          type: string
          enum:
            - INVALID
            - VALID
            - PENDING
            - VERIFIED
            - ARCHIVED
            - DECLINED
    KycApplicationListElementDto:
      required:
        - creationDate
        - id
        - personId
        - personType
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        personId:
          type: string
          format: uuid
        personType:
          type: string
          enum:
            - CONSUMER
            - CORPORATE_RELATED_PHYSICAL_PERSON
        address:
          $ref: '#/components/schemas/AddressResponseDto'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthDate:
          type: string
          format: date
        emailAddress:
          type: string
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        status:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        statusReason:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
    ListResponseDtoKycApplicationListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/KycApplicationListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    KycApplicationInfoResponseDto_Partner:
      required:
        - accessType
        - creationDate
        - id
        - person
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        person:
          $ref: '#/components/schemas/PersonInfo_Partner'
        address:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthDate:
          type: string
          format: date
        emailAddress:
          type: string
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        status:
          $ref: '#/components/schemas/KycStatusInfo_Partner'
        accessType:
          type: string
          enum:
            - LINK
            - SDK
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
    KycStatusInfo_Partner:
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        reason:
          type: string
    PersonInfo_Partner:
      required:
        - id
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - CONSUMER
            - CORPORATE_RELATED_PHYSICAL_PERSON
    ExternalCardListElementDto_Partner:
      required:
        - cardHolderName
        - creationDate
        - endUserId
        - expiryDate
        - id
        - maskedPan
        - scheme
        - type
        - validityDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUserId:
          type: string
          format: uuid
        maskedPan:
          type: string
        cardHolderName:
          type: string
        scheme:
          type: string
        type:
          type: string
        expiryDate:
          type: string
        creationDate:
          type: string
          format: date-time
        validityDate:
          type: string
          format: date-time
    ListResponseDtoExternalCardListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCardListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    DocumentListElementDto_Partner:
      required:
        - creationDate
        - endUser
        - id
        - requested
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUser:
          $ref: '#/components/schemas/EndUserIdResponseDto_Partner'
        friendlyName:
          type: string
        fileName:
          type: string
        type:
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DILIGENCE_REVIEW
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        status:
          type: string
          enum:
            - UPLOADED
            - REQUESTED
            - DECLINED
            - VALIDATED
        transactionId:
          type: string
          description: >-
            ID of the transaction if the document is a TRANSACTION_RECEIPT or
            any document related to a transaction.
          format: uuid
        beneficiaryId:
          type: string
          description: ID of the beneficiary associated with the document.
          format: uuid
        corporateRelatedId:
          type: string
          description: ID of the corporate related associated with the document.
          format: uuid
        addressId:
          type: string
          description: ID of the address associated with the document.
          format: uuid
        requested:
          type: boolean
        creationDate:
          type: string
          format: date-time
    EndUserIdResponseDto_Partner:
      title: End-user
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ListResponseDtoDocumentListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/DocumentListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    DocumentInfoResponseDto_Partner:
      required:
        - creationDate
        - endUser
        - id
        - requested
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUser:
          $ref: '#/components/schemas/EndUserIdResponseDto_Partner'
        contentType:
          type: string
        type:
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DILIGENCE_REVIEW
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        friendlyName:
          type: string
        fileName:
          type: string
        status:
          type: string
          enum:
            - UPLOADED
            - REQUESTED
            - DECLINED
            - VALIDATED
        transactionId:
          type: string
          description: >-
            ID of the transaction if the document is a TRANSACTION_RECEIPT or
            any document related to a transaction.
          format: uuid
        beneficiaryId:
          type: string
          description: ID of the beneficiary associated with the document.
          format: uuid
        corporateRelatedId:
          type: string
          description: ID of the corporate related associated with the document.
          format: uuid
        addressId:
          type: string
          description: ID of the address associated with the document.
          format: uuid
        requested:
          type: boolean
        note:
          type: string
        verificationDate:
          type: string
          format: date-time
        uploadDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        download:
          $ref: '#/components/schemas/Download_Partner'
    Download_Partner:
      required:
        - ttl
        - url
      type: object
      properties:
        url:
          type: string
        ttl:
          type: string
          example: PT8H6M12.345S
    TemplateDocumentResponseDto:
      title: TemplateDocumentResponse
      required:
        - ttl
        - url
      type: object
      properties:
        url:
          type: string
        ttl:
          type: string
          example: PT8H6M12.345S
      description: Response including url link and time to leave Duration.
    TermsAndConditionsInfoRequestDto:
      required:
        - language
        - type
      type: object
      properties:
        type:
          type: string
          example: CONSUMER
          enum:
            - CONSUMER
            - CORPORATE
        language:
          type: string
          default: EN
          enum:
            - EN
            - FR
      description: Information used to get specific terms and conditions.
    TermsAndConditionsInfoResponseDto:
      required:
        - downloadUrl
        - language
        - type
        - version
      type: object
      properties:
        type:
          type: string
          enum:
            - CONSUMER
            - CORPORATE
        downloadUrl:
          type: string
          description: Url to download the file.
        version:
          type: string
          example: '1.0'
        language:
          type: string
          enum:
            - EN
            - FR
      description: Terms and conditions information.
    CryptoWalletListResponseElementDto_Partner:
      required:
        - blockchain
        - creationDate
        - endUserId
        - id
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSED
            - FAILED
        friendlyName:
          type: string
        address:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        endUserId:
          type: string
          format: uuid
    ListResponseDtoCryptoWalletListResponseElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CryptoWalletListResponseElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    CryptoAsset_Partner:
      required:
        - balance
        - blockchain
        - decimals
        - symbol
      type: object
      properties:
        symbol:
          type: string
        decimals:
          type: integer
          format: int32
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        balance:
          type: string
        contract:
          type: string
        name:
          type: string
        verified:
          type: boolean
    CryptoWalletGetResponseDto_Partner:
      required:
        - assets
        - blockchain
        - creationDate
        - endUserId
        - id
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSED
            - FAILED
        friendlyName:
          type: string
        address:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        endUserId:
          type: string
          format: uuid
        assets:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CryptoAsset_Partner'
    CryptoTransactionActorResponseDto_Partner:
      title: Crypto Transaction Actor
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        walletId:
          type: string
          format: uuid
        walletAddress:
          type: string
        walletFriendlyName:
          type: string
    CryptoTransactionFeesResponseDto_Partner:
      title: Crypto Transaction Fees
      required:
        - asset
        - decimals
      type: object
      properties:
        amount:
          type: number
        asset:
          type: string
        decimals:
          type: integer
          format: int32
    CryptoTransactionInformationResponseDto_Partner:
      title: Crypto Transaction Information
      required:
        - blockchain
      type: object
      properties:
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        transactionHash:
          type: string
    CryptoTransactionResponseDto_Partner:
      required:
        - amount
        - asset
        - creationDate
        - decimals
        - id
        - information
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        paymentType:
          type: string
          enum:
            - TOKEN_SEND
            - TOKEN_RECEIVE
        type:
          type: string
          enum:
            - DIGITAL_ASSETS
        status:
          type: string
          enum:
            - APPROVED
            - PENDING
            - DECLINED
        amount:
          type: number
        asset:
          type: string
        decimals:
          type: integer
          format: int32
        information:
          $ref: '#/components/schemas/CryptoTransactionInformationResponseDto_Partner'
        fees:
          $ref: '#/components/schemas/CryptoTransactionFeesResponseDto_Partner'
        sender:
          $ref: '#/components/schemas/CryptoTransactionActorResponseDto_Partner'
        receiver:
          $ref: '#/components/schemas/CryptoTransactionActorResponseDto_Partner'
        reference:
          type: string
        creationDate:
          type: string
          format: date-time
        confirmationDate:
          type: string
          format: date-time
      description: The information on a crypto transaction.
    ListResponseDtoCryptoTransactionResponseDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CryptoTransactionResponseDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    CryptoBeneficiaryResponseDto_Partner:
      required:
        - active
        - creationDate
        - display
        - id
        - name
        - status
        - type
        - updateDate
        - walletDetails
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        friendlyName:
          type: string
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        active:
          type: boolean
        display:
          type: boolean
        status:
          type: string
          enum:
            - DECLINED
            - PENDING_REVIEW
            - VALID
            - PENDING
            - NEED_ADDITIONAL_INFORMATION
        walletDetails:
          $ref: '#/components/schemas/WalletDetails_Partner'
      description: The information on a crypto beneficiary.
    ListResponseDtoCryptoBeneficiaryResponseDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CryptoBeneficiaryResponseDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    WalletDetails_Partner:
      required:
        - address
        - blockchain
        - type
      type: object
      properties:
        address:
          type: string
          description: Counterparty wallet address.
        blockchain:
          type: string
          description: >-
            Counterparty wallet blockchain. The enumeration is the same as the
            one in Create Wallet endpoint because you can only create
            transactions on the same blockchain as the wallet sender.
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        type:
          type: string
          enum:
            - CUSTODIAL
            - NON_CUSTODIAL
        provider:
          type: string
          description: Optional, used only for CUSTODIAL wallets.
    CorporateListElementDto_Partner:
      required:
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - registeredName
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        registeredName:
          type: string
        incorporationCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
        status:
          $ref: '#/components/schemas/CorporateStatusResponseDto_Partner'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
    CorporateStatusResponseDto_Partner:
      title: CorporateStatus
      required:
        - banking
        - compliance
        - kyb
        - linkcy
        - overall
        - suspension
      type: object
      properties:
        banking:
          $ref: '#/components/schemas/EndUserBanking_Partner'
        kyb:
          $ref: '#/components/schemas/KybResponse_Partner'
        suspension:
          $ref: '#/components/schemas/EndUserSuspension_Partner'
        linkcy:
          $ref: '#/components/schemas/EndUserLinkcy_Partner'
        compliance:
          $ref: '#/components/schemas/EndUserCompliance_Partner'
        overall:
          $ref: '#/components/schemas/Overall_Partner'
    EndUserBanking_Partner:
      title: Banking
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - VALIDATED
            - PENDING
            - MISSING_DATA
            - BLOCKED
            - NOT_CREATED
        reason:
          type: string
    EndUserCompliance_Partner:
      title: Compliance
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - PENDING
            - DECLINED
            - PENDING_REVIEW
            - VALIDATED
        reason:
          type: string
    EndUserLinkcy_Partner:
      title: Linkcy
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - PENDING
            - FORBIDDEN
            - MISSING_DATA
            - VALIDATED
            - LIMITED
            - CLOSING
            - CLOSED
        reason:
          type: string
    EndUserSuspension_Partner:
      title: Suspension
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - SUSPENDED
            - NOT_SUSPENDED
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        reason:
          type: string
    KybResponse_Partner:
      title: Kyb
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - COMPLETING
            - PENDING_VERIFICATION
            - NEED_ADDITIONAL_INFORMATION
            - DECLINED
            - VALIDATED
        reason:
          type: string
        lastVerificationRequestDate:
          type: string
          format: date-time
    ListResponseDtoCorporateListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CorporateListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    Overall_Partner:
      title: Overall
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
    ComplianceInfo_Partner:
      required:
        - isExtendedUbos
        - maxUbosLayer
        - relatedLayersTotal
      type: object
      properties:
        maxUbosLayer:
          type: integer
          format: int32
        relatedLayersTotal:
          type: integer
          format: int32
        isExtendedUbos:
          type: boolean
    CorporateFinancialInformationResponseDto_Partner:
      title: FinancialInformation
      type: object
      properties:
        expectedMonthlyOutgoingVolume:
          type: string
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        monthlyNetIncome:
          type: string
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingVolume:
          type: string
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    CorporateInfoResponseDto_Partner:
      required:
        - accountPurposes
        - complianceInfo
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - industry
        - registeredAddress
        - registeredName
        - scaDevices
        - status
        - strongAuthentication
        - termsAccepted
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        registeredName:
          type: string
        tradeName:
          type: string
        incorporationCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
        incorporationDate:
          type: string
          format: date
        legalType:
          type: string
          enum:
            - AL_SHOQERI_AKSIONERE_SHA
            - AL_SHOQERI_KOLEKTIVE
            - AL_SHOQERI_KOMANDITE
            - AL_SHOQERI_ME_PERGJEGJESI_TE_KUFIZUAR_SHPK
            - AR_SOCIEDAD_ANONIMA_SA
            - AR_SOCIEDAD_COLECTIVA_SOCCOL
            - AR_SOCIEDAD_DEL_ESTADO_SE
            - AR_SOCIEDAD_DE_CAPITAL_E_INDUSTRIA_SCEI
            - AR_SOCIEDAD_DE_GARANTIA_RECIPROCA_SGR
            - AR_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_SRL
            - AR_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_SCPA
            - AR_SOCIEDAD_EN_COMANDITA_SIMPLE_SCS
            - AT_AKTIENGESELLSCHAFT_AG
            - AT_EINGETRAGENES_EINZELUNTERNEHMEN_EU
            - AT_EUROPEAN_BUSINESS_ENTITIES
            - AT_GENOSSENSCHAFT_GEN
            - AT_GESELLSCHAFT_DES_BURGERLICHEN_RECHTS_GESBR
            - AT_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - AT_KOMMANDITERWERBSGESELLSCHAFT_KEG
            - AT_KOMMANDITGESELLSCHAFT_KG
            - AT_OFFENE_ERWERBSGESELLSCHAFT_OEG
            - AT_OFFENE_GESELLSCHAFT_OG
            - AT_PRIVATSTIFTUNG
            - AT_STILLE_GESELLSCHAFT_STG
            - AT_VEREIN
            - AU_INCORPORATED_INC
            - AU_LIMITED_LTD
            - AU_NO_LIABILITY_NL
            - AU_PROPRIETARY_LIMITED_COMPANY_PTYLTD
            - AU_UNLIMITED_PROPRIETARY_PTY
            - BA_AKCIONARSKO_DRUSTVO_AD
            - BA_DIONICKO_DRUSTVO_DD
            - BA_DRUSTVO_S_NEOGRANICENOM_SOLIDARNOM_ODGOVORNOSCU_DNO
            - BA_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_DOO
            - BA_KOMANDITNO_DRUSTVO_KD
            - BA_SAMOSTALNI_PREDUZETNIK_SP
            - BE_ASSOCIATION_SANS_BUT_LUCRATIF_ASBL
            - BE_BESLOTEN_VENNOOTSCHAP_BV
            - BE_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_BVBA
            - BE_COMMANDITAIRE_VENNOOTSCHAP_OP_AANDELEN_COMMVA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_CVBA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_ONBEPERKTE_AANSPRAKELIJKHEID_CVOA
            - BE_ECONOMISCH_SAMENWERKINGSVERBAND_ESV
            - BE_EENMANSZAAK
            - >-
              BE_EENPERSOONS_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_EBVBA
            - BE_ENTREPRISE_INDIVIDUELLE
            - BE_FEITELIJKE_VERENIGING
            - BE_FONDATION_DUTILITE_PUBLIQUE
            - BE_FONDATION_PRIVEE
            - BE_GEWONE_COMMANDITAIRE_VENNOOTSCHAP_COMMV
            - BE_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - BE_NAAMLOZE_VENNOOTSCHAP_NV
            - BE_PRIVATE_STICHTING
            - BE_SOCIETE_ANONYME_SA
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_ILLIMITEE_SCRI
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_LIMITEE_SCRL
            - BE_SOCIETE_DE_FAIT
            - BE_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - BE_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - BE_SOCIETE_EN_NOM_COLLECTIF_SN
            - BE_SOCIETE_EN_PARTICIPATION_SEP
            - BE_SOCIETE_INTERNE
            - BE_SOCIETE_MOMENTANEE
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_SPRL
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_UNIPERSONNELLE_SPRLU
            - BE_STICHTING_VAN_OPENBAAR_NUT
            - BE_STILLE_HANDELSVENNOOTSCHAP
            - BE_TIJDELIJKE_HANDELSVENNOOTSCHAP
            - BE_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - BE_VEREINIGUNG_OHNE_GEWINNERZIELUNGSABSICHT_VOG
            - BE_VERENIGING_IN_DEELNEMING
            - BE_VERENIGING_ZONDER_WINSTOOGMERK_VZW
            - BG_AKTSIONERNO_DRUJESTVO_AD
            - >-
              BG_AKTSIONERNO_DRUZHESTVO_SUS_SPETSIALNA_INVESTITSIONNA_TSEL_ADSITZ
            - BG_DRUJESTVO_S_OGRANICHENA_OTGOVORNOST_OOD
            - BG_EDNOLICHEN_TURGOVETZ_ET
            - BG_EDNOLICHNO_AKTSIONERNO_DRUZHESTVO_EAD
            - BG_EDNOLICHNO_DRUZHESTVO_S_OGRANICHENA_OTGOVORNOST_EOOD
            - BG_KOMANDITNO_DRUZHESTVO_KD
            - BG_KOMANDITNO_DRUZHESTVO_S_AKTZII_KDA
            - BG_SUBIRATELNO_DRUZHESTVO_SD
            - BN_COMPANY
            - BN_PARTNERSHIP
            - BN_SOLE_PROPRIETORSHIP
            - BR_ASSOCIACAO_EM_SENTIDO_ESTRITO
            - BR_COOPERATIVA
            - BR_EMPRESA_INDIVIDUAL_DE_RESPONSABILIDADE_LIMITADA_EIRELI
            - BR_EMPRESA_INDIVIDUAL_FIRMA_INDIVIDUAL
            - BR_EMPRESA_PUBLICA
            - BR_FUNDACAO_PRIVADA
            - BR_FUNDACAO_PUBLICA
            - BR_MICRO_EMPREENDEDOR_INDIVIDUAL
            - BR_ORGANIZACAO_DA_SOCIEDADE_CIVIL_DE_INTERESSE_PUBLICO
            - BR_ORGANIZACAO_NAO_GOVERNAMENTAL
            - BR_ORGANIZACAO_SOCIAL
            - BR_SERVICOS_SOCIAIS_AUTONOMOS
            - BR_SOCIEDADE_ANONIMA_SA
            - BR_SOCIEDADE_DE_ECONOMIA_MISTA
            - BR_SOCIEDADE_EM_COMANDITA_SIMPLES
            - BR_SOCIEDADE_EM_COMUM
            - BR_SOCIEDADE_EM_CONTA_DE_PARTICIPACAO
            - BR_SOCIEDADE_EM_NOME_COLETIVO
            - BR_SOCIEDADE_LIMITADA_LTDA
            - BR_SOCIEDADE_SIMPLES
            - CA_CORPORATION
            - CA_GENERAL_PARTNERSHIP_GP
            - CA_JOINT_VENTURE
            - CA_LIMITED_PARTNERSHIP_LP
            - CA_SOLE_PROPRIETORSHIP_SP
            - CH_AKTIENGESELLSCHAFT_AG
            - CH_ASSOCIATION
            - CH_ASSOCIAZIONE
            - CH_DITTA_INDIVIDUALE
            - CH_EINFACHE_GESELLSCHAFT_EG
            - CH_EINZELUNTERNEHMEN
            - CH_ENTREPRISE_INDIVIDUELLE
            - CH_FONDATION
            - CH_FONDAZIONE
            - CH_GENOSSENSCHAFT
            - CH_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - CH_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - CH_GRUPPO_DI_INTERESSE_ECONOMICO
            - CH_INVESTMENTGESELLSCHAFT_MIT_FESTEM_KAPITAL
            - CH_INVESTMENTGESELLSCHAFT_MIT_VARIABLEM_KAPITALS
            - CH_INVESTMENT_FUND
            - CH_KOLLEKTIVGESELLSCHAFT_KOLG
            - CH_KOMMANDITAKTIENGESELLSCHAFT_KOMAG
            - CH_KOMMANDITGESELLSCHAFT_KG
            - CH_RAISON_INDIVIDUELLE_RI
            - CH_SOCIETA_ANONIMA_SA
            - CH_SOCIETA_A_GARANZIA_LIMITATA_SAGL
            - CH_SOCIETA_COOPERATIVA
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_FISSO_SICAF
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_VARIABILE_SICAV
            - CH_SOCIETA_IN_ACCOMANDITA
            - CH_SOCIETA_IN_ACCOMANDITA_PER_AZIONI
            - CH_SOCIETA_IN_NOME_COLLETTIVO
            - CH_SOCIETA_SEMPLICE
            - CH_SOCIETE_ANONYME_SA
            - CH_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - CH_SOCIETE_COOPERATIVE
            - CH_SOCIETE_COOPERATIVE_SCOOP
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE_SICAF
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - CH_SOCIETE_EN_COMMANDITE
            - CH_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - CH_SOCIETE_EN_COMMANDITE_SC
            - CH_SOCIETE_EN_NOM_COLLECTIF
            - CH_SOCIETE_EN_NOM_COLLECTIF_SNC
            - CH_SOCIETE_SIMPLE
            - CH_STIFTUNG
            - CH_SUCCURSALE
            - CH_VEREIN
            - CH_WIRTSCHAFTLICHE_INTERESSENGEMEINSCHAFT_WIG
            - CH_ZWEIGNIEDERLASSUNG
            - CL_EMPRESA_INDIVIDUAL_DE_RESPONSABILIDAD_LIMITADA_EIRL
            - CL_SOCIEDAD_ANONIMA_SA
            - CL_SOCIEDAD_DE_GARANTIA_RECIPROCA_SGR
            - CL_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_LTDA
            - CL_SOCIEDAD_POR_ACCIONES_SPA
            - CO_COMANDITA_POR_ACCIONES_SCA
            - CO_COMANDITA_SIMPLE_S_EN_C
            - CO_EMPRESA_UNIPERSONAL_EU
            - CO_SOCIEDADES_POR_ACCIONES_SIMPLIFICAD_SAS
            - CO_SOCIEDAD_ANONIMA_SA
            - CO_SOCIEDAD_COLECTIVA_SC
            - CO_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_LTDA
            - CY_BUSINESS_NAME_SOLE_TRADER
            - CY_LIMITED_LIABILITY_COMPANY_BY_GUARANTEE_WITHOUT_SHARE_CAPITAL
            - CY_LIMITED_LIABILITY_COMPANY_BY_GUARANTEE_WITH_A_SHARE_CAPITAL
            - CY_OVERSEAS_COMPANY
            - CY_PRIVATE_LIMITED_LIABILITY_COMPANY_BY_SHARES_LTD
            - CY_PUBLIC_LIMITED_LIABILITY_COMPANY_BY_SHARES_PLC
            - CY_PRIVATE_LIMITED_COMPANY_LTD
            - CY_PUBLIC_LIMITED_COMPANY_PLC
            - CY_COMPANY_LIMITED_BY_GUARANTEE
            - CY_GENERAL_PARTNERSHIP
            - CY_LIMITED_PARTNERSHIP
            - CY_SOLO_PROPRIETORSHIP
            - CZ_AKCIOVA_SPOLECNOST_AS
            - CZ_KOMANDITNI_SPOLECNOST_KS
            - CZ_OBECNE_PROSPESNA_SPOLECNOST_OPS
            - CZ_PRISPEVKOVA_ORGANIZACE
            - CZ_SPOLECNOST_S_RUCENIM_OMEZENYM_SRO
            - CZ_STATNI_PODNIK_SP
            - CZ_VEREJNA_OBCHODNI_SPOLECNOST_VOS
            - CZ_ZAPSANY_SPOLEK_ZS
            - CZ_ZIVNOST
            - DE_AKTIENGESELLSCHAFT_AG
            - DE_ALTRECHTLICHER_VEREIN_RECHTSFAHIGER_VEREIN_RV
            - DE_ANSTALT_DES_OFFENTLICHEN_RECHTS
            - DE_EINGETRAGENER_KAUFMANN_EINGETRAGENE_KAUFFRAU_EK_EKFM_EKFR
            - DE_EINGETRAGENER_VEREIN_EV
            - DE_EINGETRAGENE_GENOSSENSCHAFT_EG
            - DE_EINZELUNTERNEHMEN
            - DE_GESELLSCHAFT_BURGERLICHEN_RECHTS_BGB_GESELLSCHAFT_GBR
            - DE_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - DE_KOMMANDITGESELLSCHAFT_AUF_AKTIEN_KGAA
            - DE_KOMMANDITGESELLSCHAFT_KG
            - DE_NICHT_EINGETRAGENER_VEREI
            - DE_OFFENE_HANDELSGESELLSCHAFT_OHG
            - DE_PARTENREEDEREI
            - >-
              DE_PARTNERSCHAFTSGESELLSCHAFT_MIT_BESCHRANKTER_BERUFSHAFTUNG_PARTGMBBH
            - DE_PARTNERSCHAFTSGESELLSCHAFT_PARTG
            - DE_STIFTUNG
            - DE_STIFTUNG_DES_OFFENTLICHEN_RECHTS
            - DE_UNTERNEHMERGESELLSCHAFT_UG
            - DE_WIRTSCHAFTLICHER_VEREIN
            - DK_AKTIESELSKAB_A_S
            - DK_ANDELSSELSKAB_MED_BEGRAENSET_ANSVAR_AMBA
            - DK_ANPARTSSELSKAB_APS
            - DK_ENKELTMANDSVIRKSOMHED
            - DK_ERHVERVSDRIVENDE_FOND
            - DK_FORENING
            - DK_FORENING_MED_BEGRAENSET_ANSVAR_FMBA
            - DK_GENSIDIGT_SELSKAB_G_S
            - DK_INTERESSENTSKAB_I_S
            - DK_IVAERKSAETTERSELSKAB_IVS
            - DK_KOMMANDITSELSKAB_K_S
            - DK_PARTNERSELSKAB_OR_KOMMANDITAKTIESELSKAB_P_S
            - DK_PARTSREDERI
            - DK_SELSKAB_MED_BEGRAENSET_ANSVAR_SMBA
            - DO_COMPANIA_POR_ACCIONES_C_POR_A
            - DO_EMPRESA_INDIVIDUAL_DE_RESPONSABILIDAD_LIMITADA_EIRL
            - DO_SOCIEDAD_ANONIMA_SA
            - DO_SOCIEDAD_ANONIMA_SIMPLIFICADA_SAS
            - DO_SOCIEDAD_DE_RESPOSABILIDAD_LIMITADA_SRL
            - DO_SOCIEDAD_EN_COMANDITA_SIMPLE
            - EC_COMPANIA_ANONIMA_CA
            - EC_COMPANIA_LIMITADA_CIA_LTDA
            - EC_EMPRESA_PUBLICA_EP
            - EC_SOCIEDAD_ANONIMA_SA
            - EEA_EUROPEAN_ECONOMIC_INTEREST_GROUPING_EEIG
            - EEA_SOCIETAS_COOPERATIVA_EUROPAEA_SCE
            - EEA_SOCIETAS_EUROPAEA_SE
            - EEA_SOCIETAS_PRIVATA_EUROPAEA_SPE
            - EE_AKTSIASELTS_AS
            - EE_FUUSILISEST_ISIKUST_ETTEVOTJA_FIE
            - EE_MITTETULUNDUSUHING_MTU
            - EE_OSAUHING_OU
            - EE_TAISUHING_TU
            - EE_TULUNDUSUHISTU
            - EE_USALDUSUHING_UU
            - EG_LIMITED_LIABILITY_COMPANY_LLC
            - EG_SHARIKAT_AL_MOSSAHAMAH_SAE
            - EG_SHARIKAT_TADAMUN
            - EG_SHARIKAT_TAWSSIYAH_BASSITA
            - EG_SHARIKAT_TAWSSIYAH_BELASHOM
            - ES_SOCIEDAD_ANONIMA_DEPORTIVA_SAD
            - ES_SOCIEDAD_ANONIMA_SA
            - ES_SOCIEDAD_CIVIL_PRIVADA_SCP
            - ES_SOCIEDAD_COLECTIVA_SC
            - ES_SOCIEDAD_COMANDITARIA_SCRA
            - ES_SOCIEDAD_COOPERATIVA_SCOOP
            - ES_SOCIEDAD_LIMITADA_LABORAL_SLL
            - ES_SOCIEDAD_LIMITADA_NUEVA_EMPRESA_SLNE
            - ES_SOCIEDAD_LIMITADA_SL
            - ET_COOPERATIVE_SOCIETIES_AMHARIC_CS
            - ET_PRIVATE_LIMITED_COMPANY_AMHARIC_PLC
            - ET_PUBLIC_ENTERPRISES_OR_PUBLIC_CORPORATIONS_AMHARIC_PE_OR_PC
            - ET_SHARE_COMPANY_AMHARIC_SC
            - FI_ASUNTO_OSAKEYHTIO
            - FI_AVOIN_YHTIO_AY
            - FI_EUROOPPALAINEN_TALOUDELLINEN_ETUYHTYMA_EEIG
            - FI_EUROOPPAOSUUSKUNTA_SCE
            - FI_EUROOPPAYHTIO_SE
            - FI_JULKINEN_KESKINAINEN_VAKUUTUSYHTIO_JY
            - FI_JULKINEN_OSAKEYHTIO_OYJ
            - FI_KESKINAINEN_KIINTEISTOOSAKEYHTIO
            - FI_KESKINAINEN_VAKUUTUSYHTIO
            - FI_KESKIVEDENKORKEUDEN_MUUTTAMISTA_VARTEN_PERUSTETTU_YHTEISO
            - FI_KOMMANDIITTIYHTIO_KY
            - FI_KUNNALLINEN_LIIKELAITOS
            - FI_LAIVAISANNISTOYHTIO
            - FI_OJITUSYHTEISO
            - FI_OSAKASKUNTA
            - FI_OSAKEYHTIO_OY
            - FI_OSUUSKUNTA_OSK
            - FI_PALISKUNTA
            - FI_REKISTEROITY_PUOLUE_RP
            - FI_REKISTEROITY_YHDISTYS_RY
            - FI_SAANNOSTELY_YHTEISO
            - FI_SAASTOPANKKI
            - FI_SAATIO_RS
            - FI_TIEKUNTA
            - FI_TOIMINIMI_TMI
            - FI_UITTOYHTEISO
            - FI_USKONNOLLINEN_YHDYSKUNTA
            - FI_VALTION_LIIKELAITOS
            - FI_VESIOIKEUDELLINEN_YHTEISO_BODIES_OF_WATER
            - FI_VOLUNTARY_ASSOCIATIONS_CHARTERED_BY_STATUTE_LAW
            - FI_YHTEISALUE
            - FI_YHTEISMETSA
            - FR_ASSOCIATION_DECLAREE
            - FR_ASSOCIATION_NON_DECLAREE
            - FR_AUTO_ENTREPRENEUR
            - FR_ENTREPRISE_INDIVIDUELLE_ENTREPRISE_EN_NOM_PERSONNEL_EI
            - FR_ENTREPRISE_UNIPERSONNELLE_A_RESPONSABILITE_LIMITEE_EURL
            - FR_FOND_COMMUN_DE_PLACEMENT_FCP
            - FR_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - FR_PROFESSION_LIBERAL
            - FR_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - FR_SOCIETE_ANONYME_SA
            - FR_SOCIETES_DEXERCICE_LIBERAL
            - FR_SOCIETE_COOPERATIVE_DE_PRODUCTION_SCOP
            - FR_SOCIETE_DECONOMIE_MIXTE_SEM
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - FR_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - FR_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - FR_SOCIETE_EN_NOM_COLLECTIF_SNC
            - FR_SOCIETE_EN_PARTICIPATION_SEP
            - FR_SOCIETE_PAR_ACTIONS_SIMPLIFIEE_SAS
            - FR_SOCIETE_CIVILE_IMMOBILIERE_SCI
            - FR_U_UNIPERSONNELLE_SAS_SASU
            - GB_CHARITABLE_INCORPORATED_ORGANISATION_CIO
            - GB_COMMUNITY_INTEREST_COMPANY_CIC
            - GB_GENERAL_PARTNERSHIP
            - GB_INDUSTRIAL_AND_PROVIDENT_SOCIETY
            - GB_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - GB_LIMITED_PARTNERSHIP_LP
            - GB_PRIVATE_COMPANY_LIMITED_BY_GUARANTEE_LTD
            - GB_PRIVATE_COMPANY_LIMITED_BY_SHARES_LTD
            - GB_PUBLIC_LIMITED_COMPANY_PLC
            - GB_SOLE_PROPRIETORSHIP
            - GB_UNLIMITED_COMPANY
            - GR_ANONIMI_ETERIA_AE
            - GR_ANONIMI_VIOMIHANIKI_EMBORIKI_ETERIA_AVEE
            - GR_ETERIA_PERIORISMENIS_EUTHINIS_EPE
            - GR_ETERORITHMI_ETERIA_EE
            - GR_IDIOTIKI_KEFALEOUHIKI_ETERIA_IKE
            - GR_MONOPROSOPI_ETERIA_PERIORISMENIS_EUTHINIS_MEPE
            - GR_OMORITHMI_ETERIA_OE
            - GR_OMORITHMI_VIOMIHANIKI_EMBORIKI_ETERIA_OVEE
            - GT_SOCIEDAD_ANONIMA_S_A
            - GT_SOCIEDAD_COLECTIVA_Y_CIA_S_C
            - GT_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_CIA_LTDA
            - GT_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_CIA_S_C_A
            - GT_SOCIEDAD_EN_COMANDITA_SIMPLE_Y_CIA_S_EN_C
            - HR_DIONICKO_DRUSTVO_DD
            - HR_DOMACA_RADINOST_AND_SPOREDNO_ZANIMANJE
            - HR_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_DOO
            - HR_GOSPODARSKO_INTERESNO_UDRUZENJE_GIU
            - HR_JAVNO_TRGOVACKO_DRUSTVO_JTD
            - HR_JEDNOSTAVNO_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_JDOO
            - HR_KOMANDITNO_DRUSTVO_KD
            - HR_OBITELJSKO_POLJOPRIVREDNO_GOSPODARSTVO_OPG
            - HR_OBRT
            - HR_ORTAKLUK
            - HR_SLOBODNA_DJELATNOST
            - HR_ZADRUGA
            - HT_SOCIEDAD_ANONIMA_SA
            - HU_BETETI_TARSASAG_BT
            - HU_EGYENI_CEG_EC
            - HU_EGYENI_VALLALKOZO_EV
            - HU_EGYESULES
            - HU_KORLATOLT_FELELOSSEGU_TARSASAG_KFT
            - HU_KOZHASZNU_TARSASAG_KHT
            - HU_KOZKERESETI_TARSASAG_KKT
            - HU_KOZOS_VALLALAT_KV
            - HU_NYILVANOSAN_MUKODO_RESZVENYTARSASAG_NYRT
            - HU_RESZVENYTARSASAG_RT
            - HU_SZOVETKEZET_SZOV
            - HU_ZARTKOZUEN_MUKODO_RESZVENYTARSASAG_ZRT
            - ID_FIRMA_FA
            - ID_KOPERASI
            - ID_MAATSCHAP_PERSEKUTUAN_PERDATA
            - ID_PERJAN_PERUSAHAAN_JAWATAN
            - ID_PERSEKUTUAN_KOMANDITER
            - ID_PERSERO
            - ID_PERSEROAN_TERBATAS_PT
            - ID_PERSEROAN_TERBATAS_TERBUKA_OR_PERSEROAN_TERBUKA_PT_TBK
            - ID_PERUM_PERUSAHAAN_UMUM
            - ID_USAHA_DAGANG_UD
            - ID_YAYASAN
            - IE_A_PUBLIC_LIMITED_COMPANY
            - IE_COMPANY_LIMITED_BY_GUARANTEE_HAVING_A_SHARE_CAPITAL
            - IE_COMPANY_LIMITED_BY_GUARANTEE_NOT_HAVING_A_SHARE_CAPITAL
            - IE_PRIVATE_COMPANY_LIMITED_BY_SHARES
            - IE_SINGLE_MEMBER_COMPANY
            - >-
              IE_UNDERTAKINGS_FOR_COLLECTIVE_INVESTMENT_IN_TRANSFERABLE_SECURITIES_UCITS
            - IE_UNLIMITED_COMPANY
            - IL_BEERAVON_MUGBA_BM
            - IL_COOPERATIVE
            - IL_FOREIGN_COMPANY_BRANCH
            - IL_NON_PROFIT_ORGANIZATION
            - IL_PARTNERSHIP
            - IL_PRIVATE_COMPANY
            - IL_PUBLIC_COMPANY
            - IL_SELF_EMPLOYED
            - IN_COOPERATIVE
            - IN_DORMANT_COMPANY
            - IN_FAMILY_OWNED_BUSINESS
            - IN_HINDU_UNDIVIDED_FAMILY_HUF
            - IN_INCORPORATED_COMPANY
            - IN_LIMITED_LIABILITY_PARTNERSHIP
            - IN_ONE_PERSON_COMPANY
            - IN_PARTNERSHIP
            - IN_PRIVATE_LIMITED_COMPANY_PVT_LTD
            - IN_PUBLIC_LIMITED_COMPANY_LTD
            - IN_PUBLIC_SECTOR_UNDERTAKING_PSU
            - IN_REGISTRATION_NOT_REQUIRED
            - IN_SMALL_COMPANY
            - IN_SOLE_PROPRIETORSHIP
            - IN_UNLIMITED_COMPANY
            - IR_SHERKAT_BA_MASOULIYAT_MAHDOUD
            - IR_SHERKAT_MOKHTALET_GHEYR_SAHAMI
            - IR_SHERKAT_MOKHTALET_SAHAMI
            - IR_SHERKAT_NESBI
            - IR_SHERKAT_SAHAMI_AM
            - IR_SHERKAT_SAHAMI_KHAS
            - IR_SHERKAT_TAZAMONI
            - IR_SHERKAT_TA_AVONI_TOLID_VA_MASRAF
            - IS_EINKAHLUTAFELAG_EHF
            - IS_EINSTAKLINGSFYRIRTAEKI
            - IS_HLUTAFELAG_HF
            - IS_OPINBERT_HLUTAFELAG_OHF
            - IS_SAMEIGNARFELAG_SF
            - IS_SAMLAGSFELAG
            - IS_SAMVINNUFELAG
            - IS_SJALFSEIGNARSTOFNUN
            - IT_ARTIGIANO
            - IT_IMPRENDITORE
            - IT_LAVORATORE_AUTONOMO
            - IT_LIBERO_PROFESSIONISTA
            - IT_SOCIETA_A_RESPONSABILITA_LIMITATA_SRL
            - IT_SOCIETA_COOPERATIVA_A_RESPONSABILITA_LIMITATA_SCRL
            - IT_SOCIETA_IN_ACCOMANDITA_PER_AZIONI_SAPA
            - IT_SOCIETA_IN_ACCOMANDITA_SEMPLICE_SAS
            - IT_SOCIETA_IN_NOME_COLLETTIVO_SNC
            - IT_SOCIETA_PER_AZIONI_SPA
            - IT_SOCIETA_SEMPLICE_SS
            - JO_FOREIGN_COMPANY
            - JO_LIMITED_LIABILITY
            - JO_LIMITED_LIABILITY_IN_SHARES
            - JO_PARTNERSHIP
            - JO_PRIVATE_SHAREHOLDING_COMPANIES
            - JO_PUBLIC_SHAREHOLDING
            - JP_GODO_KAISHA_GK
            - JP_GOMEI_KAISHA_GMK
            - JP_GOSHI_KAISHA_GSK
            - JP_KABUSHIKI_KAISHA_KK
            - JP_NINI_KUMIAI_NK
            - JP_TOKUMEI_KUMIAI_TK
            - JP_TOSHI_JIGYO_YUGEN_SEKININ_KUMIAI
            - JP_YUGEN_KAISHA_YK
            - JP_YUGEN_SEKININ_JIGYO_KUMIAI
            - KH_GENERAL_PARTNERSHIP_GP
            - KH_IMPORT_EXPORT_CO_LTD
            - KH_LIMITED_PARTNERSHIP_LP
            - KH_PRIVATE_LIMITED_COMPANY_PTE_LTD
            - KH_PUBLIC_ESTABLISHMENT_WITH_ECONOMIC_CHARACTERISTICS_PEEC
            - KH_PUBLIC_LIMITED_COMPANY_PLC_LTD
            - KH_SINGLE_MEMBER_PRIVATE_LIMITED_COMPANY_SM
            - KH_SOLE_PROPRIETORSHIP_SP
            - KH_STATE_COMPANY
            - KH_STATE_JOINT_VENTURE_COMPANY
            - KR_HAPJA_HOESA
            - KR_HAPMYEONG_HOESA
            - KR_JUSIK_HOESA
            - KR_YUHAN_HOESA
            - KZ_AKTSIONERNOE_OBSCHESTVO_AO
            - KZ_GOSUDARSTVENOE_PREDPRIYATIE_GP
            - KZ_KOMANDITNOE_TOVARISHCHESTVO_KT
            - KZ_OBSHESTVENNOE_OBEDINENIE_OO
            - KZ_POLNOE_TOVARISHCHESTVO_PT
            - KZ_POTREBIBITELSKII_KOOPERATIV_PTK
            - KZ_PROIZVODSTVENNI_KOOPERATIV_PRK
            - KZ_RELITIOZNOE_OBEDINENIE_PO
            - KZ_TOVARISHCHESTVO_S_DOPOLNITELNOYU_OTVETSTVENNOSTYU_TDO
            - KZ_TOVARISHCHESTVO_S_OGRANICHENNOY_OTVETSTVENNOSTYU_TOO
            - KZ_UCHREZHDENIE_UCHR
            - LB_BRANCH_OF_FOREIGN_COMPANY
            - LB_HOLDING_COMPANY
            - LB_OFFSHORE_COMPANY
            - LB_REPRESENTATIVE_OFFICE
            - LB_SOCIETE_ANONYME_LIBANAISE_SAL
            - LB_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - LB_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - LB_SOCIETE_EN_NOM_COLLECTIF_SNC
            - LI_AKTIENGESELLSCHAFT_AG
            - LI_ANSTALT
            - LI_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - LI_STIFTUNG
            - LI_TREUHANDSC_TREUUNTERNEHMEN_HAFT
            - LT_AKCINE_BENDROVE_AB
            - LT_INDIVIDUALI_IMONE_II
            - LT_INDIVIDUALI_VEIKLA
            - LT_KOMANDITINE_UKINE_BENDRIJA_KUB
            - LT_MAZOJI_BENDRIJA_MB
            - LT_TIKROJI_UKINE_BENDRIJA_TUB
            - LT_UZDAROJI_AKCINE_BENDROVE_UAB
            - LT_VIESOJI_ISTAIGA_VSI
            - LU_SOCIETE_ANONYME_SA
            - LU_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - LU_SOCIETE_EN_COMMANDITE_SIMPLE_SECS
            - LV_AKCIJU_SABIEDRIBA_AS
            - LV_ARZEMJU_KOMERSANTA_FILIALE_AKF
            - LV_BEZPELNAS_ORGANIZACIJA_BO
            - LV_INDIVIDUALAIS_KOMERSANTS_IK
            - LV_KOMANDITSABIEDRIBA_KS
            - LV_PILNSABIEDRIBA_PS
            - LV_SABIEDRIBA_AR_IEROBEZOTU_ATBILDIBU_SIA
            - MA_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - MA_SOCIETE_ANONYME_SA
            - MA_SOCIETE_ANONYME_SIMPLIFIEE_SAS
            - MA_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - MA_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - MA_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - MA_SOCIETE_EN_NOM_COLLECTIF_SNC
            - MC_ASSOCIATION
            - MC_FONDATION
            - MC_SOCIETE_ANONYME_MONEGASQUE_SAM
            - MC_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - MC_SOCIETE_EN_NOM_COLLECTIF_SNC
            - MC_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - MC_ENTREPRISE_INDIVIDUELLE_EI
            - MC_SUCCURSALE
            - MC_SOCIETE_CIVILE_IMMOBILIERE_SCI
            - ME_AKCIONARSKO_DRUSTVO_AD
            - ME_DIO_STRANOG_DRUSTVA
            - ME_DRUSTVO_SA_OGRANICENOM_ODGOVORNOSCU_DOO
            - ME_KOMANDITNO_DRUSTVO_KD
            - ME_ORTACKO_DRUSTVO_OD
            - ME_PREDUZETNIK
            - MK_AKCIONERSKO_DRUSTVO_AD
            - MK_DRUSTVO_SO_OGRANICENA_ODGOVORNOST_DOO
            - MK_DRUSTVO_SO_OGRANICENA_ODGOVORNOST_OD_EDNO_LICE_DOOEL
            - MK_JAVNO_TRGOVSKO_DRUSTVO_JTD
            - MK_KOMANDITNO_DRUSTVOO_KD
            - MK_KOMANDITNO_DRUSTVO_SO_AKCIE_KDA
            - MN_KHUVITSAAT_KOMPANI_XK
            - MN_KHYAZGAARLAGDMAL_KHARIUTSLAGATAI_KOMPANI_XXK
            - MN_TERIIN_VUS_VAIGRUULLAGA_TBB
            - MT_PRIVATE_LIMITED_COMPANY
            - MT_PUBLIC_LIABILITY_COMPANY
            - MT_PARTNERSHIP_EN_NOM_COLLECTIF
            - MT_PARTNERSHIP_EN_COMMANDITE
            - MT_LIMITED_LIABILITY_COMPANY_LLC
            - MT_BRANCHES_OF_OVERSEA_COMPANIES
            - MT_GENERAL_PARTNERSHIPS
            - MT_LIMITED_PARTNERSHIPS
            - MX_PERSONA_FISICA
            - MX_SOCIEDAD_ANONIMA_BURSATIL_SAB
            - MX_SOCIEDAD_ANONIMA_PROMOTORA_DE_INVERSION_SAPI
            - MX_SOCIEDAD_ANONIMA_SA
            - MX_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_S_DE_RL
            - MX_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_S_EN_C_POR_A
            - MX_SOCIEDAD_EN_COMANDITA_SIMPLE_S_EN_C
            - MX_SOCIEDAD_EN_NOMBRE_COLECTIVO
            - MY_BERHAD_BHD
            - MY_PLT_PLT
            - MY_SENDIRIAN_BERHAD_SDN_BHD
            - NA_CLOSE_CORPORATION
            - NA_COMPANIES
            - NA_CO_OPERATIVES
            - NA_PARTNERSHIP
            - NA_SOLE_TRADER
            - NA_TRUSTS
            - NG_LIMITED_BY_GUARANTEE_LTD_GTE
            - NG_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - NG_PRIVATE_LIMITED_COMPANY_LTD
            - NG_PUBLIC_LIMITED_COMPANY_PLC
            - NG_UNLIMITED_ULTD
            - NI_SOCIEDAD_ANONIMA_SA
            - NI_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_SCA
            - NI_SOCIEDAD_EN_COMANDITA_SIMPLE_SCS
            - NI_SOCIEDAD_EN_NOMBRE_COLECTIVO_CIA
            - >-
              NI_SOCIEDAD_EN_NOMBRE_COLECTIVO_DE_RESPONSABILIDAD_LIMITADA_CIA_LTDA
            - NL_BEPERKTE_AANSPRAKELIJKHEID_BA
            - NL_BESLOTEN_VENNOOTSCHAP_BV
            - NL_COMMANDITAIRE_VENNOOTSCHAP_CV
            - NL_COOPERATIE
            - NL_EENMANSZAAK
            - NL_MAATSCHAP_MTS
            - NL_NAAMLOZE_VENNOOTSCHAP_NV
            - NL_ONDERLINGE_WAARBORGMAATSCHAPPIJ
            - NL_STICHTING
            - NL_UITSLUITING_VAN_AANSPRAKELIJKHEID_UA
            - NL_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - NL_WETTELIJKE_AANSPRAKELIJKHEID_WA
            - NO_AKSJESELSKAP_AS
            - NO_ALLMENNAKSJESELSKAP_ASA
            - NO_ANSVARLIG_SELSKAP_ANS
            - NO_BORETTSLAG_BL
            - NO_ENKELTPERSONFORETAK
            - NO_FYLKESKOMMUNALT_FORETAK_FKF
            - NO_HELSEFORETAK_HF
            - NO_INTERKOMMUNALT_SELSKAP_IKS
            - NO_KOMMANDITTSELSKAP_KS
            - NO_KOMMUNALT_FORETAK_KF
            - NO_NORSKREGISTRERT_UTENLANDSK_FORETAK_NUF
            - NO_REGIONALT_HELSEFORETAK_RHF
            - NO_SELSKAP_MED_BEGRENSET_ANSVAR_BA
            - NO_SELSKAP_MED_DELT_ANSVAR_DA
            - NO_SPAREBANK_SAVINGS_BANK
            - NO_STATE_COUNTY_OR_MUNICIPAL_AGENCY_ETAT
            - NO_STATSFORETAK_SF
            - NO_STIFTELSE
            - NP_BRANCH
            - NP_PRIVATE_LIMITED_COMPANY
            - NZ_LIMITED_LTD
            - NZ_LOOK_THROUGH_COMPANY
            - OM_SOCIETE_ANONYME_OMANAISE_CLOSE_SAOC
            - OM_SOCIETE_ANONYME_OMANAISE_GENERALE_SAOG
            - OTHER
            - PE_SOCIEDAD_ANONIMA_ABIERTA_SAA
            - PE_SOCIEDAD_ANONIMA_SA
            - PH_COMPANIA_CIA
            - PH_COMPANY_CO
            - PH_COOPERATIVE_COOP
            - PH_CORPORATION_CORP
            - PH_ENTERPRISE_ENT
            - PH_INCORPORATED_INC
            - PH_LIMITED_COMPANY_LTD_CO
            - PH_LIMITED_LIABILITY_COMPANY_LLC
            - PH_LIMITED_LTD
            - PH_SOCIEDAD_ANONIMA_SA
            - PK_COMPANY
            - PK_PARTNERSHIP
            - PK_SOLE_PROPRIETORSHIP
            - PL_JEDNOOSOBOWA_DZIALALNOSC_GOSPODARCZA
            - PL_PRZEDSIEBIORSTWO_PANSTWOWE
            - PL_SPOLDZIELNIA
            - PL_SPOLKA_AKCYJNA_SA
            - PL_SPOLKA_CYWILNA_SC
            - PL_SPOLKA_JAWNA_SPJ
            - PL_SPOLKA_KOMANDYTOWA_SPK
            - PL_SPOLKA_KOMANDYTOWO_AKCYJNA_SKA
            - PL_SPOLKA_PARTNERSKA_SPP
            - PL_SPOLKA_Z_OGRANICZONA_ODPOWIEDZIALNOSCIA_SP_Z_OO
            - PT_COOPERATIVA_DE_RESPONSABILIDADE_LIMITADA_CRL
            - PT_LIMITADA_LDA
            - PT_SOCIEDADE_ABERTA_SA
            - PT_SOCIEDADE_FECHADA_SF
            - PT_SOCIEDADE_GESTORA_DE_PARTICIPACOES_SOCIAIS_SGPS
            - RO_ORGANIZATIE_NON_GUVERNAMENTALA_ONG
            - RO_PERSOANA_FIZICA_AUTORIZATA_PFA
            - >-
              RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_CU_PROPRIETAR_UNIC_SRL_CU_PROPRIETAR_UNIC
            - RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATEA_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATEA_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATEA_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATEA_PE_ACTIUNI_SA
            - RO_SOCIETATE_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATE_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATE_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATE_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATE_PE_ACTIUNI_SA
            - RS_AKCIONARSKO_DRUSTVO_AD
            - RS_DRUSTVO_SA_OGRANICENOM_ODGOVORNOSCU_DOO
            - RS_JAVNO_PREDUZECE_JP
            - RS_KOMANDITNO_DRUSTVO_KD
            - RS_ORTACKO_DRUSTVO_OD
            - RS_PREDUZETNIK
            - RU_AKTSIONERNOYE_OBSHCHESTVO_AO
            - RU_GOSUDARSTVENNOYE_UNITARNOYE_PREDPRIYATIE_GP_GUP
            - RU_HOZYAYSTVENNOE_PARTNERSTVO
            - RU_INDIVIDUALNY_PREDPRINIMATEL_IP
            - RU_KOMMANDITNOE_TOVARISHESTVO
            - RU_KOOPERATIV
            - RU_NEKOMMERCHESKAYA_ORGANIZATSIYA
            - RU_OBSHCHESTVO_S_OGRANICHENNOY_OTVETSTVENNOSTYU_OOO
            - RU_PROSTOYE_TOVARISHESTVO
            - RU_PUBLICHNOYE_AKTSIONERNOYE_OBSHCHESTVO_PAO
            - SA_FOREIGN_COMPANY
            - SA_GENERAL_PARTNERSHIP_COMPANY
            - SA_INDIVIDUAL_ESTABLISHMENT
            - SA_JOINT_STOCK_COMPANY
            - SA_LIMITED_PARTNERSHIP
            - SA_PRIVATE_LIMITED_COMPANY
            - SE_AKTIEBOLAG_AB
            - SE_BOSTADSRATTSFORENING
            - SE_EKONOMISK_FORENING_EK_FOR
            - SE_ENKELT_BOLAG
            - SE_ENSKILD_FIRMA
            - SE_HANDELSBOLAG_HB
            - SE_HYRESRATTSFORENING
            - SE_IDEELL_FORENING
            - SE_KOMMANDITBOLAG_KB
            - SE_KOOPERATIV
            - SE_PUBLIKT_AKTIEBOLAG_AB_PUBL
            - SE_STIFTELSE
            - SG_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - SG_PRIVATE_LIMITED_COMPANY_SENDIRIAN_BERHAD_PTE_LTD_SDN_BHD
            - SG_PTE_EXIST
            - SG_PUBLIC_LIMITED_COMPANY_BERHAD_LTD_BHD
            - SG_SINGAPORE_SUBSIDIARY_COMPANY
            - SI_DELNISKA_DRUZBA_DD
            - SI_DRUZBA_Z_NEOMEJENO_ODGOVORNOSTJO_DNO
            - SI_DRUZBA_Z_OMEJENO_ODGOVORNOSTJO_DOO
            - SI_KOMANDITNA_DRUZBA_KD
            - SI_SAMOSTOJNI_PODJETNIK_SP
            - SK_AKCIOVA_SPOLOCNOST_AS
            - SK_DRUZSTVO
            - SK_KOMANDITNA_SPOLOCNOST_KS
            - SK_SPOLOCNOST_S_RUCENIM_OBMEDZENYM_SRO
            - SK_VEREJNA_OBCHODNA_SPOLOCNOST_VOS
            - SK_ZIVNOST
            - TN_ENTREPRISE_INDIVIDUELLE
            - TN_SOCIETE_ANONYME_SA
            - TN_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - TN_SOCIETE_UNIPERSONNELLE_A_RESPONSABILITE_LIMITEE_SUARL
            - TR_ADI_SIRKET
            - TR_ANONIM_ORTAKLIK_AO
            - TR_ANONIM_SIRKET_AS
            - TR_HALKA_ACIK_ANONIM_ORTAKLIK_HAAO
            - TR_IRTIBAT_BUROSU
            - TR_KOLEKTIF_SIRKET_KOLL_STI
            - TR_KOMANDIT_SIRKET_KOM_STI
            - TR_KOOPERATIF_SIRKET_KOOP
            - TR_LIMITED_ORTAKLIK_LO
            - TR_LIMITED_SIRKET_LS
            - TR_LIMITED_SIRKET_LTD_STI
            - TR_SAHIS_FIRMASI
            - TR_SUBE_SB
            - TW_LIMITED_COMPANY
            - TW_LIMITED_PARTNERSHIP
            - TW_PUBLIC_LIMITED_COMPANY_OR_CORPORATION
            - TW_UNLIMITED_COMPANY
            - UA_AKTSIONERNE_TOVARYSTVO_AT_AT
            - UA_COMANDYTNE_TOVARYSTVO_KT
            - UA_DERZHAVNE_AKTSIONERNE_TOVARYSTVO_DAT
            - UA_F_O_P_FOP
            - UA_POVNE_TOVARYSTVO_PT
            - UA_PRYVATNE_PIDPRYIEMSTVO_PP
            - UA_TOVARYSTVO_Z_DODATKVOIU_VIDPOVIDALNISTIU_TDV
            - UA_TOVARYSTVO_Z_OBMEZHENOIU_VIDPOVIDALNISTIU_TOV
            - UA_VIDKRYTE_AKTSIONERNE_TOVARYSTV_VAT
            - UA_ZAKRYTE_AKTSIONERNE_TOVARYSTVO_ZAT
            - US_DOING_BUSINESS_AS
            - US_FEDERAL_CREDIT_UNION
            - US_GENERAL_PARTNERSHIP
            - US_INC_CORPORATION_INCORPORATED_CORP
            - US_LIMITED_LIABILITY_COMPANY_LLC_LC_LTDCO
            - US_LIMITED_LIABILITY_LIMITED_PARTNERSHIP_LLLP
            - US_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - US_LIMITED_PARTNERSHIP_LP
            - US_NATIONAL_ASSOCIATION_NA
            - US_NATIONAL_TRUST_AND_SAVINGS_ASSOCIATION_NT_SA
            - US_PROFESSIONAL_CORPORATION_PC
            - US_PROFESSIONAL_LIMITED_LIABILITY_COMPANY_PLLC
            - US_SOLE_PROPRIETORSHIP
            - UZ_AKSIYADORLIK_JAMIYATI_AJ
            - UZ_MASULIYATI_CHEKLANGAN_JAMIYAT_MCHJ
            - UZ_OCHIQ_AKSIYADORLIK_JAMIYATI_OAJ
            - UZ_OILAVIY_KORXONA_OK
            - UZ_QOSHIMCHA_MASULIYATLI_JAMIYAT_QMJ
            - UZ_QOSHMA_KORXONA_QK
            - UZ_UNITAR_KORXONA_UK
            - UZ_XUSUSIY_KORXONA_XK
            - UZ_XUSUSIY_TADBIRKORLIK_XT
            - UZ_YOPIQ_AKSIYADORLIK_JAMIYATI_YOAJ
            - VN_CHI_NHANH
            - VN_CONG_TY_CO_PHAN_CTY_CP
            - VN_CONG_TY_HOP_DANH
            - VN_CONG_TY_NHOM_CTY
            - VN_CONG_TY_TRACH_NHIEM_HUU_HAN_CTY_TNHH
            - VN_CONG_TY_TRACH_NHIEM_HUU_HAN_MOT_THANH_VIEN_CTY_TNHH_MTV
            - VN_DOANH_NGHIEP_CO_VON_DAU_TU_NUOC_NGOAI_DTNN
            - VN_DOANH_NGHIEP_HOP_DANH
            - VN_DOANH_NGHIEP_NHA_NUOC_DNNN
            - VN_DOANH_NGHIEP_TU_NHAN_DNTN
            - VN_HOP_TAC_XA_HTX
            - ZA_BUSINESS_TRUST
            - ZA_CLOSE_CORPORATION_CC_BK
            - ZA_COMPANY_LIMITED_BY_GUARANTEE
            - ZA_INCORPORATED_ASSOCIATION_NOT_FOR_GAIN
            - ZA_PARTNERSHIP
            - ZA_PRIVATE_COMPANY
            - ZA_PUBLIC_COMPANY
            - ZA_SOLE_PROPRIETORSHIP
            - ZA_UNLIMITED_LIABILITY_COMPANY
        website:
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        vatNumber:
          type: string
        registeredAddress:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        businessAddress:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        employeesRange:
          type: string
          enum:
            - BTW_1_AND_10
            - BTW_11_AND_50
            - MORE_THAN_50
        financialInformation:
          $ref: >-
            #/components/schemas/CorporateFinancialInformationResponseDto_Partner
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        complianceInfo:
          $ref: '#/components/schemas/ComplianceInfo_Partner'
        termsAccepted:
          type: boolean
        strongAuthentication:
          $ref: '#/components/schemas/ScaDeviceInfoResponseDto_Partner'
        scaDevices:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ScaDeviceInfoDto_Partner'
        notes:
          type: string
          description: Public additional information concerning this entity.
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/CorporateStatusResponseDto_Partner'
        partnerMetadata:
          title: Metadata
          type: object
        userMetadata:
          title: Metadata
          type: object
      description: The complete corporate information.
    ScaDeviceInfoDto_Partner:
      required:
        - creationDate
        - id
        - status
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - CREATED
            - AWAITING_ACTIVATION
            - ACTIVE
            - SUSPENDED
            - REMOVED
        creationDate:
          type: string
          format: date-time
        name:
          type: string
        platform:
          type: string
        deviceInfo:
          type: string
    ScaDeviceInfoResponseDto_Partner:
      title: ScaDeviceInfo
      required:
        - biometryStatus
        - creationDate
        - endpointId
        - id
        - pinStatus
      type: object
      properties:
        id:
          type: string
          format: uuid
        endpointId:
          type: string
        creationDate:
          type: string
          format: date-time
        pinStatus:
          type: string
          enum:
            - SET
        biometryStatus:
          type: string
          enum:
            - SET
    CorporateRelatedCorporateListElement_Partner:
      required:
        - corporate
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - position
        - registeredName
        - totalSharePercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        position:
          $ref: '#/components/schemas/Position_Partner'
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        totalSharePercentage:
          type: number
          format: float
        registeredName:
          type: string
          description: The official corporate name. Must only contains Latin-1 characters.
        tradeName:
          type: string
          description: >-
            The name used for business if there is one. Must only contains
            Latin-1 characters.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        website:
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        registeredAddress:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Partner'
    CorporateRelatedListElementDto_Partner:
      required:
        - corporate
        - creationDate
        - id
        - position
        - totalSharePercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        externalId:
          type: string
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Partner'
        totalSharePercentage:
          type: number
          format: float
        position:
          $ref: '#/components/schemas/Position_Partner'
      anyOf:
        - $ref: >-
            #/components/schemas/CorporateRelatedPhysicalPersonListElement_Partner
        - $ref: '#/components/schemas/CorporateRelatedCorporateListElement_Partner'
    CorporateRelatedPhysicalPersonListElement_Partner:
      required:
        - corporate
        - creationDate
        - id
        - kycInfo
        - position
        - totalSharePercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        address:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Partner'
        emailAddress:
          type: string
        kycInfo:
          $ref: '#/components/schemas/KycInfoResponseDto_Partner'
        position:
          $ref: '#/components/schemas/PhysicalPersonPosition_Partner'
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        totalSharePercentage:
          type: number
          format: float
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Partner'
    CorporateShortInfoResponseDto_Partner:
      required:
        - id
        - registeredName
      type: object
      properties:
        id:
          type: string
          format: uuid
        tradeName:
          type: string
        registeredName:
          type: string
    KycInfoResponseDto_Partner:
      required:
        - status
        - type
      type: object
      properties:
        kycApplicationId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        statusReason:
          type: string
        type:
          type: string
          enum:
            - FULL_KYC
            - DOC_ONLY
            - NOT_REQUIRED
        updateDate:
          type: string
          format: date-time
    ListResponseDtoCorporateRelatedListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CorporateRelatedListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    PhoneInfoResponseDto_Partner:
      required:
        - verified
      type: object
      properties:
        countryCode:
          type: string
        number:
          type: string
        verified:
          type: boolean
        verificationDate:
          type: string
          format: date-time
    PhysicalPersonPosition_Partner:
      required:
        - isAccountOwner
        - isDirector
        - isSpecialUbo
        - isUbo
      type: object
      properties:
        isAccountOwner:
          type: boolean
          description: Indicates if this is the person who manage the corporate account.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        isUbo:
          type: boolean
          description: >-
            Indicates if this person owns more than 25% of the corporate
            end-user shares (10% if the corporate required extended UBOs) or
            isSpecialUbo.
        isSpecialUbo:
          type: boolean
          description: >-
            Indicates whether this person was designated UBO because no
            shareholder holds the percentage of shares required to become one.
    Position_Partner:
      required:
        - isDirector
      type: object
      properties:
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
    CorporateRelatedCorporate_Partner:
      required:
        - corporate
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - position
        - registeredName
        - shares
        - totalSharesPercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        registeredName:
          type: string
        tradeName:
          type: string
        incorporationCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
        website:
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        registeredAddress:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        externalId:
          type: string
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Partner'
        shares:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CorporateShareResponseDto_Partner'
        totalSharesPercentage:
          type: number
          format: float
        notes:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        position:
          $ref: '#/components/schemas/Position_Partner'
    CorporateRelatedInfoResponseDto_Partner:
      type: object
      description: Information about this corporate-related entity.
      anyOf:
        - $ref: '#/components/schemas/CorporateRelatedPhysicalPerson_Partner'
        - $ref: '#/components/schemas/CorporateRelatedCorporate_Partner'
    CorporateRelatedPhysicalPerson_Partner:
      required:
        - corporate
        - creationDate
        - email
        - id
        - isPep
        - kycInfo
        - position
        - shares
        - totalSharesPercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Partner'
        shares:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CorporateShareResponseDto_Partner'
        address:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Partner'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        email:
          $ref: '#/components/schemas/EmailInfoResponseDto_Partner'
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        birthDate:
          type: string
          format: date
        kycInfo:
          $ref: '#/components/schemas/KycInfoResponseDto_Partner'
        notes:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        position:
          $ref: '#/components/schemas/PhysicalPersonPosition_Partner'
        isPep:
          type: boolean
          description: Indicates whether this person is a politically exposed person.
        totalSharesPercentage:
          type: number
          format: float
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        pep:
          type: boolean
          writeOnly: true
    CorporateShareResponseDto_Partner:
      required:
        - directSharesPercentage
        - finalSharesPercentage
        - id
        - layer
      type: object
      properties:
        id:
          type: string
          format: uuid
        ownedCorporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Partner'
        directSharesPercentage:
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
        finalSharesPercentage:
          type: number
          description: Percentage of the corporate end-user held.
          format: float
        layer:
          type: integer
          format: int32
    EmailInfoResponseDto_Partner:
      required:
        - verified
      type: object
      properties:
        address:
          type: string
        verified:
          type: boolean
        verificationDate:
          type: string
          format: date-time
    ConsumerListElementDto_Partner:
      required:
        - creationDate
        - id
        - phone
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Partner'
        firstName:
          type: string
        lastName:
          type: string
        emailAddress:
          type: string
        status:
          $ref: '#/components/schemas/ConsumerStatusResponseDto_Partner'
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
    ConsumerStatusResponseDto_Partner:
      title: ConsumerStatus
      required:
        - banking
        - compliance
        - kyc
        - linkcy
        - overall
        - suspension
      type: object
      properties:
        banking:
          $ref: '#/components/schemas/EndUserBanking_Partner'
        kyc:
          $ref: '#/components/schemas/Kyc_Partner'
        suspension:
          $ref: '#/components/schemas/EndUserSuspension_Partner'
        linkcy:
          $ref: '#/components/schemas/EndUserLinkcy_Partner'
        compliance:
          $ref: '#/components/schemas/EndUserCompliance_Partner'
        overall:
          $ref: '#/components/schemas/Overall_Partner'
    Kyc_Partner:
      title: Kyc
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        reason:
          type: string
    ListResponseDtoConsumerListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ConsumerListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    ConsumerFinancialInformationResponseDto_Partner:
      title: FinancialInformation
      type: object
      properties:
        monthlyNetIncome:
          type: string
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        expectedMonthlyIncomingVolume:
          type: string
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyOutgoingVolume:
          type: string
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    ConsumerInfoResponseDto_Partner:
      required:
        - accountPurposes
        - creationDate
        - email
        - id
        - kycInfo
        - phone
        - scaDevices
        - status
        - strongAuthentication
        - termsAccepted
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Partner'
        kycInfo:
          $ref: '#/components/schemas/KycInfoResponseDto_Partner'
        status:
          $ref: '#/components/schemas/ConsumerStatusResponseDto_Partner'
        termsAccepted:
          type: boolean
        address:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        email:
          $ref: '#/components/schemas/EmailInfoResponseDto_Partner'
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        birthDate:
          type: string
          format: date
        sourceOfFunds:
          type: string
          enum:
            - COMPENSATION_PAYOUT
            - COMPANY_PROFITS
            - COMPANY_SALE
            - DIVIDEND_PAYMENTS
            - DIVORCE_SETTLEMENT
            - FIXED_DEPOSITS
            - GIFT
            - INHERITANCE
            - INSURANCE_PAYOUT
            - LOAN
            - LOTTERY_OR_GAMBLING_WIN
            - RETIREMENT_INCOME
            - SALE_OF_INVESTMENT
            - SALE_OF_PROPERTY
            - SAVINGS_FROM_SALARY
            - OTHER
        otherSourceOfFunds:
          type: string
        occupation:
          type: string
          enum:
            - BUSINESS_OWNER
            - CLERGY
            - CRAFTSMAN
            - ENGINEER
            - EXECUTIVE
            - FARMER
            - FREELANCE
            - LIBERAL_PROFESSION
            - POLITICIAN
            - PROFESSOR
            - PUBLIC_SERVANT
            - RETIRED
            - SHOPKEEPER
            - STUDENT
            - UNEMPLOYED
            - WORKER
            - OTHER
        otherOccupation:
          type: string
        notes:
          type: string
          description: Public additional information concerning this entity.
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        taxIdentificationNumber:
          type: string
        taxCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        strongAuthentication:
          $ref: '#/components/schemas/ScaDeviceInfoResponseDto_Partner'
        scaDevices:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ScaDeviceInfoDto_Partner'
        financialInformation:
          $ref: '#/components/schemas/ConsumerFinancialInformationResponseDto_Partner'
        partnerMetadata:
          title: Metadata
          type: object
        userMetadata:
          title: Metadata
          type: object
      description: The complete consumer information.
    CardListElementDto:
      required:
        - creationDate
        - endUserId
        - expiryDate
        - id
        - ledgerId
        - nameOnCard
        - profile
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUserId:
          type: string
          format: uuid
        ledgerId:
          type: string
          format: uuid
        friendlyName:
          type: string
        profile:
          $ref: '#/components/schemas/Profile'
        expiryDate:
          type: string
        nameOnCard:
          type: string
        cardholderNameOnCard:
          type: string
        type:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        status:
          type: string
          enum:
            - CREATING
            - AWAITING_ACTIVATION
            - ACTIVATING
            - REACTIVATING
            - ACTIVE
            - SUSPENDING
            - SUSPENDED
            - CLOSING
            - CLOSED
            - EXPIRED
            - FAILED
        creationDate:
          type: string
          format: date-time
    ListResponseDtoCardListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CardListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    Profile:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    CardInfoResponseDto_Partner:
      required:
        - creationDate
        - currency
        - endUserId
        - id
        - ledgerId
        - pinStatus
        - profile
        - rules
        - scheme
        - status
        - suspensionsInformation
        - type
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUserId:
          type: string
          format: uuid
        ledgerId:
          type: string
          format: uuid
        profile:
          $ref: '#/components/schemas/Profile_Partner'
        expiryDate:
          type: string
        nameOnCard:
          type: string
        cardholderNameOnCard:
          type: string
        friendlyName:
          type: string
        deliveryAddress:
          $ref: '#/components/schemas/AddressResponseDto_Partner'
        deliveryMethod:
          type: string
          enum:
            - UK_MAIL
            - INTERNATIONAL_MAIL
            - FRENCH_MAIL
            - FRENCH_MAIL_TRACKING
            - DHL
            - COURIER
        deliveryShipmentDate:
          type: string
          format: date
        deliveryTrackingNumber:
          type: string
        truncatedPan:
          type: string
          description: >-
            Last 4 digits of the card. The truncated pan is only displayed if
            the card has been activated.
        type:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        scheme:
          type: string
          enum:
            - MASTERCARD
            - VISA
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        status:
          $ref: '#/components/schemas/CardStatusDto_Partner'
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/CardSuspensionInfoDto_Partner'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        pinStatus:
          type: string
          enum:
            - LOCKED
            - UNLOCKING
            - UNLOCKED
            - WAITING_ONLINE_TRANSACTION
        rules:
          type: array
          items:
            $ref: '#/components/schemas/CardRuleResponseDto_Partner'
      description: The complete card information
    CardRuleResponseDto_Partner:
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
        creator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
      anyOf:
        - $ref: '#/components/schemas/ValueCardRuleResponseDto_Partner'
        - $ref: '#/components/schemas/TargetsCardRuleResponseDto_Partner'
    CardStatusDto_Partner:
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - CREATING
            - AWAITING_ACTIVATION
            - ACTIVATING
            - REACTIVATING
            - ACTIVE
            - SUSPENDING
            - SUSPENDED
            - CLOSING
            - CLOSED
            - EXPIRED
            - FAILED
        reason:
          type: string
          enum:
            - STOLEN
            - LOST
            - DAMAGED
            - OTHER
            - LEDGER_CLOSED
        otherReason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    CardSuspensionInfoDto_Partner:
      required:
        - date
        - operator
      type: object
      properties:
        date:
          type: string
          format: date-time
        reason:
          type: string
          enum:
            - STOLEN
            - LOST
            - DAMAGED
            - OTHER
            - LEDGER_CLOSED
        otherReason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    Profile_Partner:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    TargetsCardRuleResponseDto_Partner:
      required:
        - type
      type: object
      properties:
        name:
          type: string
        creator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        targets:
          type: array
          items:
            type: string
    ValueCardRuleResponseDto_Partner:
      required:
        - type
      type: object
      properties:
        name:
          type: string
        creator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        value:
          type: integer
          format: int64
    CardPinGetResponseDto:
      required:
        - pin
      type: object
      properties:
        pin:
          type: string
          description: >-
            The PIN code to allow your end-user to carry out transactions on
            payment terminals.
    CardPanCredentialsGetResponseDto:
      required:
        - secret
        - token
        - ttl
      type: object
      properties:
        token:
          type: string
          description: The token to allow your end-user to use the PAN SDK.
          example: '237733595'
        secret:
          type: string
          description: The secret to allow your end-user to use the PAN SDK.
          example: 066#28055031
        ttl:
          type: string
          description: The secret remaining time to live duration in ISO 8601.
          example: PT8H6M12.345S
          default: PT1M
    CardPanAndCvvResponseDto:
      required:
        - cvv
        - pan
      type: object
      properties:
        pan:
          type: string
        cvv:
          type: string
    CardProfileListElementDto:
      required:
        - active
        - cardType
        - design
        - id
        - ledgerType
        - name
        - program
        - rules
        - scheme
        - userType
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        scheme:
          type: string
          enum:
            - MASTERCARD
            - VISA
        ledgerType:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_ESTONIA
            - EUR_LITHUANIA
            - USD_USA
            - GBP_GREAT_BRITAIN
            - EUR_BG
        cardType:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        userType:
          type: string
          enum:
            - CORPORATE
            - CONSUMER
        active:
          type: boolean
        program:
          $ref: '#/components/schemas/Program'
        design:
          $ref: '#/components/schemas/Design'
        rules:
          type: array
          items:
            $ref: '#/components/schemas/ProfileRuleResponseDto'
    Design:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ListResponseDtoCardProfileListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CardProfileListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    ProfileRuleResponseDto:
      title: Card Rule
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
        value:
          type: integer
          format: int64
        targets:
          type: array
          items:
            type: string
    Program:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    CardDesignListElementDto_Partner:
      required:
        - availableCountries
        - cardType
        - friendlyName
        - id
        - ledgerType
        - scheme
        - userType
      type: object
      properties:
        id:
          type: string
          format: uuid
        friendlyName:
          type: string
        scheme:
          type: string
          enum:
            - MASTERCARD
            - VISA
        ledgerType:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_ESTONIA
            - EUR_LITHUANIA
            - USD_USA
            - GBP_GREAT_BRITAIN
            - EUR_BG
        cardType:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        userType:
          type: string
          enum:
            - CORPORATE
            - CONSUMER
        availableCountries:
          type: array
          items:
            type: string
            enum:
              - ABW
              - AFG
              - AGO
              - AIA
              - ALA
              - ALB
              - AND
              - ARE
              - ARG
              - ARM
              - ASM
              - ATA
              - ATF
              - ATG
              - AUS
              - AUT
              - AZE
              - BDI
              - BEL
              - BEN
              - BES
              - BFA
              - BGD
              - BGR
              - BHR
              - BHS
              - BIH
              - BLM
              - BLR
              - BLZ
              - BMU
              - BOL
              - BRA
              - BRB
              - BRN
              - BTN
              - BVT
              - BWA
              - CAF
              - CAN
              - CCK
              - CHE
              - CHL
              - CHN
              - CIV
              - CMR
              - COD
              - COG
              - COK
              - COL
              - COM
              - CPV
              - CRI
              - CUB
              - CUW
              - CXR
              - CYM
              - CYP
              - CZE
              - DEU
              - DJI
              - DMA
              - DNK
              - DOM
              - DZA
              - ECU
              - EGY
              - ERI
              - ESH
              - ESP
              - EST
              - ETH
              - FIN
              - FJI
              - FLK
              - FRA
              - FRO
              - FSM
              - GAB
              - GBR
              - GEO
              - GGY
              - GHA
              - GIB
              - GIN
              - GMB
              - GNB
              - GNQ
              - GRC
              - GRD
              - GRL
              - GTM
              - GUM
              - GUY
              - HKG
              - HMD
              - HND
              - HRV
              - HTI
              - HUN
              - IDN
              - IMN
              - IND
              - IOT
              - IRL
              - IRN
              - IRQ
              - ISL
              - ISR
              - ITA
              - JAM
              - JEY
              - JOR
              - JPN
              - KAZ
              - KEN
              - KGZ
              - KHM
              - KIR
              - KNA
              - KOR
              - KWT
              - LAO
              - LBN
              - LBR
              - LBY
              - LCA
              - LIE
              - LKA
              - LSO
              - LTU
              - LUX
              - LVA
              - MAC
              - MAF
              - MAR
              - MCO
              - MDA
              - MDG
              - MDV
              - MEX
              - MHL
              - MKD
              - MLI
              - MLT
              - MMR
              - MNE
              - MNG
              - MNP
              - MOZ
              - MRT
              - MSR
              - MUS
              - MWI
              - MYS
              - NAM
              - NCL
              - NER
              - NFK
              - NGA
              - NIC
              - NIU
              - NLD
              - NOR
              - NPL
              - NRU
              - NZL
              - OMN
              - PAK
              - PAN
              - PCN
              - PER
              - PHL
              - PLW
              - PNG
              - POL
              - PRI
              - PRK
              - PRT
              - PRY
              - PSE
              - PYF
              - QAT
              - ROU
              - RUS
              - RWA
              - SAU
              - SDN
              - SEN
              - SGP
              - SGS
              - SHN
              - SJM
              - SLB
              - SLE
              - SLV
              - SMR
              - SOM
              - SPM
              - SRB
              - SSD
              - STP
              - SUR
              - SVK
              - SVN
              - SWE
              - SWZ
              - SXM
              - SYC
              - SYR
              - TCA
              - TCD
              - TGO
              - THA
              - TJK
              - TKL
              - TKM
              - TLS
              - TON
              - TTO
              - TUN
              - TUR
              - TUV
              - TWN
              - TZA
              - UGA
              - UKR
              - UMI
              - URY
              - USA
              - UZB
              - VAT
              - VCT
              - VEN
              - VGB
              - VIR
              - VNM
              - VUT
              - WLF
              - WSM
              - XXK
              - YEM
              - ZAF
              - ZMB
              - ZWE
    ListResponseDtoCardDesignListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CardDesignListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    BicInfoResponseDto:
      required:
        - bic
      type: object
      properties:
        bic:
          type: string
        name:
          type: string
    BeneficiaryListElementDto_Partner:
      required:
        - accountType
        - active
        - creationDate
        - display
        - endUserId
        - id
        - name
        - status
        - type
        - updateDate
      type: object
      properties:
        name:
          type: string
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        status:
          type: string
          enum:
            - DECLINED
            - PENDING_REVIEW
            - VALID
            - PENDING
            - NEED_ADDITIONAL_INFORMATION
        active:
          type: boolean
        friendlyName:
          type: string
        endUserId:
          type: string
          format: uuid
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        accountType:
          type: string
          enum:
            - IBAN
            - GBP
            - USD
        display:
          type: boolean
      description: The information on a beneficiary.
    GbpBeneficiaryListElementDto_Partner:
      required:
        - accountNumber
        - accountType
        - active
        - creationDate
        - display
        - endUserId
        - id
        - name
        - sortCode
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/BeneficiaryListElementDto_Partner'
        - type: object
          properties:
            accountNumber:
              type: string
            sortCode:
              type: string
    ListResponseDtoBeneficiaryListElementDto_Partner:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/GbpBeneficiaryListElementDto_Partner'
              - $ref: '#/components/schemas/SepaBeneficiaryListElementDto_Partner'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    SepaBeneficiaryListElementDto_Partner:
      required:
        - accountType
        - active
        - bicOrSwift
        - creationDate
        - display
        - endUserId
        - iban
        - id
        - name
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/BeneficiaryListElementDto_Partner'
        - type: object
          properties:
            iban:
              type: string
            bicOrSwift:
              type: string
    BeneficiaryInfoResponseDto:
      required:
        - accountType
        - active
        - creationDate
        - endUserId
        - id
        - name
        - status
        - type
        - updateDate
      type: object
      properties:
        linkcyLedgerId:
          type: string
          description: >-
            Sometimes a beneficiary can correspond to a ledger that you manage,
            in this case, we would send you the corresponding id.
          format: uuid
        name:
          type: string
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        status:
          type: string
          enum:
            - DECLINED
            - PENDING_REVIEW
            - VALID
            - PENDING
            - NEED_ADDITIONAL_INFORMATION
        active:
          type: boolean
        friendlyName:
          type: string
        endUserId:
          type: string
          description: The endUser owning this beneficiary.
          format: uuid
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        accountType:
          type: string
          enum:
            - IBAN
            - GBP
            - USD
        display:
          type: boolean
      description: The information on a beneficiary.
    GbpBeneficiaryInfoResponseDto:
      required:
        - accountNumber
        - accountType
        - active
        - creationDate
        - endUserId
        - id
        - name
        - sortCode
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/BeneficiaryInfoResponseDto'
        - type: object
          properties:
            accountNumber:
              type: string
            sortCode:
              type: string
    SepaBeneficiaryInfoResponseDto:
      required:
        - accountType
        - active
        - bicOrSwift
        - creationDate
        - endUserId
        - iban
        - id
        - name
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/BeneficiaryInfoResponseDto'
        - type: object
          properties:
            iban:
              type: string
            bicOrSwift:
              type: string
    ListResponseDtoPartnerUserAccountListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/PartnerUserAccountListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    PartnerUserAccountListElementDto:
      required:
        - creationDate
        - email
        - id
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
        roles:
          uniqueItems: true
          type: array
          description: List of roles of the user.
          items:
            title: LinkcyRole
            type: string
            description: List of roles of the user.
            enum:
              - ACCOUNT_CREATE
              - BANKING_DETAILS_DOCUMENT_EXPORT
              - BENEFICIARY_CREATE
              - BENEFICIARY_INFO
              - BENEFICIARY_LIST
              - BENEFICIARY_UPDATE
              - DIRECT_DEBIT_MANDATE_CREATE
              - DIRECT_DEBIT_MANDATE_UPDATE
              - DIRECT_DEBIT_MANDATE_ACTIVATE
              - DIRECT_DEBIT_MANDATE_CANCEL
              - DIRECT_DEBIT_MANDATE_LIST
              - DIRECT_DEBIT_MANDATE_INFO
              - CARD_ACTIVATE
              - CARD_CLOSE
              - CARD_CREATE
              - CARD_UPDATE
              - CARD_DESIGN_LIST
              - CARD_INFO
              - CARD_LIST
              - CARD_PAN_CREDENTIALS
              - CARD_PIN
              - CARD_PAN_AND_CVV
              - CARD_RENEW
              - CARD_SUSPEND
              - CARD_RESET_PIN_ATTEMPTS
              - CARD_PROFILE_CREATE
              - CARD_PROFILE_LIST
              - CARD_PROFILE_RULE_DELETE
              - CARD_PROFILE_RULE_UPDATE
              - CARD_PROFILE_UPDATE
              - CARD_RULE_DELETE
              - CARD_RULE_UPDATE
              - EXTERNAL_CARD_LIST
              - CONSUMER_CREATE
              - CONSUMER_INFO
              - CONSUMER_LIST
              - CONSUMER_UPDATE
              - CONSUMER_CONTACT_UPDATE
              - CORPORATE_CREATE
              - CORPORATE_INFO
              - CORPORATE_LIST
              - CORPORATE_UPDATE
              - CORPORATE_RELATED_CREATE
              - CORPORATE_RELATED_DELETE
              - CORPORATE_RELATED_INFO
              - CORPORATE_RELATED_LIST
              - CORPORATE_RELATED_UPDATE
              - KYB_VERIFICATION_ASK
              - DOCUMENT_REQUEST_CREATE
              - DOCUMENT_CREATE
              - DOCUMENT_INFO
              - DOCUMENT_LIST
              - DILIGENCE_REVIEW_DOCUMENT_EXPORT
              - TRANSACTION_RECEIPT_DOCUMENT_EXPORT
              - END_USER_SUSPEND
              - END_USER_UNSUSPEND
              - END_USER_ADDRESSES_LIST
              - KYC_CREATE
              - KYC_LIST
              - KYC_INFO
              - LEDGER_CLOSE
              - LEDGER_CREATE
              - LEDGER_UPDATE
              - LEDGER_STATEMENT_DOCUMENT_EXPORT
              - LEDGER_SUSPEND
              - LEDGER_UNSUSPEND
              - LEDGER_INFO
              - LEDGER_LIST
              - LEDGER_UPGRADE
              - BIC_FROM_IBAN_GET
              - PARTNER_INFO
              - PARTNER_UPDATE
              - PARTNER_ACQUIRING_CONFIGURATION_INFO
              - PHONE_VERIFICATION_SEND
              - PHONE_VERIFICATION_VERIFY
              - SMS_SEND
              - EMAIL_VERIFICATION_CREATE
              - ADDRESS_VERIFY
              - SCA_DEVICE_CREATE
              - SCA_DEVICE_ACTIVATE
              - SCA_DEVICE_UPDATE
              - SCA_DEVICE_RESET
              - SHARE_INFO
              - SHARE_CREATE
              - SHARE_UPDATE
              - SHARE_DELETE
              - ACQUIRING_ACCOUNT_LOAD_CREATE
              - ACQUIRING_PAYMENT_CREATE
              - ACQUIRING_TRANSACTION_INFO
              - TRANSACTION_INFO
              - TRANSACTION_LIST
              - INTER_LEDGER_TRANSACTION_CREATE
              - DIRECT_DEBIT_TRANSACTION_CREATE
              - BENEFICIARY_TRANSACTION_CREATE
              - WEBHOOK_PORTAL
              - CRYPTO_WALLET_CREATE
              - CRYPTO_WALLET_LIST
              - CRYPTO_WALLET_INFO
              - CRYPTO_BENEFICIARY_CREATE
              - CRYPTO_BENEFICIARY_LIST
              - CRYPTO_BENEFICIARY_INFO
              - CRYPTO_BENEFICIARY_UPDATE
              - CRYPTO_TRANSACTION_CREATE
              - CRYPTO_TRANSACTION_LIST
              - CRYPTO_TRANSACTION_INFO
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
    AcquiringDetailsResponseDto_Internal:
      title: Acquiring details
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        cardHolderName:
          type: string
        cardIssuer:
          type: string
        cardType:
          type: string
        cardScheme:
          type: string
        cardIssuerCountryCode:
          type: string
        cardTruncPan:
          type: string
        threeDsCheck:
          type: string
        targetLedgerId:
          type: string
          format: uuid
        loadTransactionId:
          type: string
          format: uuid
        paymentMethod:
          type: string
    AcquiringTransactionFeesDto_Internal:
      type: object
      properties:
        acquiringCommission:
          type: string
        merchantCharge:
          type: string
        schemeFee:
          type: string
        interchangeFee:
          type: string
        partnerFee:
          type: number
    AcquiringTransactionInformationResponseDto_Internal:
      title: Transaction Information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        note:
          type: string
        clearingDate:
          type: string
          format: date-time
        paymentDate:
          type: string
          format: date
        reference:
          type: string
    AcquiringTransactionResponseDto_Internal:
      title: Acquiring
      required:
        - amount
        - creationDate
        - currency
        - details
        - id
        - information
        - partner
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - ACQUIRING
        paymentType:
          type: string
          enum:
            - ACCOUNT_LOAD
            - PAYMENT
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: >-
            #/components/schemas/AcquiringTransactionInformationResponseDto_Internal
        sender:
          $ref: '#/components/schemas/TransactionActorResponseDto_Internal'
        receiver:
          $ref: '#/components/schemas/TransactionActorResponseDto_Internal'
        details:
          $ref: '#/components/schemas/AcquiringDetailsResponseDto_Internal'
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        netAmount:
          type: number
        fees:
          $ref: '#/components/schemas/AcquiringTransactionFeesDto_Internal'
    CardTransactionActorResponseDto_Internal:
      title: Card Actor
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
        cardId:
          type: string
          format: uuid
        cardFriendlyName:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
    CardTransactionCardDetailsResponseDto_Internal:
      title: Card Details
      required:
        - auth3dsMethod
        - cardPresent
        - deviceFormFactor
        - holderPresent
        - inputMethod
        - terminalAttendance
        - token
        - truncatedPan
      type: object
      properties:
        truncatedPan:
          type: string
        token:
          type: string
        terminalAttendance:
          type: string
          enum:
            - ATTENDED
            - UNATTENDED
            - UNKNOWN
            - NO_TERMINAL_USED
        holderPresent:
          type: string
          enum:
            - NOT_PRESENT_STANDING_AUTH_OR_RECURRING_TRANSACTION
            - NOT_PRESENT_INSTALLMENT_TRANSACTION
            - UNKNOWN
            - PRESENT
            - NOT_PRESENT_E_COMMERCE
            - NOT_PRESENT_MAIL_ORDER
            - NOT_PRESENT_UNSPECIFIED
            - NOT_PRESENT_TELEPHONE_ORDER
        cardPresent:
          type: string
          enum:
            - UNKNOWN
            - PRESENT
            - NOT_PRESENT
        deviceFormFactor:
          type: string
          enum:
            - TABLET
            - JEWELRY
            - STICKER
            - MOBILE_PHONE
            - MOBILE_PHONE_OR_TABLET
            - WRISTBAND
            - UNKNOWN
            - MINI_CARD
            - CLOTHING_OR_APPAREL
            - MOBILE_TAG_CASE_OR_SLEEVE
            - FASHION_ACCESSORY
            - DOMESTIC_APPLICATION
            - NON_CARD
            - CARD
            - FOB_OR_KEY_FOB
            - WATCH
            - VEHICLE
            - PERSONAL_COMPUTER_OR_LAPTOP
            - MEDIA_OR_GAMING_DEVICE
        inputMethod:
          type: string
          enum:
            - EMV_CONTACT
            - UNSPECIFIED
            - E_COMMERCE_WITH_EMV
            - BARCODE
            - KEY_ENTERED_BY_ACQUIRER
            - MAGNETIC_STRIPE
            - E_COMMERCE
            - MAGNETIC_STRIPE_CONTACTLESS
            - QR_CODE
            - EMV_CONTACTLESS
            - MANUAL
            - OCR
            - KEY_ENTERED
            - ACCOUNT_DATA_ON_FILE
            - MICR_READER
            - UNKNOWN
        auth3dsMethod:
          type: string
          enum:
            - AUTHENTICATED_BY_ACS
            - AUTHENTICATED_BY_MASTERCARD_IDCX
            - AUTHENTICATED_WITH_UNKNOWN_METHOD
            - DELEGATED
            - FRICTIONLESS_FLOW
            - FRICTIONLESS_FLOW_RISK_BASED_AUTHENTICATION_REVIEW
            - KNOWLEDGE_BASED_AUTHENTICATION
            - NONE
            - OTHER_AUTHENTICATION_METHOD
            - OTP_VIA_APP_METHOD
            - OTP_VIA_OTHER_METHOD
            - OUT_OF_BAND_WITH_APP_LOGIN_METHOD
            - OUT_OF_BAND_WITH_BIOMETRIC_METHOD
            - OUT_OF_BAND_WITH_OTHER_METHOD
            - PASSWORD
            - PKI
            - PUSH_CONFIRMATION
            - SECRET_KEY
            - SERVER_RESPONDING
            - UNKNOWN_AUTHENTICATION_METHOD
            - UNKNOWN_OR_NOT_APPLICABLE
            - UNRECOGNISED
            - UNRECOGNIZED_AUTHENTICATION_METHOD
    CardTransactionInformationResponseDto_Internal:
      title: Card Transaction Information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - REFER_TO_CARD_ISSUER
            - INVALID_MERCHANT
            - DO_NOT_HONOUR
            - INVALID_AMOUNT
            - INVALID_CARD_NUMBER
            - EXPIRED_CARD
            - LOST_CARD
            - STOLEN_CARD
            - ACCOUNT_CLOSED
            - INSUFFICIENT_FUNDS
            - INCORRECT_PIN
            - TRANSACTION_NOT_PERMITTED_TO_ENDUSER
            - TRANSACTION_NOT_PERMITTED_TO_TERMINAL
            - SUSPECTED_FRAUD
            - RESTRICTED_CARD
            - SECURITY_VIOLATION
            - EXCEEDS_LIMIT
            - EXCEEDS_WITHDRAWAL_LIMIT
            - EXCEEDS_WITHDRAWAL_FREQUENCY_LIMIT
            - VERIFICATION_DATA_FAILED
            - CARDHOLDER_TO_CONTACT_ISSUER
            - PIN_TRIES_EXCEEDED
            - CARD_NOT_ACTIVE
            - ISSUER_OR_SWITCH_INOPERATIVE
            - UNABLE_TO_ROUTE_TRANSACTION
            - LAW_VIOLATION
            - SYSTEM_MALFUNCTION
            - STRONG_CUSTOMER_CARD_BASED_AUTHENTICATION_REQUIRED
            - STRONG_CUSTOMER_NON_CARD_BASED_AUTHENTICATION_REQUIRED
            - DECLINE_FOR_CVV2_FAILURE
            - UNKNOWN
        note:
          type: string
        originalTransaction:
          $ref: '#/components/schemas/LinkedTransactionDto_Internal'
        clearingTransaction:
          $ref: '#/components/schemas/LinkedTransactionDto_Internal'
        acquirerReferenceData:
          type: string
        interchangeFeeAmount:
          type: number
        interchangeFeeCurrency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        clearingDate:
          type: string
          format: date-time
    CardTransactionResponseDto_Internal:
      title: Card
      required:
        - amount
        - creationDate
        - currency
        - direction
        - id
        - information
        - merchant
        - partner
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - CARD_AUTHORIZATION
            - CARD_CLEARING
        paymentType:
          type: string
          enum:
            - ACCOUNT_FUNDING
            - ACCOUNT_TRANSFER
            - ACCOUNT_VERIFICATION
            - ADJUSTMENT_CREDIT
            - ADJUSTMENT_DEBIT
            - CASH_ADVANCE
            - CHARGEBACK
            - CHECK_DEPOSIT
            - DEPOSIT
            - FEE_COLLECTION
            - ORIGINAL_CREDIT
            - PAYMENT_TRANSACTION
            - PURCHASE
            - PURCHASE_RETURN_OR_REFUND
            - PURCHASE_WITH_CASHBACK
            - QUASI_CASH
            - UNIQUE_MCC_TRANSACTION
            - WITHDRAWAL
            - UNKNOWN
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/CardTransactionInformationResponseDto_Internal'
        sender:
          $ref: '#/components/schemas/CardTransactionActorResponseDto_Internal'
        receiver:
          $ref: '#/components/schemas/CardTransactionActorResponseDto_Internal'
        merchant:
          $ref: '#/components/schemas/TransactionMerchantResponseDto_Internal'
        cardDetails:
          $ref: '#/components/schemas/CardTransactionCardDetailsResponseDto_Internal'
        direction:
          type: string
          enum:
            - DEBIT
            - CREDIT
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    InterLedgerTransactionInformationResponseDto_Internal:
      title: Transaction Information
      required:
        - clearingDate
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        note:
          type: string
        clearingDate:
          type: string
          format: date-time
        reference:
          type: string
    InterLedgerTransactionResponseDto_Internal:
      title: Inter-Ledger
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - partner
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - INTER_LEDGER
        paymentType:
          type: string
          enum:
            - MONEY_TRANSFER
            - ACCOUNT_LOAD
            - TECH_MVC_CREATION
            - TECH_TRANSACTION
            - TECH_VIRTUAL_TRANSFER
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: >-
            #/components/schemas/InterLedgerTransactionInformationResponseDto_Internal
        sender:
          $ref: '#/components/schemas/TransactionActorResponseDto_Internal'
        receiver:
          $ref: '#/components/schemas/TransactionActorResponseDto_Internal'
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    LinkedTransactionDto_Internal:
      required:
        - date
      type: object
      properties:
        id:
          type: string
          format: uuid
        date:
          type: string
          format: date-time
      description: >-
        For card authorization, you get the transaction id and date of the
        corresponding card clearing.
    ListResponseDtoTransactionResponseDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/TransactionResponseDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    OtherTransactionInformationResponseDto_Internal:
      title: Other Transaction Information
      required:
        - clearingDate
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        clearingDate:
          type: string
          format: date-time
        note:
          type: string
    OtherTransactionResponseDto_Internal:
      title: Other
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - partner
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - FX
            - UNKNOWN
        paymentType:
          type: string
          enum:
            - GLOBAL_SWIFT
            - UNKNOWN
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/OtherTransactionInformationResponseDto_Internal'
        sender:
          $ref: '#/components/schemas/TransactionActorResponseDto_Internal'
        receiver:
          $ref: '#/components/schemas/TransactionActorResponseDto_Internal'
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    SepaTransactionActorDetailsResponseDto_Internal:
      title: Sepa Actor
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        bic:
          type: string
        iban:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
    SepaTransactionInformationResponseDto_Internal:
      title: Sepa Credit Transaction Information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
        - sequence
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        note:
          type: string
        clearingDate:
          type: string
          format: date-time
        reference:
          type: string
        sequence:
          type: string
          enum:
            - FIRST
            - RECURRING
            - FINAL
            - ONE_OFF
            - NONE
    SepaTransactionReceiverResponseDto_Internal:
      title: Sepa Receiver
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        bic:
          type: string
        iban:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
        beneficiaryId:
          type: string
          format: uuid
        originalName:
          type: string
    SepaTransactionResponseDto_Internal:
      title: SEPA
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - partner
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - SEPA_CREDIT_TRANSFER
            - SEPA_DIRECT_DEBIT
        paymentType:
          type: string
          enum:
            - SCT_RECEIVE
            - SCT_INST_RECEIVE
            - SCT_SEND
            - SCT_INST_SEND
            - SDD_SEND
            - SDD_RECEIVE
            - TECH_CARD_SETTLEMENT
            - TECH_SCT_RETURN
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/SepaTransactionInformationResponseDto_Internal'
        sender:
          $ref: '#/components/schemas/SepaTransactionActorDetailsResponseDto_Internal'
        receiver:
          $ref: '#/components/schemas/SepaTransactionReceiverResponseDto_Internal'
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    TransactionActorResponseDto_Internal:
      title: Transaction Actor
      type: object
      properties:
        ledgerFriendlyName:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        name:
          type: string
        endUserId:
          type: string
          format: uuid
        ledgerId:
          type: string
          format: uuid
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
    TransactionMerchantResponseDto_Internal:
      title: Card Transaction Merchant
      required:
        - acquirerId
        - categoryCode
        - city
        - country
        - description
        - id
        - name
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        city:
          type: string
        country:
          type: string
        categoryCode:
          type: string
        description:
          type: string
        acquirerId:
          type: string
    TransactionResponseDto_Internal:
      required:
        - creationDate
        - id
        - partner
      type: object
      properties:
        id:
          type: string
          format: uuid
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        creationDate:
          type: string
          format: date-time
        cbsId:
          type: string
      anyOf:
        - $ref: '#/components/schemas/InterLedgerTransactionResponseDto_Internal'
        - $ref: '#/components/schemas/SepaTransactionResponseDto_Internal'
        - $ref: '#/components/schemas/CardTransactionResponseDto_Internal'
        - $ref: '#/components/schemas/UkTransactionResponseDto_Internal'
        - $ref: '#/components/schemas/OtherTransactionResponseDto_Internal'
        - $ref: '#/components/schemas/AcquiringTransactionResponseDto_Internal'
    UkTransactionInformationResponseDto_Internal:
      title: UK transaction information
      required:
        - conversionRate
        - originalAmount
        - originalCurrency
      type: object
      properties:
        originalAmount:
          type: number
        originalCurrency:
          type: string
        conversionRate:
          type: string
        declineReason:
          type: string
          enum:
            - BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED
            - BENEFICIARY_INFORMATION_MISSING
            - BENEFICIARY_INFORMATION_INVALID
            - BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT
            - BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS
            - REFERENCE_INVALID
            - SENDER_ACCOUNT_CLOSED
            - SENDER_INFORMATION_INVALID
            - AMOUNT_OR_CURRENCY_INVALID
            - INSUFFICIENT_FUNDS
            - TRANSACTION_CURRENCY_DIFFERENT_TO_RECEIVER_ACCOUNT
            - LIMITS_EXCEEDED
            - TRANSACTION_FAILED
            - TRANSACTION_UNAUTHORISED
            - TRANSACTION_CANCELLED
            - RETURNED_VIA_RECALL
            - REJECTED_BY_RECEIVING_BANK
            - REJECTED_COMPLIANCE_REASON
            - REJECTED_NOT_ROUTABLE
            - REJECTED_NO_SPECIFIED_REASON
            - REJECTED_ACCOUNT_CLOSED
            - REJECTED_ACCOUNT_INVALID
            - REJECTED_TECHNICAL_ISSUE
            - UNSUPPORTED_CARD_TYPE
            - UNSUPPORTED_ISSUING_COUNTRY
            - THREEDS_ERROR
            - RISK_CHECK_ERROR
            - MISSING_FIELD
            - INVALID_FIELD
        clearingDate:
          type: string
          format: date-time
        reference:
          type: string
        note:
          type: string
    UkTransactionReceiverResponseDto_Internal:
      title: UK Receiver
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        sortCode:
          type: string
        accountNumber:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
        beneficiaryId:
          type: string
          format: uuid
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
    UkTransactionResponseDto_Internal:
      title: UK
      required:
        - amount
        - creationDate
        - currency
        - id
        - information
        - partner
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          title: UK Transaction Type
          type: string
          enum:
            - UK_CREDIT_TRANSFER
        paymentType:
          title: Uk Payment Type
          type: string
          enum:
            - BACS_RECEIVE
            - FASTER_PAYMENT_RECEIVE
            - BACS_SEND
            - FASTER_PAYMENT_SEND
        status:
          type: string
          enum:
            - APPROVED
            - DECLINED
            - RELEASED
            - REVERSED
            - PENDING
            - PENDING_REVIEW
            - UNKNOWN
            - ABORTED
        creationDate:
          type: string
          format: date-time
        amount:
          type: number
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        information:
          $ref: '#/components/schemas/UkTransactionInformationResponseDto_Internal'
        sender:
          $ref: '#/components/schemas/UkTransactionSenderResponseDto_Internal'
        receiver:
          $ref: '#/components/schemas/UkTransactionReceiverResponseDto_Internal'
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    UkTransactionSenderResponseDto_Internal:
      title: UK Sender
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        ledgerId:
          type: string
          format: uuid
        ledgerFriendlyName:
          type: string
        sortCode:
          type: string
        accountNumber:
          type: string
        bic:
          type: string
        iban:
          type: string
        virtualLedgerId:
          type: string
          format: uuid
        virtualLedgerFriendlyName:
          type: string
        previousTotalBalance:
          type: number
        previousReservedBalance:
          type: number
    InternalBlockedPhoneListElementDto:
      required:
        - phone
      type: object
      properties:
        phone:
          type: string
        count:
          type: integer
          format: int32
        blockedDate:
          type: string
          format: date-time
    ListResponseDtoInternalBlockedPhoneListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/InternalBlockedPhoneListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    InternalPartnerListElementDto:
      required:
        - creationDate
        - id
        - name
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
    ListResponseDtoInternalPartnerListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/InternalPartnerListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    AddressResponseDto_Internal:
      required:
        - city
        - id
        - isoCountryCode
        - status
      type: object
      properties:
        id:
          type: string
          format: uuid
        isoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        city:
          type: string
        postalCode:
          type: string
        street:
          type: string
        number:
          type: string
        refinement:
          type: string
        stateOrProvince:
          type: string
        status:
          type: string
          enum:
            - INVALID
            - VALID
            - PENDING
            - VERIFIED
            - ARCHIVED
            - DECLINED
      description: Address used on the bank statements of your users.
    ComplianceScoring_Internal:
      type: object
      properties:
        receivingSendingFundsRisk:
          title: RiskLevels
          type: string
          description: >-
            The risk level depending on the countries that would send funds to
            or receive funds from the said account.
          enum:
            - LOW
            - HIGH
        jointAccount:
          type: boolean
          description: If this partner can open joint account for this end-user.
        fraudHistory:
          type: boolean
          description: Is there any record of fraud history.
        natureOfPaymentRisk:
          type: string
          description: >-
            The risk level depending on the persons/entities that would send
            funds to or receive funds from the said account.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        paymentStructureRisk:
          type: string
          description: >-
            The risk level depending on the typologies of payments the account
            will perform.
          enum:
            - LOW
            - MEDIUM
            - HIGH
        riskAssessment:
          type: string
        cryptoRelated:
          type: boolean
    ContactInformation_Internal:
      type: object
      properties:
        adminEmail:
          type: string
        billingEmail:
          type: string
        commercialEmail:
          type: string
        techEmail:
          type: string
        complianceEmail:
          type: string
    EmailProperties_Internal:
      type: object
      properties:
        senderEmailAddress:
          type: string
          description: Email address used to send emails on your behalf.
        senderEmailName:
          type: string
          description: Name used to send emails on your behalf.
        emailVerificationTemplateId:
          type: string
    PartnerDefaultLedgerLimitsResponseDto_Internal:
      title: Partner Default Ledger Limits
      required:
        - ddMonthlyLimit
        - ddTransactionLimit
        - transactionDailyLimit
        - transactionLimit
        - transactionMonthlyLimit
      type: object
      properties:
        transactionLimit:
          type: number
        transactionDailyLimit:
          type: number
        transactionMonthlyLimit:
          type: number
        ddTransactionLimit:
          type: number
        ddMonthlyLimit:
          type: number
      description: Configuration of the default ledger limits for this partner.
    PartnerDefaultLimitedStatusLimitsResponseDto_Internal:
      title: Partner Default limited status Limits
      required:
        - limitedStatusTransactionLimit
        - limitedStatusTransactionLimitInterval
      type: object
      properties:
        limitedStatusTransactionLimit:
          type: number
        limitedStatusTransactionLimitInterval:
          type: integer
          format: int32
      description: >-
        Default transaction limit configuration for end-users with limited
        status for this partner
    PartnerDefaultSctInstLimitsResponseDto_Internal:
      title: Partner Default SEPA Credit Transfer Instant Limits
      type: object
      properties:
        sctInstLimit:
          type: number
        sctInstDailyLimit:
          type: number
        sctInstWeeklyLimit:
          type: number
      description: >-
        Configuration of the default transaction limit for SEPA Instant Credit
        Transfer (SCT Inst) for this partner.
    PartnerInfoResponseDto_Internal:
      required:
        - contactInformation
        - creationDate
        - limits
        - name
        - updateDate
      type: object
      properties:
        name:
          type: string
        displayName:
          type: string
          description: Name display on documents.
        logoUrl:
          type: string
          description: Url that provides the logo.
        address:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        consumerOtpMessage:
          type: string
          description: Message displayed when requesting a OTP message.
        corporateOtpMessage:
          type: string
          description: Message displayed when requesting a OTP message.
        emailProperties:
          $ref: '#/components/schemas/EmailProperties_Internal'
        contactInformation:
          $ref: '#/components/schemas/ContactInformation_Internal'
        limits:
          $ref: '#/components/schemas/PartnerLimitsResponseDto_Internal'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        id:
          type: string
          format: uuid
        fullKycVerificationFlow:
          type: string
        docOnlyVerificationFlow:
          type: string
        twilioVerificationSid:
          type: string
        twilioMessagingSid:
          type: string
        complianceScoring:
          $ref: '#/components/schemas/ComplianceScoring_Internal'
        delegatedPhoneVerification:
          type: boolean
          description: If true, phone numbers will automatically be considered verified.
        delegatedPoa:
          type: boolean
          description: If true, address could be verified without Linkcy Verification.
        delegatedSca:
          type: boolean
          description: If true, SCA can be bypassed even for end-users.
        delegatedKyc:
          type: boolean
          description: If true, KYC can be provided by your system.
        showKycFiles:
          type: boolean
          description: >-
            If true, the partner may see KYC files in an end-user's document
            list..
        mvcOnFirstLedger:
          type: boolean
          description: >-
            If true, an associated MVC (for banking cards) will also be created
            the first time an end-user creates a ledger. By default is false.
        wultraAppId:
          type: string
          description: >-
            Wultra Mobile SDK AppId required for SCA registration and data
            signing
        cbs:
          type: string
          enum:
            - RAILSR
            - PAYNOVATE
            - PAYNETICS
      description: Your information as Partner.
    PartnerLimitsResponseDto_Internal:
      type: object
      properties:
        ledger:
          $ref: '#/components/schemas/PartnerDefaultLedgerLimitsResponseDto_Internal'
        sctInst:
          $ref: '#/components/schemas/PartnerDefaultSctInstLimitsResponseDto_Internal'
        limitedStatus:
          $ref: >-
            #/components/schemas/PartnerDefaultLimitedStatusLimitsResponseDto_Internal
      description: Configuration of limits.
    InternalOperationRestrictionListElementDto:
      required:
        - id
        - operation
        - partnerId
        - type
        - userType
      type: object
      properties:
        id:
          type: string
          format: uuid
        partnerId:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - INTERDICTION
        userType:
          type: string
          description: The type of user affected.
          enum:
            - ANONYMOUS
            - CONSUMER
            - CORPORATE
            - PARTNER
        operation:
          type: string
          description: The name of the restricted operation.
          enum:
            - ACCOUNT_CREATE
            - ACCOUNT_LIST
            - ACCOUNT_UPDATE
            - INTERNAL_ACCOUNT_UPDATE
            - INTERNAL_ACCOUNT_LIST
            - BANKING_DETAILS_DOCUMENT_EXPORT
            - BENEFICIARY_CREATE
            - BENEFICIARY_INFO
            - BENEFICIARY_LIST
            - BENEFICIARY_UPDATE
            - BENEFICIARY_BYPASS_STATUS
            - INTERNAL_BENEFICIARY_INFO
            - INTERNAL_BENEFICIARY_LIST
            - INTERNAL_BENEFICIARY_UPDATE
            - DIRECT_DEBIT_MANDATE_CREATE
            - DIRECT_DEBIT_MANDATE_UPDATE
            - DIRECT_DEBIT_MANDATE_ACTIVATE
            - DIRECT_DEBIT_MANDATE_CANCEL
            - DIRECT_DEBIT_MANDATE_LIST
            - DIRECT_DEBIT_MANDATE_INFO
            - INTERNAL_DIRECT_DEBIT_MANDATE_LIST
            - INTERNAL_DIRECT_DEBIT_MANDATE_INFO
            - CARD_ACTIVATE
            - CARD_CLOSE
            - CARD_CREATE
            - CARD_UPDATE
            - CARD_DESIGN_LIST
            - INTERNAL_CARD_DESIGN_LIST
            - CARD_INFO
            - CARD_LIST
            - CARD_PAN_CREDENTIALS
            - CARD_PIN
            - CARD_PAN_AND_CVV
            - CARD_SUSPEND
            - CARD_RESET_PIN_ATTEMPTS
            - CARD_PROFILE_CREATE
            - CARD_PROFILE_LIST
            - CARD_PROFILE_RULE_DELETE
            - CARD_PROFILE_RULE_UPDATE
            - CARD_PROFILE_UPDATE
            - INTERNAL_CARD_PROFILE_LIST
            - CARD_RULE_DELETE
            - CARD_RULE_UPDATE
            - CARD_TRUNCATED_PAN
            - INTERNAL_CARD_INFO
            - INTERNAL_CARD_LIST
            - INTERNAL_CARD_PROGRAM_LIST
            - INTERNAL_CARD_RULE_DELETE
            - INTERNAL_CARD_RULE_UPDATE
            - EXTERNAL_CARD_LIST
            - I_EXTERNAL_CARD_LIST
            - CONSUMER_CREATE
            - CONSUMER_INFO
            - CONSUMER_LIST
            - CONSUMER_UPDATE
            - CONSUMER_CONTACT_UPDATE
            - CONSUMER_DELETE
            - INTERNAL_CONSUMER_INFO
            - INTERNAL_CONSUMER_UPDATE
            - INTERNAL_CONSUMER_CONTACT_UPDATE
            - CORPORATE_CREATE
            - CORPORATE_INFO
            - CORPORATE_LIST
            - CORPORATE_UPDATE
            - CORPORATE_DELETE
            - CORPORATE_RELATED_CREATE
            - CORPORATE_RELATED_DELETE
            - CORPORATE_RELATED_INFO
            - CORPORATE_RELATED_LIST
            - CORPORATE_RELATED_UPDATE
            - KYB_VERIFICATION_ASK
            - CORPORATE_BYPASS_KYB
            - INTERNAL_CORPORATE_INFO
            - INTERNAL_CORPORATE_UPDATE
            - INTERNAL_CORPORATE_RELATED_INFO
            - INTERNAL_CORPORATE_RELATED_LIST
            - INTERNAL_CORPORATE_RELATED_UPDATE
            - INTERNAL_OPERATION_RESTRICTION_CREATE
            - INTERNAL_OPERATION_RESTRICTION_DELETE
            - INTERNAL_OPERATION_RESTRICTION_LIST
            - DOCUMENT_REQUEST_CREATE
            - DOCUMENT_CREATE
            - DOCUMENT_INFO
            - DOCUMENT_LIST
            - DILIGENCE_REVIEW_DOCUMENT_EXPORT
            - RISK_ASSESSMENT_DOCUMENT_EXPORT
            - TRANSACTION_RECEIPT_DOCUMENT_EXPORT
            - INTERNAL_DOCUMENT_CREATE
            - INTERNAL_DOCUMENT_LIST
            - INTERNAL_DOCUMENT_UPDATE
            - INTERNAL_DOCUMENT_DELETE
            - EMAIL_VERIFICATION_CREATE
            - CONSUMER_EMAIL_CHECK
            - END_USER_SUSPEND
            - I_END_USER_CLOSE
            - END_USER_UNSUSPEND
            - I_END_USER_DELETE
            - END_USER_ADDRESSES_LIST
            - END_USER_ONBOARD
            - GET_ID_WEBHOOK_VERIFIED
            - GET_ID_WEBHOOK_CREATED
            - WULTRA_REGISTRATION_WEBHOOK_UPDATE
            - KYC_CREATE
            - KYC_LIST
            - KYC_SIMULATE
            - KYC_INFO
            - INTERNAL_KYC_LIST
            - INTERNAL_KYC_UPDATE
            - INTERNAL_KYC_INFO
            - LEDGER_CLOSE
            - LEDGER_CREATE
            - LEDGER_UPDATE
            - LEDGER_STATEMENT_DOCUMENT_EXPORT
            - LEDGER_SUSPEND
            - LEDGER_UNSUSPEND
            - LEDGER_INFO
            - LEDGER_LIST
            - LEDGER_UPGRADE
            - INTERNAL_LEDGER_UPDATE
            - INTERNAL_LEDGER_INFO
            - INTERNAL_LEDGER_LIST
            - INTERNAL_LEDGER_UPGRADE
            - INTERNAL_LEDGER_CLOSE
            - INTERNAL_LEDGER_SUSPEND
            - INTERNAL_LEDGER_UNSUSPEND
            - GET_BIC_FROM_IBAN
            - INTERNAL_BLOCKED_PHONE_LIST
            - INTERNAL_PHONE_BLOCK_DELETE
            - PARTNER_INFO
            - PARTNER_UPDATE
            - INTERNAL_PARTNER_CREATE
            - INTERNAL_PARTNER_INFO
            - INTERNAL_PARTNER_LIST
            - INTERNAL_PARTNER_UPDATE
            - INTERNAL_PARTNER_DELETE
            - PARTNER_ACQUIRING_CONFIGURATION_INFO
            - INTERNAL_PARTNER_ACQUIRING_CONFIGURATION_INFO
            - INTERNAL_PARTNER_ACQUIRING_CONFIGURATION_UPDATE
            - PHONE_VERIFICATION_SEND
            - PHONE_VERIFICATION_VERIFY
            - SMS_SEND
            - ADDRESS_VERIFY
            - SCA_DEVICE_CREATE
            - SCA_DEVICE_ACTIVATE
            - SCA_DEVICE_DELETE
            - SHARE_INFO
            - SHARE_CREATE
            - SHARE_UPDATE
            - SHARE_DELETE
            - TERMS_AND_CONDITIONS_INFO
            - TRANSACTION_INFO
            - TRANSACTION_LIST
            - TRANSACTION_INTER_LEDGER
            - TRANSACTION_TO_BENEFICIARY
            - TRANSACTION_DIRECT_DEBIT
            - TRANSACTION_SIMULATE
            - INTERNAL_TRANSACTION_INFO
            - INTERNAL_TRANSACTION_LIST
            - INTERNAL_TRANSACTION_UPDATE
            - INTERNAL_TRANSACTION_INTER_LEDGER
            - INTERNAL_TRANSACTION_TO_BENEFICIARY
            - INTERNAL_TRANSACTION_DIRECT_DEBIT
            - ACQUIRING_CREATE_ACCOUNT_LOAD
            - ACQUIRING_CREATE_PAYMENT
            - USER_LOGIN
            - USER_CHANGE_PASSWORD
            - USER_REFRESH_LOGIN
            - USER_RESET_PASSWORD
            - WEB_PAGE_RETRIEVE
            - WEBHOOK_PORTAL
            - CRYPTO_WALLET_CREATE
            - CRYPTO_WALLET_LIST
            - CRYPTO_WALLET_INFO
            - INTERNAL_CRYPTO_WALLET_LIST
            - INTERNAL_CRYPTO_WALLET_INFO
            - CRYPTO_BENEFICIARY_CREATE
            - CRYPTO_BENEFICIARY_LIST
            - CRYPTO_BENEFICIARY_UPDATE
            - CRYPTO_BENEFICIARY_INFO
            - INTERNAL_CRYPTO_BENEFICIARY_LIST
            - INTERNAL_CRYPTO_BENEFICIARY_INFO
            - INTERNAL_CRYPTO_BENEFICIARY_UPDATE
            - CRYPTO_TRANSACTION_LIST
            - INTERNAL_CRYPTO_TRANSACTION_LIST
            - CRYPTO_TRANSACTION_CREATE
            - CRYPTO_TRANSACTION_INFO
            - INTERNAL_CRYPTO_TRANSACTION_INFO
            - UNKNOWN
    ListResponseDtoInternalOperationRestrictionListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/InternalOperationRestrictionListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    DebtorBankingDetails_Internal:
      type: object
      anyOf:
        - $ref: '#/components/schemas/SepaDebtorBankingDetails_Internal'
    DebtorInfoResponseDto_Internal:
      required:
        - name
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        name:
          type: string
        bankingDetails:
          $ref: '#/components/schemas/DebtorBankingDetails_Internal'
        ledgerId:
          type: string
          description: >-
            Sometimes the debtor account can correspond to a ledger that you
            manage, in this case, we would send you the corresponding id.
          format: uuid
    DirectDebitMandateListElementDto_Internal:
      required:
        - creationDate
        - debtor
        - endUserId
        - id
        - status
        - uniqueReference
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        uniqueReference:
          type: string
        endUserId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - AWAITING_ACTIVATION
            - ACTIVATING
            - ACTIVATED
            - CANCELING
            - CANCELED
            - FAILED
        friendlyName:
          type: string
        debtor:
          $ref: '#/components/schemas/DebtorInfoResponseDto_Internal'
        recurring:
          type: boolean
        expirationDate:
          type: string
          format: date
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    ListResponseDtoDirectDebitMandateListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/DirectDebitMandateListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    SepaDebtorBankingDetails_Internal:
      required:
        - bic
        - iban
      type: object
      properties:
        iban:
          type: string
          description: Must be a valid iban format following the standard ISO_13616.
        bic:
          type: string
          description: Must be a valid bic following the standard ISO_9362.
    DirectDebitMandateInfoResponseDto_Internal:
      required:
        - creationDate
        - debtor
        - endUserId
        - id
        - status
        - uniqueReference
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        uniqueReference:
          type: string
        endUserId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - AWAITING_ACTIVATION
            - ACTIVATING
            - ACTIVATED
            - CANCELING
            - CANCELED
            - FAILED
        friendlyName:
          type: string
        debtor:
          $ref: '#/components/schemas/DebtorInfoResponseDto_Internal'
        recurring:
          type: boolean
        expirationDate:
          type: string
          format: date
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    InternalLedgerListElementDto:
      required:
        - country
        - creationDate
        - currency
        - endUser
        - id
        - isUpgraded
        - partner
        - status
      type: object
      properties:
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto'
        isUpgraded:
          type: boolean
        id:
          type: string
          format: uuid
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        parentId:
          type: string
          description: The id of the parent ledger if this ledger is virtual
          format: uuid
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        friendlyName:
          type: string
        endUser:
          $ref: '#/components/schemas/EndUserIdResponseDto'
        creationDate:
          type: string
          format: date-time
    ListResponseDtoInternalLedgerListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/InternalLedgerListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    PartnerShortInfoResponseDto:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    ClassicLedgerInfoResponseDto_Internal:
      required:
        - availableAmount
        - country
        - creationDate
        - currency
        - endUserId
        - id
        - isUpgraded
        - limits
        - reservedAmount
        - status
        - suspensionsInformation
        - totalAmount
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUserId:
          type: string
          format: uuid
        friendlyName:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        totalAmount:
          type: number
        availableAmount:
          type: number
        reservedAmount:
          type: number
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        isUpgraded:
          type: boolean
          description: >-
            When inactive, no external banking information will be returned.
            Assign an account number to enable the fields.
        iban:
          type: string
        bicOrSwift:
          type: string
        accountNumber:
          type: string
        sortCode:
          type: string
        routingNumber:
          type: string
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/LedgerSuspensionInfoDto_Internal'
        limits:
          $ref: '#/components/schemas/LedgerLimitsWithUsageResponseDto_Internal'
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        cbsId:
          type: string
        type:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_ESTONIA
            - EUR_LITHUANIA
            - USD_USA
            - GBP_GREAT_BRITAIN
            - EUR_BG
        cbsData:
          $ref: '#/components/schemas/JsonNode_Internal'
        closeInformation:
          $ref: '#/components/schemas/LedgerCloseInfoDto_Internal'
    JsonNode_Internal:
      type: object
    LedgerCloseInfoDto_Internal:
      required:
        - date
        - operator
      type: object
      properties:
        date:
          type: string
          format: date-time
        reason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    LedgerLimitsWithUsageResponseDto_Internal:
      required:
        - ddMonthlyLimit
        - ddMonthlyLimitUsed
        - ddTransactionLimit
        - transactionDailyLimit
        - transactionDailyLimitUsed
        - transactionLimit
        - transactionMonthlyLimit
        - transactionMonthlyLimitUsed
      type: object
      properties:
        ddTransactionLimit:
          type: number
          description: >-
            Direct debit transaction limit. If null, it will take the default
            value defined in the partner configuration.
        ddMonthlyLimit:
          type: number
          description: >-
            Direct Debit Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
        ddMonthlyLimitUsed:
          type: number
        transactionLimit:
          type: number
          description: >-
            Transaction Limit. If null, it will take the default value defined
            in the partner configuration.
        transactionDailyLimit:
          type: number
          description: >-
            Transaction Daily Limit. If null, it will take the default value
            defined in the partner configuration.
        transactionDailyLimitUsed:
          type: number
        transactionMonthlyLimit:
          type: number
          description: >-
            Transaction Monthly Limit. If null, it will take the default value
            defined in the partner configuration.
        transactionMonthlyLimitUsed:
          type: number
    LedgerResponseDto_Internal:
      required:
        - country
        - creationDate
        - currency
        - endUserId
        - id
        - limits
        - status
        - suspensionsInformation
        - updateDate
      type: object
      properties:
        closeInformation:
          $ref: '#/components/schemas/LedgerCloseInfoDto_Internal'
        id:
          type: string
          format: uuid
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        friendlyName:
          type: string
        endUserId:
          type: string
          format: uuid
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        accountNumber:
          type: string
        sortCode:
          type: string
        iban:
          type: string
        bicOrSwift:
          type: string
        routingNumber:
          type: string
        limits:
          $ref: '#/components/schemas/LedgerLimitsWithUsageResponseDto_Internal'
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/LedgerSuspensionInfoDto_Internal'
      anyOf:
        - $ref: '#/components/schemas/ClassicLedgerInfoResponseDto_Internal'
        - $ref: '#/components/schemas/VirtualLedgerInfoResponseDto_Internal'
    LedgerSuspensionInfoDto_Internal:
      required:
        - date
        - operator
      type: object
      properties:
        date:
          type: string
          format: date-time
        reason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    VirtualLedgerInfoResponseDto_Internal:
      required:
        - country
        - creationDate
        - currency
        - endUserId
        - id
        - limits
        - parentId
        - status
        - suspensionsInformation
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        parentId:
          type: string
          description: The id of the parent ledger if this ledger is virtual
          format: uuid
        endUserId:
          type: string
          format: uuid
        friendlyName:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSING
            - CLOSED
            - SUSPENDED
            - FAILED
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        country:
          type: string
          enum:
            - ESTONIA
            - FRANCE
            - BELGIUM
            - GREAT_BRITAIN
            - LITHUANIA
            - BULGARIA
            - USA
        totalAmount:
          type: number
        availableAmount:
          type: number
        reservedAmount:
          type: number
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        iban:
          type: string
        bicOrSwift:
          type: string
        accountNumber:
          type: string
        sortCode:
          type: string
        routingNumber:
          type: string
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/LedgerSuspensionInfoDto_Internal'
        limits:
          $ref: '#/components/schemas/LedgerLimitsWithUsageResponseDto_Internal'
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        cbsId:
          type: string
        type:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_ESTONIA
            - EUR_LITHUANIA
            - USD_USA
            - GBP_GREAT_BRITAIN
            - EUR_BG
        cbsData:
          $ref: '#/components/schemas/JsonNode_Internal'
        closeInformation:
          $ref: '#/components/schemas/LedgerCloseInfoDto_Internal'
    InternalKycApplicationListElementDto:
      required:
        - creationDate
        - id
        - partnerId
        - personId
        - personType
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        partnerId:
          type: string
          format: uuid
        personId:
          type: string
          format: uuid
        personType:
          type: string
          enum:
            - CONSUMER
            - CORPORATE_RELATED_PHYSICAL_PERSON
        address:
          $ref: '#/components/schemas/AddressResponseDto'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthDate:
          type: string
          format: date
        emailAddress:
          type: string
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        status:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        kycStatusReason:
          type: string
        internalKycStatusReason:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
    ListResponseDtoInternalKycApplicationListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/InternalKycApplicationListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    IdentityDocumentInfo_Internal:
      required:
        - id
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - PASSPORT
            - DRIVING_LICENCE
            - IDENTITY_CARD
            - RESIDENCE_PERMIT
            - OTHER
        lastName:
          type: string
        firstName:
          type: string
        middleName:
          type: string
        gender:
          type: string
        birthDate:
          type: string
          format: date
        documentNumber:
          type: string
        countryOfIssue:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        issueDate:
          type: string
          format: date
        expiryDate:
          type: string
          format: date
        birthPlace:
          type: string
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
    KycApplicationInfoResponseDto_Internal:
      required:
        - accessType
        - creationDate
        - id
        - person
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        person:
          $ref: '#/components/schemas/PersonInfo_Internal'
        address:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthDate:
          type: string
          format: date
        emailAddress:
          type: string
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        status:
          $ref: '#/components/schemas/KycStatusInfo_Internal'
        accessType:
          type: string
          enum:
            - LINK
            - SDK
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        partner:
          $ref: '#/components/schemas/PartnerInfo_Internal'
        link:
          type: string
        platformId:
          type: string
        cbsId:
          type: string
        identityDocument:
          $ref: '#/components/schemas/IdentityDocumentInfo_Internal'
        onboardingCity:
          type: string
        onboardingCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        internalNote:
          type: string
        kycDocuments:
          $ref: '#/components/schemas/KycDocumentsResponseDto_Internal'
        kycPlatform:
          $ref: '#/components/schemas/KycPlatformResponseDto_Internal'
    KycDocumentsResponseDto_Internal:
      type: object
      properties:
        summaryId:
          type: string
          description: The id of the KYC summary document.
          format: uuid
        frontId:
          type: string
          description: The id of the front KYC identity document.
          format: uuid
        backId:
          type: string
          description: The id of the back KYC identity document.
          format: uuid
        selfieId:
          type: string
          description: The id of the KYC selfie document.
          format: uuid
    KycPlatformResponseDto_Internal:
      required:
        - amlScreeningHit
        - initialResult
        - kycApprovalDate
        - kycCreationDate
        - name
      type: object
      properties:
        kycId:
          type: string
          description: The id from the KYC platform system.
        name:
          type: string
          enum:
            - GETID
            - SUMSUB
            - OTHER
        initialResult:
          type: string
          description: The status result returned initially by the KYC platform used.
          enum:
            - VALIDATED
            - REVIEW
            - DECLINED
        kycCreationDate:
          type: string
          format: date-time
        kycApprovalDate:
          type: string
          format: date-time
        kycType:
          type: string
          enum:
            - FULL_KYC
            - DOC_ONLY
        amlScreeningHit:
          type: boolean
        amlScreeningHitResult:
          type: string
          description: >-
            The aml screening hit result returned by the KYC platform used,
            mandatory if amlScreeningHit is set to true.
          enum:
            - TRUE_POSITIVE
            - FALSE_POSITIVE
    KycStatusInfo_Internal:
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        reason:
          type: string
        internalReason:
          type: string
    PartnerInfo_Internal:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    PersonInfo_Internal:
      required:
        - id
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - CONSUMER
            - CORPORATE_RELATED_PHYSICAL_PERSON
    ExternalCardListElementDto_Internal:
      required:
        - cardHolderName
        - creationDate
        - endUserId
        - expiryDate
        - id
        - maskedPan
        - scheme
        - type
        - validityDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUserId:
          type: string
          format: uuid
        maskedPan:
          type: string
        cardHolderName:
          type: string
        scheme:
          type: string
        type:
          type: string
        expiryDate:
          type: string
        creationDate:
          type: string
          format: date-time
        validityDate:
          type: string
          format: date-time
        partnerId:
          type: string
          format: uuid
        partnerName:
          type: string
        xref:
          type: string
    ListResponseDtoExternalCardListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ExternalCardListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    DocumentListElementDto_Internal:
      required:
        - creationDate
        - endUser
        - id
        - requested
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUser:
          $ref: '#/components/schemas/EndUserIdResponseDto_Internal'
        friendlyName:
          type: string
        fileName:
          type: string
        type:
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DILIGENCE_REVIEW
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        status:
          type: string
          enum:
            - UPLOADED
            - REQUESTED
            - DECLINED
            - VALIDATED
        transactionId:
          type: string
          description: >-
            ID of the transaction if the document is a TRANSACTION_RECEIPT or
            any document related to a transaction.
          format: uuid
        beneficiaryId:
          type: string
          description: ID of the beneficiary associated with the document.
          format: uuid
        corporateRelatedId:
          type: string
          description: ID of the corporate related associated with the document.
          format: uuid
        addressId:
          type: string
          description: ID of the address associated with the document.
          format: uuid
        requested:
          type: boolean
        creationDate:
          type: string
          format: date-time
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        uploadedToCbs:
          type: boolean
    EndUserIdResponseDto_Internal:
      title: End-user
      required:
        - id
      type: object
      properties:
        id:
          type: string
          format: uuid
    ListResponseDtoDocumentListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/DocumentListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    DocumentInfoResponseDto_Internal:
      required:
        - creationDate
        - endUser
        - id
        - requested
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUser:
          $ref: '#/components/schemas/EndUserIdResponseDto_Internal'
        contentType:
          type: string
        type:
          type: string
          enum:
            - ARTICLE_OF_ASSOCIATION
            - BANK_ACCOUNT_DETAILS
            - BANK_ACCOUNT_STATEMENT
            - COMPANY_INCORPORATION
            - COMPANY_REGISTRY_EXTRACT
            - DILIGENCE_REVIEW
            - DIRECT_DEBIT_MANDATE
            - DRIVING_LICENCE
            - FAMILY_RECORD_BOOK
            - HEALTH_INSURANCE
            - IDENTITY_CARD
            - INVOICE
            - KYC_SUMMARY
            - PASSPORT
            - PAYSLIP
            - POWER_OF_ATTORNEY
            - PROOF_OF_ADDRESS
            - RESIDENCE_PERMIT
            - RESUME
            - RISK_ASSESSMENT
            - SELFIE
            - SHAREHOLDING_STRUCTURE
            - SOURCE_OF_FUNDS
            - SOURCE_OF_WEALTH_DECLARATION
            - TAX_STATEMENT
            - TRANSACTION_RECEIPT
            - UBO_REGISTRY
            - VISA
            - OTHER
        friendlyName:
          type: string
        fileName:
          type: string
        status:
          type: string
          enum:
            - UPLOADED
            - REQUESTED
            - DECLINED
            - VALIDATED
        transactionId:
          type: string
          description: >-
            ID of the transaction if the document is a TRANSACTION_RECEIPT or
            any document related to a transaction.
          format: uuid
        beneficiaryId:
          type: string
          description: ID of the beneficiary associated with the document.
          format: uuid
        corporateRelatedId:
          type: string
          description: ID of the corporate related associated with the document.
          format: uuid
        addressId:
          type: string
          description: ID of the address associated with the document.
          format: uuid
        requested:
          type: boolean
        note:
          type: string
        verificationDate:
          type: string
          format: date-time
        uploadDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        download:
          $ref: '#/components/schemas/Download_Internal'
        uploadedToCbs:
          type: boolean
          description: >-
            Indicates if the document has been uploaded to the CBS (If updated
            to true, it will be automatically uploaded to the CBS).
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    Download_Internal:
      required:
        - ttl
        - url
      type: object
      properties:
        url:
          type: string
        ttl:
          type: string
          example: PT8H6M12.345S
    CryptoWalletListResponseElementDto_Internal:
      required:
        - blockchain
        - creationDate
        - endUserId
        - id
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        providerId:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSED
            - FAILED
        friendlyName:
          type: string
        address:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        endUserId:
          type: string
          format: uuid
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    ListResponseDtoCryptoWalletListResponseElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CryptoWalletListResponseElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    CryptoAsset_Internal:
      required:
        - balance
        - blockchain
        - decimals
        - symbol
      type: object
      properties:
        symbol:
          type: string
        decimals:
          type: integer
          format: int32
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        balance:
          type: string
        contract:
          type: string
        name:
          type: string
        verified:
          type: boolean
    CryptoWalletGetResponseDto_Internal:
      required:
        - assets
        - blockchain
        - creationDate
        - endUserId
        - id
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        providerId:
          type: string
        status:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - CLOSED
            - FAILED
        friendlyName:
          type: string
        address:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        endUserId:
          type: string
          format: uuid
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        assets:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CryptoAsset_Internal'
    CryptoTransactionActorResponseDto_Internal:
      title: Crypto Transaction Actor
      type: object
      properties:
        endUserId:
          type: string
          format: uuid
        name:
          type: string
        walletId:
          type: string
          format: uuid
        walletAddress:
          type: string
        walletFriendlyName:
          type: string
    CryptoTransactionFeesResponseDto_Internal:
      title: Crypto Transaction Fees
      required:
        - asset
        - decimals
      type: object
      properties:
        amount:
          type: number
        asset:
          type: string
        decimals:
          type: integer
          format: int32
    CryptoTransactionInformationResponseDto_Internal:
      title: Crypto Transaction Information
      required:
        - blockchain
      type: object
      properties:
        blockchain:
          type: string
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        transactionHash:
          type: string
        note:
          type: string
    CryptoTransactionResponseDto_Internal:
      required:
        - amount
        - asset
        - creationDate
        - decimals
        - id
        - information
        - paymentType
        - status
        - type
      type: object
      properties:
        id:
          type: string
          format: uuid
        paymentType:
          type: string
          enum:
            - TOKEN_SEND
            - TOKEN_RECEIVE
        type:
          type: string
          enum:
            - DIGITAL_ASSETS
        status:
          type: string
          enum:
            - APPROVED
            - PENDING
            - DECLINED
        amount:
          type: number
        asset:
          type: string
        decimals:
          type: integer
          format: int32
        information:
          $ref: >-
            #/components/schemas/CryptoTransactionInformationResponseDto_Internal
        fees:
          $ref: '#/components/schemas/CryptoTransactionFeesResponseDto_Internal'
        sender:
          $ref: '#/components/schemas/CryptoTransactionActorResponseDto_Internal'
        receiver:
          $ref: '#/components/schemas/CryptoTransactionActorResponseDto_Internal'
        reference:
          type: string
        creationDate:
          type: string
          format: date-time
        confirmationDate:
          type: string
          format: date-time
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        providerId:
          type: string
      description: The information on a crypto transaction.
    ListResponseDtoCryptoTransactionResponseDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CryptoTransactionResponseDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    CryptoBeneficiaryResponseDto_Internal:
      required:
        - active
        - creationDate
        - display
        - id
        - name
        - status
        - type
        - updateDate
        - walletDetails
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        friendlyName:
          type: string
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        active:
          type: boolean
        display:
          type: boolean
        status:
          type: string
          enum:
            - DECLINED
            - PENDING_REVIEW
            - VALID
            - PENDING
            - NEED_ADDITIONAL_INFORMATION
        walletDetails:
          $ref: '#/components/schemas/WalletDetails_Internal'
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
      description: The information on a crypto beneficiary.
    ListResponseDtoCryptoBeneficiaryResponseDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CryptoBeneficiaryResponseDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    WalletDetails_Internal:
      required:
        - address
        - blockchain
        - type
      type: object
      properties:
        address:
          type: string
          description: Counterparty wallet address.
        blockchain:
          type: string
          description: >-
            Counterparty wallet blockchain. The enumeration is the same as the
            one in Create Wallet endpoint because you can only create
            transactions on the same blockchain as the wallet sender.
          enum:
            - BITCOIN
            - ETHEREUM
            - BNB_SMART_CHAIN
        type:
          type: string
          enum:
            - CUSTODIAL
            - NON_CUSTODIAL
        provider:
          type: string
          description: Optional, used only for CUSTODIAL wallets.
    CorporateListElementDto_Internal:
      required:
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - registeredName
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        registeredName:
          type: string
        incorporationCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
        status:
          $ref: '#/components/schemas/CorporateStatusResponseDto_Internal'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        partnerId:
          type: string
          format: uuid
        partnerName:
          type: string
    CorporateStatusResponseDto_Internal:
      title: CorporateStatus
      required:
        - banking
        - compliance
        - kyb
        - linkcy
        - overall
        - suspension
      type: object
      properties:
        banking:
          $ref: '#/components/schemas/EndUserBanking_Internal'
        kyb:
          $ref: '#/components/schemas/KybResponse_Internal'
        suspension:
          $ref: '#/components/schemas/EndUserSuspension_Internal'
        linkcy:
          $ref: '#/components/schemas/EndUserLinkcy_Internal'
        compliance:
          $ref: '#/components/schemas/EndUserCompliance_Internal'
        overall:
          $ref: '#/components/schemas/Overall_Internal'
    EndUserBanking_Internal:
      title: Banking
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - VALIDATED
            - PENDING
            - MISSING_DATA
            - BLOCKED
            - NOT_CREATED
        reason:
          type: string
    EndUserSuspension_Internal:
      title: Suspension
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - SUSPENDED
            - NOT_SUSPENDED
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        reason:
          type: string
    KybResponse_Internal:
      title: Kyb
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - COMPLETING
            - PENDING_VERIFICATION
            - NEED_ADDITIONAL_INFORMATION
            - DECLINED
            - VALIDATED
        reason:
          type: string
        lastVerificationRequestDate:
          type: string
          format: date-time
        internalReason:
          type: string
    ListResponseDtoCorporateListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CorporateListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    Overall_Internal:
      title: Overall
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
    ComplianceInfo_Internal:
      required:
        - isExtendedUbos
        - maxUbosLayer
        - relatedLayersTotal
      type: object
      properties:
        maxUbosLayer:
          type: integer
          format: int32
        relatedLayersTotal:
          type: integer
          format: int32
        isExtendedUbos:
          type: boolean
    CorporateFinancialInformationResponseDto_Internal:
      title: FinancialInformation
      type: object
      properties:
        expectedMonthlyOutgoingVolume:
          type: string
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        monthlyNetIncome:
          type: string
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingVolume:
          type: string
          enum:
            - LESS_THAN_10_000
            - BTW_10_000_AND_50_000
            - BTW_50_000_AND_250_000
            - MORE_THAN_250_000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    CorporateInfoResponseDto_Internal:
      required:
        - accountPurposes
        - complianceInfo
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - industry
        - registeredAddress
        - registeredName
        - scaDevices
        - status
        - strongAuthentication
        - termsAccepted
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        registeredName:
          type: string
        tradeName:
          type: string
        incorporationCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
        incorporationDate:
          type: string
          format: date
        legalType:
          type: string
          enum:
            - AL_SHOQERI_AKSIONERE_SHA
            - AL_SHOQERI_KOLEKTIVE
            - AL_SHOQERI_KOMANDITE
            - AL_SHOQERI_ME_PERGJEGJESI_TE_KUFIZUAR_SHPK
            - AR_SOCIEDAD_ANONIMA_SA
            - AR_SOCIEDAD_COLECTIVA_SOCCOL
            - AR_SOCIEDAD_DEL_ESTADO_SE
            - AR_SOCIEDAD_DE_CAPITAL_E_INDUSTRIA_SCEI
            - AR_SOCIEDAD_DE_GARANTIA_RECIPROCA_SGR
            - AR_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_SRL
            - AR_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_SCPA
            - AR_SOCIEDAD_EN_COMANDITA_SIMPLE_SCS
            - AT_AKTIENGESELLSCHAFT_AG
            - AT_EINGETRAGENES_EINZELUNTERNEHMEN_EU
            - AT_EUROPEAN_BUSINESS_ENTITIES
            - AT_GENOSSENSCHAFT_GEN
            - AT_GESELLSCHAFT_DES_BURGERLICHEN_RECHTS_GESBR
            - AT_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - AT_KOMMANDITERWERBSGESELLSCHAFT_KEG
            - AT_KOMMANDITGESELLSCHAFT_KG
            - AT_OFFENE_ERWERBSGESELLSCHAFT_OEG
            - AT_OFFENE_GESELLSCHAFT_OG
            - AT_PRIVATSTIFTUNG
            - AT_STILLE_GESELLSCHAFT_STG
            - AT_VEREIN
            - AU_INCORPORATED_INC
            - AU_LIMITED_LTD
            - AU_NO_LIABILITY_NL
            - AU_PROPRIETARY_LIMITED_COMPANY_PTYLTD
            - AU_UNLIMITED_PROPRIETARY_PTY
            - BA_AKCIONARSKO_DRUSTVO_AD
            - BA_DIONICKO_DRUSTVO_DD
            - BA_DRUSTVO_S_NEOGRANICENOM_SOLIDARNOM_ODGOVORNOSCU_DNO
            - BA_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_DOO
            - BA_KOMANDITNO_DRUSTVO_KD
            - BA_SAMOSTALNI_PREDUZETNIK_SP
            - BE_ASSOCIATION_SANS_BUT_LUCRATIF_ASBL
            - BE_BESLOTEN_VENNOOTSCHAP_BV
            - BE_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_BVBA
            - BE_COMMANDITAIRE_VENNOOTSCHAP_OP_AANDELEN_COMMVA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_CVBA
            - BE_COOPERATIEVE_VENNOOTSCHAP_MET_ONBEPERKTE_AANSPRAKELIJKHEID_CVOA
            - BE_ECONOMISCH_SAMENWERKINGSVERBAND_ESV
            - BE_EENMANSZAAK
            - >-
              BE_EENPERSOONS_BESLOTEN_VENNOOTSCHAP_MET_BEPERKTE_AANSPRAKELIJKHEID_EBVBA
            - BE_ENTREPRISE_INDIVIDUELLE
            - BE_FEITELIJKE_VERENIGING
            - BE_FONDATION_DUTILITE_PUBLIQUE
            - BE_FONDATION_PRIVEE
            - BE_GEWONE_COMMANDITAIRE_VENNOOTSCHAP_COMMV
            - BE_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - BE_NAAMLOZE_VENNOOTSCHAP_NV
            - BE_PRIVATE_STICHTING
            - BE_SOCIETE_ANONYME_SA
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_ILLIMITEE_SCRI
            - BE_SOCIETE_COOPERATIVE_A_RESPONSABILITE_LIMITEE_SCRL
            - BE_SOCIETE_DE_FAIT
            - BE_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - BE_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - BE_SOCIETE_EN_NOM_COLLECTIF_SN
            - BE_SOCIETE_EN_PARTICIPATION_SEP
            - BE_SOCIETE_INTERNE
            - BE_SOCIETE_MOMENTANEE
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_SPRL
            - BE_SOCIETE_PRIVEE_A_RESPONSABILITE_LIMITEE_UNIPERSONNELLE_SPRLU
            - BE_STICHTING_VAN_OPENBAAR_NUT
            - BE_STILLE_HANDELSVENNOOTSCHAP
            - BE_TIJDELIJKE_HANDELSVENNOOTSCHAP
            - BE_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - BE_VEREINIGUNG_OHNE_GEWINNERZIELUNGSABSICHT_VOG
            - BE_VERENIGING_IN_DEELNEMING
            - BE_VERENIGING_ZONDER_WINSTOOGMERK_VZW
            - BG_AKTSIONERNO_DRUJESTVO_AD
            - >-
              BG_AKTSIONERNO_DRUZHESTVO_SUS_SPETSIALNA_INVESTITSIONNA_TSEL_ADSITZ
            - BG_DRUJESTVO_S_OGRANICHENA_OTGOVORNOST_OOD
            - BG_EDNOLICHEN_TURGOVETZ_ET
            - BG_EDNOLICHNO_AKTSIONERNO_DRUZHESTVO_EAD
            - BG_EDNOLICHNO_DRUZHESTVO_S_OGRANICHENA_OTGOVORNOST_EOOD
            - BG_KOMANDITNO_DRUZHESTVO_KD
            - BG_KOMANDITNO_DRUZHESTVO_S_AKTZII_KDA
            - BG_SUBIRATELNO_DRUZHESTVO_SD
            - BN_COMPANY
            - BN_PARTNERSHIP
            - BN_SOLE_PROPRIETORSHIP
            - BR_ASSOCIACAO_EM_SENTIDO_ESTRITO
            - BR_COOPERATIVA
            - BR_EMPRESA_INDIVIDUAL_DE_RESPONSABILIDADE_LIMITADA_EIRELI
            - BR_EMPRESA_INDIVIDUAL_FIRMA_INDIVIDUAL
            - BR_EMPRESA_PUBLICA
            - BR_FUNDACAO_PRIVADA
            - BR_FUNDACAO_PUBLICA
            - BR_MICRO_EMPREENDEDOR_INDIVIDUAL
            - BR_ORGANIZACAO_DA_SOCIEDADE_CIVIL_DE_INTERESSE_PUBLICO
            - BR_ORGANIZACAO_NAO_GOVERNAMENTAL
            - BR_ORGANIZACAO_SOCIAL
            - BR_SERVICOS_SOCIAIS_AUTONOMOS
            - BR_SOCIEDADE_ANONIMA_SA
            - BR_SOCIEDADE_DE_ECONOMIA_MISTA
            - BR_SOCIEDADE_EM_COMANDITA_SIMPLES
            - BR_SOCIEDADE_EM_COMUM
            - BR_SOCIEDADE_EM_CONTA_DE_PARTICIPACAO
            - BR_SOCIEDADE_EM_NOME_COLETIVO
            - BR_SOCIEDADE_LIMITADA_LTDA
            - BR_SOCIEDADE_SIMPLES
            - CA_CORPORATION
            - CA_GENERAL_PARTNERSHIP_GP
            - CA_JOINT_VENTURE
            - CA_LIMITED_PARTNERSHIP_LP
            - CA_SOLE_PROPRIETORSHIP_SP
            - CH_AKTIENGESELLSCHAFT_AG
            - CH_ASSOCIATION
            - CH_ASSOCIAZIONE
            - CH_DITTA_INDIVIDUALE
            - CH_EINFACHE_GESELLSCHAFT_EG
            - CH_EINZELUNTERNEHMEN
            - CH_ENTREPRISE_INDIVIDUELLE
            - CH_FONDATION
            - CH_FONDAZIONE
            - CH_GENOSSENSCHAFT
            - CH_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - CH_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - CH_GRUPPO_DI_INTERESSE_ECONOMICO
            - CH_INVESTMENTGESELLSCHAFT_MIT_FESTEM_KAPITAL
            - CH_INVESTMENTGESELLSCHAFT_MIT_VARIABLEM_KAPITALS
            - CH_INVESTMENT_FUND
            - CH_KOLLEKTIVGESELLSCHAFT_KOLG
            - CH_KOMMANDITAKTIENGESELLSCHAFT_KOMAG
            - CH_KOMMANDITGESELLSCHAFT_KG
            - CH_RAISON_INDIVIDUELLE_RI
            - CH_SOCIETA_ANONIMA_SA
            - CH_SOCIETA_A_GARANZIA_LIMITATA_SAGL
            - CH_SOCIETA_COOPERATIVA
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_FISSO_SICAF
            - CH_SOCIETA_DI_INVESTIMENTO_A_CAPITALE_VARIABILE_SICAV
            - CH_SOCIETA_IN_ACCOMANDITA
            - CH_SOCIETA_IN_ACCOMANDITA_PER_AZIONI
            - CH_SOCIETA_IN_NOME_COLLETTIVO
            - CH_SOCIETA_SEMPLICE
            - CH_SOCIETE_ANONYME_SA
            - CH_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - CH_SOCIETE_COOPERATIVE
            - CH_SOCIETE_COOPERATIVE_SCOOP
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE_SICAF
            - CH_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - CH_SOCIETE_EN_COMMANDITE
            - CH_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - CH_SOCIETE_EN_COMMANDITE_SC
            - CH_SOCIETE_EN_NOM_COLLECTIF
            - CH_SOCIETE_EN_NOM_COLLECTIF_SNC
            - CH_SOCIETE_SIMPLE
            - CH_STIFTUNG
            - CH_SUCCURSALE
            - CH_VEREIN
            - CH_WIRTSCHAFTLICHE_INTERESSENGEMEINSCHAFT_WIG
            - CH_ZWEIGNIEDERLASSUNG
            - CL_EMPRESA_INDIVIDUAL_DE_RESPONSABILIDAD_LIMITADA_EIRL
            - CL_SOCIEDAD_ANONIMA_SA
            - CL_SOCIEDAD_DE_GARANTIA_RECIPROCA_SGR
            - CL_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_LTDA
            - CL_SOCIEDAD_POR_ACCIONES_SPA
            - CO_COMANDITA_POR_ACCIONES_SCA
            - CO_COMANDITA_SIMPLE_S_EN_C
            - CO_EMPRESA_UNIPERSONAL_EU
            - CO_SOCIEDADES_POR_ACCIONES_SIMPLIFICAD_SAS
            - CO_SOCIEDAD_ANONIMA_SA
            - CO_SOCIEDAD_COLECTIVA_SC
            - CO_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_LTDA
            - CY_BUSINESS_NAME_SOLE_TRADER
            - CY_LIMITED_LIABILITY_COMPANY_BY_GUARANTEE_WITHOUT_SHARE_CAPITAL
            - CY_LIMITED_LIABILITY_COMPANY_BY_GUARANTEE_WITH_A_SHARE_CAPITAL
            - CY_OVERSEAS_COMPANY
            - CY_PRIVATE_LIMITED_LIABILITY_COMPANY_BY_SHARES_LTD
            - CY_PUBLIC_LIMITED_LIABILITY_COMPANY_BY_SHARES_PLC
            - CY_PRIVATE_LIMITED_COMPANY_LTD
            - CY_PUBLIC_LIMITED_COMPANY_PLC
            - CY_COMPANY_LIMITED_BY_GUARANTEE
            - CY_GENERAL_PARTNERSHIP
            - CY_LIMITED_PARTNERSHIP
            - CY_SOLO_PROPRIETORSHIP
            - CZ_AKCIOVA_SPOLECNOST_AS
            - CZ_KOMANDITNI_SPOLECNOST_KS
            - CZ_OBECNE_PROSPESNA_SPOLECNOST_OPS
            - CZ_PRISPEVKOVA_ORGANIZACE
            - CZ_SPOLECNOST_S_RUCENIM_OMEZENYM_SRO
            - CZ_STATNI_PODNIK_SP
            - CZ_VEREJNA_OBCHODNI_SPOLECNOST_VOS
            - CZ_ZAPSANY_SPOLEK_ZS
            - CZ_ZIVNOST
            - DE_AKTIENGESELLSCHAFT_AG
            - DE_ALTRECHTLICHER_VEREIN_RECHTSFAHIGER_VEREIN_RV
            - DE_ANSTALT_DES_OFFENTLICHEN_RECHTS
            - DE_EINGETRAGENER_KAUFMANN_EINGETRAGENE_KAUFFRAU_EK_EKFM_EKFR
            - DE_EINGETRAGENER_VEREIN_EV
            - DE_EINGETRAGENE_GENOSSENSCHAFT_EG
            - DE_EINZELUNTERNEHMEN
            - DE_GESELLSCHAFT_BURGERLICHEN_RECHTS_BGB_GESELLSCHAFT_GBR
            - DE_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - DE_KOMMANDITGESELLSCHAFT_AUF_AKTIEN_KGAA
            - DE_KOMMANDITGESELLSCHAFT_KG
            - DE_NICHT_EINGETRAGENER_VEREI
            - DE_OFFENE_HANDELSGESELLSCHAFT_OHG
            - DE_PARTENREEDEREI
            - >-
              DE_PARTNERSCHAFTSGESELLSCHAFT_MIT_BESCHRANKTER_BERUFSHAFTUNG_PARTGMBBH
            - DE_PARTNERSCHAFTSGESELLSCHAFT_PARTG
            - DE_STIFTUNG
            - DE_STIFTUNG_DES_OFFENTLICHEN_RECHTS
            - DE_UNTERNEHMERGESELLSCHAFT_UG
            - DE_WIRTSCHAFTLICHER_VEREIN
            - DK_AKTIESELSKAB_A_S
            - DK_ANDELSSELSKAB_MED_BEGRAENSET_ANSVAR_AMBA
            - DK_ANPARTSSELSKAB_APS
            - DK_ENKELTMANDSVIRKSOMHED
            - DK_ERHVERVSDRIVENDE_FOND
            - DK_FORENING
            - DK_FORENING_MED_BEGRAENSET_ANSVAR_FMBA
            - DK_GENSIDIGT_SELSKAB_G_S
            - DK_INTERESSENTSKAB_I_S
            - DK_IVAERKSAETTERSELSKAB_IVS
            - DK_KOMMANDITSELSKAB_K_S
            - DK_PARTNERSELSKAB_OR_KOMMANDITAKTIESELSKAB_P_S
            - DK_PARTSREDERI
            - DK_SELSKAB_MED_BEGRAENSET_ANSVAR_SMBA
            - DO_COMPANIA_POR_ACCIONES_C_POR_A
            - DO_EMPRESA_INDIVIDUAL_DE_RESPONSABILIDAD_LIMITADA_EIRL
            - DO_SOCIEDAD_ANONIMA_SA
            - DO_SOCIEDAD_ANONIMA_SIMPLIFICADA_SAS
            - DO_SOCIEDAD_DE_RESPOSABILIDAD_LIMITADA_SRL
            - DO_SOCIEDAD_EN_COMANDITA_SIMPLE
            - EC_COMPANIA_ANONIMA_CA
            - EC_COMPANIA_LIMITADA_CIA_LTDA
            - EC_EMPRESA_PUBLICA_EP
            - EC_SOCIEDAD_ANONIMA_SA
            - EEA_EUROPEAN_ECONOMIC_INTEREST_GROUPING_EEIG
            - EEA_SOCIETAS_COOPERATIVA_EUROPAEA_SCE
            - EEA_SOCIETAS_EUROPAEA_SE
            - EEA_SOCIETAS_PRIVATA_EUROPAEA_SPE
            - EE_AKTSIASELTS_AS
            - EE_FUUSILISEST_ISIKUST_ETTEVOTJA_FIE
            - EE_MITTETULUNDUSUHING_MTU
            - EE_OSAUHING_OU
            - EE_TAISUHING_TU
            - EE_TULUNDUSUHISTU
            - EE_USALDUSUHING_UU
            - EG_LIMITED_LIABILITY_COMPANY_LLC
            - EG_SHARIKAT_AL_MOSSAHAMAH_SAE
            - EG_SHARIKAT_TADAMUN
            - EG_SHARIKAT_TAWSSIYAH_BASSITA
            - EG_SHARIKAT_TAWSSIYAH_BELASHOM
            - ES_SOCIEDAD_ANONIMA_DEPORTIVA_SAD
            - ES_SOCIEDAD_ANONIMA_SA
            - ES_SOCIEDAD_CIVIL_PRIVADA_SCP
            - ES_SOCIEDAD_COLECTIVA_SC
            - ES_SOCIEDAD_COMANDITARIA_SCRA
            - ES_SOCIEDAD_COOPERATIVA_SCOOP
            - ES_SOCIEDAD_LIMITADA_LABORAL_SLL
            - ES_SOCIEDAD_LIMITADA_NUEVA_EMPRESA_SLNE
            - ES_SOCIEDAD_LIMITADA_SL
            - ET_COOPERATIVE_SOCIETIES_AMHARIC_CS
            - ET_PRIVATE_LIMITED_COMPANY_AMHARIC_PLC
            - ET_PUBLIC_ENTERPRISES_OR_PUBLIC_CORPORATIONS_AMHARIC_PE_OR_PC
            - ET_SHARE_COMPANY_AMHARIC_SC
            - FI_ASUNTO_OSAKEYHTIO
            - FI_AVOIN_YHTIO_AY
            - FI_EUROOPPALAINEN_TALOUDELLINEN_ETUYHTYMA_EEIG
            - FI_EUROOPPAOSUUSKUNTA_SCE
            - FI_EUROOPPAYHTIO_SE
            - FI_JULKINEN_KESKINAINEN_VAKUUTUSYHTIO_JY
            - FI_JULKINEN_OSAKEYHTIO_OYJ
            - FI_KESKINAINEN_KIINTEISTOOSAKEYHTIO
            - FI_KESKINAINEN_VAKUUTUSYHTIO
            - FI_KESKIVEDENKORKEUDEN_MUUTTAMISTA_VARTEN_PERUSTETTU_YHTEISO
            - FI_KOMMANDIITTIYHTIO_KY
            - FI_KUNNALLINEN_LIIKELAITOS
            - FI_LAIVAISANNISTOYHTIO
            - FI_OJITUSYHTEISO
            - FI_OSAKASKUNTA
            - FI_OSAKEYHTIO_OY
            - FI_OSUUSKUNTA_OSK
            - FI_PALISKUNTA
            - FI_REKISTEROITY_PUOLUE_RP
            - FI_REKISTEROITY_YHDISTYS_RY
            - FI_SAANNOSTELY_YHTEISO
            - FI_SAASTOPANKKI
            - FI_SAATIO_RS
            - FI_TIEKUNTA
            - FI_TOIMINIMI_TMI
            - FI_UITTOYHTEISO
            - FI_USKONNOLLINEN_YHDYSKUNTA
            - FI_VALTION_LIIKELAITOS
            - FI_VESIOIKEUDELLINEN_YHTEISO_BODIES_OF_WATER
            - FI_VOLUNTARY_ASSOCIATIONS_CHARTERED_BY_STATUTE_LAW
            - FI_YHTEISALUE
            - FI_YHTEISMETSA
            - FR_ASSOCIATION_DECLAREE
            - FR_ASSOCIATION_NON_DECLAREE
            - FR_AUTO_ENTREPRENEUR
            - FR_ENTREPRISE_INDIVIDUELLE_ENTREPRISE_EN_NOM_PERSONNEL_EI
            - FR_ENTREPRISE_UNIPERSONNELLE_A_RESPONSABILITE_LIMITEE_EURL
            - FR_FOND_COMMUN_DE_PLACEMENT_FCP
            - FR_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - FR_PROFESSION_LIBERAL
            - FR_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - FR_SOCIETE_ANONYME_SA
            - FR_SOCIETES_DEXERCICE_LIBERAL
            - FR_SOCIETE_COOPERATIVE_DE_PRODUCTION_SCOP
            - FR_SOCIETE_DECONOMIE_MIXTE_SEM
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_FIXE
            - FR_SOCIETE_DINVESTISSEMENT_A_CAPITAL_VARIABLE_SICAV
            - FR_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - FR_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - FR_SOCIETE_EN_NOM_COLLECTIF_SNC
            - FR_SOCIETE_EN_PARTICIPATION_SEP
            - FR_SOCIETE_PAR_ACTIONS_SIMPLIFIEE_SAS
            - FR_SOCIETE_CIVILE_IMMOBILIERE_SCI
            - FR_U_UNIPERSONNELLE_SAS_SASU
            - GB_CHARITABLE_INCORPORATED_ORGANISATION_CIO
            - GB_COMMUNITY_INTEREST_COMPANY_CIC
            - GB_GENERAL_PARTNERSHIP
            - GB_INDUSTRIAL_AND_PROVIDENT_SOCIETY
            - GB_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - GB_LIMITED_PARTNERSHIP_LP
            - GB_PRIVATE_COMPANY_LIMITED_BY_GUARANTEE_LTD
            - GB_PRIVATE_COMPANY_LIMITED_BY_SHARES_LTD
            - GB_PUBLIC_LIMITED_COMPANY_PLC
            - GB_SOLE_PROPRIETORSHIP
            - GB_UNLIMITED_COMPANY
            - GR_ANONIMI_ETERIA_AE
            - GR_ANONIMI_VIOMIHANIKI_EMBORIKI_ETERIA_AVEE
            - GR_ETERIA_PERIORISMENIS_EUTHINIS_EPE
            - GR_ETERORITHMI_ETERIA_EE
            - GR_IDIOTIKI_KEFALEOUHIKI_ETERIA_IKE
            - GR_MONOPROSOPI_ETERIA_PERIORISMENIS_EUTHINIS_MEPE
            - GR_OMORITHMI_ETERIA_OE
            - GR_OMORITHMI_VIOMIHANIKI_EMBORIKI_ETERIA_OVEE
            - GT_SOCIEDAD_ANONIMA_S_A
            - GT_SOCIEDAD_COLECTIVA_Y_CIA_S_C
            - GT_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_CIA_LTDA
            - GT_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_CIA_S_C_A
            - GT_SOCIEDAD_EN_COMANDITA_SIMPLE_Y_CIA_S_EN_C
            - HR_DIONICKO_DRUSTVO_DD
            - HR_DOMACA_RADINOST_AND_SPOREDNO_ZANIMANJE
            - HR_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_DOO
            - HR_GOSPODARSKO_INTERESNO_UDRUZENJE_GIU
            - HR_JAVNO_TRGOVACKO_DRUSTVO_JTD
            - HR_JEDNOSTAVNO_DRUSTVO_S_OGRANICENOM_ODGOVORNOSCU_JDOO
            - HR_KOMANDITNO_DRUSTVO_KD
            - HR_OBITELJSKO_POLJOPRIVREDNO_GOSPODARSTVO_OPG
            - HR_OBRT
            - HR_ORTAKLUK
            - HR_SLOBODNA_DJELATNOST
            - HR_ZADRUGA
            - HT_SOCIEDAD_ANONIMA_SA
            - HU_BETETI_TARSASAG_BT
            - HU_EGYENI_CEG_EC
            - HU_EGYENI_VALLALKOZO_EV
            - HU_EGYESULES
            - HU_KORLATOLT_FELELOSSEGU_TARSASAG_KFT
            - HU_KOZHASZNU_TARSASAG_KHT
            - HU_KOZKERESETI_TARSASAG_KKT
            - HU_KOZOS_VALLALAT_KV
            - HU_NYILVANOSAN_MUKODO_RESZVENYTARSASAG_NYRT
            - HU_RESZVENYTARSASAG_RT
            - HU_SZOVETKEZET_SZOV
            - HU_ZARTKOZUEN_MUKODO_RESZVENYTARSASAG_ZRT
            - ID_FIRMA_FA
            - ID_KOPERASI
            - ID_MAATSCHAP_PERSEKUTUAN_PERDATA
            - ID_PERJAN_PERUSAHAAN_JAWATAN
            - ID_PERSEKUTUAN_KOMANDITER
            - ID_PERSERO
            - ID_PERSEROAN_TERBATAS_PT
            - ID_PERSEROAN_TERBATAS_TERBUKA_OR_PERSEROAN_TERBUKA_PT_TBK
            - ID_PERUM_PERUSAHAAN_UMUM
            - ID_USAHA_DAGANG_UD
            - ID_YAYASAN
            - IE_A_PUBLIC_LIMITED_COMPANY
            - IE_COMPANY_LIMITED_BY_GUARANTEE_HAVING_A_SHARE_CAPITAL
            - IE_COMPANY_LIMITED_BY_GUARANTEE_NOT_HAVING_A_SHARE_CAPITAL
            - IE_PRIVATE_COMPANY_LIMITED_BY_SHARES
            - IE_SINGLE_MEMBER_COMPANY
            - >-
              IE_UNDERTAKINGS_FOR_COLLECTIVE_INVESTMENT_IN_TRANSFERABLE_SECURITIES_UCITS
            - IE_UNLIMITED_COMPANY
            - IL_BEERAVON_MUGBA_BM
            - IL_COOPERATIVE
            - IL_FOREIGN_COMPANY_BRANCH
            - IL_NON_PROFIT_ORGANIZATION
            - IL_PARTNERSHIP
            - IL_PRIVATE_COMPANY
            - IL_PUBLIC_COMPANY
            - IL_SELF_EMPLOYED
            - IN_COOPERATIVE
            - IN_DORMANT_COMPANY
            - IN_FAMILY_OWNED_BUSINESS
            - IN_HINDU_UNDIVIDED_FAMILY_HUF
            - IN_INCORPORATED_COMPANY
            - IN_LIMITED_LIABILITY_PARTNERSHIP
            - IN_ONE_PERSON_COMPANY
            - IN_PARTNERSHIP
            - IN_PRIVATE_LIMITED_COMPANY_PVT_LTD
            - IN_PUBLIC_LIMITED_COMPANY_LTD
            - IN_PUBLIC_SECTOR_UNDERTAKING_PSU
            - IN_REGISTRATION_NOT_REQUIRED
            - IN_SMALL_COMPANY
            - IN_SOLE_PROPRIETORSHIP
            - IN_UNLIMITED_COMPANY
            - IR_SHERKAT_BA_MASOULIYAT_MAHDOUD
            - IR_SHERKAT_MOKHTALET_GHEYR_SAHAMI
            - IR_SHERKAT_MOKHTALET_SAHAMI
            - IR_SHERKAT_NESBI
            - IR_SHERKAT_SAHAMI_AM
            - IR_SHERKAT_SAHAMI_KHAS
            - IR_SHERKAT_TAZAMONI
            - IR_SHERKAT_TA_AVONI_TOLID_VA_MASRAF
            - IS_EINKAHLUTAFELAG_EHF
            - IS_EINSTAKLINGSFYRIRTAEKI
            - IS_HLUTAFELAG_HF
            - IS_OPINBERT_HLUTAFELAG_OHF
            - IS_SAMEIGNARFELAG_SF
            - IS_SAMLAGSFELAG
            - IS_SAMVINNUFELAG
            - IS_SJALFSEIGNARSTOFNUN
            - IT_ARTIGIANO
            - IT_IMPRENDITORE
            - IT_LAVORATORE_AUTONOMO
            - IT_LIBERO_PROFESSIONISTA
            - IT_SOCIETA_A_RESPONSABILITA_LIMITATA_SRL
            - IT_SOCIETA_COOPERATIVA_A_RESPONSABILITA_LIMITATA_SCRL
            - IT_SOCIETA_IN_ACCOMANDITA_PER_AZIONI_SAPA
            - IT_SOCIETA_IN_ACCOMANDITA_SEMPLICE_SAS
            - IT_SOCIETA_IN_NOME_COLLETTIVO_SNC
            - IT_SOCIETA_PER_AZIONI_SPA
            - IT_SOCIETA_SEMPLICE_SS
            - JO_FOREIGN_COMPANY
            - JO_LIMITED_LIABILITY
            - JO_LIMITED_LIABILITY_IN_SHARES
            - JO_PARTNERSHIP
            - JO_PRIVATE_SHAREHOLDING_COMPANIES
            - JO_PUBLIC_SHAREHOLDING
            - JP_GODO_KAISHA_GK
            - JP_GOMEI_KAISHA_GMK
            - JP_GOSHI_KAISHA_GSK
            - JP_KABUSHIKI_KAISHA_KK
            - JP_NINI_KUMIAI_NK
            - JP_TOKUMEI_KUMIAI_TK
            - JP_TOSHI_JIGYO_YUGEN_SEKININ_KUMIAI
            - JP_YUGEN_KAISHA_YK
            - JP_YUGEN_SEKININ_JIGYO_KUMIAI
            - KH_GENERAL_PARTNERSHIP_GP
            - KH_IMPORT_EXPORT_CO_LTD
            - KH_LIMITED_PARTNERSHIP_LP
            - KH_PRIVATE_LIMITED_COMPANY_PTE_LTD
            - KH_PUBLIC_ESTABLISHMENT_WITH_ECONOMIC_CHARACTERISTICS_PEEC
            - KH_PUBLIC_LIMITED_COMPANY_PLC_LTD
            - KH_SINGLE_MEMBER_PRIVATE_LIMITED_COMPANY_SM
            - KH_SOLE_PROPRIETORSHIP_SP
            - KH_STATE_COMPANY
            - KH_STATE_JOINT_VENTURE_COMPANY
            - KR_HAPJA_HOESA
            - KR_HAPMYEONG_HOESA
            - KR_JUSIK_HOESA
            - KR_YUHAN_HOESA
            - KZ_AKTSIONERNOE_OBSCHESTVO_AO
            - KZ_GOSUDARSTVENOE_PREDPRIYATIE_GP
            - KZ_KOMANDITNOE_TOVARISHCHESTVO_KT
            - KZ_OBSHESTVENNOE_OBEDINENIE_OO
            - KZ_POLNOE_TOVARISHCHESTVO_PT
            - KZ_POTREBIBITELSKII_KOOPERATIV_PTK
            - KZ_PROIZVODSTVENNI_KOOPERATIV_PRK
            - KZ_RELITIOZNOE_OBEDINENIE_PO
            - KZ_TOVARISHCHESTVO_S_DOPOLNITELNOYU_OTVETSTVENNOSTYU_TDO
            - KZ_TOVARISHCHESTVO_S_OGRANICHENNOY_OTVETSTVENNOSTYU_TOO
            - KZ_UCHREZHDENIE_UCHR
            - LB_BRANCH_OF_FOREIGN_COMPANY
            - LB_HOLDING_COMPANY
            - LB_OFFSHORE_COMPANY
            - LB_REPRESENTATIVE_OFFICE
            - LB_SOCIETE_ANONYME_LIBANAISE_SAL
            - LB_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - LB_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - LB_SOCIETE_EN_NOM_COLLECTIF_SNC
            - LI_AKTIENGESELLSCHAFT_AG
            - LI_ANSTALT
            - LI_GESELLSCHAFT_MIT_BESCHRANKTER_HAFTUNG_GMBH
            - LI_STIFTUNG
            - LI_TREUHANDSC_TREUUNTERNEHMEN_HAFT
            - LT_AKCINE_BENDROVE_AB
            - LT_INDIVIDUALI_IMONE_II
            - LT_INDIVIDUALI_VEIKLA
            - LT_KOMANDITINE_UKINE_BENDRIJA_KUB
            - LT_MAZOJI_BENDRIJA_MB
            - LT_TIKROJI_UKINE_BENDRIJA_TUB
            - LT_UZDAROJI_AKCINE_BENDROVE_UAB
            - LT_VIESOJI_ISTAIGA_VSI
            - LU_SOCIETE_ANONYME_SA
            - LU_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - LU_SOCIETE_EN_COMMANDITE_SIMPLE_SECS
            - LV_AKCIJU_SABIEDRIBA_AS
            - LV_ARZEMJU_KOMERSANTA_FILIALE_AKF
            - LV_BEZPELNAS_ORGANIZACIJA_BO
            - LV_INDIVIDUALAIS_KOMERSANTS_IK
            - LV_KOMANDITSABIEDRIBA_KS
            - LV_PILNSABIEDRIBA_PS
            - LV_SABIEDRIBA_AR_IEROBEZOTU_ATBILDIBU_SIA
            - MA_GROUPEMENT_DINTERET_ECONOMIQUE_GIE
            - MA_SOCIETE_ANONYME_SA
            - MA_SOCIETE_ANONYME_SIMPLIFIEE_SAS
            - MA_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - MA_SOCIETE_EN_COMMANDITE_PAR_ACTIONS_SCA
            - MA_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - MA_SOCIETE_EN_NOM_COLLECTIF_SNC
            - MC_ASSOCIATION
            - MC_FONDATION
            - MC_SOCIETE_ANONYME_MONEGASQUE_SAM
            - MC_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - MC_SOCIETE_EN_NOM_COLLECTIF_SNC
            - MC_SOCIETE_EN_COMMANDITE_SIMPLE_SCS
            - MC_ENTREPRISE_INDIVIDUELLE_EI
            - MC_SUCCURSALE
            - MC_SOCIETE_CIVILE_IMMOBILIERE_SCI
            - ME_AKCIONARSKO_DRUSTVO_AD
            - ME_DIO_STRANOG_DRUSTVA
            - ME_DRUSTVO_SA_OGRANICENOM_ODGOVORNOSCU_DOO
            - ME_KOMANDITNO_DRUSTVO_KD
            - ME_ORTACKO_DRUSTVO_OD
            - ME_PREDUZETNIK
            - MK_AKCIONERSKO_DRUSTVO_AD
            - MK_DRUSTVO_SO_OGRANICENA_ODGOVORNOST_DOO
            - MK_DRUSTVO_SO_OGRANICENA_ODGOVORNOST_OD_EDNO_LICE_DOOEL
            - MK_JAVNO_TRGOVSKO_DRUSTVO_JTD
            - MK_KOMANDITNO_DRUSTVOO_KD
            - MK_KOMANDITNO_DRUSTVO_SO_AKCIE_KDA
            - MN_KHUVITSAAT_KOMPANI_XK
            - MN_KHYAZGAARLAGDMAL_KHARIUTSLAGATAI_KOMPANI_XXK
            - MN_TERIIN_VUS_VAIGRUULLAGA_TBB
            - MT_PRIVATE_LIMITED_COMPANY
            - MT_PUBLIC_LIABILITY_COMPANY
            - MT_PARTNERSHIP_EN_NOM_COLLECTIF
            - MT_PARTNERSHIP_EN_COMMANDITE
            - MT_LIMITED_LIABILITY_COMPANY_LLC
            - MT_BRANCHES_OF_OVERSEA_COMPANIES
            - MT_GENERAL_PARTNERSHIPS
            - MT_LIMITED_PARTNERSHIPS
            - MX_PERSONA_FISICA
            - MX_SOCIEDAD_ANONIMA_BURSATIL_SAB
            - MX_SOCIEDAD_ANONIMA_PROMOTORA_DE_INVERSION_SAPI
            - MX_SOCIEDAD_ANONIMA_SA
            - MX_SOCIEDAD_DE_RESPONSABILIDAD_LIMITADA_S_DE_RL
            - MX_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_S_EN_C_POR_A
            - MX_SOCIEDAD_EN_COMANDITA_SIMPLE_S_EN_C
            - MX_SOCIEDAD_EN_NOMBRE_COLECTIVO
            - MY_BERHAD_BHD
            - MY_PLT_PLT
            - MY_SENDIRIAN_BERHAD_SDN_BHD
            - NA_CLOSE_CORPORATION
            - NA_COMPANIES
            - NA_CO_OPERATIVES
            - NA_PARTNERSHIP
            - NA_SOLE_TRADER
            - NA_TRUSTS
            - NG_LIMITED_BY_GUARANTEE_LTD_GTE
            - NG_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - NG_PRIVATE_LIMITED_COMPANY_LTD
            - NG_PUBLIC_LIMITED_COMPANY_PLC
            - NG_UNLIMITED_ULTD
            - NI_SOCIEDAD_ANONIMA_SA
            - NI_SOCIEDAD_EN_COMANDITA_POR_ACCIONES_SCA
            - NI_SOCIEDAD_EN_COMANDITA_SIMPLE_SCS
            - NI_SOCIEDAD_EN_NOMBRE_COLECTIVO_CIA
            - >-
              NI_SOCIEDAD_EN_NOMBRE_COLECTIVO_DE_RESPONSABILIDAD_LIMITADA_CIA_LTDA
            - NL_BEPERKTE_AANSPRAKELIJKHEID_BA
            - NL_BESLOTEN_VENNOOTSCHAP_BV
            - NL_COMMANDITAIRE_VENNOOTSCHAP_CV
            - NL_COOPERATIE
            - NL_EENMANSZAAK
            - NL_MAATSCHAP_MTS
            - NL_NAAMLOZE_VENNOOTSCHAP_NV
            - NL_ONDERLINGE_WAARBORGMAATSCHAPPIJ
            - NL_STICHTING
            - NL_UITSLUITING_VAN_AANSPRAKELIJKHEID_UA
            - NL_VENNOOTSCHAP_ONDER_FIRMA_VOF
            - NL_WETTELIJKE_AANSPRAKELIJKHEID_WA
            - NO_AKSJESELSKAP_AS
            - NO_ALLMENNAKSJESELSKAP_ASA
            - NO_ANSVARLIG_SELSKAP_ANS
            - NO_BORETTSLAG_BL
            - NO_ENKELTPERSONFORETAK
            - NO_FYLKESKOMMUNALT_FORETAK_FKF
            - NO_HELSEFORETAK_HF
            - NO_INTERKOMMUNALT_SELSKAP_IKS
            - NO_KOMMANDITTSELSKAP_KS
            - NO_KOMMUNALT_FORETAK_KF
            - NO_NORSKREGISTRERT_UTENLANDSK_FORETAK_NUF
            - NO_REGIONALT_HELSEFORETAK_RHF
            - NO_SELSKAP_MED_BEGRENSET_ANSVAR_BA
            - NO_SELSKAP_MED_DELT_ANSVAR_DA
            - NO_SPAREBANK_SAVINGS_BANK
            - NO_STATE_COUNTY_OR_MUNICIPAL_AGENCY_ETAT
            - NO_STATSFORETAK_SF
            - NO_STIFTELSE
            - NP_BRANCH
            - NP_PRIVATE_LIMITED_COMPANY
            - NZ_LIMITED_LTD
            - NZ_LOOK_THROUGH_COMPANY
            - OM_SOCIETE_ANONYME_OMANAISE_CLOSE_SAOC
            - OM_SOCIETE_ANONYME_OMANAISE_GENERALE_SAOG
            - OTHER
            - PE_SOCIEDAD_ANONIMA_ABIERTA_SAA
            - PE_SOCIEDAD_ANONIMA_SA
            - PH_COMPANIA_CIA
            - PH_COMPANY_CO
            - PH_COOPERATIVE_COOP
            - PH_CORPORATION_CORP
            - PH_ENTERPRISE_ENT
            - PH_INCORPORATED_INC
            - PH_LIMITED_COMPANY_LTD_CO
            - PH_LIMITED_LIABILITY_COMPANY_LLC
            - PH_LIMITED_LTD
            - PH_SOCIEDAD_ANONIMA_SA
            - PK_COMPANY
            - PK_PARTNERSHIP
            - PK_SOLE_PROPRIETORSHIP
            - PL_JEDNOOSOBOWA_DZIALALNOSC_GOSPODARCZA
            - PL_PRZEDSIEBIORSTWO_PANSTWOWE
            - PL_SPOLDZIELNIA
            - PL_SPOLKA_AKCYJNA_SA
            - PL_SPOLKA_CYWILNA_SC
            - PL_SPOLKA_JAWNA_SPJ
            - PL_SPOLKA_KOMANDYTOWA_SPK
            - PL_SPOLKA_KOMANDYTOWO_AKCYJNA_SKA
            - PL_SPOLKA_PARTNERSKA_SPP
            - PL_SPOLKA_Z_OGRANICZONA_ODPOWIEDZIALNOSCIA_SP_Z_OO
            - PT_COOPERATIVA_DE_RESPONSABILIDADE_LIMITADA_CRL
            - PT_LIMITADA_LDA
            - PT_SOCIEDADE_ABERTA_SA
            - PT_SOCIEDADE_FECHADA_SF
            - PT_SOCIEDADE_GESTORA_DE_PARTICIPACOES_SOCIAIS_SGPS
            - RO_ORGANIZATIE_NON_GUVERNAMENTALA_ONG
            - RO_PERSOANA_FIZICA_AUTORIZATA_PFA
            - >-
              RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_CU_PROPRIETAR_UNIC_SRL_CU_PROPRIETAR_UNIC
            - RO_SOCIETATEA_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATEA_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATEA_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATEA_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATEA_PE_ACTIUNI_SA
            - RO_SOCIETATE_CU_RASPUNDERE_LIMITATA_SRL
            - RO_SOCIETATE_IN_COMANDITA_PE_ACTIUNI_SCA
            - RO_SOCIETATE_IN_COMANDITA_SIMPLA_SCS
            - RO_SOCIETATE_IN_NUME_COLECTIV_SNC
            - RO_SOCIETATE_PE_ACTIUNI_SA
            - RS_AKCIONARSKO_DRUSTVO_AD
            - RS_DRUSTVO_SA_OGRANICENOM_ODGOVORNOSCU_DOO
            - RS_JAVNO_PREDUZECE_JP
            - RS_KOMANDITNO_DRUSTVO_KD
            - RS_ORTACKO_DRUSTVO_OD
            - RS_PREDUZETNIK
            - RU_AKTSIONERNOYE_OBSHCHESTVO_AO
            - RU_GOSUDARSTVENNOYE_UNITARNOYE_PREDPRIYATIE_GP_GUP
            - RU_HOZYAYSTVENNOE_PARTNERSTVO
            - RU_INDIVIDUALNY_PREDPRINIMATEL_IP
            - RU_KOMMANDITNOE_TOVARISHESTVO
            - RU_KOOPERATIV
            - RU_NEKOMMERCHESKAYA_ORGANIZATSIYA
            - RU_OBSHCHESTVO_S_OGRANICHENNOY_OTVETSTVENNOSTYU_OOO
            - RU_PROSTOYE_TOVARISHESTVO
            - RU_PUBLICHNOYE_AKTSIONERNOYE_OBSHCHESTVO_PAO
            - SA_FOREIGN_COMPANY
            - SA_GENERAL_PARTNERSHIP_COMPANY
            - SA_INDIVIDUAL_ESTABLISHMENT
            - SA_JOINT_STOCK_COMPANY
            - SA_LIMITED_PARTNERSHIP
            - SA_PRIVATE_LIMITED_COMPANY
            - SE_AKTIEBOLAG_AB
            - SE_BOSTADSRATTSFORENING
            - SE_EKONOMISK_FORENING_EK_FOR
            - SE_ENKELT_BOLAG
            - SE_ENSKILD_FIRMA
            - SE_HANDELSBOLAG_HB
            - SE_HYRESRATTSFORENING
            - SE_IDEELL_FORENING
            - SE_KOMMANDITBOLAG_KB
            - SE_KOOPERATIV
            - SE_PUBLIKT_AKTIEBOLAG_AB_PUBL
            - SE_STIFTELSE
            - SG_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - SG_PRIVATE_LIMITED_COMPANY_SENDIRIAN_BERHAD_PTE_LTD_SDN_BHD
            - SG_PTE_EXIST
            - SG_PUBLIC_LIMITED_COMPANY_BERHAD_LTD_BHD
            - SG_SINGAPORE_SUBSIDIARY_COMPANY
            - SI_DELNISKA_DRUZBA_DD
            - SI_DRUZBA_Z_NEOMEJENO_ODGOVORNOSTJO_DNO
            - SI_DRUZBA_Z_OMEJENO_ODGOVORNOSTJO_DOO
            - SI_KOMANDITNA_DRUZBA_KD
            - SI_SAMOSTOJNI_PODJETNIK_SP
            - SK_AKCIOVA_SPOLOCNOST_AS
            - SK_DRUZSTVO
            - SK_KOMANDITNA_SPOLOCNOST_KS
            - SK_SPOLOCNOST_S_RUCENIM_OBMEDZENYM_SRO
            - SK_VEREJNA_OBCHODNA_SPOLOCNOST_VOS
            - SK_ZIVNOST
            - TN_ENTREPRISE_INDIVIDUELLE
            - TN_SOCIETE_ANONYME_SA
            - TN_SOCIETE_A_RESPONSABILITE_LIMITEE_SARL
            - TN_SOCIETE_UNIPERSONNELLE_A_RESPONSABILITE_LIMITEE_SUARL
            - TR_ADI_SIRKET
            - TR_ANONIM_ORTAKLIK_AO
            - TR_ANONIM_SIRKET_AS
            - TR_HALKA_ACIK_ANONIM_ORTAKLIK_HAAO
            - TR_IRTIBAT_BUROSU
            - TR_KOLEKTIF_SIRKET_KOLL_STI
            - TR_KOMANDIT_SIRKET_KOM_STI
            - TR_KOOPERATIF_SIRKET_KOOP
            - TR_LIMITED_ORTAKLIK_LO
            - TR_LIMITED_SIRKET_LS
            - TR_LIMITED_SIRKET_LTD_STI
            - TR_SAHIS_FIRMASI
            - TR_SUBE_SB
            - TW_LIMITED_COMPANY
            - TW_LIMITED_PARTNERSHIP
            - TW_PUBLIC_LIMITED_COMPANY_OR_CORPORATION
            - TW_UNLIMITED_COMPANY
            - UA_AKTSIONERNE_TOVARYSTVO_AT_AT
            - UA_COMANDYTNE_TOVARYSTVO_KT
            - UA_DERZHAVNE_AKTSIONERNE_TOVARYSTVO_DAT
            - UA_F_O_P_FOP
            - UA_POVNE_TOVARYSTVO_PT
            - UA_PRYVATNE_PIDPRYIEMSTVO_PP
            - UA_TOVARYSTVO_Z_DODATKVOIU_VIDPOVIDALNISTIU_TDV
            - UA_TOVARYSTVO_Z_OBMEZHENOIU_VIDPOVIDALNISTIU_TOV
            - UA_VIDKRYTE_AKTSIONERNE_TOVARYSTV_VAT
            - UA_ZAKRYTE_AKTSIONERNE_TOVARYSTVO_ZAT
            - US_DOING_BUSINESS_AS
            - US_FEDERAL_CREDIT_UNION
            - US_GENERAL_PARTNERSHIP
            - US_INC_CORPORATION_INCORPORATED_CORP
            - US_LIMITED_LIABILITY_COMPANY_LLC_LC_LTDCO
            - US_LIMITED_LIABILITY_LIMITED_PARTNERSHIP_LLLP
            - US_LIMITED_LIABILITY_PARTNERSHIP_LLP
            - US_LIMITED_PARTNERSHIP_LP
            - US_NATIONAL_ASSOCIATION_NA
            - US_NATIONAL_TRUST_AND_SAVINGS_ASSOCIATION_NT_SA
            - US_PROFESSIONAL_CORPORATION_PC
            - US_PROFESSIONAL_LIMITED_LIABILITY_COMPANY_PLLC
            - US_SOLE_PROPRIETORSHIP
            - UZ_AKSIYADORLIK_JAMIYATI_AJ
            - UZ_MASULIYATI_CHEKLANGAN_JAMIYAT_MCHJ
            - UZ_OCHIQ_AKSIYADORLIK_JAMIYATI_OAJ
            - UZ_OILAVIY_KORXONA_OK
            - UZ_QOSHIMCHA_MASULIYATLI_JAMIYAT_QMJ
            - UZ_QOSHMA_KORXONA_QK
            - UZ_UNITAR_KORXONA_UK
            - UZ_XUSUSIY_KORXONA_XK
            - UZ_XUSUSIY_TADBIRKORLIK_XT
            - UZ_YOPIQ_AKSIYADORLIK_JAMIYATI_YOAJ
            - VN_CHI_NHANH
            - VN_CONG_TY_CO_PHAN_CTY_CP
            - VN_CONG_TY_HOP_DANH
            - VN_CONG_TY_NHOM_CTY
            - VN_CONG_TY_TRACH_NHIEM_HUU_HAN_CTY_TNHH
            - VN_CONG_TY_TRACH_NHIEM_HUU_HAN_MOT_THANH_VIEN_CTY_TNHH_MTV
            - VN_DOANH_NGHIEP_CO_VON_DAU_TU_NUOC_NGOAI_DTNN
            - VN_DOANH_NGHIEP_HOP_DANH
            - VN_DOANH_NGHIEP_NHA_NUOC_DNNN
            - VN_DOANH_NGHIEP_TU_NHAN_DNTN
            - VN_HOP_TAC_XA_HTX
            - ZA_BUSINESS_TRUST
            - ZA_CLOSE_CORPORATION_CC_BK
            - ZA_COMPANY_LIMITED_BY_GUARANTEE
            - ZA_INCORPORATED_ASSOCIATION_NOT_FOR_GAIN
            - ZA_PARTNERSHIP
            - ZA_PRIVATE_COMPANY
            - ZA_PUBLIC_COMPANY
            - ZA_SOLE_PROPRIETORSHIP
            - ZA_UNLIMITED_LIABILITY_COMPANY
        website:
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        vatNumber:
          type: string
        registeredAddress:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        businessAddress:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        employeesRange:
          type: string
          enum:
            - BTW_1_AND_10
            - BTW_11_AND_50
            - MORE_THAN_50
        financialInformation:
          $ref: >-
            #/components/schemas/CorporateFinancialInformationResponseDto_Internal
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        complianceInfo:
          $ref: '#/components/schemas/ComplianceInfo_Internal'
        termsAccepted:
          type: boolean
        strongAuthentication:
          $ref: '#/components/schemas/ScaDeviceInfoResponseDto_Internal'
        scaDevices:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ScaDeviceInfoDto_Internal'
        notes:
          type: string
          description: Public additional information concerning this entity.
        internalNotes:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        status:
          $ref: '#/components/schemas/CorporateStatusResponseDto_Internal'
        partnerMetadata:
          title: Metadata
          type: object
        userMetadata:
          title: Metadata
          type: object
        lastTermsAccepted:
          type: string
        cbsId:
          type: string
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        complianceScoring:
          $ref: '#/components/schemas/ComplianceScoring_Internal'
      description: The complete corporate information.
    ScaDeviceInfoDto_Internal:
      required:
        - creationDate
        - id
        - status
      type: object
      properties:
        id:
          type: string
          format: uuid
        providerId:
          type: string
        status:
          type: string
          enum:
            - CREATED
            - AWAITING_ACTIVATION
            - ACTIVE
            - SUSPENDED
            - REMOVED
        creationDate:
          type: string
          format: date-time
        name:
          type: string
        platform:
          type: string
        deviceInfo:
          type: string
    ScaDeviceInfoResponseDto_Internal:
      title: ScaDeviceInfo
      required:
        - biometryStatus
        - creationDate
        - endpointId
        - id
        - pinStatus
      type: object
      properties:
        id:
          type: string
          format: uuid
        endpointId:
          type: string
        creationDate:
          type: string
          format: date-time
        pinStatus:
          type: string
          enum:
            - SET
        biometryStatus:
          type: string
          enum:
            - SET
    CorporateRelatedCorporateListElement_Internal:
      required:
        - corporate
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - partner
        - position
        - registeredName
        - totalSharePercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        position:
          $ref: '#/components/schemas/Position_Internal'
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        totalSharePercentage:
          type: number
          format: float
        registeredName:
          type: string
          description: The official corporate name. Must only contains Latin-1 characters.
        tradeName:
          type: string
          description: >-
            The name used for business if there is one. Must only contains
            Latin-1 characters.
        incorporationCountry:
          type: string
          description: The country where the corporate has been registered in ISO3 format.
          example: FRA
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
          description: >-
            The official incorporation code assigned in the country. Must only
            contains Latin-1 characters.
          example: '12345678900013'
        website:
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        registeredAddress:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Internal'
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    CorporateRelatedListElementDto_Internal:
      required:
        - corporate
        - creationDate
        - id
        - partner
        - position
        - totalSharePercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        externalId:
          type: string
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Internal'
        totalSharePercentage:
          type: number
          format: float
        position:
          $ref: '#/components/schemas/Position_Internal'
      anyOf:
        - $ref: >-
            #/components/schemas/CorporateRelatedPhysicalPersonListElement_Internal
        - $ref: '#/components/schemas/CorporateRelatedCorporateListElement_Internal'
    CorporateRelatedPhysicalPersonListElement_Internal:
      required:
        - corporate
        - creationDate
        - id
        - kycInfo
        - partner
        - position
        - totalSharePercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        address:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Internal'
        emailAddress:
          type: string
        kycInfo:
          $ref: '#/components/schemas/KycInfoResponseDto_Internal'
        position:
          $ref: '#/components/schemas/PhysicalPersonPosition_Internal'
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        totalSharePercentage:
          type: number
          format: float
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Internal'
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
    CorporateShortInfoResponseDto_Internal:
      required:
        - id
        - registeredName
      type: object
      properties:
        id:
          type: string
          format: uuid
        tradeName:
          type: string
        registeredName:
          type: string
    KycInfoResponseDto_Internal:
      required:
        - status
        - type
      type: object
      properties:
        kycApplicationId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        statusReason:
          type: string
        internalStatusReason:
          type: string
        type:
          type: string
          enum:
            - FULL_KYC
            - DOC_ONLY
            - NOT_REQUIRED
        updateDate:
          type: string
          format: date-time
    ListResponseDtoCorporateRelatedListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CorporateRelatedListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    PhoneInfoResponseDto_Internal:
      required:
        - verified
      type: object
      properties:
        countryCode:
          type: string
        number:
          type: string
        verified:
          type: boolean
        verificationDate:
          type: string
          format: date-time
    PhysicalPersonPosition_Internal:
      required:
        - isAccountOwner
        - isDirector
        - isSpecialUbo
        - isUbo
      type: object
      properties:
        isAccountOwner:
          type: boolean
          description: Indicates if this is the person who manage the corporate account.
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
        isUbo:
          type: boolean
          description: >-
            Indicates if this person owns more than 25% of the corporate
            end-user shares (10% if the corporate required extended UBOs) or
            isSpecialUbo.
        isSpecialUbo:
          type: boolean
          description: >-
            Indicates whether this person was designated UBO because no
            shareholder holds the percentage of shares required to become one.
    Position_Internal:
      required:
        - isDirector
      type: object
      properties:
        isDirector:
          type: boolean
          description: Indicates if this entity is a director of the corporate.
        directorAppointmentDate:
          type: string
          description: If director, the date on which he was appointed.
          format: date
    CorporateRelatedCorporate_Internal:
      required:
        - corporate
        - creationDate
        - id
        - incorporationCode
        - incorporationCountry
        - partner
        - position
        - registeredName
        - shares
        - totalSharesPercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        registeredName:
          type: string
        tradeName:
          type: string
        incorporationCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        incorporationCode:
          type: string
        website:
          type: string
        industry:
          type: string
          enum:
            - ADULT_ENTERTAINMENT
            - DATING_SERVICES
            - ESCORT_SERVICES
            - HOLDING_OR_TRADING_CO_FOR_ASSET_MANAGEMENT_PURPOSES
            - USED_CAR_RESALE_AND_DISTRIBUTION
            - AVIATION_COMMERCIAL_CHARTERS_AND_AIRLINES
            - FOOD_RESTAURANT_CATERING
            - CHARITY_NON_RECOGNIZED
            - CHARITY_RECOGNIZED
            - TRANSPORT_TAXI_SERVICES_CHAUFFEUR
            - ARCHITECTS_LICENSED
            - INTERIOR_DESIGNERS__LANDSCAPERS__GARDENERS__HANDY_MEN
            - PLUMBING_ELECTRICIANS_KEY_CONTRACTORS
            - CONSTRUCTION
            - INFRASTRUCTURE
            - CONSULTANCY_LICENSED_TAX_OR_OTHER
            - CONSULTANCY_NON_LICENSED
            - MARKETING_AGENCIES_NON_ONLINE
            - MARKETING_SERVICES_AFFILIATE_MANAGERS
            - MULTI_LEVEL_MARKETING
            - SECURITY_SERVICES_ARMED
            - SECURITY_SERVICES_NON_ARMED
            - RESCUE
            - INCIDENT_ASSESSMENT_AND_HEALTH_AND_SAFETY
            - CORPORATE_SERVICE_PROVIDER_LICENSED_EU_OR_EQUIVALENT
            - CRYPTO_EXCHANGE_LICENSED
            - CRYPTO_EXCHANGE_NON_LICENSED
            - CRYPTO_MINING
            - ICO
            - EXPORT_IMPORT_OF_GENERAL_GOODS
            - FOOD_OR_APPAREL
            - EXPORT_IMPORT_OF_PARTS_AND_EQUIPMENT_NON_DUAL_USE_GOODS
            - TRADERS_OF_COMMODITIES
            - DRUG_PARAPHERNALIA
            - PROFESSIONAL_COURSES_CONFERENCES_SEMINARS_WORKSHOPS
            - SCHOOLS_AND_ACADEMIES_LICENSED
            - BAR
            - CAFETERIA
            - CLUB_DISCO
            - MOVIES_CINEMA_TELEVISION
            - MUSIC_PRODUCTION
            - GAS_OIL_EXTRACTION_EQUIPMENT
            - MINERAL_EXTRACTION
            - OIL_GAS_EXTRACTION
            - CARDS_ISSUERS_ACQUIRERS_LICENSED
            - FINANCIAL_CONSULTANTS_LICENSED_IN_THE_EU_OR_EQUIVALENT
            - FOREIGN_EXCHANGE_LICENSED
            - FOREIGN_EXCHANGE_NOT_LICENSED
            - INSURER_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - INSURERS_LICENSED_OUT_OF_THE_EU_OR_EQUIVALENT
            - INSURERS_NOT_LICENSED
            - INVESTMENTS_LICENSED
            - INVESTMENTS_NOT_LICENSED
            - MONEY_REMITTANCE_LICENSED
            - MONEY_REMITTANCE_NOT_LICENSED
            - PAYMENT_GATEWAY
            - PRIVATE_BANKING_LICENSED
            - PRIVATE_BANKING_NOT_LICENSED
            - PAYMENT_SERVICE_PROVIDER_LICENSED
            - PAYMENT_SERVICE_PROVIDER_NOT_LICENSED
            - GOVERNMENT
            - HOTEL_B_AND_B_GUESTHOUSE_HOSTELS
            - IT_SERVICES
            - ROYALTIES_AND_OR_LICENSES
            - IIPS_AND_VISA_APPLICATION_CONSULTANCY
            - LAWYERS_LAW_FIRMS_EU_OR_EQUIVALENT
            - LAWYERS_LAW_FIRMS_OUTSIDE_THE_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_OUT_OF_EU_OR_EQUIVALENT
            - NOTARY_LAWYER_WITHIN_THE_EU_OR_EQUIVALENT
            - TRUST_FIDUCIARIES_NOT_LICENSED
            - TRUST_FIDUCIARIES_LICENSED
            - ANTIQUE_DEALER_AUCTIONEER
            - ART_DEALERS
            - DESIGNER_APPAREL_AND_CLOTHING
            - FASHION_DESIGNERS_CONSULTANTS
            - JEWELERS
            - WATCHES_AND_COLLECTABLES
            - CAR_MANUFACTURING
            - ELECTRONICS_MANUFACTURERS_NON_DUAL_USE_GOODS
            - MANUFACTURERS_OR_DISTRIBUTORS_SOFTWARE_AND_HARDWARE_DEVELOPERS
            - METALLURGY
            - PARTS_FOR_ELECTRONIC_EQUIPMENT_NON_DUAL_USE_ITEM
            - PARTS_FOR_EQUIPMENT_NON_DUAL_USE_ITEM
            - PLASTIC_AND_OTHER_OIL_COMPOUNDS
            - TEXTILES
            - SALES_MANUFACTURING_OF_VESSELS
            - YACHTING_CHARTERING
            - BROKER_LICENSED
            - BROKER_NOT_LICENSED
            - CHIROPRACTORS_LICENSED
            - DENTISTS_LICENSED
            - GENERAL_MEDICAL_PRACTITIONERS
            - HEALTHCARE_MEDICAL_PROFESSIONALS_SOLE_PRACTITIONERS
            - MEDICAL_LABORATORIES_LICENSED
            - VETERINARY_CLINICS
            - PRECIOUS_METALS_NON_RAW
            - RAW_PRECIOUS_METALS
            - NGO_NOT_RECOGNIZED
            - NGO_RECOGNIZED
            - PHILANTHROPY_CLUBS_AND_ASSOCIATIONS_BAND_CLUBS
            - FOOTBALL_CLUBS
            - GAMING_GAMBLING_LICENSED_B2B_AND_B2C
            - GAMING_GAMBLING_NOT_LICENSED
            - GAMING_LUDBOX_TYPE_SKINS_ACCESSORIES
            - GAMING_ONLINE_VIDEO_GAMES
            - BIOTECH
            - MEDICAL_CANNABIS_LICENSED
            - NUTRACEUTICALS
            - PHARMACEUTICALS_LICENSED
            - PHARMACEUTICALS_NOT_LICENSED
            - PROPERTY_MANAGEMENT
            - REAL_ESTATE
            - WASTE_MANAGEMENT_TECHNOLOGIES
            - FUEL_REFINERY_AND_DISTRIBUTION
            - ECOMMERCE_TRADER_FOR_GENERAL_GOODS
            - FURNITURE_STORES
            - GENERAL_APPAREL
            - CLEANING_SERVICES
            - TRANSLATORS
            - ADMIN_AND_DOCUMENTATION_SUPPORT_SERVICES
            - TELECOMMUNICATIONS_LICENSED_OUTSIDE_OF_THE_EU_OR_EQUIVALENT
            - TELECOMMUNICATIONS_LICENSED_WITHIN_THE_EU_OR_EQUIVALENT
            - TOBACCO_AND_LIQUORS_LICENSED
            - TRAVEL_AGENTS
            - BEAUTY_CLINICS_AND_HAIR_SALON
            - SPAS
            - GYMS_AND_WELLNESS_CENTERS
        registeredAddress:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        externalId:
          type: string
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Internal'
        shares:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CorporateShareResponseDto_Internal'
        totalSharesPercentage:
          type: number
          format: float
        notes:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        position:
          $ref: '#/components/schemas/Position_Internal'
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        internalNotes:
          type: string
          description: Private additional information concerning this entity.
    CorporateRelatedInfoResponseDto_Internal:
      required:
        - partner
      type: object
      properties:
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        internalNotes:
          type: string
          description: Private additional information concerning this entity.
      description: Information about this corporate-related entity.
      anyOf:
        - $ref: '#/components/schemas/CorporateRelatedPhysicalPerson_Internal'
        - $ref: '#/components/schemas/CorporateRelatedCorporate_Internal'
    CorporateRelatedPhysicalPerson_Internal:
      required:
        - corporate
        - creationDate
        - email
        - id
        - internalKycInfo
        - isPep
        - partner
        - position
        - shares
        - totalSharesPercentage
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        corporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Internal'
        shares:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/CorporateShareResponseDto_Internal'
        address:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Internal'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        email:
          $ref: '#/components/schemas/EmailInfoResponseDto_Internal'
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        birthDate:
          type: string
          format: date
        internalKycInfo:
          $ref: '#/components/schemas/KycInfoResponseDto_Internal'
        notes:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        position:
          $ref: '#/components/schemas/PhysicalPersonPosition_Internal'
        isPep:
          type: boolean
          description: Indicates whether this person is a politically exposed person.
        totalSharesPercentage:
          type: number
          format: float
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        internalNotes:
          type: string
          description: Private additional information concerning this entity.
        pep:
          type: boolean
          writeOnly: true
    CorporateShareResponseDto_Internal:
      required:
        - directSharesPercentage
        - finalSharesPercentage
        - id
        - layer
      type: object
      properties:
        id:
          type: string
          format: uuid
        ownedCorporate:
          $ref: '#/components/schemas/CorporateShortInfoResponseDto_Internal'
        directSharesPercentage:
          type: number
          description: >-
            Percentage of corporate shares held directly (same as
            finalSharesPercentage if direct shareholder).
          format: float
        finalSharesPercentage:
          type: number
          description: Percentage of the corporate end-user held.
          format: float
        layer:
          type: integer
          format: int32
    EmailInfoResponseDto_Internal:
      required:
        - verified
      type: object
      properties:
        address:
          type: string
        verified:
          type: boolean
        verificationDate:
          type: string
          format: date-time
    ConsumerListElementDto_Internal:
      required:
        - creationDate
        - id
        - phone
        - status
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Internal'
        firstName:
          type: string
        lastName:
          type: string
        emailAddress:
          type: string
        status:
          $ref: '#/components/schemas/ConsumerStatusResponseDto_Internal'
        updateDate:
          type: string
          format: date-time
        creationDate:
          type: string
          format: date-time
        partnerId:
          type: string
          format: uuid
        partnerName:
          type: string
    ConsumerStatusResponseDto_Internal:
      title: ConsumerStatus
      required:
        - banking
        - compliance
        - kyc
        - linkcy
        - overall
        - suspension
      type: object
      properties:
        banking:
          $ref: '#/components/schemas/EndUserBanking_Internal'
        kyc:
          $ref: '#/components/schemas/Kyc_Internal'
        suspension:
          $ref: '#/components/schemas/EndUserSuspension_Internal'
        linkcy:
          $ref: '#/components/schemas/EndUserLinkcy_Internal'
        compliance:
          $ref: '#/components/schemas/EndUserCompliance_Internal'
        overall:
          $ref: '#/components/schemas/Overall_Internal'
    Kyc_Internal:
      title: Kyc
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - NOT_STARTED
            - CREATED
            - PROCESSING
            - ABORTED
            - PENDING_REVIEW
            - VALIDATED
            - DECLINED
        reason:
          type: string
        internalReason:
          type: string
    ListResponseDtoConsumerListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/ConsumerListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    ConsumerFinancialInformationResponseDto_Internal:
      title: FinancialInformation
      type: object
      properties:
        monthlyNetIncome:
          type: string
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        expectedMonthlyIncomingVolume:
          type: string
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyOutgoingVolume:
          type: string
          enum:
            - LESS_THAN_1000
            - BETWEEN_1001_AND_5000
            - BETWEEN_5001_AND_10000
            - BETWEEN_10001_AND_15000
            - MORE_THAN_15000
        expectedMonthlyIncomingTransferFrequency:
          type: string
          enum:
            - LESS_THAN_TWO_TIMES
            - BETWEEN_3_AND_5_TIMES
            - MORE_THAN_6_TIMES
    ConsumerInfoResponseDto_Internal:
      required:
        - accountPurposes
        - creationDate
        - email
        - id
        - kycInfo
        - phone
        - scaDevices
        - status
        - strongAuthentication
        - termsAccepted
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalId:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneInfoResponseDto_Internal'
        kycInfo:
          $ref: '#/components/schemas/KycInfoResponseDto_Internal'
        status:
          $ref: '#/components/schemas/ConsumerStatusResponseDto_Internal'
        termsAccepted:
          type: boolean
        address:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        email:
          $ref: '#/components/schemas/EmailInfoResponseDto_Internal'
        gender:
          type: string
          enum:
            - MALE
            - FEMALE
        birthCity:
          type: string
        birthIsoCountryCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        nationalityCode:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        birthDate:
          type: string
          format: date
        sourceOfFunds:
          type: string
          enum:
            - COMPENSATION_PAYOUT
            - COMPANY_PROFITS
            - COMPANY_SALE
            - DIVIDEND_PAYMENTS
            - DIVORCE_SETTLEMENT
            - FIXED_DEPOSITS
            - GIFT
            - INHERITANCE
            - INSURANCE_PAYOUT
            - LOAN
            - LOTTERY_OR_GAMBLING_WIN
            - RETIREMENT_INCOME
            - SALE_OF_INVESTMENT
            - SALE_OF_PROPERTY
            - SAVINGS_FROM_SALARY
            - OTHER
        otherSourceOfFunds:
          type: string
        occupation:
          type: string
          enum:
            - BUSINESS_OWNER
            - CLERGY
            - CRAFTSMAN
            - ENGINEER
            - EXECUTIVE
            - FARMER
            - FREELANCE
            - LIBERAL_PROFESSION
            - POLITICIAN
            - PROFESSOR
            - PUBLIC_SERVANT
            - RETIRED
            - SHOPKEEPER
            - STUDENT
            - UNEMPLOYED
            - WORKER
            - OTHER
        otherOccupation:
          type: string
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        taxIdentificationNumber:
          type: string
        taxCountry:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        accountPurposes:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
              - PAY_BILLS
              - MONEY_TO_FROM_FAMILY
              - DIVIDENDS
              - SAVINGS
              - PERSONAL_BUSINESS_PURPOSES
              - PENSION
              - CRYPTO
              - SALARY
              - LOTTERY_GAMING
              - RECONCILIATION
              - VIRTUAL_ACCOUNT
              - CURRENCY_EXCHANGE
              - OTHER
        strongAuthentication:
          $ref: '#/components/schemas/ScaDeviceInfoResponseDto_Internal'
        scaDevices:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/ScaDeviceInfoDto_Internal'
        financialInformation:
          $ref: >-
            #/components/schemas/ConsumerFinancialInformationResponseDto_Internal
        partnerMetadata:
          title: Metadata
          type: object
        userMetadata:
          title: Metadata
          type: object
        isPep:
          type: boolean
        complianceScoring:
          $ref: '#/components/schemas/ComplianceScoring_Internal'
        partnerId:
          type: string
          format: uuid
        cbsId:
          type: string
        externalNotes:
          type: string
        internalNotes:
          type: string
      description: The complete consumer information.
    CardInfoResponseDto_Internal:
      required:
        - creationDate
        - currency
        - endUserId
        - id
        - ledgerId
        - pinStatus
        - profile
        - rules
        - scheme
        - status
        - suspensionsInformation
        - type
        - updateDate
      type: object
      properties:
        id:
          type: string
          format: uuid
        endUserId:
          type: string
          format: uuid
        ledgerId:
          type: string
          format: uuid
        profile:
          $ref: '#/components/schemas/Profile_Internal'
        expiryDate:
          type: string
        nameOnCard:
          type: string
        cardholderNameOnCard:
          type: string
        friendlyName:
          type: string
        deliveryAddress:
          $ref: '#/components/schemas/AddressResponseDto_Internal'
        deliveryMethod:
          type: string
          enum:
            - UK_MAIL
            - INTERNATIONAL_MAIL
            - FRENCH_MAIL
            - FRENCH_MAIL_TRACKING
            - DHL
            - COURIER
        deliveryShipmentDate:
          type: string
          format: date
        deliveryTrackingNumber:
          type: string
        truncatedPan:
          type: string
          description: >-
            Last 4 digits of the card. The truncated pan is only displayed if
            the card has been activated.
        type:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        scheme:
          type: string
          enum:
            - MASTERCARD
            - VISA
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
            - PLN
            - AUD
            - CHF
            - CAD
            - SEK
            - NOK
            - JPY
            - HUF
            - HKD
            - NZD
            - CZK
            - SGD
            - RON
            - HRK
        status:
          $ref: '#/components/schemas/CardStatusDto_Internal'
        suspensionsInformation:
          type: array
          items:
            $ref: '#/components/schemas/CardSuspensionInfoDto_Internal'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        pinStatus:
          type: string
          enum:
            - LOCKED
            - UNLOCKING
            - UNLOCKED
            - WAITING_ONLINE_TRANSACTION
        rules:
          type: array
          items:
            $ref: '#/components/schemas/CardRuleResponseDto_Internal'
        cbsId:
          type: string
      description: The complete card information
    CardRuleResponseDto_Internal:
      required:
        - type
      type: object
      properties:
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        name:
          type: string
        creator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
      anyOf:
        - $ref: '#/components/schemas/ValueCardRuleResponseDto_Internal'
        - $ref: '#/components/schemas/TargetsCardRuleResponseDto_Internal'
    CardStatusDto_Internal:
      required:
        - value
      type: object
      properties:
        value:
          type: string
          enum:
            - CREATING
            - AWAITING_ACTIVATION
            - ACTIVATING
            - REACTIVATING
            - ACTIVE
            - SUSPENDING
            - SUSPENDED
            - CLOSING
            - CLOSED
            - EXPIRED
            - FAILED
        reason:
          type: string
          enum:
            - STOLEN
            - LOST
            - DAMAGED
            - OTHER
            - LEDGER_CLOSED
        otherReason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        internalStatusReason:
          type: string
    CardSuspensionInfoDto_Internal:
      required:
        - date
        - operator
      type: object
      properties:
        date:
          type: string
          format: date-time
        reason:
          type: string
          enum:
            - STOLEN
            - LOST
            - DAMAGED
            - OTHER
            - LEDGER_CLOSED
        otherReason:
          type: string
        operator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
    Profile_Internal:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
    TargetsCardRuleResponseDto_Internal:
      required:
        - type
      type: object
      properties:
        name:
          type: string
        creator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        targets:
          type: array
          items:
            type: string
    ValueCardRuleResponseDto_Internal:
      required:
        - type
      type: object
      properties:
        name:
          type: string
        creator:
          type: string
          enum:
            - END_USER
            - PARTNER
            - LINKCY
        type:
          type: string
          enum:
            - DAILY_MAX_SPEND
            - MONTHLY_MAX_SPEND
            - WEEKLY_MAX_SPEND
            - DISABLE_CONTACTLESS
            - DISABLE_ONLINE
            - DISABLE_RECURRING
            - MCC_WHITELIST
            - MCC_BLACKLIST
            - MERCHANT_WHITELIST
            - MERCHANT_BLACKLIST
            - DAY_WHITELIST
            - DAY_BLACKLIST
        value:
          type: integer
          format: int64
    CountryCardProgramResponseDto:
      title: Available Country
      required:
        - cbsId
        - country
      type: object
      properties:
        country:
          type: string
          enum:
            - ABW
            - AFG
            - AGO
            - AIA
            - ALA
            - ALB
            - AND
            - ARE
            - ARG
            - ARM
            - ASM
            - ATA
            - ATF
            - ATG
            - AUS
            - AUT
            - AZE
            - BDI
            - BEL
            - BEN
            - BES
            - BFA
            - BGD
            - BGR
            - BHR
            - BHS
            - BIH
            - BLM
            - BLR
            - BLZ
            - BMU
            - BOL
            - BRA
            - BRB
            - BRN
            - BTN
            - BVT
            - BWA
            - CAF
            - CAN
            - CCK
            - CHE
            - CHL
            - CHN
            - CIV
            - CMR
            - COD
            - COG
            - COK
            - COL
            - COM
            - CPV
            - CRI
            - CUB
            - CUW
            - CXR
            - CYM
            - CYP
            - CZE
            - DEU
            - DJI
            - DMA
            - DNK
            - DOM
            - DZA
            - ECU
            - EGY
            - ERI
            - ESH
            - ESP
            - EST
            - ETH
            - FIN
            - FJI
            - FLK
            - FRA
            - FRO
            - FSM
            - GAB
            - GBR
            - GEO
            - GGY
            - GHA
            - GIB
            - GIN
            - GMB
            - GNB
            - GNQ
            - GRC
            - GRD
            - GRL
            - GTM
            - GUM
            - GUY
            - HKG
            - HMD
            - HND
            - HRV
            - HTI
            - HUN
            - IDN
            - IMN
            - IND
            - IOT
            - IRL
            - IRN
            - IRQ
            - ISL
            - ISR
            - ITA
            - JAM
            - JEY
            - JOR
            - JPN
            - KAZ
            - KEN
            - KGZ
            - KHM
            - KIR
            - KNA
            - KOR
            - KWT
            - LAO
            - LBN
            - LBR
            - LBY
            - LCA
            - LIE
            - LKA
            - LSO
            - LTU
            - LUX
            - LVA
            - MAC
            - MAF
            - MAR
            - MCO
            - MDA
            - MDG
            - MDV
            - MEX
            - MHL
            - MKD
            - MLI
            - MLT
            - MMR
            - MNE
            - MNG
            - MNP
            - MOZ
            - MRT
            - MSR
            - MUS
            - MWI
            - MYS
            - NAM
            - NCL
            - NER
            - NFK
            - NGA
            - NIC
            - NIU
            - NLD
            - NOR
            - NPL
            - NRU
            - NZL
            - OMN
            - PAK
            - PAN
            - PCN
            - PER
            - PHL
            - PLW
            - PNG
            - POL
            - PRI
            - PRK
            - PRT
            - PRY
            - PSE
            - PYF
            - QAT
            - ROU
            - RUS
            - RWA
            - SAU
            - SDN
            - SEN
            - SGP
            - SGS
            - SHN
            - SJM
            - SLB
            - SLE
            - SLV
            - SMR
            - SOM
            - SPM
            - SRB
            - SSD
            - STP
            - SUR
            - SVK
            - SVN
            - SWE
            - SWZ
            - SXM
            - SYC
            - SYR
            - TCA
            - TCD
            - TGO
            - THA
            - TJK
            - TKL
            - TKM
            - TLS
            - TON
            - TTO
            - TUN
            - TUR
            - TUV
            - TWN
            - TZA
            - UGA
            - UKR
            - UMI
            - URY
            - USA
            - UZB
            - VAT
            - VCT
            - VEN
            - VGB
            - VIR
            - VNM
            - VUT
            - WLF
            - WSM
            - XXK
            - YEM
            - ZAF
            - ZMB
            - ZWE
        cbsId:
          type: string
    InternalCardProgramListElementDto:
      required:
        - cardType
        - countryCardPrograms
        - creationDate
        - friendlyName
        - id
        - ledgerType
        - partnerInfo
        - scheme
        - userType
      type: object
      properties:
        id:
          type: string
          format: uuid
        partnerInfo:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto'
        friendlyName:
          type: string
        countryCardPrograms:
          type: array
          items:
            $ref: '#/components/schemas/CountryCardProgramResponseDto'
        scheme:
          type: string
          enum:
            - MASTERCARD
            - VISA
        ledgerType:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_ESTONIA
            - EUR_LITHUANIA
            - USD_USA
            - GBP_GREAT_BRITAIN
            - EUR_BG
        cardType:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        userType:
          type: string
          enum:
            - CORPORATE
            - CONSUMER
        creationDate:
          type: string
          format: date-time
    ListResponseDtoInternalCardProgramListElementDto:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/InternalCardProgramListElementDto'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    CardDesignListElementDto_Internal:
      required:
        - availableCountries
        - cardType
        - friendlyName
        - id
        - ledgerType
        - scheme
        - userType
      type: object
      properties:
        id:
          type: string
          format: uuid
        friendlyName:
          type: string
        scheme:
          type: string
          enum:
            - MASTERCARD
            - VISA
        ledgerType:
          type: string
          enum:
            - EUR_BELGIUM
            - EUR_FRANCE
            - EUR_ESTONIA
            - EUR_LITHUANIA
            - USD_USA
            - GBP_GREAT_BRITAIN
            - EUR_BG
        cardType:
          type: string
          enum:
            - PHYSICAL
            - VIRTUAL
        userType:
          type: string
          enum:
            - CORPORATE
            - CONSUMER
        availableCountries:
          type: array
          items:
            type: string
            enum:
              - ABW
              - AFG
              - AGO
              - AIA
              - ALA
              - ALB
              - AND
              - ARE
              - ARG
              - ARM
              - ASM
              - ATA
              - ATF
              - ATG
              - AUS
              - AUT
              - AZE
              - BDI
              - BEL
              - BEN
              - BES
              - BFA
              - BGD
              - BGR
              - BHR
              - BHS
              - BIH
              - BLM
              - BLR
              - BLZ
              - BMU
              - BOL
              - BRA
              - BRB
              - BRN
              - BTN
              - BVT
              - BWA
              - CAF
              - CAN
              - CCK
              - CHE
              - CHL
              - CHN
              - CIV
              - CMR
              - COD
              - COG
              - COK
              - COL
              - COM
              - CPV
              - CRI
              - CUB
              - CUW
              - CXR
              - CYM
              - CYP
              - CZE
              - DEU
              - DJI
              - DMA
              - DNK
              - DOM
              - DZA
              - ECU
              - EGY
              - ERI
              - ESH
              - ESP
              - EST
              - ETH
              - FIN
              - FJI
              - FLK
              - FRA
              - FRO
              - FSM
              - GAB
              - GBR
              - GEO
              - GGY
              - GHA
              - GIB
              - GIN
              - GMB
              - GNB
              - GNQ
              - GRC
              - GRD
              - GRL
              - GTM
              - GUM
              - GUY
              - HKG
              - HMD
              - HND
              - HRV
              - HTI
              - HUN
              - IDN
              - IMN
              - IND
              - IOT
              - IRL
              - IRN
              - IRQ
              - ISL
              - ISR
              - ITA
              - JAM
              - JEY
              - JOR
              - JPN
              - KAZ
              - KEN
              - KGZ
              - KHM
              - KIR
              - KNA
              - KOR
              - KWT
              - LAO
              - LBN
              - LBR
              - LBY
              - LCA
              - LIE
              - LKA
              - LSO
              - LTU
              - LUX
              - LVA
              - MAC
              - MAF
              - MAR
              - MCO
              - MDA
              - MDG
              - MDV
              - MEX
              - MHL
              - MKD
              - MLI
              - MLT
              - MMR
              - MNE
              - MNG
              - MNP
              - MOZ
              - MRT
              - MSR
              - MUS
              - MWI
              - MYS
              - NAM
              - NCL
              - NER
              - NFK
              - NGA
              - NIC
              - NIU
              - NLD
              - NOR
              - NPL
              - NRU
              - NZL
              - OMN
              - PAK
              - PAN
              - PCN
              - PER
              - PHL
              - PLW
              - PNG
              - POL
              - PRI
              - PRK
              - PRT
              - PRY
              - PSE
              - PYF
              - QAT
              - ROU
              - RUS
              - RWA
              - SAU
              - SDN
              - SEN
              - SGP
              - SGS
              - SHN
              - SJM
              - SLB
              - SLE
              - SLV
              - SMR
              - SOM
              - SPM
              - SRB
              - SSD
              - STP
              - SUR
              - SVK
              - SVN
              - SWE
              - SWZ
              - SXM
              - SYC
              - SYR
              - TCA
              - TCD
              - TGO
              - THA
              - TJK
              - TKL
              - TKM
              - TLS
              - TON
              - TTO
              - TUN
              - TUR
              - TUV
              - TWN
              - TZA
              - UGA
              - UKR
              - UMI
              - URY
              - USA
              - UZB
              - VAT
              - VCT
              - VEN
              - VGB
              - VIR
              - VNM
              - VUT
              - WLF
              - WSM
              - XXK
              - YEM
              - ZAF
              - ZMB
              - ZWE
        cardProgramId:
          type: string
          format: uuid
        manufacturerDesignId:
          type: string
        manufacturerPackageId:
          type: string
        manufacturerPrintImageId:
          type: string
    ListResponseDtoCardDesignListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/CardDesignListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    BeneficiaryListElementDto_Internal:
      required:
        - accountType
        - active
        - creationDate
        - display
        - endUserId
        - id
        - name
        - status
        - type
        - updateDate
      type: object
      properties:
        name:
          type: string
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
            - PERSON
            - COMPANY
        status:
          type: string
          enum:
            - DECLINED
            - PENDING_REVIEW
            - VALID
            - PENDING
            - NEED_ADDITIONAL_INFORMATION
        active:
          type: boolean
        friendlyName:
          type: string
        endUserId:
          type: string
          format: uuid
        partner:
          $ref: '#/components/schemas/PartnerShortInfoResponseDto_Internal'
        creationDate:
          type: string
          format: date-time
        updateDate:
          type: string
          format: date-time
        accountType:
          type: string
          enum:
            - IBAN
            - GBP
            - USD
        display:
          type: boolean
      description: The information on a beneficiary.
    GbpBeneficiaryListElementDto_Internal:
      required:
        - accountNumber
        - accountType
        - active
        - creationDate
        - display
        - endUserId
        - id
        - name
        - sortCode
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/BeneficiaryListElementDto_Internal'
        - type: object
          properties:
            accountNumber:
              type: string
            sortCode:
              type: string
    ListResponseDtoBeneficiaryListElementDto_Internal:
      required:
        - content
        - page
        - pageSize
        - totalElements
      type: object
      properties:
        content:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/GbpBeneficiaryListElementDto_Internal'
              - $ref: '#/components/schemas/SepaBeneficiaryListElementDto_Internal'
        totalElements:
          type: integer
          format: int64
          example: 1
        page:
          type: integer
          description: The page number.
          format: int32
        pageSize:
          type: integer
          description: The requested page size.
          format: int32
    SepaBeneficiaryListElementDto_Internal:
      required:
        - accountType
        - active
        - bicOrSwift
        - creationDate
        - display
        - endUserId
        - iban
        - id
        - name
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/BeneficiaryListElementDto_Internal'
        - type: object
          properties:
            iban:
              type: string
            bicOrSwift:
              type: string
    InternalBeneficiaryInfoResponseDto:
      type: object
      description: The information on a beneficiary.
    InternalGbpBeneficiaryInfoResponseDto:
      required:
        - accountNumber
        - accountType
        - active
        - creationDate
        - endUserId
        - id
        - name
        - partner
        - sortCode
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/InternalBeneficiaryInfoResponseDto'
        - type: object
          properties:
            id:
              type: string
              format: uuid
            endUserId:
              type: string
              description: The endUser owning this beneficiary.
              format: uuid
            linkcyLedgerId:
              type: string
              description: >-
                Sometimes a beneficiary can correspond to a ledger that you
                manage, in this case, we would send you the corresponding id.
              format: uuid
            name:
              type: string
            friendlyName:
              type: string
            accountType:
              type: string
              enum:
                - IBAN
                - GBP
                - USD
            type:
              type: string
              enum:
                - PERSON
                - COMPANY
            creationDate:
              type: string
              format: date-time
            updateDate:
              type: string
              format: date-time
            active:
              type: boolean
            display:
              type: boolean
            status:
              type: string
              enum:
                - DECLINED
                - PENDING_REVIEW
                - VALID
                - PENDING
                - NEED_ADDITIONAL_INFORMATION
            accountNumber:
              type: string
            sortCode:
              type: string
            partner:
              $ref: '#/components/schemas/PartnerShortInfoResponseDto'
    InternalSepaBeneficiaryInfoResponseDto:
      required:
        - accountType
        - active
        - bicOrSwift
        - creationDate
        - endUserId
        - iban
        - id
        - name
        - partner
        - status
        - type
        - updateDate
      type: object
      allOf:
        - $ref: '#/components/schemas/InternalBeneficiaryInfoResponseDto'
        - type: object
          properties:
            id:
              type: string
              format: uuid
            endUserId:
              type: string
              description: The endUser owning this beneficiary.
              format: uuid
            linkcyLedgerId:
              type: string
              description: >-
                Sometimes a beneficiary can correspond to a ledger that you
                manage, in this case, we would send you the corresponding id.
              format: uuid
            name:
              type: string
            friendlyName:
              type: string
            accountType:
              type: string
              enum:
                - IBAN
                - GBP
                - USD
            type:
              type: string
              enum:
                - PERSON
                - COMPANY
            creationDate:
              type: string
              format: date-time
            updateDate:
              type: string
              format: date-time
            active:
              type: boolean
            display:
              type: boolean
            status:
              type: string
              enum:
                - DECLINED
                - PENDING_REVIEW
                - VALID
                - PENDING
                - NEED_ADDITIONAL_INFORMATION
            iban:
              type: string
            bicOrSwift:
              type: string
            partner:
              $ref: '#/components/schemas/PartnerShortInfoResponseDto'
  securitySchemes:
    Linkcy-Auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
  - name: Authentication
    tags:
      - Authentication
      - Strong Authentication
  - name: Configuration
    tags:
      - Partner
      - Webhook
      - Operation restriction
  - name: End-User
    tags:
      - End-user
      - Consumer
      - Corporate
  - name: Onboarding
    tags:
      - KYC
      - KYB
      - Onboard
      - Documents
  - name: Banking
    tags:
      - Ledger
      - Card
      - Acquiring
  - name: Transaction
    tags:
      - Beneficiary
      - Transaction
      - Direct Debit Mandate
  - name: Crypto
    tags:
      - Wallet
      - Crypto Beneficiary
      - Crypto Transaction
  - name: Tools
    tags:
      - Additional
      - Sandbox
      - Web Pages
