openapi: 3.1.0
servers:
  - url: https://kyc-test.adyen.com/lem/v1
info:
  contact:
    email: developer-experience@adyen.com
    name: Adyen Developer Experience team
    url: https://www.adyen.help/hc/en-us/community/topics
    x-twitter: Adyen
  description: |+
    The Legal Entity Management API enables you to manage legal entities that contain information required for verification. 
    ## Authentication
    To connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:

    ```
    curl
    -U "ws_123456@Scope.BalancePlatform_YourBalancePlatform":"YourWsPassword" \
    -H "Content-Type: application/json" \
    ...
    ```
    Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).

    ## Versioning
    The Legal Entity Management API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.

    For example:
    ```
    https://kyc-test.adyen.com/lem/v1/legalEntities
    ```
    ## Going live
    When going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v1`.

  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  title: Legal Entity Management API
  version: "1"
  x-apisguru-categories:
    - payment
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter_com_Adyen_profile_image.svg
  x-origin:
    - format: openapi
      url: https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/LegalEntityService-v1.json
      version: "3.1"
  x-preferred: false
  x-providerName: adyen.com
  x-publicVersion: true
  x-serviceName: LegalEntityService
  x-timestamp: 2023-04-11T19:23:16Z
tags:
  - name: Legal entities
  - name: Hosted Onboarding
  - name: Business lines
  - name: Documents
  - name: Terms of Service
  - name: Transfer instruments
  - name: PCI questionnaires
paths:
  /businessLines:
    post:
      description: |-
        Creates a business line. 

        This 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.
      operationId: post-businessLines
      requestBody:
        content:
          application/json:
            examples:
              createBusinessLines-businessAccounts:
                $ref: "#/components/examples/post-businessLines-createBusinessLines-businessAccounts"
              createBusinessLines-receive:
                $ref: "#/components/examples/post-businessLines-createBusinessLines-receive"
            schema:
              $ref: "#/components/schemas/BusinessLineInfo"
      responses:
        "200":
          content:
            application/json:
              examples:
                createBusinessLines-businessAccounts:
                  $ref: "#/components/examples/post-businessLines-createBusinessLines-businessAccounts-200"
                createBusinessLines-receive:
                  $ref: "#/components/examples/post-businessLines-createBusinessLines-receive-200"
              schema:
                $ref: "#/components/schemas/BusinessLine"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Create a business line
      tags:
        - Business lines
      x-addedInVersion: "1"
      x-groupName: Business lines
      x-methodName: createBusinessLine
      x-sortIndex: 12
  "/businessLines/{id}":
    delete:
      description: |-
        Deletes a business line.

         >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.
      operationId: delete-businessLines-id
      parameters:
        - description: The unique identifier of the business line to be deleted.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: No Content - the request has been successfully processed, but there is no additional content.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Delete a business line
      tags:
        - Business lines
      x-addedInVersion: "1"
      x-groupName: Business lines
      x-methodName: deleteBusinessLine
      x-sortIndex: 14
    get:
      description: Returns the detail of a business line.
      operationId: get-businessLines-id
      parameters:
        - description: The unique identifier of the business line.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-businessLines-id-success-200"
              schema:
                $ref: "#/components/schemas/BusinessLine"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get a business line
      tags:
        - Business lines
      x-addedInVersion: "1"
      x-groupName: Business lines
      x-methodName: getBusinessLine
      x-sortIndex: 13
  /documents:
    post:
      description: |-
        Uploads a document for verification checks.

         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.

         You should only upload documents when Adyen requests additional information for the legal entity. 
      operationId: post-documents
      requestBody:
        content:
          application/json:
            examples:
              uploadDocument:
                $ref: "#/components/examples/post-documents-uploadDocument"
            schema:
              $ref: "#/components/schemas/Document"
      responses:
        "200":
          content:
            application/json:
              examples:
                uploadDocument:
                  $ref: "#/components/examples/post-documents-uploadDocument-200"
              schema:
                $ref: "#/components/schemas/Document"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Upload a document for verification checks
      tags:
        - Documents
      x-addedInVersion: "1"
      x-groupName: Documents
      x-methodName: uploadDocumentForVerificationChecks
      x-sortIndex: 4
  "/documents/{id}":
    delete:
      description: Deletes a document.
      operationId: delete-documents-id
      parameters:
        - description: The unique identifier of the document to be deleted.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VoidResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Delete a document
      tags:
        - Documents
      x-addedInVersion: "1"
      x-groupName: Documents
      x-methodName: deleteDocument
      x-sortIndex: 7
    get:
      description: Returns a document.
      operationId: get-documents-id
      parameters:
        - description: The unique identifier of the document.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-documents-id-success-200"
              schema:
                $ref: "#/components/schemas/Document"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get a document
      tags:
        - Documents
      x-addedInVersion: "1"
      x-groupName: Documents
      x-methodName: getDocument
      x-sortIndex: 5
    patch:
      description: Updates a document.
      operationId: patch-documents-id
      parameters:
        - description: The unique identifier of the document to be updated.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              updateDocument:
                $ref: "#/components/examples/patch-documents-id-updateDocument"
            schema:
              $ref: "#/components/schemas/Document"
      responses:
        "200":
          content:
            application/json:
              examples:
                updateDocument:
                  $ref: "#/components/examples/patch-documents-id-updateDocument-200"
              schema:
                $ref: "#/components/schemas/Document"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Update a document
      tags:
        - Documents
      x-addedInVersion: "1"
      x-groupName: Documents
      x-methodName: updateDocument
      x-sortIndex: 6
  /legalEntities:
    post:
      description: |+
        Creates a legal entity. 

        This 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. 

      operationId: post-legalEntities
      requestBody:
        content:
          application/json:
            examples:
              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"
            schema:
              $ref: "#/components/schemas/LegalEntityInfoRequiredType"
      responses:
        "200":
          content:
            application/json:
              examples:
                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"
              schema:
                $ref: "#/components/schemas/LegalEntity"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Create a legal entity
      tags:
        - Legal entities
      x-addedInVersion: "1"
      x-groupName: Legal entities
      x-methodName: createLegalEntity
      x-sortIndex: 1
  "/legalEntities/{id}":
    get:
      description: Returns a legal entity.
      operationId: get-legalEntities-id
      parameters:
        - description: The unique identifier of the legal entity.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-legalEntities-id-success-200"
              schema:
                $ref: "#/components/schemas/LegalEntity"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get a legal entity
      tags:
        - Legal entities
      x-addedInVersion: "1"
      x-groupName: Legal entities
      x-methodName: getLegalEntity
      x-sortIndex: 2
    patch:
      description: |-
        Updates a legal entity.

         >To change the legal entity type, include only the new `type` in your 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.
      operationId: patch-legalEntities-id
      parameters:
        - description: The unique identifier of the legal entity.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              changeLegalEntityType:
                $ref: "#/components/examples/patch-legalEntities-id-changeLegalEntityType"
              updateLegalEntityOrganization:
                $ref: "#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization"
            schema:
              $ref: "#/components/schemas/LegalEntityInfo"
      responses:
        "200":
          content:
            application/json:
              examples:
                changeLegalEntityType:
                  $ref: "#/components/examples/patch-legalEntities-id-changeLegalEntityType-200"
                updateLegalEntityOrganization:
                  $ref: "#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization-200"
              schema:
                $ref: "#/components/schemas/LegalEntity"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Update a legal entity
      tags:
        - Legal entities
      x-addedInVersion: "1"
      x-groupName: Legal entities
      x-methodName: updateLegalEntity
      x-sortIndex: 3
  "/legalEntities/{id}/businessLines":
    get:
      description: Returns the business lines owned by a legal entity.
      operationId: get-legalEntities-id-businessLines
      parameters:
        - description: The unique identifier of the legal entity.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-legalEntities-id-businessLines-success-200"
              schema:
                $ref: "#/components/schemas/BusinessLines"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get all business lines under a legal entity
      tags:
        - Legal entities
      x-addedInVersion: "1"
      x-groupName: Legal entities
      x-methodName: getAllBusinessLinesUnderLegalEntity
      x-sortIndex: 4
  "/legalEntities/{id}/onboardingLinks":
    post:
      description: Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.
      operationId: post-legalEntities-id-onboardingLinks
      parameters:
        - description: The unique identifier of the legal entity
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              createOnboardingLink:
                $ref: "#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink"
            schema:
              $ref: "#/components/schemas/OnboardingLinkInfo"
      responses:
        "200":
          content:
            application/json:
              examples:
                createOnboardingLink:
                  $ref: "#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink-200"
              schema:
                $ref: "#/components/schemas/OnboardingLink"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get a link to an Adyen-hosted onboarding page
      tags:
        - Hosted Onboarding
      x-addedInVersion: "1"
      x-groupName: Hosted Onboarding
      x-methodName: getLinkToAdyenhostedOnboardingPage
      x-sortIndex: 1
  "/legalEntities/{id}/pciQuestionnaires":
    get:
      description: Get a list of signed PCI questionnaires.
      operationId: get-legalEntities-id-pciQuestionnaires
      parameters:
        - description: The unique identifier of the legal entity to get PCI questionnaire information.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-legalEntities-id-pciQuestionnaires-success-200"
              schema:
                $ref: "#/components/schemas/GetPciQuestionnaireInfosResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get PCI questionnaire details
      tags:
        - PCI questionnaires
      x-addedInVersion: "1"
      x-groupName: PCI questionnaires
      x-methodName: getPciQuestionnaireDetails
      x-sortIndex: 3
  "/legalEntities/{id}/pciQuestionnaires/generatePciTemplates":
    post:
      description: Generates the required PCI questionnaire based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels). If multiple questionnaires are required, this request creates a single consodilated document to be signed.
      operationId: post-legalEntities-id-pciQuestionnaires-generatePciTemplates
      parameters:
        - description: The legal entity ID of the individual who will sign the PCI questionnaire.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              createPciQuestionnaire:
                $ref: "#/components/examples/post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire"
            schema:
              $ref: "#/components/schemas/GeneratePciDescriptionRequest"
      responses:
        "200":
          content:
            application/json:
              examples:
                createPciQuestionnaire:
                  $ref: "#/components/examples/post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200"
              schema:
                $ref: "#/components/schemas/GeneratePciDescriptionResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Generate PCI questionnaire
      tags:
        - PCI questionnaires
      x-addedInVersion: "1"
      x-groupName: PCI questionnaires
      x-methodName: generatePciQuestionnaire
      x-sortIndex: 1
  "/legalEntities/{id}/pciQuestionnaires/signPciTemplates":
    post:
      description: Signs the required PCI questionnaire.
      operationId: post-legalEntities-id-pciQuestionnaires-signPciTemplates
      parameters:
        - description: The legal entity ID of the individual who signed the PCI questionnaire.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              signPciQuestionnaire:
                $ref: "#/components/examples/post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire"
            schema:
              $ref: "#/components/schemas/PciSigningRequest"
      responses:
        "200":
          content:
            application/json:
              examples:
                signPciQuestionnaire:
                  $ref: "#/components/examples/post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire-200"
              schema:
                $ref: "#/components/schemas/PciSigningResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Sign PCI questionnaire
      tags:
        - PCI questionnaires
      x-addedInVersion: "1"
      x-groupName: PCI questionnaires
      x-methodName: signPciQuestionnaire
      x-sortIndex: 2
  "/legalEntities/{id}/pciQuestionnaires/{pciid}":
    get:
      description: Returns the signed PCI questionnaire.
      operationId: get-legalEntities-id-pciQuestionnaires-pciid
      parameters:
        - description: The legal entity ID of the individual who signed the PCI questionnaire.
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: The unique identifier of the signed PCI questionnaire.
          in: path
          name: pciid
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-legalEntities-id-pciQuestionnaires-pciid-success-200"
              schema:
                $ref: "#/components/schemas/GetPciQuestionnaireResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get PCI questionnaire
      tags:
        - PCI questionnaires
      x-addedInVersion: "1"
      x-groupName: PCI questionnaires
      x-methodName: getPciQuestionnaire
      x-sortIndex: 4
  "/legalEntities/{id}/termsOfService":
    post:
      description: Returns the Terms of Service document for a legal entity.
      operationId: post-legalEntities-id-termsOfService
      parameters:
        - description: The unique identifier of the legal entity.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            examples:
              createTermsofService:
                $ref: "#/components/examples/post-legalEntities-id-termsOfService-createTermsofService"
            schema:
              $ref: "#/components/schemas/GetTermsOfServiceDocumentRequest"
      responses:
        "200":
          content:
            application/json:
              examples:
                createTermsofService:
                  $ref: "#/components/examples/post-legalEntities-id-termsOfService-createTermsofService-200"
              schema:
                $ref: "#/components/schemas/GetTermsOfServiceDocumentResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get Terms of Service document
      tags:
        - Terms of Service
      x-addedInVersion: "1"
      x-groupName: Terms of Service
      x-methodName: getTermsOfServiceDocument
      x-sortIndex: 1
  "/legalEntities/{id}/termsOfService/{termsofservicedocumentid}":
    patch:
      description: Accepts Terms of Service.
      operationId: patch-legalEntities-id-termsOfService-termsofservicedocumentid
      parameters:
        - description: The unique identifier of the legal entity.
          in: path
          name: id
          required: true
          schema:
            type: string
        - description: The unique identifier of the Terms of Service document.
          in: path
          name: termsofservicedocumentid
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AcceptTermsOfServiceRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AcceptTermsOfServiceResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Accept Terms of Service
      tags:
        - Terms of Service
      x-addedInVersion: "1"
      x-groupName: Terms of Service
      x-methodName: acceptTermsOfService
      x-sortIndex: 2
  "/legalEntities/{id}/termsOfServiceAcceptanceInfos":
    get:
      description: Returns Terms of Service information for a legal entity.
      operationId: get-legalEntities-id-termsOfServiceAcceptanceInfos
      parameters:
        - description: The unique identifier of the legal entity.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200"
              schema:
                $ref: "#/components/schemas/GetTermsOfServiceAcceptanceInfosResponse"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get Terms of Service information for a legal entity
      tags:
        - Terms of Service
      x-addedInVersion: "1"
      x-groupName: Terms of Service
      x-methodName: getTermsOfServiceInformationForLegalEntity
      x-sortIndex: 3
  /themes:
    get:
      description: Returns a list of hosted onboarding page themes.
      operationId: get-themes
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-themes-success-200"
              schema:
                $ref: "#/components/schemas/OnboardingThemes"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get a list of hosted onboarding page themes
      tags:
        - Hosted Onboarding
      x-addedInVersion: "1"
      x-groupName: Hosted Onboarding
      x-methodName: listHostedOnboardingPageThemes
      x-sortIndex: 2
  "/themes/{id}":
    get:
      description: Returns the details of the theme identified in the path.
      operationId: get-themes-id
      parameters:
        - description: The unique identifier of the theme
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-themes-id-success-200"
              schema:
                $ref: "#/components/schemas/OnboardingTheme"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get an onboarding link theme
      tags:
        - Hosted Onboarding
      x-addedInVersion: "1"
      x-groupName: Hosted Onboarding
      x-methodName: getOnboardingLinkTheme
      x-sortIndex: 4
  /transferInstruments:
    post:
      description: |-
        Creates a transfer instrument. 

        A 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.

        When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).
      operationId: post-transferInstruments
      requestBody:
        content:
          application/json:
            examples:
              createTransferInstrumentEUR:
                $ref: "#/components/examples/post-transferInstruments-createTransferInstrumentEUR"
              createTransferInstrumentUSD:
                $ref: "#/components/examples/post-transferInstruments-createTransferInstrumentUSD"
            schema:
              $ref: "#/components/schemas/TransferInstrumentInfo"
      responses:
        "200":
          content:
            application/json:
              examples:
                createTransferInstrumentEUR:
                  $ref: "#/components/examples/post-transferInstruments-createTransferInstrumentEUR-200"
                createTransferInstrumentUSD:
                  $ref: "#/components/examples/post-transferInstruments-createTransferInstrumentUSD-200"
              schema:
                $ref: "#/components/schemas/TransferInstrument"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Create a transfer instrument
      tags:
        - Transfer instruments
      x-addedInVersion: "1"
      x-groupName: Transfer instruments
      x-methodName: createTransferInstrument
      x-sortIndex: 8
  "/transferInstruments/{id}":
    delete:
      description: Deletes a transfer instrument.
      operationId: delete-transferInstruments-id
      parameters:
        - description: The unique identifier of the transfer instrument to be deleted.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "204":
          description: No Content - the request has been successfully processed, but there is no additional content.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Delete a transfer instrument
      tags:
        - Transfer instruments
      x-addedInVersion: "1"
      x-groupName: Transfer instruments
      x-methodName: deleteTransferInstrument
      x-sortIndex: 11
    get:
      description: Returns the details of a transfer instrument.
      operationId: get-transferInstruments-id
      parameters:
        - description: The unique identifier of the transfer instrument.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                success:
                  $ref: "#/components/examples/get-transferInstruments-id-success-200"
              schema:
                $ref: "#/components/schemas/TransferInstrument"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Get a transfer instrument
      tags:
        - Transfer instruments
      x-addedInVersion: "1"
      x-groupName: Transfer instruments
      x-methodName: getTransferInstrument
      x-sortIndex: 9
    patch:
      description: Updates a transfer instrument.
      operationId: patch-transferInstruments-id
      parameters:
        - description: The unique identifier of the transfer instrument.
          in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransferInstrumentInfo"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransferInstrument"
          description: OK - the request has succeeded.
        "400":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Bad Request - a problem reading or understanding the request.
        "401":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unauthorized - authentication required.
        "403":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Forbidden - insufficient permissions to process the request.
        "422":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Unprocessable Entity - a request validation error.
        "500":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ServiceError"
          description: Internal Server Error - the server could not process the request.
      security:
        - BasicAuth: []
        - ApiKeyAuth: []
      summary: Update a transfer instrument
      tags:
        - Transfer instruments
      x-addedInVersion: "1"
      x-groupName: Transfer instruments
      x-methodName: updateTransferInstrument
      x-sortIndex: 10
components:
  examples:
    get-businessLines-id-success-200:
      description: Example response when getting the business line details
      summary: Details of a business line
      value:
        capability: issueBankAccount
        id: SE322KH223222F5GV2SQ924F6
        industryCode: "4531"
        legalEntityId: YOUR_LEGAL_ENTITY
        sourceOfFunds:
          adyenProcessedFunds: false
          description: Funds from my flower shop business
          type: business
        webData:
          - webAddress: https://www.adyen.com
    get-documents-id-success-200:
      description: Example response when getting document details
      summary: Details of a document
      value:
        attachments:
          - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Registration doc for Example Company
        fileName: Registration doc for Example Company
        id: SE322JV223222F5GV2N9L8GDK
        owner:
          id: YOUR_LEGAL_ENTITY
          type: legalEntity
        type: registrationDocument
    get-legalEntities-id-businessLines-success-200:
      description: Example response when getting the list of business lines for a legal entity
      summary: List of business lines for a legal entity
      value:
        businessLines:
          - capability: issueBankAccount
            id: SE322JV223222F5GVGMLNB83F
            industryCode: "4531"
            legalEntityId: YOUR_LEGAL_ENTITY
            sourceOfFunds:
              adyenProcessedFunds: false
              description: Funds from my flower shop business
              type: business
            webData:
              - webAddress: https://www.adyen.com
          - capability: receivePayments
            id: SE322JV223222F5GVGPNRB9GJ
            industryCode: 339E
            legalEntityId: YOUR_LEGAL_ENTITY
            salesChannels:
              - eCommerce
              - ecomMoto
            webData:
              - webAddress: https://yoururl.com
    get-legalEntities-id-pciQuestionnaires-pciid-success-200:
      description: Example response when getting the details of a PCI questionnaire
      summary: Details of a PCI questionnaire
      value:
        content: JVBERi0xLjUKJdDUxdgKMTAg.....
        createdAt: 2023-03-02T17:54:19.538365Z
        id: PCID422GZ22322565HHMH48CW63CPH
        validUntil: 2024-03-01T17:54:19.538365Z
    get-legalEntities-id-pciQuestionnaires-success-200:
      description: Example response when getting the list of PCI questionnaires
      summary: Details of PCI questionnaires signed by a user
      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:
      description: Example response when getting the details of a legal entity
      summary: Details of a legal entity
      value:
        capabilities:
          receiveFromBalanceAccount:
            allowed: false
            requested: true
            verificationStatus: pending
          receiveFromPlatformPayments:
            allowed: false
            requested: true
            verificationStatus: pending
          receivePayments:
            allowed: false
            requested: true
            verificationStatus: pending
          sendToBalanceAccount:
            allowed: false
            requested: true
            verificationStatus: pending
          sendToTransferInstrument:
            allowed: false
            requested: true
            verificationStatus: pending
        id: YOUR_LEGAL_ENTITY
        individual:
          birthData:
            dateOfBirth: 1990-06-21
          email: s.hopper@example.com
          name:
            firstName: Simone
            lastName: Hopper
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
            street2: "274"
        type: individual
    get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200:
      description: Example response when getting Terms of Service information for a legal entity
      summary: Terms of Service information for a legal entity
      value:
        data:
          - acceptedBy: YOUR_LEGAL_ENTITY_2
            acceptedFor: YOUR_LEGAL_ENTITY_1
            createdAt: 2022-12-05T13:36:58.212253Z
            id: TOSA000AB00000000B2AAAB2BA0AA0
            type: adyenIssuing
    get-themes-id-success-200:
      description: Example response when getting the details of a page theme
      summary: Details of a page theme
      value:
        createdAt: 2022-06-22T00:00:00+02:00
        description: Light colors theme
        id: ONBT422KH223222D5G82M968PB46HR
        properties:
          backgroundColor: "#FFFFFF"
          backgroundImage: ONBA422JV223222D5G82M96F6P2VTV
          faqPage: https://docs.adyen.com/hosted-onboarding-faqs
          logo: ONBA422JV223222D5FWC4TK25S3DQW
          pageLayout: withBackground
          pageTitle: Example onboarding light colors
          privacyStatementPage: https://www.adyen.com/legal/terms-and-conditions
          supportPage: https://www.adyen.com/contact
        updatedAt: 2022-08-25T00:00:00+02:00
    get-themes-success-200:
      description: Example response when getting the list of hosted onboarding themes
      summary: List of hosted onboarding themes for your balance platform
      value:
        themes:
          - createdAt: 2022-01-20T00:00:00+01:00
            description: Dark colors theme
            id: ONBT422JV223222D5FGJ77B9C52WNN
            properties:
              backgroundColor: "#000000"
              backgroundImage: ONBA422KH223222D5G8VG2TG9S5ZBH
              faqPage: https://docs.adyen.com/hosted-onboarding-faqs
              logo: ONBA422JV223222D5G8VG2T8JV39GV
              pageLayout: withBackground
              pageTitle: Example onboarding dark colors
              supportPage: https://www.adyen.com/contact
            updatedAt: 2022-08-25T00:00:00+02:00
          - createdAt: 2022-06-22T00:00:00+02:00
            description: Light colors theme
            id: ONBT422KH223222D5G82M968PB46HR
            properties:
              backgroundColor: "#FFFFFF"
              backgroundImage: ONBA422JV223222D5G82M96F6P2VTV
              faqPage: https://docs.adyen.com/hosted-onboarding-faqs
              logo: ONBA422JV223222D5FWC4TK25S3DQW
              pageLayout: withBackground
              pageTitle: Example onboarding light colors
              privacyStatementPage: https://www.adyen.com/legal/terms-and-conditions
              supportPage: https://www.adyen.com/contact
            updatedAt: 2022-08-25T00:00:00+02:00
    get-transferInstruments-id-success-200:
      description: Example response when getting the details of a transfer instrument
      summary: Details of a transfer instrument
      value:
        bankAccount:
          countryCode: NL
          currencyCode: EUR
          iban: NL62ABNA0000000123
        id: SE322JV223222F5GNXSR89TMW
        legalEntityId: YOUR_LEGAL_ENTITY
        type: bankAccount
    patch-documents-id-updateDocument:
      description: Example request for updating a document
      summary: Update a document
      value:
        description: Proof of industry doc for Example Company
        type: proofOfIndustry
    patch-documents-id-updateDocument-200:
      description: Example response when a document is updated
      summary: Document updated
      value:
        attachments:
          - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Proof of industry for Example Company
        fileName: Proof of industry for Example Company
        id: SE322JV223222F5GV2N9L8GDK
        owner:
          id: YOUR_LEGAL_ENTITY
          type: legalEntity
        type: proofOfIndustry
    patch-legalEntities-id-changeLegalEntityType:
      description: Example request when changing the legal entity type
      summary: Change a legal entity from an organization to an individual
      value:
        type: individual
    patch-legalEntities-id-changeLegalEntityType-200:
      description: Example response when changing the legal entity type
      summary: Legal entity type changed
      value:
        id: YOUR_LEGAL_ENTITY
        individual:
          name:
            firstName: Explorer
            lastName: Company based in US
          residentialAddress:
            country: US
        type: individual
    patch-legalEntities-id-updateLegalEntityOrganization:
      description: Example request adding entity associations to a legal entity
      summary: Add entity associations to an organization
      value:
        entityAssociations:
          - jobTitle: CEO
            legalEntityId: YOUR_LEGAL_ENTITY_1
            type: uboThroughControl
    patch-legalEntities-id-updateLegalEntityOrganization-200:
      description: Example response for adding an entity association to an organization
      summary: Entity associations added
      value:
        entityAssociations:
          - associatorId: YOUR_LEGAL_ENTITY_2
            entityType: individual
            jobTitle: CEO
            legalEntityId: YOUR_LEGAL_ENTITY_1
            name: Simone Hopper
            type: uboThroughControl
        id: YOUR_LEGAL_ENTITY_2
        organization:
          description: FinTech
          doingBusinessAs: Adyen BV
          email: john.doe@adyen.com
          legalName: Adyen BV
          phone:
            countryCode: NL
            number: "646467363"
            type: mobile
          registeredAddress:
            city: AMS
            country: NL
            postalCode: 1234EE
            stateOrProvince: NH
            street: Simon Carmiggeltstraat 6 - 50
          registrationNumber: ""
          stockData:
            marketIdentifier: ADYN
            stockNumber: NL012345ABC4
            tickerSymbol: ADYN.M
          taxExempt: false
          type: listedPublicCompany
        type: organization
    post-businessLines-createBusinessLines-businessAccounts:
      description: Example request for creating a business line for a business account
      summary: Create a business line for a business account
      value:
        capability: issueBankAccount
        industryCode: "4531"
        legalEntityId: YOUR_LEGAL_ENTITY
        sourceOfFunds:
          adyenProcessedFunds: false
          description: Funds from my flower shop business
          type: business
        webData:
          - webAddress: https://www.adyen.com
    post-businessLines-createBusinessLines-businessAccounts-200:
      summary: Example response for creating a business line
      value:
        capability: issueBankAccount
        id: SE322KT223222D5FJ7TJN2986
        industryCode: "4531"
        legalEntityId: YOUR_LEGAL_ENTITY
        sourceOfFunds:
          adyenProcessedFunds: false
          description: Funds from my flower shop business
          type: business
        webData:
          - webAddress: https://www.adyen.com
    post-businessLines-createBusinessLines-receive:
      description: Example request for receiving payments
      summary: Create a business line for receiving payments
      value:
        capability: receivePayments
        industryCode: 339E
        legalEntityId: YOUR_LEGAL_ENTITY
        salesChannels:
          - eCommerce
          - ecomMoto
        webData:
          - webAddress: https://yoururl.com
    post-businessLines-createBusinessLines-receive-200:
      summary: Example response for creating a business line
      value:
        capability: receivePayments
        id: SE322KT223222D5FJ7TJN2986
        industryCode: 339E
        legalEntityId: YOUR_LEGAL_ENTITY
        salesChannels:
          - eCommerce
          - ecomMoto
        webData:
          - webAddress: https://yoururl.com
    post-documents-uploadDocument:
      description: Example request for uploading a document
      summary: Upload a document
      value:
        attachments:
          - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Registration doc for Example Company
        owner:
          id: YOUR_LEGAL_ENTITY
          type: legalEntity
        type: registrationDocument
    post-documents-uploadDocument-200:
      description: Example response when a document is uploaded
      summary: Document uploaded
      value:
        attachments:
          - content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        description: Registration doc for Example Company
        fileName: Registration doc for Example Company
        id: SE322JV223222F5GV2N9L8GDK
        owner:
          id: YOUR_LEGAL_ENTITY
          type: legalEntity
        type: registrationDocument
    post-legalEntities-createLegalEntityIndividualNL:
      description: Example request for creating a legal entity for an individual residing in the Netherlands
      summary: Create a legal entity for an individual residing in the Netherlands
      value:
        individual:
          birthData:
            dateOfBirth: 1990-06-21
          email: s.eller@example.com
          name:
            firstName: Shelly
            lastName: Eller
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
        type: individual
    post-legalEntities-createLegalEntityIndividualNL-200:
      description: Example response for creating a legal entity for an individual residing in the Netherlands
      summary: Individual legal entity created
      value:
        id: YOUR_LEGAL_ENTITY
        individual:
          birthData:
            dateOfBirth: 1990-06-21
          email: s.eller@example.com
          name:
            firstName: Shelly
            lastName: Eller
          residentialAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
        type: individual
    post-legalEntities-createLegalEntityIndividualUS:
      description: Example request for creating a legal entity for an individual residing in the US
      summary: Create a legal entity for an individual residing in the US
      value:
        individual:
          birthData:
            dateOfBirth: 1990-06-21
          email: s.eller@example.com
          name:
            firstName: Shelly
            lastName: Eller
          phone:
            number: "+14153671502"
            type: mobile
          residentialAddress:
            city: New York
            country: US
            postalCode: "10003"
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
        type: individual
    post-legalEntities-createLegalEntityIndividualUS-200:
      description: Example response for creating a legal entity for an individual residing in the US
      summary: Individual legal entity created
      value:
        id: YOUR_LEGAL_ENTITY
        individual:
          birthData:
            dateOfBirth: 1990-06-21
          email: s.eller@example.com
          name:
            firstName: Shelly
            lastName: Eller
          phone:
            number: "+14153671502"
            type: mobile
          residentialAddress:
            city: New York
            country: US
            postalCode: "10003"
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
        type: individual
    post-legalEntities-createLegalEntityOrganizationNL:
      description: Example request for creating a legal entity for an organization operating in the Netherlands
      summary: Create a legal entity for a Dutch organization
      value:
        entityAssociations:
          - jobTitle: CEO
            legalEntityId: YOUR_LEGAL_ENTITY_1
            type: signatory
        organization:
          doingBusinessAs: API Company Trading
          email: organization@example.com
          legalName: Explorer Company based in NL
          registeredAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
          registrationNumber: "34179503"
          type: privateCompany
        type: organization
    post-legalEntities-createLegalEntityOrganizationNL-200:
      description: Example response for creating a legal entity for an organization operating in the Netherlands
      summary: Organization legal entity created
      value:
        entityAssociations:
          - associatorId: YOUR_LEGAL_ENTITY_2
            entityType: individual
            jobTitle: CEO
            legalEntityId: YOUR_LEGAL_ENTITY_1
            name: Simone Hopper
            type: signatory
        id: YOUR_LEGAL_ENTITY_2
        organization:
          doingBusinessAs: API Company Trading
          email: organization@example.com
          legalName: Explorer Company based in NL
          registeredAddress:
            city: Amsterdam
            country: NL
            postalCode: 1011DJ
            street: Simon Carmiggeltstraat 6 - 50
          registrationNumber: "34179503"
          type: privateCompany
        type: organization
    post-legalEntities-createLegalEntityOrganizationUS:
      description: Example request for creating a legal entity for an organization operating in the US
      summary: Create a legal entity for an organization in the US
      value:
        organization:
          legalName: Explorer Company based in US
          registeredAddress:
            city: New York
            country: US
            postalCode: "10003"
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
          registrationNumber: "101002749"
          type: privateCompany
        type: organization
    post-legalEntities-createLegalEntityOrganizationUS-200:
      description: Example response for creating a legal entity for an organization operating in the US
      summary: Organization legal entity created
      value:
        id: YOUR_LEGAL_ENTITY
        organization:
          legalName: Explorer Company based in US
          registeredAddress:
            city: New York
            country: US
            postalCode: "10003"
            stateOrProvince: NY
            street: 71 5th Avenue
            street2: 11th floor
          registrationNumber: "101002749"
          taxExempt: false
          type: privateCompany
        type: organization
    post-legalEntities-id-onboardingLinks-createOnboardingLink:
      description: Example request for creating a hosted onboarding link
      summary: Create a hosted onboarding link
      value:
        locale: nl-NL
        redirectUrl: https://your.redirect-url.com/
    post-legalEntities-id-onboardingLinks-createOnboardingLink-200:
      description: Example response for a hosted onboarding link
      summary: Hosted onboarding link created
      value:
        url: https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL
    post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire:
      description: Example request for generating the PCI questionnaire in French
      summary: Generate the PCI questionnaire
      value:
        language: fr
    post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200:
      description: Example response for getting a PCI questionnaire
      summary: PCI questionnaire returned
      value:
        content: l345JKNFj345FJLG3lk...
        language: fr
        pciTemplateReferences:
          - PCIT-T7KC6VGL
          - PCIT-PKB6DKS4
    post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire:
      description: Example request for signing the PCI questionnaires
      summary: Sign the PCI questionnaires
      value:
        pciTemplateReferences:
          - PCIT-T7KC6VGL
          - PCIT-PKB6DKS4
        signedBy: LE00000000000000000000002
    post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire-200:
      description: Example response for signing PCI questionnaires
      summary: PCI questionnaires signed
      value:
        pciQuestionnaireIds:
          - PCID422GZ22322565HHMH48CW63CPH
          - PCID422GZ22322565HHMH49CW75Z9H
    post-legalEntities-id-termsOfService-createTermsofService:
      description: Example request for getting the Terms of Service document
      summary: Get the Terms of Service document
      value:
        language: en
        type: adyenIssuing
    post-legalEntities-id-termsOfService-createTermsofService-200:
      description: Example response for getting a Terms of Service document
      summary: Terms of Service document returned
      value:
        document: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==
        id: YOUR_LEGAL_ENTITY
        language: en
        termsOfServiceDocumentId: abc123
        type: adyenIssuing
    post-transferInstruments-createTransferInstrumentEUR:
      description: Example request for creating a transfer instrument for EUR
      summary: Add a EUR bank account
      value:
        bankAccount:
          countryCode: NL
          currencyCode: EUR
          iban: NL62ABNA0000000123
        legalEntityId: YOUR_LEGAL_ENTITY
        type: bankAccount
    post-transferInstruments-createTransferInstrumentEUR-200:
      description: Example response for adding a bank account as a transfer instrument of a legal entity
      summary: Bank account added
      value:
        bankAccount:
          countryCode: NL
          currencyCode: EUR
          iban: NL62ABNA0000000123
        id: SE576BH223222F5GJVKHH6BDT
        legalEntityId: YOUR_LEGAL_ENTITY
        type: bankAccount
    post-transferInstruments-createTransferInstrumentUSD:
      description: Example request for creating a transfer instrument for USD
      summary: Add a USD bank account
      value:
        bankAccount:
          accountNumber: "0000000123"
          accountType: checking
          branchCode: "121202211"
          countryCode: US
          currencyCode: USD
        legalEntityId: YOUR_LEGAL_ENTITY
        type: bankAccount
    post-transferInstruments-createTransferInstrumentUSD-200:
      description: Example response for adding a bank account as a transfer instrument of a legal entity
      summary: Bank account added
      value:
        bankAccount:
          accountNumber: "0000000123"
          accountType: checking
          branchCode: "121202211"
          countryCode: US
          currencyCode: USD
        id: SE322JV223222F5GJVKHH8DTC
        legalEntityId: YOUR_LEGAL_ENTITY
        type: bankAccount
  schemas:
    AcceptTermsOfServiceRequest:
      properties:
        acceptedBy:
          description: The unique identifier of the user accepting the Terms of Service.
          type: string
        ipAddress:
          description: The IP address of the user accepting the Terms of Service.
          type: string
      type: object
    AcceptTermsOfServiceResponse:
      properties:
        acceptedBy:
          description: The unique identifier of the user that accepted the Terms of Service.
          type: string
        id:
          description: The unique identifier of the Terms of Service acceptance.
          type: string
        ipAddress:
          description: The IP address of the user that accepted the Terms of Service.
          type: string
        language:
          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. For example, **nl** for Dutch.
          type: string
        termsOfServiceDocumentId:
          description: The unique identifier of the Terms of Service document.
          type: string
        type:
          description: The type of Terms of Service.
          enum:
            - adyenAccount
            - adyenCapital
            - adyenCard
            - adyenForPlatformsAdvanced
            - adyenForPlatformsManage
            - adyenFranchisee
            - adyenIssuing
          type: string
      type: object
    Address:
      properties:
        city:
          description: |-
            The name of the city. Required if `stateOrProvince` is provided.

            If you specify the city, you must also send `postalCode` and `street`.
          type: string
        country:
          description: The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
          type: string
        postalCode:
          description: Postal code. Required if `stateOrProvince` and/or `city` is provided.
          type: string
        stateOrProvince:
          description: |-
            The two-letter ISO 3166-2 state or province code. For example, **CA** in the US. 

            If you specify the state or province, you must also send `city`, `postalCode`, and `street`.
          type: string
        street:
          description: The name of the street, and the house or building number. Required if `stateOrProvince` and/or `city` is provided.
          type: string
        street2:
          description: The apartment, unit, or suite number.
          type: string
      required:
        - country
      type: object
    Amount:
      properties:
        currency:
          description: The type of currency. Must be EUR (or EUR equivalent)
          type: string
        value:
          description: Total value of amount. Must be >= 0
          format: int64
          type: integer
      type: object
    Attachment:
      properties:
        content:
          contentEncoding: base64
          description: The document in Base64-encoded string format.
          type: string
        contentType:
          deprecated: true
          description: |-
            The file format.

             Possible values: **application/pdf**, **image/jpg**, **image/jpeg**, **image/png**. 
          type: string
          x-deprecatedInVersion: "1"
        filename:
          deprecated: true
          description: The name of the file including the file extension.
          type: string
          x-deprecatedInVersion: "1"
        pageType:
          description: |-
            Specifies which side of the ID card is uploaded.

            * When `type` is **driversLicense** or **identityCard**, set this to **front** or **back**.

            * When omitted, we infer the page number based on the order of attachments.
          type: string
      required:
        - content
      type: object
    BankAccountInfo:
      properties:
        accountNumber:
          description: |-
            The bank account number (without separators).

             When this is provided, the `branchCode` is also required.
          type: string
        accountType:
          description: The type of bank account.
          type: string
        bankBicSwift:
          description: The bank's BIC or SWIFT code.
          type: string
        bankCity:
          description: The city where the bank is located.
          type: string
        bankCode:
          description: The bank code of the banking institution with which the bank account is registered.
          type: string
        bankName:
          description: The name of the banking institution where the bank account is held.
          type: string
        branchCode:
          description: |-
            The branch code of the branch under which the bank account is registered.

            Required when you provide an `accountNumber`.

             In the following countries, this value corresponds to:


            * United States: routing number
            * United Kingdom: sort code
            * Germany: Bankleitzahl
          type: string
        checkCode:
          description: The check code of the bank account.
          type: string
        countryCode:
          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**.
          type: string
        currencyCode:
          description: The account's three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **EUR**.
          type: string
        iban:
          description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.
          type: string
      required:
        - currencyCode
      type: object
    BirthData:
      properties:
        dateOfBirth:
          description: The individual's date of birth, in YYYY-MM-DD format.
          type: string
      type: object
    BusinessLine:
      properties:
        capability:
          description: The capability for which you are creating the business line. For example, **receivePayments**.
          type: string
        id:
          description: The unique identifier of the business line.
          readOnly: true
          type: string
        industryCode:
          description: A code that represents the industry of the legal entity. For example, **4431A** for computer software stores.
          type: string
        legalEntityId:
          description: Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line.
          type: string
        salesChannels:
          description: |-
            A list of channels where goods or services are sold.

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

            Required only in combination with the `capability` to **receivePayments** or **receiveFromPlatformPayments**.
          items:
            type: string
          type: array
        sourceOfFunds:
          $ref: "#/components/schemas/SourceOfFunds"
          description: Contains information about the source of your user's funds. Required only for the `capability` to **issueBankAccount**.
        webData:
          description: List of website URLs where your user's goods or services are sold. When this is required for a capability but your user does not have an online presence, provide the reason in the `webDataExemption` object.
          items:
            $ref: "#/components/schemas/WebData"
          type: array
        webDataExemption:
          $ref: "#/components/schemas/WebDataExemption"
          description: The reason why the web data is not provided.
      required:
        - capability
        - industryCode
        - legalEntityId
        - id
      type: object
    BusinessLineInfo:
      properties:
        capability:
          description: The capability for which you are creating the business line. For example, **receivePayments**.
          type: string
        industryCode:
          description: A code that represents the industry of the legal entity. For example, **4431A** for computer software stores.
          type: string
        legalEntityId:
          description: Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line.
          type: string
        salesChannels:
          description: |-
            A list of channels where goods or services are sold.

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

            Required only in combination with the `capability` to **receivePayments** or **receiveFromPlatformPayments**.
          items:
            type: string
          type: array
        sourceOfFunds:
          $ref: "#/components/schemas/SourceOfFunds"
          description: Contains information about the source of your user's funds. Required only for the `capability` to **issueBankAccount**.
        webData:
          description: List of website URLs where your user's goods or services are sold. When this is required for a capability but your user does not have an online presence, provide the reason in the `webDataExemption` object.
          items:
            $ref: "#/components/schemas/WebData"
          type: array
        webDataExemption:
          $ref: "#/components/schemas/WebDataExemption"
          description: The reason why the web data is not provided.
      required:
        - capability
        - industryCode
        - legalEntityId
      type: object
    BusinessLines:
      properties:
        businessLines:
          description: List of business lines.
          items:
            $ref: "#/components/schemas/BusinessLine"
          type: array
      required:
        - businessLines
      type: object
    CapabilityProblem:
      properties:
        entity:
          $ref: "#/components/schemas/CapabilityProblemEntity"
        verificationErrors:
          items:
            $ref: "#/components/schemas/VerificationError"
          type: array
      type: object
    CapabilityProblemEntity:
      properties:
        documents:
          items:
            type: string
          type: array
        id:
          type: string
        owner:
          $ref: "#/components/schemas/CapabilityProblemEntity-recursive"
        type:
          enum:
            - BankAccount
            - Document
            - LegalEntity
          type: string
      type: object
    CapabilityProblemEntity-recursive:
      properties:
        documents:
          items:
            type: string
          type: array
        id:
          type: string
        type:
          enum:
            - BankAccount
            - Document
            - LegalEntity
          type: string
      type: object
    CapabilitySettings:
      properties:
        amountPerIndustry:
          additionalProperties:
            $ref: "#/components/schemas/Amount"
          description: The maximum amount a card holder can spend per industry.
          type: object
        authorizedCardUsers:
          description: The number of card holders who can use the card.
          type: boolean
        fundingSource:
          description: The funding source of the card, for example **debit**.
          items:
            enum:
              - credit
              - debit
              - prepaid
            type: string
          type: array
        interval:
          description: The period when the rule conditions apply.
          enum:
            - daily
            - monthly
            - weekly
          type: string
        maxAmount:
          $ref: "#/components/schemas/Amount"
          description: The maximum amount a card holder can withdraw per day.
      type: object
    Document:
      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:
          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"
          type: array
        creationDate:
          description: The creation date of the document.
          format: date-time
          readOnly: true
          type: string
        description:
          description: Your description for the document.
          type: string
        expiryDate:
          deprecated: true
          description: The expiry date of the document, in YYYY-MM-DD format.
          type: string
          x-deprecatedInVersion: "1"
        fileName:
          description: The filename of the document.
          type: string
        id:
          description: The unique identifier of the document.
          readOnly: true
          type: string
        issuerCountry:
          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**.
          type: string
          x-deprecatedInVersion: "1"
        issuerState:
          deprecated: true
          description: The state or province where the document was issued (AU only).
          type: string
          x-deprecatedInVersion: "1"
        modificationDate:
          description: The modification date of the document.
          format: date-time
          readOnly: true
          type: string
        number:
          description: The number in the document.
          type: string
        owner:
          $ref: "#/components/schemas/OwnerEntity"
          description: Contains information about the resource that owns the document.
        type:
          description: |-
            Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.

            When providing ID numbers:
            * For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.

            When uploading documents:
            * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **taxDocument**, **proofOfOwnership**, or **proofOfIndustry**. 

            * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **proofOfNationalIdNumber**, **proofOfResidency**, or **proofOfIndustry**.

            * 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
            - taxDocument
            - proofOfIndustry
          type: string
      required:
        - type
        - description
        - owner
        - attachments
      type: object
    EntityReference:
      properties:
        id:
          description: The unique identifier of the resource.
          type: string
      type: object
    GeneratePciDescriptionRequest:
      properties:
        language:
          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**.
          type: string
      type: object
    GeneratePciDescriptionResponse:
      properties:
        content:
          contentEncoding: base64
          description: The generated questionnaires in a base64 encoded format.
          type: string
        language:
          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**.
          type: string
        pciTemplateReferences:
          description: The array of Adyen-generated unique identifiers for the questionnaires.
          items:
            type: string
          type: array
      type: object
    GetPciQuestionnaireInfosResponse:
      properties:
        data:
          description: Information about the signed PCI questionnaires.
          items:
            $ref: "#/components/schemas/PciDocumentInfo"
          type: array
      type: object
    GetPciQuestionnaireResponse:
      properties:
        content:
          contentEncoding: base64
          description: The generated questionnaire in a base64 encoded format.
          type: string
        createdAt:
          description: The date the questionnaire was created, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00
          format: date-time
          type: string
        id:
          description: The unique identifier of the signed questionnaire.
          type: string
        validUntil:
          description: The expiration date of the questionnaire, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00
          format: date-time
          type: string
      type: object
    GetTermsOfServiceAcceptanceInfosResponse:
      properties:
        data:
          description: The Terms of Service acceptance information.
          items:
            $ref: "#/components/schemas/TermsOfServiceAcceptanceInfo"
          type: array
      type: object
    GetTermsOfServiceDocumentRequest:
      properties:
        language:
          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. For example, **nl** for Dutch.
          type: string
        type:
          description: The type of Terms of Service.
          enum:
            - adyenAccount
            - adyenCapital
            - adyenCard
            - adyenForPlatformsAdvanced
            - adyenForPlatformsManage
            - adyenFranchisee
            - adyenIssuing
          type: string
      type: object
    GetTermsOfServiceDocumentResponse:
      properties:
        document:
          contentEncoding: base64
          description: The Terms of Service document in Base64-encoded format.
          type: string
        id:
          description: The unique identifier of the legal entity.
          type: string
        language:
          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. For example, **nl** for Dutch.
          type: string
        termsOfServiceDocumentId:
          description: The unique identifier of the Terms of Service document.
          type: string
        type:
          description: The type of Terms of Service.
          enum:
            - adyenAccount
            - adyenCapital
            - adyenCard
            - adyenForPlatformsAdvanced
            - adyenForPlatformsManage
            - adyenFranchisee
            - adyenIssuing
          type: string
      type: object
    IdentificationData:
      properties:
        cardNumber:
          description: The card number of the document that was issued (AU only).
          type: string
        expiryDate:
          deprecated: true
          description: The expiry date of the document, in YYYY-MM-DD format.
          type: string
          x-deprecatedInVersion: "1"
        issuerCountry:
          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**.
          type: string
          x-deprecatedInVersion: "1"
        issuerState:
          description: The state or province where the document was issued (AU only).
          type: string
        nationalIdExempt:
          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.
          type: boolean
        number:
          description: The number in the document.
          type: string
        type:
          description: |-
            Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.

            When providing ID numbers:
            * For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.

            When uploading documents:
            * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **taxDocument**, **proofOfOwnership**, or **proofOfIndustry**. 

            * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **proofOfNationalIdNumber**, **proofOfResidency**, or **proofOfIndustry**.

            * 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
            - taxDocument
            - proofOfIndustry
          type: string
      required:
        - type
      type: object
    Individual:
      properties:
        birthData:
          $ref: "#/components/schemas/BirthData"
          description: The individual's birth information.
        email:
          description: The email address of the legal entity.
          type: string
        identificationData:
          $ref: "#/components/schemas/IdentificationData"
          description: Information about the individual's identification document.
        name:
          $ref: "#/components/schemas/Name"
          description: The individual's name.
        nationality:
          description: The individual's nationality.
          type: string
        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.
        webData:
          $ref: "#/components/schemas/WebData"
          deprecated: true
          description: The website and app URL of the legal entity.
          x-deprecatedInVersion: "1"
      required:
        - name
        - residentialAddress
      type: object
    LegalEntity:
      properties:
        capabilities:
          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.
          readOnly: true
          type: object
        documents:
          deprecated: true
          description: List of documents uploaded for the legal entity.
          items:
            $ref: "#/components/schemas/EntityReference"
          type: array
          x-deprecatedInVersion: "1"
          x-deprecatedMessage: Use the `documentDetails` array instead.
        entityAssociations:
          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"
          type: array
        id:
          description: The unique identifier of the legal entity.
          readOnly: true
          type: string
        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:
          description: Your reference for the legal entity, maximum 150 characters.
          maxLength: 150
          type: string
        transferInstruments:
          description: List of transfer instruments that the legal entity owns.
          items:
            $ref: "#/components/schemas/TransferInstrumentReference"
          readOnly: true
          type: array
        type:
          description: |-
            The type of legal entity.

             Possible values: **individual** or **organization**
          enum:
            - individual
            - organization
          type: string
      required:
        - id
      type: object
    LegalEntityAssociation:
      properties:
        associatorId:
          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
          type: string
        entityType:
          description: |-
            The legal entity type of associated legal entity. 

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

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

            Possible values for sole proprietorships: **soleProprietorship**. 
          enum:
            - signatory
            - uboThroughControl
            - uboThroughOwnership
          type: string
      required:
        - legalEntityId
        - type
      type: object
    LegalEntityCapability:
      properties:
        allowed:
          description: "Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful "
          readOnly: true
          type: boolean
        allowedLevel:
          description: |-
            The capability level that is allowed for the legal entity.

            Possible values: **notApplicable**, **low**, **medium**, **high**.
          enum:
            - high
            - low
            - medium
            - notApplicable
          readOnly: true
          type: string
        allowedSettings:
          $ref: "#/components/schemas/CapabilitySettings"
          description: The settings that were allowed for the Legal Entity.
          readOnly: true
        problems:
          description: Contains verification errors and the actions that you can take to resolve them.
          items:
            $ref: "#/components/schemas/CapabilityProblem"
          readOnly: true
          type: array
        requested:
          description: "Indicates whether the capability is requested. To check whether the Legal Entity is permitted to use the capability, "
          readOnly: true
          type: boolean
        requestedLevel:
          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
          type: string
        requestedSettings:
          $ref: "#/components/schemas/CapabilitySettings"
          description: The settings that are requested for the Legal Entity.
          readOnly: true
        transferInstruments:
          description: Capability status for transfer instruments associated with legal entity
          items:
            $ref: "#/components/schemas/SupportingEntityCapability"
          readOnly: true
          type: array
        verificationStatus:
          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
          type: string
      type: object
    LegalEntityInfo:
      properties:
        capabilities:
          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.
          readOnly: true
          type: object
        entityAssociations:
          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"
          type: array
        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:
          description: Your reference for the legal entity, maximum 150 characters.
          maxLength: 150
          type: string
        type:
          description: |-
            The type of legal entity.

             Possible values: **individual** or **organization**
          enum:
            - individual
            - organization
          type: string
      type: object
    LegalEntityInfoRequiredType:
      properties:
        capabilities:
          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.
          readOnly: true
          type: object
        entityAssociations:
          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"
          type: array
        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:
          description: Your reference for the legal entity, maximum 150 characters.
          maxLength: 150
          type: string
        type:
          description: |-
            The type of legal entity.

             Possible values: **individual** or **organization**
          enum:
            - individual
            - organization
          type: string
      required:
        - type
      type: object
    Name:
      properties:
        firstName:
          description: The individual's first name.
          type: string
        infix:
          description: The infix in the individual's name, if any.
          type: string
        lastName:
          description: The individual's last name.
          type: string
      required:
        - firstName
        - lastName
      type: object
    OnboardingLink:
      properties:
        url:
          description: |-
            The URL of the hosted onboarding page where you need to redirect your user. This URL expires after 4 minutes and can only be used once.

            If the link expires, you need to create a new link.
          type: string
      type: object
    OnboardingLinkInfo:
      properties:
        locale:
          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 values](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted#supported-languages). 

            If 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.
          type: string
        redirectUrl:
          description: The URL where the user is redirected after they complete hosted onboarding.
          type: string
        settings:
          additionalProperties:
            type: boolean
          description: |+
            Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings. By default, the values are set to **true**. Set to **false** to not allow the action.

            Possible keys:

            - **changeLegalEntityType**: The user can change their legal entity type.

            - **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.

          type: object
        themeId:
          description: The unique identifier of the hosted onboarding theme.
          type: string
      type: object
    OnboardingTheme:
      properties:
        createdAt:
          description: The creation date of the theme.
          format: date-time
          type: string
        description:
          description: The description of the theme.
          type: string
        id:
          description: The unique identifier of the theme.
          type: string
        properties:
          additionalProperties:
            type: string
          description: The properties of the theme.
          type: object
        updatedAt:
          description: The date when the theme was last updated.
          format: date-time
          type: string
      required:
        - properties
        - id
        - createdAt
      type: object
    OnboardingThemes:
      properties:
        next:
          description: The next page. Only present if there is a next page.
          type: string
        previous:
          description: The previous page. Only present if there is a previous page.
          type: string
        themes:
          description: List of onboarding themes.
          items:
            $ref: "#/components/schemas/OnboardingTheme"
          type: array
      required:
        - themes
      type: object
    Organization:
      properties:
        description:
          description: Your description for the organization.
          type: string
        doingBusinessAs:
          description: The organization's trading name, if different from the registered legal name.
          type: string
        email:
          description: The email address of the legal entity.
          type: string
        legalName:
          description: The organization's legal name.
          type: string
        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:
          description: The organization's registration number.
          type: string
        stockData:
          $ref: "#/components/schemas/StockData"
          description: Information about the organization's publicly traded stock. Provide this object only if `type` is **listedPublicCompany**.
        taxExempt:
          description: |+
            Indicates whether the legal entity is exempt from tax. When **true**, the `taxIdAbsenceReason` must be provided.

          type: boolean
        taxId:
          description: The organization's tax identifier.
          type: string
        taxIdAbsenceReason:
          description: |-
            The reason the organization has not provided a tax identifier.

            Possible values: **industryExemption**, **belowTaxThreshold**.
          enum:
            - industryExemption
            - belowTaxThreshold
          type: string
        type:
          description: |-
            Type of organization. 

            Possible values: **associationIncorporated**, **governmentalOrganization**, **listedPublicCompany**, **nonProfit**, **partnershipIncorporated**, **privateCompany**.
          enum:
            - associationIncorporated
            - governmentalOrganization
            - listedPublicCompany
            - nonProfit
            - partnershipIncorporated
            - privateCompany
          type: string
        webData:
          $ref: "#/components/schemas/WebData"
          deprecated: true
          description: The website and app URL of the legal entity.
          x-deprecatedInVersion: "1"
      required:
        - legalName
        - registeredAddress
      type: object
    OwnerEntity:
      properties:
        id:
          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: string
        type:
          description: |-
            Type of resource that owns the document.

            Possible values: **legalEntity**, **bankAccount**.
          type: string
      required:
        - id
        - type
      type: object
    PciDocumentInfo:
      properties:
        createdAt:
          description: The date the questionnaire was created, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00
          format: date-time
          type: string
        id:
          description: The unique identifier of the signed questionnaire.
          type: string
        validUntil:
          description: The expiration date of the questionnaire, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00
          format: date-time
          type: string
      type: object
    PciSigningRequest:
      properties:
        pciTemplateReferences:
          description: The array of Adyen-generated unique identifiers for the questionnaires.
          items:
            type: string
          type: array
        signedBy:
          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.
          type: string
      required:
        - signedBy
        - pciTemplateReferences
      type: object
    PciSigningResponse:
      properties:
        pciQuestionnaireIds:
          description: The unique identifiers of the signed PCI documents.
          items:
            type: string
          type: array
        signedBy:
          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.
          type: string
      type: object
    PhoneNumber:
      properties:
        countryCode:
          description: The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. For example, **US** or **NL**.
          type: string
        number:
          description: The phone number.
          type: string
        type:
          description: |-
            The type of phone number.
             Possible values: **mobile**, **landline**, **sip**, **fax.** 
          type: string
      required:
        - type
        - number
      type: object
    RemediatingAction:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    ServiceError:
      properties:
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    SourceOfFunds:
      properties:
        acquiringBusinessLineId:
          description: The unique identifier of the business line that will be the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability.
          type: string
        adyenProcessedFunds:
          description: Indicates whether the funds are coming from transactions processed by Adyen. If **false**, a `description` is required.
          type: boolean
        description:
          description: Text describing 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: string
        type:
          description: "The type of the source of funds. Possible value: **business**."
          enum:
            - business
          type: string
      type: object
    StockData:
      properties:
        marketIdentifier:
          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.
          type: string
        stockNumber:
          description: The 12-digit International Securities Identification Number (ISIN) of the company, without dashes (-).
          type: string
        tickerSymbol:
          description: The stock ticker symbol.
          type: string
      type: object
    SupportingEntityCapability:
      properties:
        allowed:
          description: |-
            Indicates whether the supporting entity capability is allowed.

            If a supporting entity is allowed but its parent legal entity is not, it means there are other supporting entities that failed validation.

            **The allowed supporting entity can still be used**
          readOnly: true
          type: boolean
        id:
          description: "Supporting entity reference "
          readOnly: true
          type: string
        requested:
          description: "Indicates whether the supporting entity capability is requested. "
          readOnly: true
          type: boolean
        verificationStatus:
          description: |
            The status of the verification checks for the supporting entity 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
          type: string
      type: object
    TermsOfServiceAcceptanceInfo:
      properties:
        acceptedBy:
          description: The unique identifier of the user that accepted the Terms of Service.
          type: string
        acceptedFor:
          description: The unique identifier of the legal entity for which the Terms of Service are accepted.
          type: string
        createdAt:
          description: The date when the Terms of Service were accepted.
          format: date-time
          type: string
        id:
          description: An Adyen-generated reference for the accepted Terms of Service.
          type: string
        type:
          description: The type of Terms of Service.
          enum:
            - adyenAccount
            - adyenCapital
            - adyenCard
            - adyenForPlatformsAdvanced
            - adyenForPlatformsManage
            - adyenFranchisee
            - adyenIssuing
          type: string
      type: object
    TransferInstrument:
      properties:
        bankAccount:
          $ref: "#/components/schemas/BankAccountInfo"
          description: Contains information about the legal entity's bank account.
        documents:
          deprecated: true
          description: List of documents uploaded for the transfer instrument.
          items:
            $ref: "#/components/schemas/EntityReference"
          type: array
          x-deprecatedInVersion: "1"
        id:
          description: The unique identifier of the transfer instrument.
          readOnly: true
          type: string
        legalEntityId:
          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: string
        type:
          description: |-
            The type of transfer instrument.

            Possible value: **bankAccount**.
          enum:
            - bankAccount
            - recurringDetail
          type: string
      required:
        - legalEntityId
        - type
        - bankAccount
        - id
      type: object
    TransferInstrumentInfo:
      properties:
        bankAccount:
          $ref: "#/components/schemas/BankAccountInfo"
          description: Contains information about the legal entity's bank account.
        legalEntityId:
          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: string
        type:
          description: |-
            The type of transfer instrument.

            Possible value: **bankAccount**.
          enum:
            - bankAccount
            - recurringDetail
          type: string
      required:
        - legalEntityId
        - type
        - bankAccount
      type: object
    TransferInstrumentReference:
      properties:
        accountIdentifier:
          description: The masked IBAN or bank account number.
          type: string
        id:
          description: The unique identifier of the resource.
          type: string
        realLastFour:
          description: Four last digits of the bank account number.
          type: string
      required:
        - id
        - accountIdentifier
      type: object
    VerificationError:
      properties:
        capabilities:
          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:
            enum:
              - acceptExternalFunding
              - acceptPspFunding
              - acceptTransactionInRestrictedCountries
              - acceptTransactionInRestrictedCountriesCommercial
              - acceptTransactionInRestrictedCountriesConsumer
              - acceptTransactionInRestrictedIndustries
              - acceptTransactionInRestrictedIndustriesCommercial
              - acceptTransactionInRestrictedIndustriesConsumer
              - acquiring
              - atmWithdrawal
              - atmWithdrawalCommercial
              - atmWithdrawalConsumer
              - atmWithdrawalInRestrictedCountries
              - atmWithdrawalInRestrictedCountriesCommercial
              - atmWithdrawalInRestrictedCountriesConsumer
              - authorisedPaymentInstrumentUser
              - getGrantOffers
              - issueBankAccount
              - issueCard
              - issueCardCommercial
              - issueCardConsumer
              - localAcceptance
              - payout
              - payoutToTransferInstrument
              - processing
              - receiveFromBalanceAccount
              - receiveFromPlatformPayments
              - receiveFromThirdParty
              - receiveFromTransferInstrument
              - receiveGrants
              - receivePayments
              - sendToBalanceAccount
              - sendToThirdParty
              - sendToTransferInstrument
              - thirdPartyFunding
              - useCard
              - useCardCommercial
              - useCardConsumer
              - useCardInRestrictedCountries
              - useCardInRestrictedCountriesCommercial
              - useCardInRestrictedCountriesConsumer
              - useCardInRestrictedIndustries
              - useCardInRestrictedIndustriesCommercial
              - useCardInRestrictedIndustriesConsumer
              - withdrawFromAtm
              - withdrawFromAtmCommercial
              - withdrawFromAtmConsumer
              - withdrawFromAtmInRestrictedCountries
              - withdrawFromAtmInRestrictedCountriesCommercial
              - withdrawFromAtmInRestrictedCountriesConsumer
            type: string
          type: array
        code:
          description: The general error code.
          type: string
        message:
          description: The general error message.
          type: string
        remediatingActions:
          description: An object containing possible solutions to fix a verification error.
          items:
            $ref: "#/components/schemas/RemediatingAction"
          type: array
        subErrors:
          description: An array containing more granular information about the cause of the verification error.
          items:
            $ref: "#/components/schemas/VerificationError-recursive"
          type: array
        type:
          description: The type of error.
          enum:
            - dataMissing
            - invalidInput
            - pendingStatus
          type: string
      type: object
    VerificationError-recursive:
      properties:
        capabilities:
          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:
            enum:
              - acceptExternalFunding
              - acceptPspFunding
              - acceptTransactionInRestrictedCountries
              - acceptTransactionInRestrictedCountriesCommercial
              - acceptTransactionInRestrictedCountriesConsumer
              - acceptTransactionInRestrictedIndustries
              - acceptTransactionInRestrictedIndustriesCommercial
              - acceptTransactionInRestrictedIndustriesConsumer
              - acquiring
              - atmWithdrawal
              - atmWithdrawalCommercial
              - atmWithdrawalConsumer
              - atmWithdrawalInRestrictedCountries
              - atmWithdrawalInRestrictedCountriesCommercial
              - atmWithdrawalInRestrictedCountriesConsumer
              - authorisedPaymentInstrumentUser
              - getGrantOffers
              - issueBankAccount
              - issueCard
              - issueCardCommercial
              - issueCardConsumer
              - localAcceptance
              - payout
              - payoutToTransferInstrument
              - processing
              - receiveFromBalanceAccount
              - receiveFromPlatformPayments
              - receiveFromThirdParty
              - receiveFromTransferInstrument
              - receiveGrants
              - receivePayments
              - sendToBalanceAccount
              - sendToThirdParty
              - sendToTransferInstrument
              - thirdPartyFunding
              - useCard
              - useCardCommercial
              - useCardConsumer
              - useCardInRestrictedCountries
              - useCardInRestrictedCountriesCommercial
              - useCardInRestrictedCountriesConsumer
              - useCardInRestrictedIndustries
              - useCardInRestrictedIndustriesCommercial
              - useCardInRestrictedIndustriesConsumer
              - withdrawFromAtm
              - withdrawFromAtmCommercial
              - withdrawFromAtmConsumer
              - withdrawFromAtmInRestrictedCountries
              - withdrawFromAtmInRestrictedCountriesCommercial
              - withdrawFromAtmInRestrictedCountriesConsumer
            type: string
          type: array
        code:
          description: The general error code.
          type: string
        message:
          description: The general error message.
          type: string
        remediatingActions:
          description: An object containing possible solutions to fix a verification error.
          items:
            $ref: "#/components/schemas/RemediatingAction"
          type: array
        type:
          description: The type of error.
          enum:
            - dataMissing
            - invalidInput
            - pendingStatus
          type: string
      type: object
    Void:
      type: object
    VoidResponse:
      type: object
    WebData:
      properties:
        webAddress:
          description: The URL of the website or the app store URL.
          type: string
        webAddressId:
          description: The unique identifier of the web address.
          readOnly: true
          type: string
      type: object
    WebDataExemption:
      properties:
        reason:
          description: "The reason why the web data was not provided. Possible value: **noOnlinePresence**."
          enum:
            - noOnlinePresence
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
  - Legal entities
  - Transfer instruments
  - Business lines
  - Documents
  - Terms of Service
  - Hosted Onboarding
  - PCI questionnaires
