openapi: 3.1.0
info:
  title: Legal Entity Management API
  description: "The Legal Entity Management API enables you to manage legal entities\
    \ that contain information required for verification.\n\n## Authentication\nEach\
    \ request to the Legal Entity Management API must be signed with an API key. Generate\
    \ an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key)\
    \ or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\
    \n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key)\
    \ in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key`\
    \ header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key:\
    \ YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\n\
    The Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning)\
    \ using a version suffix in the endpoint URL. This suffix has the following format:\
    \ \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v3/legalEntities\n\
    ```\n## Rate limits\nWe enforce rate limits on Legal Entity Management API endpoints.\
    \ When the number of requests you send exceeds a threshold within a time frame,\
    \ additional requests are blocked until the time frame ends. Current limits:\n\
    \n- Live environments: 700 requests per 5 seconds.\n\n- Test environments: 200\
    \ requests per 5 seconds.\n\n- Failed requests are subject to a limit of 5 failures\
    \ per 10 seconds.\n\n## Going live\nWhen going live, generate an API key in your\
    \ [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for\
    \ Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/)\
    \ if you have an Adyen Issuing integration.You can then use the API key to send\
    \ requests to `https://kyc-live.adyen.com/lem/v3`.\n\n"
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
  version: '3'
  x-publicVersion: true
servers:
- url: https://kyc-test.adyen.com/lem/v3
tags:
- name: Legal entities
- name: Transfer instruments
- name: Business lines
- name: Documents
- name: Terms of Service
- name: PCI questionnaires
- name: Tax eDelivery consent
- name: Hosted Onboarding
paths:
  /businessLines:
    post:
      tags:
      - Business lines
      summary: Create a business line
      description: "Creates a business line. \n\nThis resource contains information\
        \ about your user's line of business, including their industry and their source\
        \ of funds. Adyen uses this information to verify your users as required by\
        \ payment industry regulations.Adyen informs you of the verification results\
        \ through webhooks or API responses.\n\nYou can create a maximum of 200 business\
        \ lines per legal entity for payment processing.\n\nRequests to this endpoint\
        \ are subject to rate limits:\n\n- Live environments: 700 requests per 5 seconds.\n\
        \n- Test environments: 200 requests per 5 seconds.\n\n- Failed requests are\
        \ subject to a limit of 5 failures per 10 seconds.\n\n"
      operationId: post-businessLines
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessLineInfo'
            examples:
              createBusinessLines-businessAccounts:
                $ref: '#/components/examples/post-businessLines-createBusinessLines-businessAccounts'
              createBusinessLines-receive:
                $ref: '#/components/examples/post-businessLines-createBusinessLines-receive'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessLine'
              examples:
                createBusinessLines-businessAccounts:
                  $ref: '#/components/examples/post-businessLines-createBusinessLines-businessAccounts-200'
                createBusinessLines-receive:
                  $ref: '#/components/examples/post-businessLines-createBusinessLines-receive-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 12
      x-methodName: createBusinessLine
  /businessLines/{id}:
    get:
      tags:
      - Business lines
      summary: Get a business line
      description: 'Returns the detail of a business line.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-businessLines-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the business line.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessLine'
              examples:
                success:
                  $ref: '#/components/examples/get-businessLines-id-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 13
      x-methodName: getBusinessLine
    delete:
      tags:
      - Business lines
      summary: Delete a business line
      description: "Deletes a business line.\n\n >If you delete a business line linked\
        \ to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api),\
        \ it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings).\
        \ The business line is removed from all linked merchant accounts.\n\nRequests\
        \ to this endpoint are subject to rate limits:\n\n- Live environments: 700\
        \ requests per 5 seconds.\n\n- Test environments: 200 requests per 5 seconds.\n\
        \n- Failed requests are subject to a limit of 5 failures per 10 seconds.\n\
        \n"
      operationId: delete-businessLines-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the business line to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: 'No Content - look at the actual response code for the status
            of the request. '
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 14
      x-methodName: deleteBusinessLine
    patch:
      tags:
      - Business lines
      summary: Update a business line
      description: 'Updates a business line.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: patch-businessLines-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the business line.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessLineInfoUpdate'
            examples:
              updateBusinessLine:
                $ref: '#/components/examples/patch-businessLines-id-updateBusinessLine'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessLine'
              examples:
                updateBusinessLine:
                  $ref: '#/components/examples/patch-businessLines-id-updateBusinessLine-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '2'
      x-sortIndex: 15
      x-methodName: updateBusinessLine
  /documents:
    post:
      tags:
      - Documents
      summary: Upload a document for verification checks
      description: "Uploads a document for verification checks.\n\n Adyen uses the\
        \ information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities)\
        \ to run automated verification checks. If these checks fail, you will be\
        \ notified to provide additional documents.\n\n You should only upload documents\
        \ when Adyen requests additional information for the legal entity.\n\n >You\
        \ can upload a maximum of 15 pages for photo IDs.\n\nRequests to this endpoint\
        \ are subject to rate limits:\n\n- Live environments: 700 requests per 5 seconds.\n\
        \n- Test environments: 200 requests per 5 seconds.\n\n- Failed requests are\
        \ subject to a limit of 5 failures per 10 seconds.\n\n"
      operationId: post-documents
      parameters:
      - name: x-requested-verification-code
        in: header
        description: Use a suberror code as your requested verification code. You
          can include one code at a time in your request header. Requested verification
          codes can only be used in your test environment.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: '1_3008'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Document'
            examples:
              uploadDocument:
                $ref: '#/components/examples/post-documents-uploadDocument'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
              examples:
                uploadDocument:
                  $ref: '#/components/examples/post-documents-uploadDocument-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 4
      x-methodName: uploadDocumentForVerificationChecks
  /documents/{id}:
    get:
      tags:
      - Documents
      summary: Get a document
      description: 'Returns a document.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-documents-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the document.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: skipContent
        in: query
        description: Do not load document content while fetching the document.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
              examples:
                success:
                  $ref: '#/components/examples/get-documents-id-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 5
      x-methodName: getDocument
    delete:
      tags:
      - Documents
      summary: Delete a document
      description: 'Deletes a document.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: delete-documents-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the document to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: 'No Content - look at the actual response code for the status
            of the request. '
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 7
      x-methodName: deleteDocument
    patch:
      tags:
      - Documents
      summary: Update a document
      description: "Updates a document.\n\n >You can upload a maximum of 15 pages\
        \ for photo IDs.\n\nRequests to this endpoint are subject to rate limits:\n\
        \n- Live environments: 700 requests per 5 seconds.\n\n- Test environments:\
        \ 200 requests per 5 seconds.\n\n- Failed requests are subject to a limit\
        \ of 5 failures per 10 seconds.\n\n"
      operationId: patch-documents-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the document to be updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: x-requested-verification-code
        in: header
        description: Use the requested verification code 0_0001 to resolve any suberrors
          associated with the document. Requested verification codes can only be used
          in your test environment.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: '0_0001'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Document'
            examples:
              updateDocument:
                $ref: '#/components/examples/patch-documents-id-updateDocument'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Document'
              examples:
                updateDocument:
                  $ref: '#/components/examples/patch-documents-id-updateDocument-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 6
      x-methodName: updateDocument
  /legalEntities:
    post:
      tags:
      - Legal entities
      summary: Create a legal entity
      description: "Creates a legal entity. \n\nThis resource contains information\
        \ about the user that will be onboarded in your platform. Adyen uses this\
        \ information to perform verification checks as required by payment industry\
        \ regulations. Adyen informs you of the verification results through webhooks\
        \ or API responses.\n\nRequests to this endpoint are subject to rate limits:\n\
        \n- Live environments: 700 requests per 5 seconds.\n\n- Test environments:\
        \ 200 requests per 5 seconds.\n\n- Failed requests are subject to a limit\
        \ of 5 failures per 10 seconds.\n\n"
      operationId: post-legalEntities
      parameters:
      - name: x-requested-verification-code
        in: header
        description: Use a suberror code as your requested verification code. You
          can include one code at a time in your request header. Requested verification
          codes can only be used in your test environment.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: '1_3004'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LegalEntityInfoRequiredType'
            examples:
              createLegalEntityIndividualAU:
                $ref: '#/components/examples/post-legalEntities-createLegalEntityIndividualAU'
              createLegalEntityIndividualNL:
                $ref: '#/components/examples/post-legalEntities-createLegalEntityIndividualNL'
              createLegalEntityIndividualUS:
                $ref: '#/components/examples/post-legalEntities-createLegalEntityIndividualUS'
              createLegalEntityOrganizationNL:
                $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationNL'
              createLegalEntityOrganizationUS:
                $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationUS'
              createLegalEntityPaymentInstrumentUser:
                $ref: '#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser'
              createLegalEntitySolePropNL:
                $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL'
              createLegalEntitySolePropUS:
                $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS'
              createTrustAU:
                $ref: '#/components/examples/post-legalEntities-createTrustAU'
              createUnincorporatedPartnershipAU:
                $ref: '#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalEntity'
              examples:
                createLegalEntityIndividualAU:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntityIndividualAU-200'
                createLegalEntityIndividualNL:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntityIndividualNL-200'
                createLegalEntityIndividualUS:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntityIndividualUS-200'
                createLegalEntityOrganizationNL:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationNL-200'
                createLegalEntityOrganizationUS:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntityOrganizationUS-200'
                createLegalEntityPaymentInstrumentUser:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntityPaymentInstrumentUser-200'
                createLegalEntitySolePropNL:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL-200'
                createLegalEntitySolePropUS:
                  $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS-200'
                createTrustAU:
                  $ref: '#/components/examples/post-legalEntities-createTrustAU-200'
                createUnincorporatedPartnershipAU:
                  $ref: '#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 1
      x-methodName: createLegalEntity
  /legalEntities/{id}:
    get:
      tags:
      - Legal entities
      summary: Get a legal entity
      description: 'Returns a legal entity.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-legalEntities-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalEntity'
              examples:
                success:
                  $ref: '#/components/examples/get-legalEntities-id-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 2
      x-methodName: getLegalEntity
    patch:
      tags:
      - Legal entities
      summary: Update a legal entity
      description: "Updates a legal entity.\n\n >To change the legal entity type,\
        \ include only the new `type` in your request.\n\nIf you need to update information\
        \ for the legal entity, make a separate request. To update the `entityAssociations`\
        \ array, you need to replace the entire array.For example, if the array has\
        \ 3 entries and you want to remove 1 entry, you need to PATCH the resource\
        \ with the remaining 2 entries.\n\nRequests to this endpoint are subject to\
        \ rate limits:\n\n- Live environments: 700 requests per 5 seconds.\n\n- Test\
        \ environments: 200 requests per 5 seconds.\n\n- Failed requests are subject\
        \ to a limit of 5 failures per 10 seconds.\n\n"
      operationId: patch-legalEntities-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: x-requested-verification-code
        in: header
        description: Use the requested verification code 0_0001 to resolve any suberrors
          associated with the legal entity. Requested verification codes can only
          be used in your test environment.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: '0_0001'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LegalEntityInfo'
            examples:
              changeLegalEntityType:
                $ref: '#/components/examples/patch-legalEntities-id-changeLegalEntityType'
              updateLegalEntityOrganization:
                $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization'
              updateLegalEntitySoleProp:
                $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp'
              updateLegalRepresentative:
                $ref: '#/components/examples/patch-legalEntities-id-updateLegalRepresentative'
              updateTrustMember:
                $ref: '#/components/examples/patch-legalEntities-id-updateTrustMember'
              updateTrustMemberExempt:
                $ref: '#/components/examples/patch-legalEntities-id-updateTrustMemberExempt'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegalEntity'
              examples:
                changeLegalEntityType:
                  $ref: '#/components/examples/patch-legalEntities-id-changeLegalEntityType-200'
                updateLegalEntityOrganization:
                  $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization-200'
                updateLegalEntitySoleProp:
                  $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp-200'
                updateLegalRepresentative:
                  $ref: '#/components/examples/patch-legalEntities-id-updateLegalRepresentative-200'
                updateTrustMember:
                  $ref: '#/components/examples/patch-legalEntities-id-updateTrustMember-200'
                updateTrustMemberExempt:
                  $ref: '#/components/examples/patch-legalEntities-id-updateTrustMemberExempt-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 3
      x-methodName: updateLegalEntity
  /legalEntities/{id}/acceptedTermsOfServiceDocument/{termsofserviceacceptancereference}:
    get:
      tags:
      - Terms of Service
      summary: Get accepted Terms of Service document
      description: 'Returns the accepted Terms of Service document for a legal entity.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-legalEntities-id-acceptedTermsOfServiceDocument-termsofserviceacceptancereference
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity. For sole proprietorship,
          this is the individual legal entity ID of the owner. For organizations,
          this is the ID of the organization.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: termsofserviceacceptancereference
        in: path
        description: An Adyen-generated reference for the accepted Terms of Service.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: termsOfServiceDocumentFormat
        in: query
        description: 'The format of the Terms of Service document. Possible values:
          **JSON**, **PDF**, or **TXT**'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAcceptedTermsOfServiceDocumentResponse'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '2'
      x-sortIndex: 4
      x-methodName: getAcceptedTermsOfServiceDocument
  /legalEntities/{id}/businessLines:
    get:
      tags:
      - Legal entities
      summary: Get all business lines under a legal entity
      description: 'Returns the business lines owned by a legal entity.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-legalEntities-id-businessLines
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessLines'
              examples:
                success:
                  $ref: '#/components/examples/get-legalEntities-id-businessLines-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 4
      x-methodName: getAllBusinessLinesUnderLegalEntity
  /legalEntities/{id}/checkTaxElectronicDeliveryConsent:
    post:
      tags:
      - Tax eDelivery consent
      summary: Check the status of consent for electronic delivery of tax forms
      description: 'Returns the consent status for electronic delivery of tax forms.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-checkTaxElectronicDeliveryConsent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity. For sole proprietorships,
          this is the individual legal entity ID of the owner. For organizations,
          this is the ID of the organization.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckTaxElectronicDeliveryConsentResponse'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 2
      x-methodName: checkStatusOfConsentForElectronicDeliveryOfTaxForms
  /legalEntities/{id}/checkVerificationErrors:
    post:
      tags:
      - Legal entities
      summary: Check a legal entity's verification errors
      description: 'Returns the verification errors for a legal entity and its supporting
        entities.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-checkVerificationErrors
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationErrors'
              examples:
                checkVerificationErrors:
                  $ref: '#/components/examples/post-legalEntities-id-checkVerificationErrors-checkVerificationErrors-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '3'
      x-sortIndex: 2
      x-methodName: checkLegalEntitysVerificationErrors
  /legalEntities/{id}/confirmDataReview:
    post:
      tags:
      - Legal entities
      summary: Confirm data review
      description: 'Confirms that your user has reviewed the data for the legal entity
        specified in the path. Call this endpoint to inform Adyen that your user reviewed
        and verified that the data is up-to-date. The endpoint returns the timestamp
        of when Adyen received the request.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-confirmDataReview
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataReviewConfirmationResponse'
              examples:
                confirmDataReview:
                  $ref: '#/components/examples/post-legalEntities-id-confirmDataReview-confirmDataReview-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '3'
      x-sortIndex: 22
      x-methodName: confirmDataReview
  /legalEntities/{id}/onboardingLinks:
    post:
      tags:
      - Hosted Onboarding
      summary: Get a link to an Adyen-hosted onboarding page
      description: 'Returns a link to an Adyen-hosted onboarding page where you need
        to redirect your user.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-onboardingLinks
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingLinkInfo'
            examples:
              createOnboardingLink:
                $ref: '#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingLink'
              examples:
                createOnboardingLink:
                  $ref: '#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 1
      x-methodName: getLinkToAdyenhostedOnboardingPage
  /legalEntities/{id}/pciQuestionnaires:
    get:
      tags:
      - PCI questionnaires
      summary: Get PCI questionnaire details
      description: 'Get a list of signed PCI questionnaires.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-legalEntities-id-pciQuestionnaires
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity to get PCI questionnaire
          information.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPciQuestionnaireInfosResponse'
              examples:
                success:
                  $ref: '#/components/examples/get-legalEntities-id-pciQuestionnaires-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 3
      x-methodName: getPciQuestionnaireDetails
  /legalEntities/{id}/pciQuestionnaires/generatePciTemplates:
    post:
      tags:
      - PCI questionnaires
      summary: Generate PCI questionnaire
      description: 'Generates the required PCI questionnaires based on the user''s
        [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-pciQuestionnaires-generatePciTemplates
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity to get PCI questionnaire
          information.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneratePciDescriptionRequest'
            examples:
              createPciQuestionnaire:
                $ref: '#/components/examples/post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneratePciDescriptionResponse'
              examples:
                createPciQuestionnaire:
                  $ref: '#/components/examples/post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 1
      x-methodName: generatePciQuestionnaire
  /legalEntities/{id}/pciQuestionnaires/signPciTemplates:
    post:
      tags:
      - PCI questionnaires
      summary: Sign PCI questionnaire
      description: 'Signs the required PCI questionnaire.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-pciQuestionnaires-signPciTemplates
      parameters:
      - name: id
        in: path
        description: The legal entity ID of the user that has a contractual relationship
          with your platform.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PciSigningRequest'
            examples:
              signPciQuestionnaire:
                $ref: '#/components/examples/post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PciSigningResponse'
              examples:
                signPciQuestionnaire:
                  $ref: '#/components/examples/post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 2
      x-methodName: signPciQuestionnaire
  /legalEntities/{id}/pciQuestionnaires/signingRequired:
    post:
      tags:
      - PCI questionnaires
      summary: Calculate PCI status of a legal entity
      description: 'Calculate PCI status of a legal entity.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-pciQuestionnaires-signingRequired
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity to calculate PCI status.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatePciStatusRequest'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatePciStatusResponse'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 5
      x-methodName: calculatePciStatusOfLegalEntity
  /legalEntities/{id}/pciQuestionnaires/{pciid}:
    get:
      tags:
      - PCI questionnaires
      summary: Get PCI questionnaire
      description: 'Returns the signed PCI questionnaire.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-legalEntities-id-pciQuestionnaires-pciid
      parameters:
      - name: id
        in: path
        description: The legal entity ID of the individual who signed the PCI questionnaire.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: pciid
        in: path
        description: The unique identifier of the signed PCI questionnaire.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPciQuestionnaireResponse'
              examples:
                success:
                  $ref: '#/components/examples/get-legalEntities-id-pciQuestionnaires-pciid-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 4
      x-methodName: getPciQuestionnaire
  /legalEntities/{id}/setTaxElectronicDeliveryConsent:
    post:
      tags:
      - Tax eDelivery consent
      summary: Set the consent status for electronic delivery of tax forms
      description: 'Set the consent status for electronic delivery of tax forms.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-setTaxElectronicDeliveryConsent
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity. For sole proprietorships,
          this is the individual legal entity ID of the owner. For organizations,
          this is the ID of the organization.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetTaxElectronicDeliveryConsentRequest'
      responses:
        '200':
          description: 'No Content - look at the actual response code for the status
            of the request. '
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 1
      x-methodName: setConsentStatusForElectronicDeliveryOfTaxForms
  /legalEntities/{id}/termsOfService:
    post:
      tags:
      - Terms of Service
      summary: Get Terms of Service document
      description: 'Returns the Terms of Service document for a legal entity.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: post-legalEntities-id-termsOfService
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity. For sole proprietorships,
          this is the individual legal entity ID of the owner. For organizations,
          this is the ID of the organization.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTermsOfServiceDocumentRequest'
            examples:
              createTermsofService:
                $ref: '#/components/examples/post-legalEntities-id-termsOfService-createTermsofService'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTermsOfServiceDocumentResponse'
              examples:
                createTermsofService:
                  $ref: '#/components/examples/post-legalEntities-id-termsOfService-createTermsofService-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 1
      x-methodName: getTermsOfServiceDocument
  /legalEntities/{id}/termsOfService/{termsofservicedocumentid}:
    patch:
      tags:
      - Terms of Service
      summary: Accept Terms of Service
      description: 'Accepts Terms of Service.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: patch-legalEntities-id-termsOfService-termsofservicedocumentid
      parameters:
      - name: id
        in: path
        description: 'The unique identifier of the legal entity.


          For sole proprietorships, this is the individual legal entity ID of the
          owner.


          For organizations, this is the ID of the organization.


          For legal representatives of individuals, this is the ID of the individual.


          '
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: termsofservicedocumentid
        in: path
        description: The unique identifier of the Terms of Service document.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AcceptTermsOfServiceRequest'
            examples:
              updateTermsofService:
                $ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptTermsOfServiceResponse'
              examples:
                updateTermsofService:
                  $ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 2
      x-methodName: acceptTermsOfService
  /legalEntities/{id}/termsOfServiceAcceptanceInfos:
    get:
      tags:
      - Terms of Service
      summary: Get Terms of Service information for a legal entity
      description: 'Returns Terms of Service information for a legal entity.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-legalEntities-id-termsOfServiceAcceptanceInfos
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity. For sole proprietorships,
          this is the individual legal entity ID of the owner. For organizations,
          this is the ID of the organization.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTermsOfServiceAcceptanceInfosResponse'
              examples:
                success:
                  $ref: '#/components/examples/get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 3
      x-methodName: getTermsOfServiceInformationForLegalEntity
  /legalEntities/{id}/termsOfServiceStatus:
    get:
      tags:
      - Terms of Service
      summary: Get Terms of Service status
      description: 'Returns the required types of Terms of Service that need to be
        accepted by a legal entity.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-legalEntities-id-termsOfServiceStatus
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity. For sole proprietorships,
          this is the individual legal entity ID of the owner. For organizations,
          this is the ID of the organization.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculateTermsOfServiceStatusResponse'
              examples:
                success:
                  $ref: '#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 4
      x-methodName: getTermsOfServiceStatus
  /themes:
    get:
      tags:
      - Hosted Onboarding
      summary: Get a list of hosted onboarding page themes
      description: 'Returns a list of hosted onboarding page themes.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-themes
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingThemes'
              examples:
                success:
                  $ref: '#/components/examples/get-themes-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 2
      x-methodName: listHostedOnboardingPageThemes
  /themes/{id}:
    get:
      tags:
      - Hosted Onboarding
      summary: Get an onboarding link theme
      description: 'Returns the details of the theme identified in the path.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-themes-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the theme
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingTheme'
              examples:
                success:
                  $ref: '#/components/examples/get-themes-id-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 4
      x-methodName: getOnboardingLinkTheme
  /transferInstruments:
    post:
      tags:
      - Transfer instruments
      summary: Create a transfer instrument
      description: "Creates a transfer instrument. \n\nA transfer instrument is a\
        \ bank account that a legal entity owns. Adyen performs verification checks\
        \ on the transfer instrument as required by payment industry regulations.\
        \ We inform you of the verification results through webhooks or API responses.\n\
        \nWhen the transfer instrument passes the verification checks, you can start\
        \ sending funds from the balance platform to the transfer instrument (such\
        \ as payouts).\n\nRequests to this endpoint are subject to rate limits:\n\n\
        - Live environments: 700 requests per 5 seconds.\n\n- Test environments: 200\
        \ requests per 5 seconds.\n\n- Failed requests are subject to a limit of 5\
        \ failures per 10 seconds.\n\n"
      operationId: post-transferInstruments
      parameters:
      - name: x-requested-verification-code
        in: header
        description: Use a suberror code as your requested verification code. You
          can include one code at a time in your request header. Requested verification
          codes can only be used in your test environment.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: '1_7002'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferInstrumentInfo'
            examples:
              createTransferInstrumentEUR:
                $ref: '#/components/examples/post-transferInstruments-createTransferInstrumentEUR'
              createTransferInstrumentUK:
                $ref: '#/components/examples/post-transferInstruments-createTransferInstrumentUK'
              createTransferInstrumentUSD:
                $ref: '#/components/examples/post-transferInstruments-createTransferInstrumentUSD'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferInstrument'
              examples:
                createTransferInstrumentEUR:
                  $ref: '#/components/examples/post-transferInstruments-createTransferInstrumentEUR-200'
                createTransferInstrumentUK:
                  $ref: '#/components/examples/post-transferInstruments-createTransferInstrumentUK-200'
                createTransferInstrumentUSD:
                  $ref: '#/components/examples/post-transferInstruments-createTransferInstrumentUSD-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 8
      x-methodName: createTransferInstrument
  /transferInstruments/{id}:
    get:
      tags:
      - Transfer instruments
      summary: Get a transfer instrument
      description: 'Returns the details of a transfer instrument.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: get-transferInstruments-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the transfer instrument.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferInstrument'
              examples:
                success:
                  $ref: '#/components/examples/get-transferInstruments-id-success-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 9
      x-methodName: getTransferInstrument
    delete:
      tags:
      - Transfer instruments
      summary: Delete a transfer instrument
      description: 'Deletes a transfer instrument.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: delete-transferInstruments-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the transfer instrument to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: 'No Content - look at the actual response code for the status
            of the request. '
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 11
      x-methodName: deleteTransferInstrument
    patch:
      tags:
      - Transfer instruments
      summary: Update a transfer instrument
      description: 'Updates a transfer instrument.


        Requests to this endpoint are subject to rate limits:


        - Live environments: 700 requests per 5 seconds.


        - Test environments: 200 requests per 5 seconds.


        - Failed requests are subject to a limit of 5 failures per 10 seconds.


        '
      operationId: patch-transferInstruments-id
      parameters:
      - name: id
        in: path
        description: The unique identifier of the transfer instrument.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: x-requested-verification-code
        in: header
        description: Use the requested verification code 0_0001 to resolve any suberrors
          associated with the transfer instrument. Requested verification codes can
          only be used in your test environment.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: '0_0001'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferInstrumentInfo'
            examples:
              updateTransferInstrument:
                $ref: '#/components/examples/patch-transferInstruments-id-updateTransferInstrument'
      responses:
        '200':
          description: OK - the request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferInstrument'
              examples:
                updateTransferInstrument:
                  $ref: '#/components/examples/patch-transferInstruments-id-updateTransferInstrument-200'
        '400':
          description: Bad Request - a problem reading or understanding the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '401':
          description: Unauthorized - authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '403':
          description: Forbidden - insufficient permissions to process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '422':
          description: Unprocessable Entity - a request validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '500':
          description: Internal Server Error - the server could not process the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      x-addedInVersion: '1'
      x-sortIndex: 10
      x-methodName: updateTransferInstrument
  /legalEntities/{id}/requestPeriodicReview:
    post:
      tags:
      - Legal entities
      summary: Request periodic data review.
      description: Requests a periodic data review for the legal entity of the user
        specified in the path.
      operationId: post-legalEntities-id-requestPeriodicReview
      parameters:
      - name: id
        in: path
        description: The unique identifier of the legal entity.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No Content - the request has been successfully processed, but
            there is no additional content.
          content:
            application/json: {}
      x-methodName: requestPeriodicReview
      x-sortIndex: 0
components:
  schemas:
    AULocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The bank account number, without separators or whitespace.
          maxLength: 9
          minLength: 5
        bsbCode:
          type: string
          description: The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch),
            without separators or whitespace.
          maxLength: 6
          minLength: 6
        type:
          type: string
          default: auLocal
          description: '**auLocal**'
          enum:
          - auLocal
      required:
      - accountNumber
      - bsbCode
      - type
    AcceptTermsOfServiceRequest:
      type: object
      additionalProperties: false
      properties:
        acceptedBy:
          type: string
          description: 'The legal entity ID of the user accepting the Terms of Service.


            For organizations, this must be the individual legal entity ID of an authorized
            signatory for the organization.


            For sole proprietorships, this must be the individual legal entity ID
            of the owner.


            For individuals, this must be the individual legal entity id of either
            the individual, parent, or guardian.


            '
        ipAddress:
          type: string
          description: The IP address of the user accepting the Terms of Service.
      required:
      - acceptedBy
    AcceptTermsOfServiceResponse:
      type: object
      additionalProperties: false
      properties:
        acceptedBy:
          type: string
          description: The unique identifier of the user that accepted the Terms of
            Service.
        id:
          type: string
          description: The unique identifier of the Terms of Service acceptance.
        ipAddress:
          type: string
          description: The IP address of the user that accepted the Terms of Service.
        language:
          type: string
          description: 'The language used for the Terms of Service document, specified
            by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
            language code. Possible value: **en** for English or **fr** for French.


            Note that French is only available for some integration types in certain
            countries/regions. Reach out to your Adyen contact for more information.'
        termsOfServiceDocumentId:
          type: string
          description: The unique identifier of the Terms of Service document.
        type:
          type: string
          description: 'The type of Terms of Service.


            Possible values:

            *  **adyenForPlatformsManage**

            *  **adyenIssuing**

            *  **adyenForPlatformsAdvanced**

            *  **adyenCapital**

            *  **adyenAccount**

            *  **adyenCard**

            *  **adyenFranchisee**

            *  **adyenPccr**

            *  **adyenChargeCard**

            *  **kycOnInvite**


            '
          enum:
          - adyenAccount
          - adyenCapital
          - adyenCard
          - adyenChargeCard
          - adyenForPlatformsAdvanced
          - adyenForPlatformsManage
          - adyenFranchisee
          - adyenIssuing
          - adyenPccr
          - kycOnInvite
    AdditionalBankIdentification:
      type: object
      additionalProperties: false
      properties:
        code:
          type: string
          description: The value of the additional bank identification.
        type:
          type: string
          description: "The type of additional bank identification, depending on the\
            \ country.\n\nPossible values:\n\n * **auBsbCode**: The 6-digit [Australian\
            \ Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch),\
            \ without separators or spaces.\n * **caRoutingNumber**: The 9-digit [Canadian\
            \ routing number](https://en.wikipedia.org/wiki/Routing_number_(Canada)),\
            \ in EFT format, without separators or spaces.\n * **gbSortCode**: The\
            \ 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without\
            \ separators or spaces\n * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number),\
            \ without separators or spaces."
          enum:
          - auBsbCode
          - caRoutingNumber
          - gbSortCode
          - usRoutingNumber
    Address:
      type: object
      additionalProperties: false
      properties:
        city:
          type: string
          description: 'The name of the city. Required if `stateOrProvince` is provided.


            If you specify the city, you must also send `postalCode` and `street`.'
        country:
          type: string
          description: The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code.
        postalCode:
          type: string
          description: 'The postal code. Required if `stateOrProvince` and/or `city`
            is provided.


            When using alphanumeric postal codes, all letters must be uppercase. For
            example, 1234 AB or SW1A 1AA.'
        stateOrProvince:
          type: string
          description: 'The two-letter ISO 3166-2 state or province code. For example,
            **CA** in the US. Required for Australia and New Zealand.


            If you specify the state or province, you must also send `city`, `postalCode`,
            and `street`.'
        street:
          type: string
          description: The name of the street, and the house or building number. Required
            if `stateOrProvince` and/or `city` is provided.
        street2:
          type: string
          description: The apartment, unit, or suite number.
      required:
      - country
    Amount:
      type: object
      additionalProperties: false
      properties:
        currency:
          type: string
          description: The type of currency. Must be EUR (or EUR equivalent)
        value:
          type: integer
          format: int64
          description: Total value of amount. Must be >= 0
    Attachment:
      type: object
      additionalProperties: false
      properties:
        content:
          type: string
          format: byte
          description: The document in Base64-encoded string format.
        contentType:
          type: string
          deprecated: true
          description: "The file format.\n\n Possible values: **application/pdf**,\
            \ **image/jpg**, **image/jpeg**, **image/png**. "
          x-deprecatedInVersion: '1'
        filename:
          type: string
          deprecated: true
          description: The name of the file including the file extension.
          x-deprecatedInVersion: '1'
        pageName:
          type: string
          description: The name of the file including the file extension.
          x-addedInVersion: '2'
        pageType:
          type: string
          description: 'Specifies which side of the ID card is uploaded.


            * If the `type` is **driversLicense** or **identityCard**, you must set
            this to **front** or **back** and include both sides in the same API request.


            * For any other types, when this is omitted, we infer the page number
            based on the order of attachments.'
      required:
      - content
    BankAccountInfo:
      type: object
      additionalProperties: false
      properties:
        accountIdentification:
          description: Identification of the bank account.
          oneOf:
          - $ref: '#/components/schemas/AULocalAccountIdentification'
          - $ref: '#/components/schemas/CALocalAccountIdentification'
          - $ref: '#/components/schemas/CZLocalAccountIdentification'
          - $ref: '#/components/schemas/DKLocalAccountIdentification'
          - $ref: '#/components/schemas/HKLocalAccountIdentification'
          - $ref: '#/components/schemas/HULocalAccountIdentification'
          - $ref: '#/components/schemas/IbanAccountIdentification'
          - $ref: '#/components/schemas/NOLocalAccountIdentification'
          - $ref: '#/components/schemas/NZLocalAccountIdentification'
          - $ref: '#/components/schemas/NumberAndBicAccountIdentification'
          - $ref: '#/components/schemas/PLLocalAccountIdentification'
          - $ref: '#/components/schemas/SELocalAccountIdentification'
          - $ref: '#/components/schemas/SGLocalAccountIdentification'
          - $ref: '#/components/schemas/UKLocalAccountIdentification'
          - $ref: '#/components/schemas/USLocalAccountIdentification'
          x-addedInVersion: '3'
        accountType:
          type: string
          deprecated: true
          description: The type of bank account.
          x-deprecatedInVersion: '2'
        bankName:
          type: string
          description: The name of the banking institution where the bank account
            is held.
        countryCode:
          type: string
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code where the bank account is registered. For example, **NL**.
        trustedSource:
          type: boolean
          description: Identifies if the bank account was created through [instant
            bank verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding).
          readOnly: true
    BirthData:
      type: object
      additionalProperties: false
      properties:
        dateOfBirth:
          type: string
          description: The individual's date of birth, in YYYY-MM-DD format.
    BusinessLine:
      type: object
      additionalProperties: false
      properties:
        capability:
          type: string
          deprecated: true
          description: 'The capability for which you are creating the business line.


            Possible values: **receivePayments**, **receiveFromPlatformPayments**,
            **issueBankAccount**'
          enum:
          - receivePayments
          - receiveFromPlatformPayments
          - issueBankAccount
          x-deprecatedInVersion: '3'
          x-deprecatedMessage: Use `service` instead.
        id:
          type: string
          description: The unique identifier of the business line.
          readOnly: true
        industryCode:
          type: string
          description: A code that represents the industry of the legal entity for
            [marketplaces](https://docs.adyen.com/marketplaces/verification-requirements/reference-additional-products/#list-industry-codes)
            or [platforms](https://docs.adyen.com/platforms/verification-requirements/reference-additional-products/#list-industry-codes).
            For example, **4431A** for computer software stores.
        legalEntityId:
          type: string
          description: Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id)
            that owns the business line.
        problems:
          type: array
          description: The verification errors related to capabilities for this supporting
            entity.
          items:
            $ref: '#/components/schemas/CapabilityProblem'
          x-addedInVersion: '3'
        salesChannels:
          type: array
          description: 'A list of channels where goods or services are sold.


            Possible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**.


            Required only in combination with the `service` **paymentProcessing**.'
          items:
            type: string
        service:
          type: string
          description: 'The service for which you are creating the business line.




            Possible values:

            *  **paymentProcessing**

            *  **banking**


            '
          enum:
          - paymentProcessing
          - banking
          x-addedInVersion: '3'
        sourceOfFunds:
          $ref: '#/components/schemas/SourceOfFunds'
          description: Contains information about the source of your user's funds.
            Required only for the `service` **banking**.
        webData:
          type: array
          description: List of website URLs where your user's goods or services are
            sold. When this is required for a service but your user does not have
            an online presence, provide the reason in the `webDataExemption` object.
          items:
            $ref: '#/components/schemas/WebData'
        webDataExemption:
          $ref: '#/components/schemas/WebDataExemption'
          description: The reason why the web data is not provided.
      required:
      - id
      - industryCode
      - legalEntityId
      - service
    BusinessLineInfo:
      type: object
      additionalProperties: false
      properties:
        capability:
          type: string
          deprecated: true
          description: 'The capability for which you are creating the business line.


            Possible values: **receivePayments**, **receiveFromPlatformPayments**,
            **issueBankAccount**'
          enum:
          - receivePayments
          - receiveFromPlatformPayments
          - issueBankAccount
          x-deprecatedInVersion: '3'
          x-deprecatedMessage: Use `service` instead.
        industryCode:
          type: string
          description: A code that represents the industry of the legal entity for
            [marketplaces](https://docs.adyen.com/marketplaces/verification-requirements/reference-additional-products/#list-industry-codes)
            or [platforms](https://docs.adyen.com/platforms/verification-requirements/reference-additional-products/#list-industry-codes).
            For example, **4431A** for computer software stores.
        legalEntityId:
          type: string
          description: Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id)
            that owns the business line.
        salesChannels:
          type: array
          description: 'A list of channels where goods or services are sold.


            Possible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**.


            Required only in combination with the `service` **paymentProcessing**.'
          items:
            type: string
        service:
          type: string
          description: 'The service for which you are creating the business line.




            Possible values:

            *  **paymentProcessing**

            *  **banking**


            '
          enum:
          - paymentProcessing
          - banking
          x-addedInVersion: '3'
        sourceOfFunds:
          $ref: '#/components/schemas/SourceOfFunds'
          description: Contains information about the source of your user's funds.
            Required only for the `service` **banking**.
        webData:
          type: array
          description: List of website URLs where your user's goods or services are
            sold. When this is required for a service but your user does not have
            an online presence, provide the reason in the `webDataExemption` object.
          items:
            $ref: '#/components/schemas/WebData'
        webDataExemption:
          $ref: '#/components/schemas/WebDataExemption'
          description: The reason why the web data is not provided.
      required:
      - industryCode
      - legalEntityId
      - service
    BusinessLineInfoUpdate:
      type: object
      additionalProperties: false
      properties:
        industryCode:
          type: string
          description: A code that represents the industry of your legal entity. For
            example, **4431A** for computer software stores.
        salesChannels:
          type: array
          description: 'A list of channels where goods or services are sold.


            Possible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**.


            Required only in combination with the `service` **paymentProcessing**.'
          items:
            type: string
        sourceOfFunds:
          $ref: '#/components/schemas/SourceOfFunds'
          description: Contains information about the source of your user's funds.
            Required only for the `service` **banking**.
        webData:
          type: array
          description: List of website URLs where your user's goods or services are
            sold. When this is required for a service but your user does not have
            an online presence, provide the reason in the `webDataExemption` object.
          items:
            $ref: '#/components/schemas/WebData'
        webDataExemption:
          $ref: '#/components/schemas/WebDataExemption'
          description: The reason why the web data is not provided.
    BusinessLines:
      type: object
      additionalProperties: false
      properties:
        businessLines:
          type: array
          description: List of business lines.
          items:
            $ref: '#/components/schemas/BusinessLine'
      required:
      - businessLines
    CALocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 5- to 12-digit bank account number, without separators
            or whitespace.
          maxLength: 12
          minLength: 5
        accountType:
          type: string
          default: checking
          description: 'The bank account type.


            Possible values: **checking** or **savings**. Defaults to **checking**.'
          enum:
          - checking
          - savings
        institutionNumber:
          type: string
          description: The 3-digit institution number, without separators or whitespace.
          maxLength: 3
          minLength: 3
        transitNumber:
          type: string
          description: The 5-digit transit number, without separators or whitespace.
          maxLength: 5
          minLength: 5
        type:
          type: string
          default: caLocal
          description: '**caLocal**'
          enum:
          - caLocal
      required:
      - accountNumber
      - institutionNumber
      - transitNumber
      - type
    CZLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: "The 2- to 16-digit bank account number (\u010C\xEDslo \xFA\
            \u010Dtu) in the following format:\n\n- The optional prefix (p\u0159ed\u010D\
            \xEDsl\xED).\n\n- The required second part (z\xE1kladn\xED \u010D\xE1\
            st) which must be at least two non-zero digits.\n\nExamples:\n\n- **19-123457**\
            \ (with prefix)\n\n- **123457** (without prefix)\n\n- **000019-0000123457**\
            \ (with prefix, normalized)\n\n- **000000-0000123457** (without prefix,\
            \ normalized)"
          maxLength: 17
          minLength: 2
        bankCode:
          type: string
          description: "The 4-digit bank code (K\xF3d banky), without separators or\
            \ whitespace."
          maxLength: 4
          minLength: 4
        type:
          type: string
          default: czLocal
          description: '**czLocal**'
          enum:
          - czLocal
      required:
      - accountNumber
      - bankCode
      - type
    CalculatePciStatusRequest:
      type: object
      additionalProperties: false
      properties:
        additionalSalesChannels:
          type: array
          description: 'An array of additional sales channels to generate PCI questionnaires.
            Include the relevant sales channels if you need your user to sign PCI
            questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms)
            and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model)
            before you generate the questionnaires.


            Possible values:

            *  **eCommerce**

            *  **pos**

            *  **ecomMoto**

            *  **posMoto**


            '
          items:
            type: string
            enum:
            - eCommerce
            - ecomMoto
            - pos
            - posMoto
    CalculatePciStatusResponse:
      type: object
      additionalProperties: false
      properties:
        signingRequired:
          type: boolean
          description: Indicates if the user is required to sign PCI questionnaires.
            If **false**, they do not need to sign any questionnaires.
    CalculateTermsOfServiceStatusResponse:
      type: object
      additionalProperties: false
      properties:
        termsOfServiceTypes:
          type: array
          description: The type of Terms of Service that the legal entity needs to
            accept. If empty, no Terms of Service needs to be accepted.
          items:
            type: string
            enum:
            - adyenAccount
            - adyenCapital
            - adyenCard
            - adyenChargeCard
            - adyenForPlatformsAdvanced
            - adyenForPlatformsManage
            - adyenFranchisee
            - adyenIssuing
            - adyenPccr
            - kycOnInvite
    CapabilityProblem:
      type: object
      additionalProperties: false
      properties:
        entity:
          $ref: '#/components/schemas/CapabilityProblemEntity'
        verificationErrors:
          type: array
          items:
            $ref: '#/components/schemas/VerificationError'
    CapabilityProblemEntity:
      type: object
      additionalProperties: false
      properties:
        documents:
          type: array
          description: List of document IDs corresponding to the verification errors
            from capabilities.
          items:
            type: string
        id:
          type: string
        owner:
          $ref: '#/components/schemas/CapabilityProblemEntity-recursive'
        type:
          type: string
          enum:
          - BankAccount
          - Document
          - LegalEntity
          - product
    CapabilityProblemEntity-recursive:
      type: object
      additionalProperties: false
      properties:
        documents:
          type: array
          description: List of document IDs corresponding to the verification errors
            from capabilities.
          items:
            type: string
        id:
          type: string
        type:
          type: string
          enum:
          - BankAccount
          - Document
          - LegalEntity
          - product
    CapabilitySettings:
      type: object
      additionalProperties: false
      properties:
        amountPerIndustry:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Amount'
          description: The maximum amount a card holder can spend per industry.
        authorizedCardUsers:
          type: boolean
          description: The number of card holders who can use the card.
        fundingSource:
          type: array
          description: The funding source of the card, for example **debit**.
          items:
            type: string
            enum:
            - credit
            - debit
            - prepaid
        interval:
          type: string
          description: The period when the rule conditions apply.
          enum:
          - daily
          - monthly
          - weekly
        maxAmount:
          $ref: '#/components/schemas/Amount'
          description: The maximum amount a card holder can withdraw per day.
    CheckTaxElectronicDeliveryConsentResponse:
      type: object
      additionalProperties: false
      properties:
        US1099k:
          type: boolean
          description: Consent to electronically deliver tax form US1099-K.
    DKLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 4-10 digits bank account number (Kontonummer) (without
            separators or whitespace).
          maxLength: 10
          minLength: 4
        bankCode:
          type: string
          description: The 4-digit bank code (Registreringsnummer) (without separators
            or whitespace).
          maxLength: 4
          minLength: 4
        type:
          type: string
          default: dkLocal
          description: '**dkLocal**'
          enum:
          - dkLocal
      required:
      - accountNumber
      - bankCode
      - type
    DataReviewConfirmationResponse:
      type: object
      additionalProperties: false
      properties:
        dataReviewedAt:
          type: string
          description: Date when data review was confirmed.
    Document:
      type: object
      additionalProperties: false
      properties:
        attachment:
          $ref: '#/components/schemas/Attachment'
          deprecated: true
          description: Object that contains the document.
          x-deprecatedInVersion: '1'
          x-deprecatedMessage: Use the `attachments` array instead.
        attachments:
          type: array
          description: Array that contains the document. The array supports multiple
            attachments for uploading different sides or pages of a document.
          items:
            $ref: '#/components/schemas/Attachment'
        creationDate:
          type: string
          format: date-time
          description: The creation date of the document.
          readOnly: true
        description:
          type: string
          description: Your description for the document.
        expiryDate:
          type: string
          deprecated: true
          description: The expiry date of the document, in YYYY-MM-DD format.
          x-deprecatedInVersion: '1'
        fileName:
          type: string
          description: The filename of the document.
        id:
          type: string
          description: The unique identifier of the document.
          readOnly: true
        issuerCountry:
          type: string
          deprecated: true
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code where the document was issued. For example, **US**.
          x-deprecatedInVersion: '1'
        issuerState:
          type: string
          deprecated: true
          description: The state or province where the document was issued (AU only).
          x-deprecatedInVersion: '1'
        modificationDate:
          type: string
          format: date-time
          description: The modification date of the document.
          readOnly: true
        number:
          type: string
          description: The number in the document.
        owner:
          $ref: '#/components/schemas/OwnerEntity'
          description: Contains information about the resource that owns the document.
        type:
          type: string
          description: 'Type of document, used when providing an ID number or uploading
            a document. The possible values depend on the legal entity type.


            * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**,
            **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**,
            **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**.


            * For **individual**, the `type` values can be **identityCard**, **driversLicense**,
            **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**,
            **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource**
            or **proofOfRelationship**.


            * For **soleProprietorship**, the `type` values can be **constitutionalDocument**,
            **proofOfAddress**, or **proofOfIndustry**.


            * For **trust**, the `type` value is **constitutionalDocument**.


            * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**.


            * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).'
          enum:
          - bankStatement
          - driversLicense
          - identityCard
          - nationalIdNumber
          - passport
          - proofOfAddress
          - proofOfNationalIdNumber
          - proofOfResidency
          - registrationDocument
          - vatDocument
          - proofOfOrganizationTaxInfo
          - proofOfIndividualTaxId
          - proofOfOwnership
          - proofOfSignatory
          - liveSelfie
          - proofOfIndustry
          - constitutionalDocument
          - proofOfFundingOrWealthSource
          - proofOfRelationship
      required:
      - description
      - type
    DocumentPage:
      type: object
      additionalProperties: false
      properties:
        pageName:
          type: string
        pageNumber:
          type: integer
          format: int32
        type:
          type: string
          enum:
          - BACK
          - FRONT
          - UNDEFINED
    DocumentReference:
      type: object
      additionalProperties: false
      properties:
        active:
          type: boolean
          description: Identifies whether the document is active and used for checks.
        description:
          type: string
          description: Your description for the document.
        fileName:
          type: string
          description: Document name.
        id:
          type: string
          description: The unique identifier of the resource.
        modificationDate:
          type: string
          format: date-time
          description: The modification date of the document.
        pages:
          type: array
          description: List of document pages
          items:
            $ref: '#/components/schemas/DocumentPage'
        type:
          type: string
          description: Type of document, used when providing an ID number or uploading
            a document.
    EntityReference:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: The unique identifier of the resource.
    FinancialReport:
      type: object
      additionalProperties: false
      properties:
        annualTurnover:
          type: string
          description: The annual turnover of the business.
          x-addedInVersion: '3'
        balanceSheetTotal:
          type: string
          description: The balance sheet total of the business.
          x-addedInVersion: '3'
        currencyOfFinancialData:
          type: string
          description: The currency used for the annual turnover, balance sheet total,
            and net assets.
          x-addedInVersion: '3'
        dateOfFinancialData:
          type: string
          description: The date the financial data were provided, in YYYY-MM-DD format.
          x-addedInVersion: '3'
        employeeCount:
          type: string
          description: The number of employees of the business.
          x-addedInVersion: '3'
        netAssets:
          type: string
          description: The net assets of the business.
          x-addedInVersion: '3'
    GeneratePciDescriptionRequest:
      type: object
      additionalProperties: false
      properties:
        additionalSalesChannels:
          type: array
          description: 'An array of additional sales channels to generate PCI questionnaires.
            Include the relevant sales channels if you need your user to sign PCI
            questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms)
            and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model)
            before you generate the questionnaires.


            Possible values:

            *  **eCommerce**

            *  **pos**

            *  **ecomMoto**

            *  **posMoto**


            '
          items:
            type: string
            enum:
            - eCommerce
            - ecomMoto
            - pos
            - posMoto
        language:
          type: string
          description: Sets the language of the PCI questionnaire. Its value is a
            two-character [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language
            code, for example, **en**.
    GeneratePciDescriptionResponse:
      type: object
      additionalProperties: false
      properties:
        content:
          type: string
          format: byte
          description: The generated questionnaires in a base64 encoded format.
        language:
          type: string
          description: The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
            language code for the questionnaire. For example, **en**.
        pciTemplateReferences:
          type: array
          description: The array of Adyen-generated unique identifiers for the questionnaires.
            If empty, the user is not required to sign questionnaires.
          items:
            type: string
    GetAcceptedTermsOfServiceDocumentResponse:
      type: object
      additionalProperties: false
      properties:
        document:
          type: string
          format: byte
          description: The accepted Terms of Service document in the requested format
            represented as a Base64-encoded bytes array.
        id:
          type: string
          description: The unique identifier of the legal entity.
        termsOfServiceAcceptanceReference:
          type: string
          description: An Adyen-generated reference for the accepted Terms of Service.
        termsOfServiceDocumentFormat:
          type: string
          description: The format of the Terms of Service document.
          enum:
          - JSON
          - PDF
          - TXT
    GetPciQuestionnaireInfosResponse:
      type: object
      additionalProperties: false
      properties:
        data:
          type: array
          description: Information about the signed PCI questionnaires.
          items:
            $ref: '#/components/schemas/PciDocumentInfo'
    GetPciQuestionnaireResponse:
      type: object
      additionalProperties: false
      properties:
        content:
          type: string
          format: byte
          description: The generated questionnaire in a base64 encoded format.
        createdAt:
          type: string
          format: date-time
          description: The date the questionnaire was created, in ISO 8601 extended
            format. For example, 2022-12-18T10:15:30+01:00
        id:
          type: string
          description: The unique identifier of the signed questionnaire.
        validUntil:
          type: string
          format: date-time
          description: The expiration date of the questionnaire, in ISO 8601 extended
            format. For example, 2022-12-18T10:15:30+01:00
    GetTermsOfServiceAcceptanceInfosResponse:
      type: object
      additionalProperties: false
      properties:
        data:
          type: array
          description: The Terms of Service acceptance information.
          items:
            $ref: '#/components/schemas/TermsOfServiceAcceptanceInfo'
    GetTermsOfServiceDocumentRequest:
      type: object
      additionalProperties: false
      properties:
        language:
          type: string
          description: 'The language to be used for the Terms of Service document,
            specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
            language code. Possible values: **en** for English or **fr** for French.'
        termsOfServiceDocumentFormat:
          type: string
          description: 'The requested format for the Terms of Service document. Default
            value: JSON. Possible values: **JSON**, **PDF**, or **TXT**.'
        type:
          type: string
          description: 'The type of Terms of Service.


            Possible values:

            *  **adyenForPlatformsManage**

            *  **adyenIssuing**

            *  **adyenForPlatformsAdvanced**

            *  **adyenCapital**

            *  **adyenAccount**

            *  **adyenCard**

            *  **adyenFranchisee**

            *  **adyenPccr**

            *  **adyenChargeCard**

            *  **kycOnInvite**


            '
          enum:
          - adyenAccount
          - adyenCapital
          - adyenCard
          - adyenChargeCard
          - adyenForPlatformsAdvanced
          - adyenForPlatformsManage
          - adyenFranchisee
          - adyenIssuing
          - adyenPccr
          - kycOnInvite
      required:
      - language
      - type
    GetTermsOfServiceDocumentResponse:
      type: object
      additionalProperties: false
      properties:
        document:
          type: string
          format: byte
          description: The Terms of Service document in Base64-encoded format.
        id:
          type: string
          description: The unique identifier of the legal entity.
        language:
          type: string
          description: 'The language used for the Terms of Service document, specified
            by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
            language code. Possible value: **en** for English or **fr** for French.


            Note that French is only available for some integration types in certain
            countries/regions. Reach out to your Adyen contact for more information.'
        termsOfServiceDocumentFormat:
          type: string
          description: The format of the Terms of Service document.
        termsOfServiceDocumentId:
          type: string
          description: The unique identifier of the Terms of Service document.
        type:
          type: string
          description: 'The type of Terms of Service.


            Possible values:

            *  **adyenForPlatformsManage**

            *  **adyenIssuing**

            *  **adyenForPlatformsAdvanced**

            *  **adyenCapital**

            *  **adyenAccount**

            *  **adyenCard**

            *  **adyenFranchisee**

            *  **adyenPccr**

            *  **adyenChargeCard**

            *  **kycOnInvite**


            '
          enum:
          - adyenAccount
          - adyenCapital
          - adyenCard
          - adyenChargeCard
          - adyenForPlatformsAdvanced
          - adyenForPlatformsManage
          - adyenFranchisee
          - adyenIssuing
          - adyenPccr
          - kycOnInvite
    HKLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 9- to 17-digit bank account number, without separators
            or whitespace. Starts with the 3-digit branch code.
          maxLength: 17
          minLength: 9
        clearingCode:
          type: string
          description: The 3-digit clearing code, without separators or whitespace.
          maxLength: 3
          minLength: 3
        type:
          type: string
          default: hkLocal
          description: '**hkLocal**'
          enum:
          - hkLocal
      required:
      - accountNumber
      - clearingCode
      - type
    HULocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 24-digit bank account number, without separators or whitespace.
          maxLength: 24
          minLength: 24
        type:
          type: string
          default: huLocal
          description: '**huLocal**'
          enum:
          - huLocal
      required:
      - accountNumber
      - type
    IbanAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        iban:
          type: string
          description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html)
            standard.
        type:
          type: string
          default: iban
          description: '**iban**'
          enum:
          - iban
      required:
      - iban
      - type
    IdentificationData:
      type: object
      additionalProperties: false
      properties:
        cardNumber:
          type: string
          description: The card number of the document that was issued (AU only).
        expiryDate:
          type: string
          description: The expiry date of the document, in YYYY-MM-DD format.
        issuerCountry:
          type: string
          deprecated: true
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code where the document was issued. For example, **US**.
          x-deprecatedInVersion: '1'
        issuerState:
          type: string
          description: The state or province where the document was issued (AU only).
        nationalIdExempt:
          type: boolean
          description: Applies only to individuals in the US. Set to **true** if the
            individual does not have an SSN. To verify their identity, Adyen will
            require them to upload an ID document.
        number:
          type: string
          description: The number in the document.
        type:
          type: string
          description: "Type of identity data. For individuals, the following types\
            \ are supported. See our [onboarding guide](https://docs.adyen.com/platforms/onboard-users/onboarding-steps/?onboarding_type=custom)\
            \ for other supported countries.\n\n- Australia: **driversLicense**, **passport**\n\
            \n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\
            \n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**,\
            \ **nationalIdNumber**, **passport** \n\n- All other supported countries:\
            \ **nationalIdNumber**"
          enum:
          - nationalIdNumber
          - passport
          - driversLicense
          - identityCard
      required:
      - type
    Individual:
      type: object
      additionalProperties: false
      properties:
        birthData:
          $ref: '#/components/schemas/BirthData'
          description: The individual's birth information.
        email:
          type: string
          description: The email address of the legal entity.
        identificationData:
          $ref: '#/components/schemas/IdentificationData'
          description: Information about the individual's identification document.
        name:
          $ref: '#/components/schemas/Name'
          description: The individual's name.
        nationality:
          type: string
          description: The individual's nationality.
        phone:
          $ref: '#/components/schemas/PhoneNumber'
          description: The phone number of the legal entity.
        residentialAddress:
          $ref: '#/components/schemas/Address'
          description: The residential address of the individual.
        taxInformation:
          type: array
          description: The tax information of the individual.
          items:
            $ref: '#/components/schemas/TaxInformation'
          x-addedInVersion: '2'
        webData:
          $ref: '#/components/schemas/WebData'
          deprecated: true
          description: The website and app URL of the legal entity.
          x-deprecatedInVersion: '1'
      required:
      - name
      - residentialAddress
    LegalEntity:
      type: object
      additionalProperties: false
      properties:
        capabilities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/LegalEntityCapability'
          description: Contains key-value pairs that specify the actions that the
            legal entity can do in your platform.The key is a capability required
            for your integration. For example, **issueCard** for Issuing. The value
            is an object containing the settings for the capability.
        documentDetails:
          type: array
          description: List of documents uploaded for the legal entity.
          items:
            $ref: '#/components/schemas/DocumentReference'
          x-addedInVersion: '2'
        documents:
          type: array
          deprecated: true
          description: List of documents uploaded for the legal entity.
          items:
            $ref: '#/components/schemas/EntityReference'
          x-deprecatedInVersion: '1'
          x-deprecatedMessage: Use the `documentDetails` array instead.
        entityAssociations:
          type: array
          description: 'List of legal entities associated with the current legal entity.

            For example, ultimate beneficial owners associated with an organization
            through ownership or control, or as signatories.'
          items:
            $ref: '#/components/schemas/LegalEntityAssociation'
        id:
          type: string
          description: The unique identifier of the legal entity.
          readOnly: true
        individual:
          $ref: '#/components/schemas/Individual'
          description: Information about the individual. Required if `type` is **individual**.
        organization:
          $ref: '#/components/schemas/Organization'
          description: Information about the organization. Required if `type` is **organization**.
        problems:
          type: array
          description: List of verification errors related to capabilities for the
            legal entity.
          items:
            $ref: '#/components/schemas/CapabilityProblem'
          x-addedInVersion: '3'
        reference:
          type: string
          description: Your reference for the legal entity, maximum 150 characters.
          maxLength: 150
        soleProprietorship:
          $ref: '#/components/schemas/SoleProprietorship'
          description: Information about the sole proprietorship. Required if `type`
            is **soleProprietorship**.
          x-addedInVersion: '2'
        transferInstruments:
          type: array
          description: List of transfer instruments that the legal entity owns.
          items:
            $ref: '#/components/schemas/TransferInstrumentReference'
          readOnly: true
        trust:
          $ref: '#/components/schemas/Trust'
          description: Information about the trust. Required if `type` is **trust**.
        type:
          type: string
          description: 'The type of legal entity.


            Possible values: **individual**, **organization**, **soleProprietorship**,
            or **trust**.'
          enum:
          - individual
          - organization
          - soleProprietorship
          - trust
          - unincorporatedPartnership
        unincorporatedPartnership:
          $ref: '#/components/schemas/UnincorporatedPartnership'
          description: Information about the unincorporated partnership. Required
            if `type` is **unincorporatedPartnership**.
        verificationDeadlines:
          type: array
          description: List of verification deadlines and the capabilities that will
            be disallowed if verification errors are not resolved.
          items:
            $ref: '#/components/schemas/VerificationDeadline'
          readOnly: true
          x-addedInVersion: '3'
        verificationPlan:
          type: string
          description: A key-value pair that specifies the verification process for
            a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).
      required:
      - id
    LegalEntityAssociation:
      type: object
      additionalProperties: false
      properties:
        associatorId:
          type: string
          description: The unique identifier of another legal entity with which the
            `legalEntityId` is associated. When the `legalEntityId` is associated
            to legal entities other than the current one, the response returns all
            the associations.
          readOnly: true
        entityType:
          type: string
          description: 'The legal entity type of associated legal entity.


            For example, **organization**, **soleProprietorship** or **individual**.'
          readOnly: true
        jobTitle:
          type: string
          description: The individual's job title if the `type` is **uboThroughControl**
            or **signatory**.
        legalEntityId:
          type: string
          description: The unique identifier of the associated [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id).
        name:
          type: string
          description: 'The name of the associated [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id).


            - For **individual**, `name.firstName` and `name.lastName`.

            - For **organization**, `legalName`.

            - For **soleProprietorship**, `name`.'
          readOnly: true
        nominee:
          type: boolean
          description: 'Default value: **false**

            Set to **true** if the entity association `type` **director**, **secondaryPartner**
            or **shareholder** is also a nominee. Only applicable to New Zealand.'
        relationship:
          type: string
          description: 'The individual''s relationship to a legal representative if
            the `type` is **legalRepresentative**. Possible values: **parent**, **guardian**.'
        settlorExemptionReason:
          type: array
          description: 'Defines the KYC exemption reason for a settlor associated
            with a trust. Only applicable to trusts in Australia.


            For example, **professionalServiceProvider**, **deceased**, or **contributionBelowThreshold**.'
          items:
            type: string
        type:
          type: string
          description: 'Defines the relationship of the legal entity to the current
            legal entity.


            Possible value for individuals: **legalRepresentative**.


            Possible values for organizations: **director**, **signatory**, **trustOwnership**,
            **uboThroughOwnership**, **uboThroughControl**, or **ultimateParentCompany**.


            Possible values for sole proprietorships: **soleProprietorship**.


            Possible value for trusts: **trust**.


            Possible values for trust members: **definedBeneficiary**, **protector**,
            **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.


            Possible value for unincorporated partnership: **unincorporatedPartnership**.


            Possible values for unincorporated partnership members: **secondaryPartner**,
            **uboThroughControl**, **uboThroughOwnership**'
          enum:
          - definedBeneficiary
          - director
          - immediateParentCompany
          - legalRepresentative
          - pciSignatory
          - protector
          - secondaryPartner
          - secondaryTrustee
          - settlor
          - signatory
          - soleProprietorship
          - trust
          - trustOwnership
          - uboThroughControl
          - uboThroughOwnership
          - ultimateParentCompany
          - undefinedBeneficiary
          - unincorporatedPartnership
      required:
      - legalEntityId
      - type
    LegalEntityCapability:
      type: object
      additionalProperties: false
      properties:
        allowed:
          type: boolean
          description: Indicates whether the capability is allowed. Adyen sets this
            to **true** if the verification is successful.
          readOnly: true
        allowedLevel:
          type: string
          description: 'The capability level that is allowed for the legal entity.


            Possible values: **notApplicable**, **low**, **medium**, **high**.'
          enum:
          - high
          - low
          - medium
          - notApplicable
          readOnly: true
        allowedSettings:
          $ref: '#/components/schemas/CapabilitySettings'
          description: The settings that are allowed for the legal entity.
          readOnly: true
        requested:
          type: boolean
          description: Indicates whether the capability is requested. To check whether
            the legal entity is permitted to use the capability, refer to the `allowed`
            field.
          readOnly: true
        requestedLevel:
          type: string
          description: 'The requested level of the capability. Some capabilities,
            such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels),
            have different levels. Levels increase the capability, but also require
            additional checks and increased monitoring.


            Possible values: **notApplicable**, **low**, **medium**, **high**.'
          enum:
          - high
          - low
          - medium
          - notApplicable
          readOnly: true
        requestedSettings:
          $ref: '#/components/schemas/CapabilitySettings'
          description: The settings that are requested for the legal entity.
          readOnly: true
        transferInstruments:
          type: array
          description: The capability status of transfer instruments associated with
            the legal entity.
          items:
            $ref: '#/components/schemas/SupportingEntityCapability'
          readOnly: true
          x-addedInVersion: '2'
        verificationStatus:
          type: string
          description: 'The status of the verification checks for the capability.


            Possible values:


            * **pending**: Adyen is running the verification.


            * **invalid**: The verification failed. Check if the `errors` array contains
            more information.


            * **valid**: The verification has been successfully completed.


            * **rejected**: Adyen has verified the information, but found reasons
            to not allow the capability.

            '
          readOnly: true
    LegalEntityInfo:
      type: object
      additionalProperties: false
      properties:
        capabilities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/LegalEntityCapability'
          description: Contains key-value pairs that specify the actions that the
            legal entity can do in your platform.The key is a capability required
            for your integration. For example, **issueCard** for Issuing. The value
            is an object containing the settings for the capability.
        entityAssociations:
          type: array
          description: 'List of legal entities associated with the current legal entity.

            For example, ultimate beneficial owners associated with an organization
            through ownership or control, or as signatories.'
          items:
            $ref: '#/components/schemas/LegalEntityAssociation'
        individual:
          $ref: '#/components/schemas/Individual'
          description: Information about the individual. Required if `type` is **individual**.
        organization:
          $ref: '#/components/schemas/Organization'
          description: Information about the organization. Required if `type` is **organization**.
        reference:
          type: string
          description: Your reference for the legal entity, maximum 150 characters.
          maxLength: 150
        soleProprietorship:
          $ref: '#/components/schemas/SoleProprietorship'
          description: Information about the sole proprietorship. Required if `type`
            is **soleProprietorship**.
          x-addedInVersion: '2'
        trust:
          $ref: '#/components/schemas/Trust'
          description: Information about the trust. Required if `type` is **trust**.
        type:
          type: string
          description: 'The type of legal entity.


            Possible values: **individual**, **organization**, **soleProprietorship**,
            or **trust**.'
          enum:
          - individual
          - organization
          - soleProprietorship
          - trust
          - unincorporatedPartnership
        unincorporatedPartnership:
          $ref: '#/components/schemas/UnincorporatedPartnership'
          description: Information about the unincorporated partnership. Required
            if `type` is **unincorporatedPartnership**.
        verificationPlan:
          type: string
          description: A key-value pair that specifies the verification process for
            a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).
    LegalEntityInfoRequiredType:
      type: object
      additionalProperties: false
      properties:
        capabilities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/LegalEntityCapability'
          description: Contains key-value pairs that specify the actions that the
            legal entity can do in your platform.The key is a capability required
            for your integration. For example, **issueCard** for Issuing. The value
            is an object containing the settings for the capability.
        entityAssociations:
          type: array
          description: 'List of legal entities associated with the current legal entity.

            For example, ultimate beneficial owners associated with an organization
            through ownership or control, or as signatories.'
          items:
            $ref: '#/components/schemas/LegalEntityAssociation'
        individual:
          $ref: '#/components/schemas/Individual'
          description: Information about the individual. Required if `type` is **individual**.
        organization:
          $ref: '#/components/schemas/Organization'
          description: Information about the organization. Required if `type` is **organization**.
        reference:
          type: string
          description: Your reference for the legal entity, maximum 150 characters.
          maxLength: 150
        soleProprietorship:
          $ref: '#/components/schemas/SoleProprietorship'
          description: Information about the sole proprietorship. Required if `type`
            is **soleProprietorship**.
          x-addedInVersion: '2'
        trust:
          $ref: '#/components/schemas/Trust'
          description: Information about the trust. Required if `type` is **trust**.
        type:
          type: string
          description: "The type of legal entity.\n\n Possible values: **individual**,\
            \ **organization**, **soleProprietorship**, or **trust**."
          enum:
          - individual
          - organization
          - soleProprietorship
          - trust
          - unincorporatedPartnership
        unincorporatedPartnership:
          $ref: '#/components/schemas/UnincorporatedPartnership'
          description: Information about the unincorporated partnership. Required
            if `type` is **unincorporatedPartnership**.
        verificationPlan:
          type: string
          description: A key-value pair that specifies the verification process for
            a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).
      required:
      - type
    NOLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 11-digit bank account number, without separators or whitespace.
          maxLength: 11
          minLength: 11
        type:
          type: string
          default: noLocal
          description: '**noLocal**'
          enum:
          - noLocal
      required:
      - accountNumber
      - type
    NZLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 15-16 digit bank account number. The first 2 digits are
            the bank number, the next 4 digits are the branch number, the next 7 digits
            are the account number, and the final 2-3 digits are the suffix.
          maxLength: 16
          minLength: 15
        type:
          type: string
          default: nzLocal
          description: '**nzLocal**'
          enum:
          - nzLocal
      required:
      - accountNumber
      - type
    Name:
      type: object
      additionalProperties: false
      properties:
        firstName:
          type: string
          description: The individual's first name. Must not be blank.
        infix:
          type: string
          description: The infix in the individual's name, if any.
        lastName:
          type: string
          description: The individual's last name. Must not be blank.
      required:
      - firstName
      - lastName
    NumberAndBicAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The bank account number, without separators or whitespace.
            The length and format depends on the bank or country.
          maxLength: 34
        additionalBankIdentification:
          $ref: '#/components/schemas/AdditionalBankIdentification'
          description: Additional identification codes of the bank. Some banks may
            require these identifiers for cross-border transfers.
        bic:
          type: string
          description: The bank's 8- or 11-character BIC or SWIFT code.
          maxLength: 11
          minLength: 8
        type:
          type: string
          default: numberAndBic
          description: '**numberAndBic**'
          enum:
          - numberAndBic
      required:
      - accountNumber
      - bic
      - type
    OnboardingLink:
      type: object
      additionalProperties: false
      properties:
        url:
          type: string
          description: "The URL of the hosted onboarding page where you need to redirect\
            \ your user. This URL:\n\n - Expires after 4 minutes.\n\n- Can only be\
            \ used once.\n\n- Can only be clicked once by the user.\n\nIf the link\
            \ expires, you need to create a new link."
    OnboardingLinkInfo:
      type: object
      additionalProperties: false
      properties:
        locale:
          type: string
          description: "The language that will be used for the page, specified by\
            \ a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)\
            \ language and [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\
            \ country codes. See possible valuesfor [marketplaces](https://docs.adyen.com/marketplaces/onboard-users/hosted#supported-languages)\
            \ or [platforms](https://docs.adyen.com/platforms/onboard-users/hosted#supported-languages).\
            \ \n\nIf not specified in the request or if the language is not supported,\
            \ the page uses the browser language. If the browser language is not supported,\
            \ the page uses **en-US** by default."
        redirectUrl:
          type: string
          description: The URL where the user is redirected after they complete hosted
            onboarding.
        settings:
          $ref: '#/components/schemas/OnboardingLinkSettings'
          description: Key-value pairs indicating the settings for the hosted onboarding
            page. The key represents a specific setting.
        themeId:
          type: string
          description: The unique identifier of the hosted onboarding theme.
    OnboardingLinkSettings:
      type: object
      additionalProperties: false
      properties:
        acceptedCountries:
          type: array
          description: 'The list of countries the user can choose from in hosted onboarding
            when `editPrefilledCountry` is allowed.


            The value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code format.


            The array is empty by default, allowing all [countries and regions supported
            by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).'
          items:
            type: string
        allowBankAccountFormatSelection:
          type: boolean
          description: 'Default value: **false**


            Indicates if the user can select the format for their payout account (if
            applicable).'
        allowDebugUi:
          type: boolean
          description: 'Default value: **true**


            Indicates whether the debug user interface (UI) is enabled. The debug
            UI provides information for your support staff to diagnose and resolve
            user issues during onboarding. It can be accessed using a keyboard shortcut.'
        allowIntraRegionCrossBorderPayout:
          type: boolean
          description: 'Default value: **false**


            Indicates if the user can select a payout account in a different EU/EEA
            location (including Switzerland and the UK) than the location of their
            legal entity.'
        changeLegalEntityType:
          type: boolean
          description: 'Default value: **true**


            Indicates if the user can change their legal entity type.'
        editPrefilledCountry:
          type: boolean
          description: 'Default value: **true**


            Indicates if the user can change the country of their legal entity''s
            address, for example the registered address of an organization.'
        enforceLegalAge:
          type: boolean
          description: 'Default value: **false**


            Indicates if only users above the age of 18 can be onboarded.'
        hideOnboardingIntroductionIndividual:
          type: boolean
          description: 'Default value: **true**


            Indicates whether the introduction screen is hidden for the user of the
            individual legal entity type.

            The introduction screen provides brief instructions for the subsequent
            steps in the hosted onboarding process.'
        hideOnboardingIntroductionOrganization:
          type: boolean
          description: 'Default value: **true**


            Indicates whether the introduction screen is hidden for the user of the
            organization legal entity type.

            The introduction screen provides brief instructions for the subsequent
            steps in the hosted onboarding process.'
        hideOnboardingIntroductionSoleProprietor:
          type: boolean
          description: 'Default value: **true**


            Indicates whether the introduction screen is hidden for the user of the
            sole proprietorship legal entity type.

            The introduction screen provides brief instructions for the subsequent
            steps in the hosted onboarding process.'
        hideOnboardingIntroductionTrust:
          type: boolean
          description: 'Default value: **true**


            Indicates whether the introduction screen is hidden for the user of the
            trust legal entity type.

            The introduction screen provides brief instructions for the subsequent
            steps in the hosted onboarding process.'
        instantBankVerification:
          type: boolean
          description: 'Default value: **true**


            Indicates if the user can initiate the verification process through open
            banking providers, like Plaid or Tink.'
        requirePciSignEcomMoto:
          type: boolean
          description: 'Default value: **false**


            Indicates if the user is required to sign a PCI questionnaires for the
            **ecomMoto** sales channel type.'
        requirePciSignEcommerce:
          type: boolean
          description: 'Default value: **false**


            Indicates if the user is required to sign a PCI questionnaires for the
            **eCommerce** sales channel type.'
        requirePciSignPos:
          type: boolean
          description: 'Default value: **false**


            Indicates if the user is required to sign a PCI questionnaires for the
            **pos** sales channel type.'
        requirePciSignPosMoto:
          type: boolean
          description: 'Default value: **false**


            Indicates if the user is required to sign a PCI questionnaires for the
            **posMoto** sales channel type.'
        transferInstrumentLimit:
          type: integer
          format: int32
          description: The maximum number of transfer instruments the user can create.
    OnboardingTheme:
      type: object
      additionalProperties: false
      properties:
        createdAt:
          type: string
          format: date-time
          description: The creation date of the theme.
        description:
          type: string
          description: The description of the theme.
        id:
          type: string
          description: The unique identifier of the theme.
        properties:
          type: object
          additionalProperties:
            type: string
          description: The properties of the theme.
        updatedAt:
          type: string
          format: date-time
          description: The date when the theme was last updated.
      required:
      - createdAt
      - id
      - properties
    OnboardingThemes:
      type: object
      additionalProperties: false
      properties:
        next:
          type: string
          description: The next page. Only present if there is a next page.
        previous:
          type: string
          description: The previous page. Only present if there is a previous page.
        themes:
          type: array
          description: List of onboarding themes.
          items:
            $ref: '#/components/schemas/OnboardingTheme'
      required:
      - themes
    Organization:
      type: object
      additionalProperties: false
      properties:
        countryOfGoverningLaw:
          type: string
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code of the governing country.
          x-addedInVersion: '2'
        dateOfIncorporation:
          type: string
          description: The date when the organization was incorporated in YYYY-MM-DD
            format.
          x-addedInVersion: '2'
        dateOfInitiationOfLegalProceeding:
          type: string
          description: 'Required if the value of `statusOfLegalProceeding` is one
            of the following:


            **underJudicialAdministration**, **bankruptcyInsolvency**, **otherLegalMeasures**


            The date at which a legal proceeding was initiated, in **YYYY-MM-DD**
            format. Example: **2000-02-12**

            '
          x-addedInVersion: '3'
        description:
          type: string
          description: Your description for the organization.
        doingBusinessAs:
          type: string
          description: The organization's trading name, if different from the registered
            legal name.
        economicSector:
          type: string
          description: 'The sector of the economy the legal entity operates within,
            represented by a 2-4 digit code that may include a ".". Example: 45.11


            You can locate economic sector codes for your area by referencing codes
            defined by the NACE (Nomenclature of Economic Activities) used in the
            European Union.

            '
          x-addedInVersion: '3'
        email:
          type: string
          description: The email address of the legal entity.
        financialReports:
          type: array
          description: The financial report information of the organization.
          items:
            $ref: '#/components/schemas/FinancialReport'
          x-addedInVersion: '3'
        globalLegalEntityIdentifier:
          type: string
          description: The global legal entity identifier for the organization.
          x-addedInVersion: '3'
        headOfficeIndicator:
          type: boolean
          description: Indicates that the registered business address is also the
            company's headquarters.
          x-addedInVersion: '3'
        institutionalSector:
          type: string
          description: The institutional sector the organization operates within.
          enum:
          - nonFinancialCorporation
          - centralBank
          - creditInstitutions
          - depositTakingCorporations
          - moneyMarketFunds
          - nonMMFInvestmentFunds
          - financialVehicleCorporation
          - otherFinancialIntermediaries
          - financialAuxiliaries
          - captiveFinancialInstitutionsAndMoneyLenders
          - insuranceCorporations
          - pensionFunds
          - centralGovernment
          - stateGovernment
          - localGovernment
          - socialSecurityFunds
          - nonProfitInstitutionsServingHouseholds
          x-addedInVersion: '3'
        legalForm:
          type: string
          description: 'The type of business entity as defined in the national legal
            system. Use a legal form listed within the accepted legal forms compiled
            by the Central Bank of Europe.

            '
          x-addedInVersion: '3'
        legalName:
          type: string
          description: The organization's legal name.
        phone:
          $ref: '#/components/schemas/PhoneNumber'
          description: The phone number of the legal entity.
        principalPlaceOfBusiness:
          $ref: '#/components/schemas/Address'
          description: The address where the organization operates from. Provide this
            if the principal place of business is different from the `registeredAddress`.
        registeredAddress:
          $ref: '#/components/schemas/Address'
          description: The address of the organization registered at their registrar
            (such as the Chamber of Commerce).
        registrationNumber:
          type: string
          description: The organization's registration number.
        statusOfLegalProceeding:
          type: string
          description: 'The status of any current or past legal action taken against
            the legal entity.


            Possible values: **noLegalActionsTaken**, **underJudicialAdministration**,
            **bankruptcyInsolvency**, **otherLegalMeasures**


            If the value of this field is **noLegalActionsTaken**, then `dateOfInitiationOfLegalProceeding`
            is not required. Otherwise, it is required.

            '
          enum:
          - noLegalActionsTaken
          - underJudicialAdministration
          - bankruptcyInsolvency
          - otherLegalMeasures
          x-addedInVersion: '3'
        stockData:
          $ref: '#/components/schemas/StockData'
          description: Information about the organization's publicly traded stock.
            Provide this object only if `type` is **listedPublicCompany**.
        taxInformation:
          type: array
          description: The tax information of the organization.
          items:
            $ref: '#/components/schemas/TaxInformation'
          x-addedInVersion: '2'
        taxReportingClassification:
          $ref: '#/components/schemas/TaxReportingClassification'
          description: The tax reporting classification (FATCA/CRS self-certification)
            of the organization.
          x-addedInVersion: '2'
        type:
          type: string
          description: 'Type of organization.


            Possible values: **associationIncorporated**, **governmentalOrganization**,
            **listedPublicCompany**, **nonProfit**, **partnershipIncorporated**, **privateCompany**.'
          enum:
          - associationIncorporated
          - governmentalOrganization
          - listedPublicCompany
          - nonProfit
          - partnershipIncorporated
          - privateCompany
        vatAbsenceReason:
          type: string
          description: 'The reason the organization has not provided a VAT number.


            Possible values: **industryExemption**, **belowTaxThreshold**.'
          enum:
          - industryExemption
          - belowTaxThreshold
          x-addedInVersion: '2'
        vatNumber:
          type: string
          description: The organization's VAT number.
          x-addedInVersion: '2'
        webData:
          $ref: '#/components/schemas/WebData'
          deprecated: true
          description: The website and app URL of the legal entity.
          x-deprecatedInVersion: '1'
      required:
      - legalName
      - registeredAddress
    OwnerEntity:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: Unique identifier of the resource that owns the document. For
            `type` **legalEntity**, this value is the unique identifier of the [legal
            entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id).
            For `type` **bankAccount**, this value is the unique identifier of the
            [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id).
        type:
          type: string
          description: 'Type of resource that owns the document.


            Possible values: **legalEntity**, **bankAccount**.'
      required:
      - id
      - type
    PLLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)),
            without separators or whitespace.
          maxLength: 26
          minLength: 26
        type:
          type: string
          default: plLocal
          description: '**plLocal**'
          enum:
          - plLocal
      required:
      - accountNumber
      - type
    PciDocumentInfo:
      type: object
      additionalProperties: false
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date the questionnaire was created, in ISO 8601 extended
            format. For example, 2022-12-18T10:15:30+01:00
        id:
          type: string
          description: The unique identifier of the signed questionnaire.
        validUntil:
          type: string
          format: date-time
          description: The expiration date of the questionnaire, in ISO 8601 extended
            format. For example, 2022-12-18T10:15:30+01:00
    PciSigningRequest:
      type: object
      additionalProperties: false
      properties:
        pciTemplateReferences:
          type: array
          description: The array of Adyen-generated unique identifiers for the questionnaires.
          items:
            type: string
        signedBy:
          type: string
          description: The [legal entity ID](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id)
            of the individual who signs the PCI questionnaire.
      required:
      - pciTemplateReferences
      - signedBy
    PciSigningResponse:
      type: object
      additionalProperties: false
      properties:
        pciQuestionnaireIds:
          type: array
          description: The unique identifiers of the signed PCI documents.
          items:
            type: string
        signedBy:
          type: string
          description: The [legal entity ID](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id)
            of the individual who signed the PCI questionnaire.
    PhoneNumber:
      type: object
      additionalProperties: false
      properties:
        number:
          type: string
          description: The full phone number, including the country code. For example,
            **+3112345678**.
        phoneCountryCode:
          type: string
          description: 'The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code prefix of the phone number. For example, **US** or **NL**.


            The value of the `phoneCountryCode` is determined by the country code
            digit(s) of `phone.number`'
          readOnly: true
          x-addedInVersion: '2'
        type:
          type: string
          description: "The type of phone number.\n Possible values: **mobile**, **landline**,\
            \ **sip**, **fax.** "
      required:
      - number
    RemediatingAction:
      type: object
      additionalProperties: false
      properties:
        code:
          type: string
        message:
          type: string
    SELocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)),
            without the clearing number, separators, or whitespace.
          maxLength: 10
          minLength: 7
        clearingNumber:
          type: string
          description: The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)),
            without separators or whitespace.
          maxLength: 5
          minLength: 4
        type:
          type: string
          default: seLocal
          description: '**seLocal**'
          enum:
          - seLocal
      required:
      - accountNumber
      - clearingNumber
      - type
    SGLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 4- to 19-digit bank account number, without separators
            or whitespace.
          maxLength: 19
          minLength: 4
        bic:
          type: string
          description: The bank's 8- or 11-character BIC or SWIFT code.
          maxLength: 11
          minLength: 8
        type:
          type: string
          default: sgLocal
          description: '**sgLocal**'
          enum:
          - sgLocal
      required:
      - accountNumber
      - bic
    ServiceError:
      type: object
      additionalProperties: false
      properties:
        errorCode:
          type: string
          description: The error code mapped to the error message.
        errorType:
          type: string
          description: The category of the error.
        message:
          type: string
          description: A short explanation of the issue.
        pspReference:
          type: string
          description: The PSP reference of the payment.
        status:
          type: integer
          format: int32
          description: The HTTP response status.
    SetTaxElectronicDeliveryConsentRequest:
      type: object
      additionalProperties: false
      properties:
        US1099k:
          type: boolean
          description: Consent to electronically deliver tax form US1099-K.
    SoleProprietorship:
      type: object
      additionalProperties: false
      properties:
        countryOfGoverningLaw:
          type: string
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code of the governing country.
        dateOfIncorporation:
          type: string
          description: The date when the legal arrangement was incorporated in YYYY-MM-DD
            format.
          x-addedInVersion: '2'
        doingBusinessAs:
          type: string
          description: The registered name, if different from the `name`.
        financialReports:
          type: array
          description: The information from the financial report of the sole proprietorship.
          items:
            $ref: '#/components/schemas/FinancialReport'
          x-addedInVersion: '3'
        name:
          type: string
          description: The legal name.
        principalPlaceOfBusiness:
          $ref: '#/components/schemas/Address'
          description: The business address. Required if the principal place of business
            is different from the `registeredAddress`.
        registeredAddress:
          $ref: '#/components/schemas/Address'
          description: The address registered at the registrar, such as the Chamber
            of Commerce.
        registrationNumber:
          type: string
          description: The registration number.
        taxAbsent:
          type: boolean
          description: The tax information is absent.
          x-addedInVersion: '2'
          nullable: true
        taxInformation:
          type: array
          description: The tax information of the entity.
          items:
            $ref: '#/components/schemas/TaxInformation'
          x-addedInVersion: '2'
        vatAbsenceReason:
          type: string
          description: 'The reason for not providing a VAT number.


            Possible values: **industryExemption**, **belowTaxThreshold**.'
          enum:
          - industryExemption
          - belowTaxThreshold
        vatNumber:
          type: string
          description: The VAT number.
      required:
      - countryOfGoverningLaw
      - name
      - registeredAddress
    SourceOfFunds:
      type: object
      additionalProperties: false
      properties:
        acquiringBusinessLineId:
          type: string
          deprecated: true
          description: The unique identifier of the business line that is the source
            of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments**
            capability.
          x-deprecatedInVersion: '3'
          x-deprecatedMessage: This field will be removed in v4.
        adyenProcessedFunds:
          type: boolean
          description: Indicates whether the funds are coming from transactions processed
            by Adyen. If **false**, a `description` is required.
        description:
          type: string
          description: A description for the source of funds. For example, for `type`
            **business**, provide a description of where the business transactions
            come from, such as payments through bank transfer. Required when `adyenProcessedFunds`
            is **false**.
        type:
          type: string
          description: 'The type of the source of funds. Possible value: **business**.'
          enum:
          - business
    StockData:
      type: object
      additionalProperties: false
      properties:
        marketIdentifier:
          type: string
          description: The four-digit [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code)
            of the stock market where the organization's stocks are traded.
        stockNumber:
          type: string
          description: The 12-digit International Securities Identification Number
            (ISIN) of the company, without dashes (-).
        tickerSymbol:
          type: string
          description: The stock ticker symbol.
    SupportingEntityCapability:
      type: object
      additionalProperties: false
      properties:
        allowed:
          type: boolean
          description: 'Indicates whether the capability is allowed for the supporting
            entity.


            If a capability is allowed for a supporting entity but not for the parent
            legal entity, this means the legal entity has other supporting entities
            that failed verification.


            **You can use the allowed supporting entity** regardless of the verification
            status of other supporting entities.'
          readOnly: true
        id:
          type: string
          description: 'Supporting entity reference '
          readOnly: true
        requested:
          type: boolean
          description: 'Indicates whether the supporting entity capability is requested. '
          readOnly: true
        verificationStatus:
          type: string
          description: 'The status of the verification checks for the capability of
            the supporting entity.


            Possible values:


            * **pending**: Adyen is running the verification.


            * **invalid**: The verification failed. Check if the `errors` array contains
            more information.


            * **valid**: The verification has been successfully completed.


            * **rejected**: Adyen has verified the information, but found reasons
            to not allow the capability.

            '
          readOnly: true
    TaxInformation:
      type: object
      additionalProperties: false
      properties:
        country:
          type: string
          description: The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code.
          maxLength: 2
          minLength: 2
        number:
          type: string
          description: The tax ID number (TIN) of the organization or individual.
        type:
          type: string
          description: 'The TIN type depending on the country where it was issued.
            Only provide if the country has multiple tax IDs: Singapore, Sweden, the
            UK, or the US. For example, provide **SSN**, **EIN**, or **ITIN** for
            the US.'
    TaxReportingClassification:
      type: object
      additionalProperties: false
      properties:
        businessType:
          type: string
          description: 'The organization''s business type.


            Possible values: **other**, **listedPublicCompany**, **subsidiaryOfListedPublicCompany**,
            **governmentalOrganization**, **internationalOrganization**, **financialInstitution**.'
          enum:
          - other
          - listedPublicCompany
          - subsidiaryOfListedPublicCompany
          - governmentalOrganization
          - internationalOrganization
          - financialInstitution
        financialInstitutionNumber:
          type: string
          description: The Global Intermediary Identification Number (GIIN) required
            for FATCA. Only required if the organization is a US financial institution
            and the `businessType` is **financialInstitution**.
        mainSourceOfIncome:
          type: string
          description: 'The organization''s main source of income. Only required if
            `businessType` is **other**.


            Possible values: **businessOperation**, **realEstateSales**, **investmentInterestOrRoyalty**,
            **propertyRental**, **other**.'
          enum:
          - businessOperation
          - realEstateSales
          - investmentInterestOrRoyalty
          - propertyRental
          - other
        type:
          type: string
          description: 'The tax reporting classification type.


            Possible values: **nonFinancialNonReportable**, **financialNonReportable**,
            **nonFinancialActive**, **nonFinancialPassive**.'
          enum:
          - nonFinancialNonReportable
          - financialNonReportable
          - nonFinancialActive
          - nonFinancialPassive
    TermsOfServiceAcceptanceInfo:
      type: object
      additionalProperties: false
      properties:
        acceptedBy:
          type: string
          description: The unique identifier of the user that accepted the Terms of
            Service.
        acceptedFor:
          type: string
          description: The unique identifier of the legal entity for which the Terms
            of Service are accepted.
        createdAt:
          type: string
          format: date-time
          description: The date when the Terms of Service were accepted, in ISO 8601
            extended format. For example, 2022-12-18T10:15:30+01:00.
        id:
          type: string
          description: An Adyen-generated reference for the accepted Terms of Service.
        type:
          type: string
          description: 'The type of Terms of Service.


            Possible values:

            *  **adyenForPlatformsManage**

            *  **adyenIssuing**

            *  **adyenForPlatformsAdvanced**

            *  **adyenCapital**

            *  **adyenAccount**

            *  **adyenCard**

            *  **adyenFranchisee**

            *  **adyenPccr**

            *  **adyenChargeCard**

            *  **kycOnInvite**


            '
          enum:
          - adyenAccount
          - adyenCapital
          - adyenCard
          - adyenChargeCard
          - adyenForPlatformsAdvanced
          - adyenForPlatformsManage
          - adyenFranchisee
          - adyenIssuing
          - adyenPccr
          - kycOnInvite
        validTo:
          type: string
          format: date-time
          description: The expiration date for the Terms of Service acceptance, in
            ISO 8601 extended format. For example, 2022-12-18T00:00:00+01:00.
    TransferInstrument:
      type: object
      additionalProperties: false
      properties:
        bankAccount:
          $ref: '#/components/schemas/BankAccountInfo'
          description: Contains information about the legal entity's bank account.
        capabilities:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SupportingEntityCapability'
          description: List of capabilities for this transfer instrument.
          x-addedInVersion: '3'
        documentDetails:
          type: array
          description: List of documents uploaded for the transfer instrument.
          items:
            $ref: '#/components/schemas/DocumentReference'
          x-addedInVersion: '2'
        id:
          type: string
          description: The unique identifier of the transfer instrument.
          readOnly: true
        legalEntityId:
          type: string
          description: The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id)
            that owns the transfer instrument.
        problems:
          type: array
          description: The verification errors related to capabilities for this transfer
            instrument.
          items:
            $ref: '#/components/schemas/CapabilityProblem'
          x-addedInVersion: '3'
        type:
          type: string
          description: 'The type of transfer instrument.


            Possible value: **bankAccount**.'
          enum:
          - bankAccount
          - recurringDetail
      required:
      - bankAccount
      - id
      - legalEntityId
      - type
    TransferInstrumentInfo:
      type: object
      additionalProperties: false
      properties:
        bankAccount:
          $ref: '#/components/schemas/BankAccountInfo'
          description: Contains information about the legal entity's bank account.
        legalEntityId:
          type: string
          description: The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id)
            that owns the transfer instrument.
        type:
          type: string
          description: 'The type of transfer instrument.


            Possible value: **bankAccount**.'
          enum:
          - bankAccount
          - recurringDetail
      required:
      - bankAccount
      - legalEntityId
      - type
    TransferInstrumentReference:
      type: object
      additionalProperties: false
      properties:
        accountIdentifier:
          type: string
          description: The masked IBAN or bank account number.
        id:
          type: string
          description: The unique identifier of the resource.
        realLastFour:
          type: string
          description: Four last digits of the bank account number. If the transfer
            instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding),
            and it is a virtual bank account, these digits may be different from the
            last four digits of the masked account number.
        trustedSource:
          type: boolean
          description: Identifies if the bank account was created through [instant
            bank verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding).
          readOnly: true
      required:
      - accountIdentifier
      - id
    Trust:
      type: object
      additionalProperties: false
      properties:
        countryOfGoverningLaw:
          type: string
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code of the governing country.
        dateOfIncorporation:
          type: string
          description: The date when the legal arrangement was incorporated in YYYY-MM-DD
            format.
          x-addedInVersion: '2'
        description:
          type: string
          description: A short description about the trust. Only applicable for charitable
            trusts in New Zealand.
          x-addedInVersion: '3'
        doingBusinessAs:
          type: string
          description: The registered name, if different from the `name`.
        name:
          type: string
          description: The legal name.
        principalPlaceOfBusiness:
          $ref: '#/components/schemas/Address'
          description: The business address. Required if the principal place of business
            is different from the `registeredAddress`.
        registeredAddress:
          $ref: '#/components/schemas/Address'
          description: The address registered at the registrar, such as the Chamber
            of Commerce.
        registrationNumber:
          type: string
          description: The registration number.
        taxInformation:
          type: array
          description: The tax information of the entity.
          items:
            $ref: '#/components/schemas/TaxInformation'
          x-addedInVersion: '2'
        type:
          type: string
          description: 'Type of trust.


            See possible values for trusts in [Australia](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-australia)
            and [New Zealand](https://docs.adyen.com/platforms/verification-requirements/?tab=trust_3_4#trust-types-in-new-zealand).'
          enum:
          - businessTrust
          - cashManagementTrust
          - charitableTrust
          - corporateUnitTrust
          - deceasedEstate
          - discretionaryTrust
          - discretionaryInvestmentTrust
          - discretionaryServicesManagementTrust
          - discretionaryTradingTrust
          - familyTrust
          - firstHomeSaverAccountsTrust
          - fixedTrust
          - fixedUnitTrust
          - hybridTrust
          - listedPublicUnitTrust
          - otherTrust
          - pooledSuperannuationTrust
          - publicTradingTrust
          - unlistedPublicUnitTrust
        undefinedBeneficiaryInfo:
          type: array
          description: The undefined beneficiary information of the entity.
          items:
            $ref: '#/components/schemas/UndefinedBeneficiary'
          x-addedInVersion: '2'
        vatAbsenceReason:
          type: string
          description: 'The reason for not providing a VAT number.


            Possible values: **industryExemption**, **belowTaxThreshold**.'
          enum:
          - industryExemption
          - belowTaxThreshold
        vatNumber:
          type: string
          description: The VAT number.
      required:
      - countryOfGoverningLaw
      - name
      - registeredAddress
      - type
    UKLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The 8-digit bank account number, without separators or whitespace.
          maxLength: 8
          minLength: 8
        sortCode:
          type: string
          description: The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code),
            without separators or whitespace.
          maxLength: 6
          minLength: 6
        type:
          type: string
          default: ukLocal
          description: '**ukLocal**'
          enum:
          - ukLocal
      required:
      - accountNumber
      - sortCode
      - type
    USLocalAccountIdentification:
      type: object
      additionalProperties: false
      properties:
        accountNumber:
          type: string
          description: The bank account number, without separators or whitespace.
          maxLength: 18
          minLength: 2
        accountType:
          type: string
          default: checking
          description: 'The bank account type.


            Possible values: **checking** or **savings**. Defaults to **checking**.'
          enum:
          - checking
          - savings
        routingNumber:
          type: string
          description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number),
            without separators or whitespace.
          maxLength: 9
          minLength: 9
        type:
          type: string
          default: usLocal
          description: '**usLocal**'
          enum:
          - usLocal
      required:
      - accountNumber
      - routingNumber
      - type
    UndefinedBeneficiary:
      type: object
      additionalProperties: false
      properties:
        description:
          type: string
          description: The details of the undefined beneficiary.
        reference:
          type: string
          description: The reference of the undefined beneficiary.
          readOnly: true
    UnincorporatedPartnership:
      type: object
      additionalProperties: false
      properties:
        countryOfGoverningLaw:
          type: string
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
            country code of the governing country.
        dateOfIncorporation:
          type: string
          description: The date when the legal arrangement was incorporated in YYYY-MM-DD
            format.
          x-addedInVersion: '2'
        description:
          type: string
          description: Short description about the Legal Arrangement.
          x-addedInVersion: '3'
        doingBusinessAs:
          type: string
          description: The registered name, if different from the `name`.
        name:
          type: string
          description: The legal name.
        principalPlaceOfBusiness:
          $ref: '#/components/schemas/Address'
          description: The business address. Required if the principal place of business
            is different from the `registeredAddress`.
        registeredAddress:
          $ref: '#/components/schemas/Address'
          description: The address registered at the registrar, such as the Chamber
            of Commerce.
        registrationNumber:
          type: string
          description: The registration number.
        taxInformation:
          type: array
          description: The tax information of the entity.
          items:
            $ref: '#/components/schemas/TaxInformation'
          x-addedInVersion: '2'
        type:
          type: string
          description: 'Type of Partnership.


            Possible values:

            *  **limitedPartnership**

            *  **generalPartnership**

            *  **familyPartnership**

            *  **commercialPartnership**

            *  **publicPartnership**

            *  **otherPartnership**

            *  **gbr**

            *  **gmbh**

            *  **kgaa**

            *  **cv**

            *  **vof**

            *  **maatschap**

            *  **privateFundLimitedPartnership**

            *  **businessTrustEntity**

            *  **businessPartnership**

            *  **limitedLiabilityPartnership**

            *  **eg**

            *  **cooperative**

            *  **vos**

            *  **comunidadDeBienes**

            *  **herenciaYacente**

            *  **comunidadDePropietarios**

            *  **sep**

            *  **sca**

            *  **bt**

            *  **kkt**

            *  **scs**

            *  **snc**


            '
          enum:
          - limitedPartnership
          - generalPartnership
          - familyPartnership
          - commercialPartnership
          - publicPartnership
          - otherPartnership
          - gbr
          - gmbh
          - kgaa
          - cv
          - vof
          - maatschap
          - privateFundLimitedPartnership
          - businessTrustEntity
          - businessPartnership
          - limitedLiabilityPartnership
          - eg
          - cooperative
          - vos
          - comunidadDeBienes
          - herenciaYacente
          - comunidadDePropietarios
          - sep
          - sca
          - bt
          - kkt
          - scs
          - snc
          readOnly: true
        vatAbsenceReason:
          type: string
          description: 'The reason for not providing a VAT number.


            Possible values: **industryExemption**, **belowTaxThreshold**.'
          enum:
          - industryExemption
          - belowTaxThreshold
        vatNumber:
          type: string
          description: The VAT number.
      required:
      - countryOfGoverningLaw
      - name
      - registeredAddress
    VerificationDeadline:
      type: object
      additionalProperties: false
      properties:
        capabilities:
          type: array
          description: The list of capabilities that will be disallowed if information
            is not reviewed by the time of the deadline
          items:
            type: string
            enum:
            - acceptExternalFunding
            - acceptPspFunding
            - acceptTransactionInRestrictedCountries
            - acceptTransactionInRestrictedCountriesCommercial
            - acceptTransactionInRestrictedCountriesConsumer
            - acceptTransactionInRestrictedIndustries
            - acceptTransactionInRestrictedIndustriesCommercial
            - acceptTransactionInRestrictedIndustriesConsumer
            - acquiring
            - atmWithdrawal
            - atmWithdrawalCommercial
            - atmWithdrawalConsumer
            - atmWithdrawalInRestrictedCountries
            - atmWithdrawalInRestrictedCountriesCommercial
            - atmWithdrawalInRestrictedCountriesConsumer
            - authorisedPaymentInstrumentUser
            - getGrantOffers
            - issueBankAccount
            - issueCard
            - issueCardCommercial
            - issueCardConsumer
            - issueChargeCard
            - issueChargeCardCommercial
            - issueCreditLimit
            - localAcceptance
            - payout
            - payoutToTransferInstrument
            - processing
            - receiveFromBalanceAccount
            - receiveFromPlatformPayments
            - receiveFromThirdParty
            - receiveFromTransferInstrument
            - receiveGrants
            - receivePayments
            - sendToBalanceAccount
            - sendToThirdParty
            - sendToTransferInstrument
            - thirdPartyFunding
            - useCard
            - useCardCommercial
            - useCardConsumer
            - useCardInRestrictedCountries
            - useCardInRestrictedCountriesCommercial
            - useCardInRestrictedCountriesConsumer
            - useCardInRestrictedIndustries
            - useCardInRestrictedIndustriesCommercial
            - useCardInRestrictedIndustriesConsumer
            - useChargeCard
            - useChargeCardCommercial
            - withdrawFromAtm
            - withdrawFromAtmCommercial
            - withdrawFromAtmConsumer
            - withdrawFromAtmInRestrictedCountries
            - withdrawFromAtmInRestrictedCountriesCommercial
            - withdrawFromAtmInRestrictedCountriesConsumer
          readOnly: true
        entityIds:
          type: array
          description: The unique identifiers of the legal entity or supporting entities
            that the deadline applies to
          items:
            type: string
          readOnly: true
        expiresAt:
          type: string
          format: date-time
          description: The date that verification is due by before capabilities are
            disallowed.
          readOnly: true
      required:
      - capabilities
      - expiresAt
    VerificationError:
      type: object
      additionalProperties: false
      properties:
        capabilities:
          type: array
          description: Contains key-value pairs that specify the actions that the
            legal entity can do in your platform. The key is a capability required
            for your integration. For example, **issueCard** for Issuing.The value
            is an object containing the settings for the capability.
          items:
            type: string
            enum:
            - acceptExternalFunding
            - acceptPspFunding
            - acceptTransactionInRestrictedCountries
            - acceptTransactionInRestrictedCountriesCommercial
            - acceptTransactionInRestrictedCountriesConsumer
            - acceptTransactionInRestrictedIndustries
            - acceptTransactionInRestrictedIndustriesCommercial
            - acceptTransactionInRestrictedIndustriesConsumer
            - acquiring
            - atmWithdrawal
            - atmWithdrawalCommercial
            - atmWithdrawalConsumer
            - atmWithdrawalInRestrictedCountries
            - atmWithdrawalInRestrictedCountriesCommercial
            - atmWithdrawalInRestrictedCountriesConsumer
            - authorisedPaymentInstrumentUser
            - getGrantOffers
            - issueBankAccount
            - issueCard
            - issueCardCommercial
            - issueCardConsumer
            - issueChargeCard
            - issueChargeCardCommercial
            - issueCreditLimit
            - localAcceptance
            - payout
            - payoutToTransferInstrument
            - processing
            - receiveFromBalanceAccount
            - receiveFromPlatformPayments
            - receiveFromThirdParty
            - receiveFromTransferInstrument
            - receiveGrants
            - receivePayments
            - sendToBalanceAccount
            - sendToThirdParty
            - sendToTransferInstrument
            - thirdPartyFunding
            - useCard
            - useCardCommercial
            - useCardConsumer
            - useCardInRestrictedCountries
            - useCardInRestrictedCountriesCommercial
            - useCardInRestrictedCountriesConsumer
            - useCardInRestrictedIndustries
            - useCardInRestrictedIndustriesCommercial
            - useCardInRestrictedIndustriesConsumer
            - useChargeCard
            - useChargeCardCommercial
            - withdrawFromAtm
            - withdrawFromAtmCommercial
            - withdrawFromAtmConsumer
            - withdrawFromAtmInRestrictedCountries
            - withdrawFromAtmInRestrictedCountriesCommercial
            - withdrawFromAtmInRestrictedCountriesConsumer
        code:
          type: string
          description: The general error code.
        message:
          type: string
          description: The general error message.
        remediatingActions:
          type: array
          description: An object containing possible solutions to fix a verification
            error.
          items:
            $ref: '#/components/schemas/RemediatingAction'
        subErrors:
          type: array
          description: An array containing more granular information about the cause
            of the verification error.
          items:
            $ref: '#/components/schemas/VerificationError-recursive'
        type:
          type: string
          description: 'The type of error.


            Possible values:

            *  **invalidInput**

            *  **dataMissing**

            *  **pendingStatus**

            *  **rejected**

            *  **dataReview**


            '
          enum:
          - dataMissing
          - dataReview
          - invalidInput
          - pendingStatus
          - rejected
    VerificationError-recursive:
      type: object
      additionalProperties: false
      properties:
        capabilities:
          type: array
          description: Contains key-value pairs that specify the actions that the
            legal entity can do in your platform. The key is a capability required
            for your integration. For example, **issueCard** for Issuing.The value
            is an object containing the settings for the capability.
          items:
            type: string
            enum:
            - acceptExternalFunding
            - acceptPspFunding
            - acceptTransactionInRestrictedCountries
            - acceptTransactionInRestrictedCountriesCommercial
            - acceptTransactionInRestrictedCountriesConsumer
            - acceptTransactionInRestrictedIndustries
            - acceptTransactionInRestrictedIndustriesCommercial
            - acceptTransactionInRestrictedIndustriesConsumer
            - acquiring
            - atmWithdrawal
            - atmWithdrawalCommercial
            - atmWithdrawalConsumer
            - atmWithdrawalInRestrictedCountries
            - atmWithdrawalInRestrictedCountriesCommercial
            - atmWithdrawalInRestrictedCountriesConsumer
            - authorisedPaymentInstrumentUser
            - getGrantOffers
            - issueBankAccount
            - issueCard
            - issueCardCommercial
            - issueCardConsumer
            - issueChargeCard
            - issueChargeCardCommercial
            - issueCreditLimit
            - localAcceptance
            - payout
            - payoutToTransferInstrument
            - processing
            - receiveFromBalanceAccount
            - receiveFromPlatformPayments
            - receiveFromThirdParty
            - receiveFromTransferInstrument
            - receiveGrants
            - receivePayments
            - sendToBalanceAccount
            - sendToThirdParty
            - sendToTransferInstrument
            - thirdPartyFunding
            - useCard
            - useCardCommercial
            - useCardConsumer
            - useCardInRestrictedCountries
            - useCardInRestrictedCountriesCommercial
            - useCardInRestrictedCountriesConsumer
            - useCardInRestrictedIndustries
            - useCardInRestrictedIndustriesCommercial
            - useCardInRestrictedIndustriesConsumer
            - useChargeCard
            - useChargeCardCommercial
            - withdrawFromAtm
            - withdrawFromAtmCommercial
            - withdrawFromAtmConsumer
            - withdrawFromAtmInRestrictedCountries
            - withdrawFromAtmInRestrictedCountriesCommercial
            - withdrawFromAtmInRestrictedCountriesConsumer
        code:
          type: string
          description: The general error code.
        message:
          type: string
          description: The general error message.
        type:
          type: string
          description: 'The type of error.


            Possible values:

            *  **invalidInput**

            *  **dataMissing**

            *  **pendingStatus**

            *  **rejected**

            *  **dataReview**


            '
          enum:
          - dataMissing
          - dataReview
          - invalidInput
          - pendingStatus
          - rejected
        remediatingActions:
          type: array
          description: An object containing possible solutions to fix a verification
            error.
          items:
            $ref: '#/components/schemas/RemediatingAction'
    VerificationErrors:
      type: object
      additionalProperties: false
      properties:
        problems:
          type: array
          description: List of the verification errors.
          items:
            $ref: '#/components/schemas/CapabilityProblem'
          x-addedInVersion: '2'
    WebData:
      type: object
      additionalProperties: false
      properties:
        webAddress:
          type: string
          description: The URL of the website or the app store URL.
        webAddressId:
          type: string
          description: The unique identifier of the web address.
          readOnly: true
    WebDataExemption:
      type: object
      additionalProperties: false
      properties:
        reason:
          type: string
          description: 'The reason why the web data was not provided. Possible value:
            **noOnlinePresence**.'
          enum:
          - noOnlinePresence
          - notCollectedDuringOnboarding
  examples:
    get-businessLines-id-success-200:
      summary: Details of a business line
      description: Example response when getting the details of a business line
      value:
        service: banking
        industryCode: '4531'
        legalEntityId: LE00000000000000000000001
        sourceOfFunds:
          adyenProcessedFunds: false
          description: Funds from my flower shop business
          type: business
        webData:
        - webAddress: https://www.adyen.com
          webAddressId: SE322JV223222J5H8V87B3DHN
        id: SE322KH223222F5GV2SQ924F6
    get-documents-id-success-200:
      summary: Details of a document
      description: Example response when getting document details
      value:
        type: registrationDocument
        attachments:
        - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Registration doc for Example Company
        fileName: Registration doc for Example Company
        owner:
          id: LE00000000000000000000001
          type: legalEntity
        id: SE322JV223222F5GV2N9L8GDK
    get-legalEntities-id-businessLines-success-200:
      summary: List of business lines for a legal entity
      description: Example response when getting the list of business lines for a
        legal entity
      value:
        businessLines:
        - service: banking
          industryCode: '55'
          legalEntityId: LE00000000000000000000001
          sourceOfFunds:
            adyenProcessedFunds: false
            description: Funds from my flower shop business
            type: business
          webData:
          - webAddress: https://www.adyen.com
            webAddressId: SE577HA334222K5H8V87B3BPU
          id: SE322JV223222F5GVGMLNB83F
        - service: paymentProcessing
          industryCode: 339E
          legalEntityId: LE00000000000000000000001
          salesChannels:
          - eCommerce
          - ecomMoto
          webData:
          - webAddress: https://yoururl.com
            webAddressId: SE908HJ723222F5GVGPNR55YH
          id: SE322JV223222F5GVGPNRB9GJ
    get-legalEntities-id-pciQuestionnaires-pciid-success-200:
      summary: Details of a PCI questionnaire
      description: Example response when getting the details of a PCI questionnaire
      value:
        content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        createdAt: '2023-03-02T17:54:19.538365Z'
        id: PCID422GZ22322565HHMH48CW63CPH
        validUntil: '2024-03-01T17:54:19.538365Z'
    get-legalEntities-id-pciQuestionnaires-success-200:
      summary: Details of PCI questionnaires signed by a user
      description: Example response when getting the list of PCI questionnaires
      value:
        data:
        - createdAt: '2023-03-02T17:54:19.538365Z'
          id: PCID422GZ22322565HHMH48CW63CPH
          validUntil: '2024-03-01T17:54:19.538365Z'
        - createdAt: '2023-03-02T17:54:19.538365Z'
          id: PCID422GZ22322565HHMH49CW75Z9H
          validUntil: '2024-03-01T17:54:19.538365Z'
    get-legalEntities-id-success-200:
      summary: Details of a legal entity
      description: Example response when getting the details of a legal entity
      value:
        capabilities:
          sendToTransferInstrument:
            allowed: false
            requested: true
            transferInstruments:
            - allowed: false
              id: SE322KH223222F5GXZFNM3BGP
              requested: true
              verificationStatus: pending
            verificationStatus: pending
          receivePayments:
            allowed: false
            requested: true
            verificationStatus: pending
          sendToBalanceAccount:
            allowed: false
            requested: true
            verificationStatus: pending
          receiveFromPlatformPayments:
            allowed: false
            requested: true
            verificationStatus: pending
          receiveFromBalanceAccount:
            allowed: false
            requested: true
            verificationStatus: pending
        individual:
          email: s.hopper@example.com
          birthData:
            dateOfBirth: '1990-06-21'
          name:
            firstName: Simone
            lastName: Hopper
          phone:
            number: '+31858888138'
            phoneCountryCode: NL
            type: mobile
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
            street2: '274'
        type: individual
        id: YOUR_LEGAL_ENTITY
        transferInstruments:
        - id: SE322KH223222F5GXZFNM3BGP
          accountIdentifier: NL**ABNA******0123
          trustedSource: false
    get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200:
      summary: Terms of Service information for a legal entity
      description: Example response when getting Terms of Service information for
        a legal entity
      value:
        data:
        - acceptedBy: LE00000000000000000000002
          acceptedFor: LE00000000000000000000001
          createdAt: '2022-12-05T13:36:58.212253Z'
          id: TOSA000AB00000000B2AAAB2BA0AA0
          type: adyenIssuing
    get-legalEntities-id-termsOfServiceStatus-success-200:
      summary: Terms of Service status for a legal entity
      description: Example response when getting the type of Terms of Service
      value:
        termsOfServiceTypes:
        - adyenIssuing
    get-themes-id-success-200:
      summary: Details of a page theme
      description: Example response when getting the details of a page theme
      value:
        description: Light colors theme
        properties:
          privacyStatementPage: https://www.adyen.com/legal/terms-and-conditions
          supportPage: https://www.adyen.com/contact
          logo: ONBA422JV223222D5FWC4TK25S3DQW
          pageTitle: Example onboarding light colors
          backgroundColor: '#FFFFFF'
          faqPage: https://docs.adyen.com/hosted-onboarding-faqs
          backgroundImage: ONBA422JV223222D5G82M96F6P2VTV
          pageLayout: withBackground
        createdAt: '2022-06-22T00:00:00+02:00'
        id: ONBT422KH223222D5G82M968PB46HR
        updatedAt: '2022-08-25T00:00:00+02:00'
    get-themes-success-200:
      summary: List of hosted onboarding themes for your balance platform
      description: Example response when getting the list of hosted onboarding themes
      value:
        themes:
        - description: Dark colors theme
          properties:
            supportPage: https://www.adyen.com/contact
            logo: ONBA422JV223222D5G8VG2T8JV39GV
            pageTitle: Example onboarding dark colors
            backgroundColor: '#000000'
            faqPage: https://docs.adyen.com/hosted-onboarding-faqs
            backgroundImage: ONBA422KH223222D5G8VG2TG9S5ZBH
            pageLayout: withBackground
          createdAt: '2022-01-20T00:00:00+01:00'
          id: ONBT422JV223222D5FGJ77B9C52WNN
          updatedAt: '2022-08-25T00:00:00+02:00'
        - description: Light colors theme
          properties:
            privacyStatementPage: https://www.adyen.com/legal/terms-and-conditions
            supportPage: https://www.adyen.com/contact
            logo: ONBA422JV223222D5FWC4TK25S3DQW
            pageTitle: Example onboarding light colors
            backgroundColor: '#FFFFFF'
            faqPage: https://docs.adyen.com/hosted-onboarding-faqs
            backgroundImage: ONBA422JV223222D5G82M96F6P2VTV
            pageLayout: withBackground
          createdAt: '2022-06-22T00:00:00+02:00'
          id: ONBT422KH223222D5G82M968PB46HR
          updatedAt: '2022-08-25T00:00:00+02:00'
    get-transferInstruments-id-success-200:
      summary: Details of a transfer instrument
      description: Example response when getting the details of a new transfer instrument
      value:
        bankAccount:
          accountIdentification:
            type: iban
            iban: NL62ABNA0000000123
          countryCode: NL
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        id: SE322KH223222F5GXZFNM3BGP
    patch-businessLines-id-updateBusinessLine:
      summary: Update a business line
      description: Example request for updating the industry code of a business line
      value:
        industryCode: '55'
        webData:
        - webAddress: https://www.example.com
    patch-businessLines-id-updateBusinessLine-200:
      summary: Business line updated
      description: Example response for updating the industry code of a business line
      value:
        service: banking
        industryCode: '55'
        legalEntityId: LE00000000000000000000001
        sourceOfFunds:
          adyenProcessedFunds: false
          description: Funds from my flower shop business
          type: business
        webData:
        - webAddress: https://www.example.com
          webAddressId: SE966LI345672J5H8V87B3FGH
        id: SE322JV223222F5GVGMLNB83F
    patch-documents-id-updateDocument:
      summary: Update a document
      description: Example request for updating a document
      value:
        type: proofOfIndustry
        description: Proof of industry doc for Example Company
    patch-documents-id-updateDocument-200:
      summary: Document updated
      description: Example response when a document is updated
      value:
        type: proofOfIndustry
        attachments:
        - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Proof of industry for Example Company
        fileName: Proof of industry for Example Company
        owner:
          id: LE00000000000000000000001
          type: legalEntity
        id: SE322JV223222F5GV2N9L8GDK
    patch-legalEntities-id-changeLegalEntityType:
      summary: Change a legal entity from an organization to an individual
      description: Example request when changing the legal entity type
      value:
        type: individual
    patch-legalEntities-id-changeLegalEntityType-200:
      summary: Legal entity type changed
      description: Example response when changing the legal entity type
      value:
        individual:
          name:
            firstName: Explorer
            lastName: Company based in US
          residentialAddress:
            country: US
        type: individual
        id: LE00000000000000000000001
    patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService:
      summary: Accept the Terms of Service document
      description: Example request for accepting the Terms of Service document
      value:
        acceptedBy: LE00000000000000000000002
    patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200:
      summary: Terms of Service document accepted
      description: Example response when accepting a Terms of Service document
      value:
        acceptedBy: LE00000000000000000000002
        id: TOSA000AB00000000B2AAAB2BA0AA0
        language: en
        termsOfServiceDocumentId: abc123
        type: adyenIssuing
    patch-legalEntities-id-updateLegalEntityOrganization:
      summary: Add entity associations to an organization
      description: Example request adding entity associations to a legal entity
      value:
        entityAssociations:
        - jobTitle: CEO
          legalEntityId: LE00000000000000000000002
          type: uboThroughControl
    patch-legalEntities-id-updateLegalEntityOrganization-200:
      summary: Entity associations added
      description: Example response for adding an entity association to an organization
      value:
        entityAssociations:
        - associatorId: LE00000000000000000000001
          entityType: individual
          jobTitle: CEO
          legalEntityId: LE00000000000000000000002
          name: Simone Hopper
          type: uboThroughControl
        organization:
          email: john.doe@adyen.com
          phone:
            number: '646467363'
            type: mobile
          description: FinTech
          doingBusinessAs: Adyen BV
          legalName: Adyen BV
          registeredAddress:
            city: AMS
            country: NL
            postalCode: 1234EE
            stateOrProvince: NH
            street: Simon Carmiggeltstraat 6 - 50
          registrationNumber: ''
          stockData:
            marketIdentifier: ADYN
            stockNumber: NL012345ABC4
            tickerSymbol: ADYN.M
          type: listedPublicCompany
        type: organization
        id: LE00000000000000000000001
    patch-legalEntities-id-updateLegalEntitySoleProp:
      summary: Add entity associations to a sole proprietorship
      description: Example request adding an entity association to a sole proprietorship
      value:
        entityAssociations:
        - legalEntityId: LE00000000000000000000002
          type: soleProprietorship
    patch-legalEntities-id-updateLegalEntitySoleProp-200:
      summary: Entity association added to a sole proprietorship
      description: Example response for adding an entity association to a sole proprietorship
      value:
        entityAssociations:
        - associatorId: LE00000000000000000000001
          entityType: soleProprietorship
          legalEntityId: LE00000000000000000000002
          type: soleProprietorship
        individual:
          email: s.eller@example.com
          birthData:
            dateOfBirth: '1990-06-21'
          name:
            firstName: Shelly
            lastName: Eller
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
        type: individual
        id: LE00000000000000000000001
    patch-legalEntities-id-updateLegalRepresentative:
      summary: Associate a legal representative with a minor user
      description: Example request associating a legal representative with a minor
        user
      value:
        entityAssociations:
        - legalEntityId: LE00000000000000000000002
          relationship: parent
          type: legalRepresentative
    patch-legalEntities-id-updateLegalRepresentative-200:
      summary: Legal representative associated
      description: Example response for associating a legal representative with a
        minor user
      value:
        entityAssociations:
        - associatorId: LE00000000000000000000001
          legalEntityId: LE00000000000000000000002
          name: Simone Hopper
          type: legalRepresentative
        individual:
          email: s.eller@example.com
          birthData:
            dateOfBirth: '1990-06-21'
          name:
            firstName: Shelly
            lastName: Eller
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
        type: individual
        id: LE00000000000000000000001
    patch-legalEntities-id-updateTrustMember:
      summary: Associate a trust member with a trust
      description: Example request associating a trust member with a trust
      value:
        entityAssociations:
        - legalEntityId: LE00000000000000000000002
          type: protector
    patch-legalEntities-id-updateTrustMember-200:
      summary: Trust member associated
      description: Example response for associating a trust member with a trust
      value:
        entityAssociations:
        - associatorId: LE00000000000000000000001
          legalEntityId: LE00000000000000000000002
          name: Simone Hopper
          type: protector
        trust:
          name: Example Trust
          type: fixedUnitTrust
          doingBusinessAs: West's Store
          countryOfGoverningLaw: AU
          taxInformation:
          - country: AU
            type: ABN
            number: '12345678901'
          registeredAddress:
            street: Winfield Avenue
            city: Sydney
            postalCode: '1197'
            stateOrProvince: NSW
            country: AU
          undefinedBeneficiaryInfo:
          - description: My future children
        type: trust
        id: LE00000000000000000000001
    patch-legalEntities-id-updateTrustMemberExempt:
      summary: Associate an exempt settlor with a trust
      description: Example request associating an exempt settlor with a trust
      value:
        entityAssociations:
        - legalEntityId: LE00000000000000000000002
          type: settlor
          entityType: individual
          settlorExemptionReason:
          - deceased
          - professionalServiceProvider
    patch-legalEntities-id-updateTrustMemberExempt-200:
      summary: Exempt settlor associated
      description: Example response for associating an exempt settlor with a trust
      value:
        entityAssociations:
        - associatorId: LE00000000000000000000001
          legalEntityId: LE00000000000000000000002
          type: settlor
          entityType: individual
          settlorExemptionReason:
          - deceased
          - professionalServiceProvider
        trust:
          name: Example Trust
          type: fixedUnitTrust
          doingBusinessAs: West's Store
          countryOfGoverningLaw: AU
          taxInformation:
          - country: AU
            type: ABN
            number: '12345678901'
          registeredAddress:
            street: Winfield Avenue
            city: Sydney
            postalCode: '1197'
            stateOrProvince: NSW
            country: AU
          undefinedBeneficiaryInfo:
          - description: My future children
        type: trust
        id: LE00000000000000000000001
    patch-transferInstruments-id-updateTransferInstrument:
      summary: Update a transfer instrument
      description: Example request for updating a transfer instrument
      value:
        bankAccount:
          accountIdentification:
            type: iban
            iban: NL02ABNA0123456789
        legalEntityId: LE00000000000000000000001
        type: bankAccount
    patch-transferInstruments-id-updateTransferInstrument-200:
      summary: Transfer instrument updated
      description: Example response for updating a transfer instrument
      value:
        bankAccount:
          accountIdentification:
            type: iban
            iban: NL02ABNA0123456789
          countryCode: NL
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        id: SE322KH223222F5GXZFNM3BGP
    post-businessLines-createBusinessLines-businessAccounts:
      summary: Create a business line for a business account
      description: Example request for creating a business line for a business account
      value:
        service: banking
        industryCode: '4531'
        webData:
        - webAddress: https://www.adyen.com
        legalEntityId: LE00000000000000000000001
        sourceOfFunds:
          type: business
          adyenProcessedFunds: false
          description: Funds from my flower shop business
    post-businessLines-createBusinessLines-businessAccounts-200:
      summary: Business line created
      description: Example response for creating a business line for a business account
      value:
        industryCode: '4531'
        legalEntityId: LE00000000000000000000001
        service: banking
        sourceOfFunds:
          adyenProcessedFunds: false
          description: Funds from my flower shop business
          type: business
        webData:
        - webAddress: https://www.adyen.com
          webAddressId: SE322JV223222F5H4CQGS77V4
        id: SE322KT223222D5FJ7TJN2986
    post-businessLines-createBusinessLines-receive:
      summary: Create a business line for receiving payments
      description: Example request for receiving payments
      value:
        service: paymentProcessing
        industryCode: 339E
        salesChannels:
        - eCommerce
        - ecomMoto
        legalEntityId: LE00000000000000000000001
        webData:
        - webAddress: https://yoururl.com
    post-businessLines-createBusinessLines-receive-200:
      summary: Business line created
      description: Example response for creating a business line for receiving payments
      value:
        service: paymentProcessing
        industryCode: 339E
        legalEntityId: LE00000000000000000000001
        salesChannels:
        - eCommerce
        - ecomMoto
        webData:
        - webAddress: https://yoururl.com
          webAddressId: SE654AC923222F5H4CQGS77V4
        id: SE322KT223222D5FJ7TJN2986
    post-documents-uploadDocument:
      summary: Upload a document
      description: Example request for uploading a document
      value:
        type: registrationDocument
        attachments:
        - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Registration doc for Example Company
        owner:
          id: LE00000000000000000000001
          type: legalEntity
    post-documents-uploadDocument-200:
      summary: Document uploaded
      description: Example response when a document is uploaded
      value:
        type: registrationDocument
        attachments:
        - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Registration doc for Example Company
        fileName: Registration doc for Example Company
        owner:
          id: LE00000000000000000000001
          type: legalEntity
        id: SE322JV223222F5GV2N9L8GDK
    post-legalEntities-createLegalEntityIndividualAU:
      summary: Create a legal entity for an individual residing in Australia
      description: Example request for creating a legal entity for an individual residing
        in Australia
      value:
        type: individual
        individual:
          residentialAddress:
            city: Sydney
            country: AU
            postalCode: '1122'
            stateOrProvince: NSW
            street: Winfield Avenue
            street2: '12'
          name:
            firstName: Shelly
            lastName: Eller
          identificationData:
            issuerState: NSW
            number: '1234567891'
            type: driversLicense
            cardNumber: '112327'
          birthData:
            dateOfBirth: '1991-01-01'
          email: s.hopper@example.com
    post-legalEntities-createLegalEntityIndividualAU-200:
      summary: Individual legal entity created
      description: Example response for creating a legal entity for an individual
        residing in Australia
      value:
        individual:
          email: s.hopper@example.com
          birthData:
            dateOfBirth: '1991-01-01'
          identificationData:
            cardNumber: '112327'
            issuerState: NSW
            number: '1234567891'
            type: driversLicense
          name:
            firstName: Shelly
            lastName: Eller
          residentialAddress:
            city: Sydney
            country: AU
            postalCode: '1122'
            stateOrProvince: NSW
            street: Winfield Avenue
            street2: '12'
        type: individual
        id: LE00000000000000000000001
    post-legalEntities-createLegalEntityIndividualNL:
      summary: Create a legal entity for an individual residing in the Netherlands
      description: Example request for creating a legal entity for an individual residing
        in the Netherlands
      value:
        type: individual
        individual:
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
          name:
            firstName: Shelly
            lastName: Eller
          phone:
            number: '+31858888138'
            type: mobile
          birthData:
            dateOfBirth: '1990-06-21'
          email: s.eller@example.com
    post-legalEntities-createLegalEntityIndividualNL-200:
      summary: Individual legal entity created
      description: Example response for creating a legal entity for an individual
        residing in the Netherlands
      value:
        individual:
          email: s.eller@example.com
          birthData:
            dateOfBirth: '1990-06-21'
          name:
            firstName: Shelly
            lastName: Eller
          phone:
            number: '+31858888138'
            phoneCountryCode: NL
            type: mobile
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
        type: individual
        id: LE00000000000000000000001
    post-legalEntities-createLegalEntityIndividualUS:
      summary: Create a legal entity for an individual residing in the US
      description: Example request for creating a legal entity for an individual residing
        in the US
      value:
        type: individual
        individual:
          residentialAddress:
            city: New York
            country: US
            postalCode: '10003'
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
          phone:
            number: '+14153671502'
            type: mobile
          name:
            firstName: Shelly
            lastName: Eller
          birthData:
            dateOfBirth: '1990-06-21'
          email: s.eller@example.com
    post-legalEntities-createLegalEntityIndividualUS-200:
      summary: Individual legal entity created
      description: Example response for creating a legal entity for an individual
        residing in the US
      value:
        individual:
          email: s.eller@example.com
          phone:
            number: '+14153671502'
            type: mobile
          birthData:
            dateOfBirth: '1990-06-21'
          name:
            firstName: Shelly
            lastName: Eller
          residentialAddress:
            city: New York
            country: US
            postalCode: '10003'
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
        type: individual
        id: LE00000000000000000000001
    post-legalEntities-createLegalEntityOrganizationNL:
      summary: Create a legal entity for a Dutch organization
      description: Example request for creating a legal entity for an organization
        operating in the Netherlands
      value:
        type: organization
        organization:
          legalName: Explorer Company based in NL
          doingBusinessAs: API Company Trading
          type: privateCompany
          registeredAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
          registrationNumber: '34179503'
          email: organization@example.com
        entityAssociations:
        - jobTitle: CEO
          legalEntityId: LE00000000000000000000001
          type: signatory
    post-legalEntities-createLegalEntityOrganizationNL-200:
      summary: Organization legal entity created
      description: Example response for creating a legal entity for an organization
        operating in the Netherlands
      value:
        entityAssociations:
        - associatorId: LE00000000000000000000002
          entityType: individual
          jobTitle: CEO
          legalEntityId: LE00000000000000000000001
          name: Simone Hopper
          type: signatory
        organization:
          email: organization@example.com
          doingBusinessAs: API Company Trading
          legalName: Explorer Company based in NL
          registeredAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
          registrationNumber: '34179503'
          type: privateCompany
        type: organization
        id: LE00000000000000000000002
    post-legalEntities-createLegalEntityOrganizationUS:
      summary: Create a legal entity for an organization in the US
      description: Example request for creating a legal entity for an organization
        operating in the US
      value:
        type: organization
        organization:
          legalName: Explorer Company based in US
          registrationNumber: '101002749'
          type: privateCompany
          registeredAddress:
            city: New York
            country: US
            postalCode: '10003'
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
    post-legalEntities-createLegalEntityOrganizationUS-200:
      summary: Organization legal entity created
      description: Example response for creating a legal entity for an organization
        operating in the US
      value:
        organization:
          legalName: Explorer Company based in US
          registrationNumber: '101002749'
          registeredAddress:
            city: New York
            country: US
            postalCode: '10003'
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
          type: privateCompany
        type: organization
        id: LE00000000000000000000001
    post-legalEntities-createLegalEntityPaymentInstrumentUser:
      summary: Create an authorized user for an issued card.
      description: Example request for creating an authorized user for an issued card
      value:
        type: individual
        individual:
          residentialAddress:
            country: NL
          name:
            firstName: John
            lastName: Test
          birthData:
            dateOfBirth: '1990-01-01'
        capabilities:
          authorisedPaymentInstrumentUser:
            requested: true
            requestedLevel: notApplicable
    post-legalEntities-createLegalEntityPaymentInstrumentUser-200:
      summary: Authorized user for an issued card created.
      description: Example response for creating an authorized user for an issued
        card
      value:
        capabilities:
          authorisedPaymentInstrumentUser:
            allowed: false
            requested: true
            verificationStatus: pending
        individual:
          birthData:
            dateOfBirth: '1990-01-01'
          name:
            firstName: John
            lastName: Test
          residentialAddress:
            country: NL
        type: individual
        id: LE32DBK223226C5M7MSG8CPD2
    post-legalEntities-createLegalEntitySolePropNL:
      summary: Create a legal entity for a Dutch sole proprietor
      description: Example request for creating a legal entity for a sole proprietor
        operating in the Netherlands
      value:
        type: soleProprietorship
        soleProprietorship:
          name: Shelly Seller Sole Trader
          countryOfGoverningLaw: NL
          registeredAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
    post-legalEntities-createLegalEntitySolePropNL-200:
      summary: Sole proprietor legal entity created
      description: Example response for creating a legal entity for a sole proprietor
        operating in the Netherlands
      value:
        type: soleProprietorship
        soleProprietorship:
          name: Shelly Seller Sole Trader
          countryOfGoverningLaw: NL
          registeredAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
        id: LE00000000000000000000001
    post-legalEntities-createLegalEntitySolePropUS:
      summary: Create a legal entity for a sole proprietor in the US
      description: Example request for creating a legal entity for a sole proprietor
        operating in the US
      value:
        type: soleProprietorship
        soleProprietorship:
          name: Shelly Eller Sole Trader
          countryOfGoverningLaw: US
          registeredAddress:
            city: New York
            country: US
            postalCode: '10003'
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
    post-legalEntities-createLegalEntitySolePropUS-200:
      summary: Sole proprietor legal entity created
      description: Example response for creating a legal entity for a sole proprietor
        operating in the US
      value:
        type: soleProprietorship
        soleProprietorship:
          name: Shelly Eller Sole Trader
          countryOfGoverningLaw: US
          registeredAddress:
            city: New York
            country: US
            postalCode: '10003'
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
        id: LE00000000000000000000001
    post-legalEntities-createTrustAU:
      summary: Create a legal entity for a trust in Australia
      description: Example request for creating a legal entity for a trust in Australia
      value:
        type: trust
        trust:
          name: Example Trust
          type: fixedUnitTrust
          doingBusinessAs: West's Store
          countryOfGoverningLaw: AU
          taxInformation:
          - country: AU
            type: ABN
            number: '12345678123'
          registeredAddress:
            street: Winfield Avenue
            city: Sydney
            postalCode: '1197'
            stateOrProvince: NSW
            country: AU
          undefinedBeneficiaryInfo:
          - description: My future children
    post-legalEntities-createTrustAU-200:
      summary: Trust legal entity created
      description: Example response for creating a legal entity for a trust in Australia
      value:
        trust:
          countryOfGoverningLaw: AU
          doingBusinessAs: West's Store
          name: Example Trust
          registeredAddress:
            city: Sydney
            country: AU
            postalCode: '1197'
            stateOrProvince: NSW
            street: Winfield Avenue
          taxInformation:
          - country: AU
            number: '12345678901'
            type: ABN
          type: fixedUnitTrust
          undefinedBeneficiaryInfo:
          - description: My future children
            reference: SE322KH223222J5HJ6JRB75HQ
        type: trust
        id: LE322KH223222J5HJ6JRB75C5
    post-legalEntities-createUnincorporatedPartnershipAU:
      summary: Create a legal entity for an unincorporated partnership in Australia
      description: Example request for creating a legal entity for an unincorporated
        partnership in Australia
      value:
        type: unincorporatedPartnership
        unincorporatedPartnership:
          name: West Family Partnership
          type: familyPartnership
          doingBusinessAs: ''
          countryOfGoverningLaw: AU
          taxInformation:
          - country: AU
            type: ABN
            number: '12345678901'
          registeredAddress:
            street: ' 53 Winterfield Avenue'
            city: Sydney
            postalCode: '1197'
            stateOrProvince: NSW
            country: AU
          principalPlaceOfBusiness:
            street: 'East City Street '
            street2: '222'
            city: Sydney
            postalCode: '5566'
            stateOrProvince: NSW
            country: AU
    post-legalEntities-createUnincorporatedPartnershipAU-200:
      summary: Unincorporated partnership legal entity created
      description: Example response for creating a legal entity for an unincorporated
        partnership in Australia
      value:
        unincorporatedPartnership:
          countryOfGoverningLaw: AU
          doingBusinessAs: ''
          name: West Family Partnership
          registeredAddress:
            city: Sydney
            country: AU
            postalCode: '1197'
            stateOrProvince: NSW
            street: Winterfield Avenue
          principalPlaceOfBusiness:
            street: 53 Winterfield Avenue
            city: Sydney
            postalCode: '1197'
            stateOrProvince: NSW
            country: AU
          taxInformation:
          - country: AU
            number: '12345678901'
            type: ABN
          type: familyPartnership
        type: unincorporatedPartnership
        id: LE322KH223222J5HJ6JRB78K8
    post-legalEntities-id-checkVerificationErrors-checkVerificationErrors-200:
      summary: Verification errors for a legal entity
      description: Example response when checking the verification errors of a legal
        entity
      value:
        problems:
        - entity:
            id: LE00000000000000000000001
            type: LegalEntity
          verificationErrors:
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8179'
            message: '''vatNumber'' was missing.'
            remediatingActions:
            - code: '2_158'
              message: Add 'organization.vatNumber' to legal entity.
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8067'
            message: '''Signatory'' was missing.'
            remediatingActions:
            - code: '2_124'
              message: Add 'organization.entityAssociations' of type 'signatory' to
                legal entity
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8189'
            message: '''UBO through control'' was missing.'
            remediatingActions:
            - code: '2_151'
              message: Add 'organization.entityAssociations' of type 'uboThroughControl'
                to legal entity
            type: dataMissing
          - capabilities:
            - receivePayments
            code: '2_8190'
            message: '''businessLine'' was missing.'
            remediatingActions:
            - code: '2_136'
              message: Add business line
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8021'
            message: '''individual.residentialAddress.postalCode'' was missing.'
            remediatingActions:
            - code: '2_108'
              message: Add 'individual.residentialAddress.postalCode' to legal entity
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8064'
            message: '''UBO through ownership'' was missing.'
            remediatingActions:
            - code: '2_123'
              message: Add 'organization.entityAssociations' of type 'uboThroughOwnership'
                to legal entity
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8141'
            message: '''Registration document'' was missing.'
            remediatingActions:
            - code: '1_501'
              message: Upload a registration document
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8019'
            message: '''individual.residentialAddress.street'' was missing.'
            remediatingActions:
            - code: '2_106'
              message: Add 'individual.residentialAddress.street' to legal entity
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8020'
            message: '''individual.residentialAddress.city'' was missing.'
            remediatingActions:
            - code: '2_107'
              message: Add 'individual.residentialAddress.city' to legal entity
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8045'
            message: '''organization.taxId'' was missing.'
            remediatingActions:
            - code: '2_118'
              message: Add 'organization.taxId' to legal entity
            type: dataMissing
          - capabilities:
            - receivePayments
            - sendToTransferInstrument
            code: '2_8043'
            message: '''organization.registrationNumber'' was missing.'
            remediatingActions:
            - code: '2_117'
              message: Add 'organization.registrationNumber' to legal entity
            type: dataMissing
    post-legalEntities-id-confirmDataReview-confirmDataReview-200:
      summary: Data review for a legal entity
      description: Example response when reviewing the data for a legal entity
      value:
        dataReviewedAt: '2023-11-13T15:19:02Z'
    post-legalEntities-id-onboardingLinks-createOnboardingLink:
      summary: Create a hosted onboarding link
      description: Example request for creating a hosted onboarding link
      value:
        themeId: YOUR_THEME_ID
        redirectUrl: https://your-company.example.com
        locale: nl-NL
    post-legalEntities-id-onboardingLinks-createOnboardingLink-200:
      summary: Hosted onboarding link created
      description: Example response for a hosted onboarding link
      value:
        url: https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour-company.example.com%2F&expiry=1667226404807&locale=nl-NL
    post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire:
      summary: Generate PCI questionnaires
      description: Example request for generating PCI questionnaires in French
      value:
        language: fr
    post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200:
      summary: PCI questionnaires returned
      description: Example response for getting PCI questionnaires
      value:
        content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        language: fr
        pciTemplateReferences:
        - PCIT-T7KC6VGL
        - PCIT-PKB6DKS4
    post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire:
      summary: Sign PCI questionnaires
      description: Example request for signing PCI questionnaires
      value:
        signedBy: LE00000000000000000000002
        pciTemplateReferences:
        - PCIT-T7KC6VGL
        - PCIT-PKB6DKS4
    post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire-200:
      summary: PCI questionnaires signed
      description: Example response for signing PCI questionnaires
      value:
        pciQuestionnaireIds:
        - PCID422GZ22322565HHMH48CW63CPH
        - PCID422GZ22322565HHMH49CW75Z9H
    post-legalEntities-id-termsOfService-createTermsofService:
      summary: Get the Terms of Service document
      description: Example request for getting the Terms of Service document
      value:
        type: adyenIssuing
        language: en
    post-legalEntities-id-termsOfService-createTermsofService-200:
      summary: Terms of Service document returned
      description: Example response for getting a Terms of Service document
      value:
        id: LE00000000000000000000001
        type: adyenIssuing
        language: en
        document: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        termsOfServiceDocumentId: abc123
        termsOfServiceDocumentFormat: JSON
    post-transferInstruments-createTransferInstrumentEUR:
      summary: Add an EU bank account
      description: Example request for creating an EU transfer instrument
      value:
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        bankAccount:
          accountIdentification:
            type: iban
            iban: NL62ABNA0000000123
    post-transferInstruments-createTransferInstrumentEUR-200:
      summary: EU bank account added
      description: Example response for adding an EU bank account as a transfer instrument
        of a legal entity
      value:
        bankAccount:
          accountIdentification:
            type: iban
            iban: NL62ABNA0000000123
          countryCode: NL
          trustedSource: false
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        capabilities:
          sendToTransferInstrument:
            allowed: false
            requested: true
            verificationStatus: pending
        id: SE322KH223222F5GXZFNM3BGP
    post-transferInstruments-createTransferInstrumentUK:
      summary: Add a UK bank account
      description: Example request for creating a UK transfer instrument
      value:
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        bankAccount:
          accountIdentification:
            type: ukLocal
            accountNumber: '00000123'
            sortCode: 090102
    post-transferInstruments-createTransferInstrumentUK-200:
      summary: UK bank account added
      description: Example response for adding a UK bank account as a transfer instrument
        of a legal entity
      value:
        bankAccount:
          accountIdentification:
            type: ukLocal
            accountNumber: '00000123'
            sortCode: 090102
          countryCode: GB
          trustedSource: false
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        id: SE3293N223226C5M9TQ9GFBRV
    post-transferInstruments-createTransferInstrumentUSD:
      summary: Add a US bank account
      description: Example request for creating a US transfer instrument
      value:
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        bankAccount:
          accountIdentification:
            type: usLocal
            accountNumber: '0000000123'
            routingNumber: '121202211'
    post-transferInstruments-createTransferInstrumentUSD-200:
      summary: US bank account added
      description: Example response for adding a US bank account as a transfer instrument
        of a legal entity
      value:
        bankAccount:
          accountIdentification:
            type: usLocal
            accountNumber: '0000000123'
            accountType: checking
            routingNumber: '121202211'
          countryCode: US
          trustedSource: false
        legalEntityId: LE00000000000000000000001
        type: bankAccount
        capabilities:
          sendToTransferInstrument:
            allowed: false
            requested: true
            verificationStatus: pending
        id: SE322JV223222F5GJVKHH8DTC
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: X-API-Key
      in: header
    BasicAuth:
      type: http
      scheme: basic