openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute legalEntities API description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```" x-timestamp: '2023-05-30T15:27:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi servers: - url: https://cal-test.adyen.com/cal/services/Account/v6 tags: - name: legalEntities paths: /legalEntities: post: tags: - legalEntities summary: Adyen Create a Legal Entity description: "Creates a legal entity. \n\nThis resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. \n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n" x-addedInVersion: '1' operationId: post-legalEntities x-sortIndex: 1 x-methodName: createLegalEntity security: - BasicAuth: [] - ApiKeyAuth: [] 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' createLegalEntitySolePropNL: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL' createLegalEntitySolePropUS: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS' createTrustAU: $ref: '#/components/examples/post-legalEntities-createTrustAU' schema: $ref: '#/components/schemas/LegalEntityInfoRequiredType' parameters: - description: Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment. example: '1_3004' name: x-requested-verification-code in: header schema: type: string 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' createLegalEntitySolePropNL: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropNL-200' createLegalEntitySolePropUS: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS-200' createTrustAU: $ref: '#/components/examples/post-legalEntities-createTrustAU-200' schema: $ref: '#/components/schemas/LegalEntity' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities400Example: summary: Default post-legalEntities 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities401Example: summary: Default post-legalEntities 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities403Example: summary: Default post-legalEntities 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities422Example: summary: Default post-legalEntities 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities500Example: summary: Default post-legalEntities 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}: get: tags: - legalEntities summary: Adyen Get a Legal Entity description: Returns a legal entity. x-addedInVersion: '1' operationId: get-legalEntities-id x-sortIndex: 2 x-methodName: getLegalEntity security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the legal entity. name: id in: path 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' examples: get-legalEntities-id400Example: summary: Default get-legalEntities-id 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id401Example: summary: Default get-legalEntities-id 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id403Example: summary: Default get-legalEntities-id 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id422Example: summary: Default get-legalEntities-id 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id500Example: summary: Default get-legalEntities-id 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK patch: tags: - legalEntities summary: Adyen Update a Legal Entity description: "Updates a legal entity.\n\n >To change the legal entity type, include only the new `type` in your request. 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." x-addedInVersion: '1' operationId: patch-legalEntities-id x-sortIndex: 3 x-methodName: updateLegalEntity security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: changeLegalEntityType: $ref: '#/components/examples/patch-legalEntities-id-changeLegalEntityType' updateLegalEntityOrganization: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization' updateLegalEntitySoleProp: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp' updateTrustMember: $ref: '#/components/examples/patch-legalEntities-id-updateTrustMember' updateTrustMemberExempt: $ref: '#/components/examples/patch-legalEntities-id-updateTrustMemberExempt' schema: $ref: '#/components/schemas/LegalEntityInfo' parameters: - description: The unique identifier of the legal entity. name: id in: path required: true schema: type: string - description: Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment. example: '0_0001' name: x-requested-verification-code in: header schema: type: string responses: '200': content: application/json: examples: changeLegalEntityType: $ref: '#/components/examples/patch-legalEntities-id-changeLegalEntityType-200' updateLegalEntityOrganization: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization-200' updateLegalEntitySoleProp: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp-200' updateTrustMember: $ref: '#/components/examples/patch-legalEntities-id-updateTrustMember-200' updateTrustMemberExempt: $ref: '#/components/examples/patch-legalEntities-id-updateTrustMemberExempt-200' schema: $ref: '#/components/schemas/LegalEntity' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id400Example: summary: Default patch-legalEntities-id 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id401Example: summary: Default patch-legalEntities-id 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id403Example: summary: Default patch-legalEntities-id 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id422Example: summary: Default patch-legalEntities-id 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id500Example: summary: Default patch-legalEntities-id 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/businessLines: get: tags: - legalEntities summary: Adyen Get All Business Lines Under a Legal Entity description: Returns the business lines owned by a legal entity. x-addedInVersion: '1' operationId: get-legalEntities-id-businessLines x-sortIndex: 4 x-methodName: getAllBusinessLinesUnderLegalEntity security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the legal entity. name: id in: path 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' examples: get-legalEntities-id-businessLines400Example: summary: Default get-legalEntities-id-businessLines 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-businessLines401Example: summary: Default get-legalEntities-id-businessLines 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-businessLines403Example: summary: Default get-legalEntities-id-businessLines 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-businessLines422Example: summary: Default get-legalEntities-id-businessLines 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-businessLines500Example: summary: Default get-legalEntities-id-businessLines 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/checkVerificationErrors: post: tags: - legalEntities summary: Adyen Check a Legal Entity's Verification Errors description: Returns the verification errors for a legal entity and its supporting entities. x-addedInVersion: '3' operationId: post-legalEntities-id-checkVerificationErrors x-sortIndex: 2 x-methodName: checkLegalEntitysVerificationErrors security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the legal entity. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: checkVerificationErrors: $ref: '#/components/examples/post-legalEntities-id-checkVerificationErrors-checkVerificationErrors-200' schema: $ref: '#/components/schemas/VerificationErrors' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-checkVerificationErrors400Example: summary: Default post-legalEntities-id-checkVerificationErrors 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-checkVerificationErrors401Example: summary: Default post-legalEntities-id-checkVerificationErrors 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-checkVerificationErrors403Example: summary: Default post-legalEntities-id-checkVerificationErrors 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-checkVerificationErrors422Example: summary: Default post-legalEntities-id-checkVerificationErrors 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-checkVerificationErrors500Example: summary: Default post-legalEntities-id-checkVerificationErrors 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/confirmDataReview: post: tags: - legalEntities summary: Adyen Confirm Data Review description: Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request. x-addedInVersion: '3' operationId: post-legalEntities-id-confirmDataReview x-sortIndex: 22 x-methodName: confirmDataReview security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the legal entity. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: confirmDataReview: $ref: '#/components/examples/post-legalEntities-id-confirmDataReview-confirmDataReview-200' schema: $ref: '#/components/schemas/DataReviewConfirmationResponse' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-confirmDataReview400Example: summary: Default post-legalEntities-id-confirmDataReview 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-confirmDataReview401Example: summary: Default post-legalEntities-id-confirmDataReview 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-confirmDataReview403Example: summary: Default post-legalEntities-id-confirmDataReview 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-confirmDataReview422Example: summary: Default post-legalEntities-id-confirmDataReview 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-confirmDataReview500Example: summary: Default post-legalEntities-id-confirmDataReview 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/onboardingLinks: post: tags: - legalEntities summary: Adyen Get a Link to an Adyen-hosted Onboarding Page description: 'Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ' x-addedInVersion: '1' operationId: post-legalEntities-id-onboardingLinks x-sortIndex: 1 x-methodName: getLinkToAdyenhostedOnboardingPage security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: createOnboardingLink: $ref: '#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink' schema: $ref: '#/components/schemas/OnboardingLinkInfo' parameters: - description: The unique identifier of the legal entity name: id in: path required: true schema: type: string 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' examples: post-legalEntities-id-onboardingLinks400Example: summary: Default post-legalEntities-id-onboardingLinks 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-onboardingLinks401Example: summary: Default post-legalEntities-id-onboardingLinks 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-onboardingLinks403Example: summary: Default post-legalEntities-id-onboardingLinks 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-onboardingLinks422Example: summary: Default post-legalEntities-id-onboardingLinks 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-onboardingLinks500Example: summary: Default post-legalEntities-id-onboardingLinks 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/pciQuestionnaires: get: tags: - legalEntities summary: Adyen Get PCI Questionnaire Details description: Get a list of signed PCI questionnaires. x-addedInVersion: '1' operationId: get-legalEntities-id-pciQuestionnaires x-sortIndex: 3 x-methodName: getPciQuestionnaireDetails security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the legal entity to get PCI questionnaire information. name: id in: path 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' examples: get-legalEntities-id-pciQuestionnaires400Example: summary: Default get-legalEntities-id-pciQuestionnaires 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires401Example: summary: Default get-legalEntities-id-pciQuestionnaires 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires403Example: summary: Default get-legalEntities-id-pciQuestionnaires 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires422Example: summary: Default get-legalEntities-id-pciQuestionnaires 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires500Example: summary: Default get-legalEntities-id-pciQuestionnaires 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/pciQuestionnaires/generatePciTemplates: post: tags: - legalEntities summary: Adyen Generate PCI Questionnaire description: Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels). x-addedInVersion: '1' operationId: post-legalEntities-id-pciQuestionnaires-generatePciTemplates x-sortIndex: 1 x-methodName: generatePciQuestionnaire security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: createPciQuestionnaire: $ref: '#/components/examples/post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire' schema: $ref: '#/components/schemas/GeneratePciDescriptionRequest' parameters: - description: The unique identifier of the legal entity to get PCI questionnaire information. name: id in: path required: true schema: type: string 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' examples: post-legalEntities-id-pciQuestionnaires-generatePciTemplates400Example: summary: Default post-legalEntities-id-pciQuestionnaires-generatePciTemplates 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-generatePciTemplates401Example: summary: Default post-legalEntities-id-pciQuestionnaires-generatePciTemplates 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-generatePciTemplates403Example: summary: Default post-legalEntities-id-pciQuestionnaires-generatePciTemplates 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-generatePciTemplates422Example: summary: Default post-legalEntities-id-pciQuestionnaires-generatePciTemplates 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-generatePciTemplates500Example: summary: Default post-legalEntities-id-pciQuestionnaires-generatePciTemplates 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/pciQuestionnaires/signPciTemplates: post: tags: - legalEntities summary: Adyen Sign PCI Questionnaire description: Signs the required PCI questionnaire. x-addedInVersion: '1' operationId: post-legalEntities-id-pciQuestionnaires-signPciTemplates x-sortIndex: 2 x-methodName: signPciQuestionnaire security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: signPciQuestionnaire: $ref: '#/components/examples/post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire' schema: $ref: '#/components/schemas/PciSigningRequest' parameters: - description: The legal entity ID of the user that has a contractual relationship with your platform. name: id in: path required: true schema: type: string 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' examples: post-legalEntities-id-pciQuestionnaires-signPciTemplates400Example: summary: Default post-legalEntities-id-pciQuestionnaires-signPciTemplates 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-signPciTemplates401Example: summary: Default post-legalEntities-id-pciQuestionnaires-signPciTemplates 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-signPciTemplates403Example: summary: Default post-legalEntities-id-pciQuestionnaires-signPciTemplates 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-signPciTemplates422Example: summary: Default post-legalEntities-id-pciQuestionnaires-signPciTemplates 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-pciQuestionnaires-signPciTemplates500Example: summary: Default post-legalEntities-id-pciQuestionnaires-signPciTemplates 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/pciQuestionnaires/{pciid}: get: tags: - legalEntities summary: Adyen Get PCI Questionnaire description: Returns the signed PCI questionnaire. x-addedInVersion: '1' operationId: get-legalEntities-id-pciQuestionnaires-pciid x-sortIndex: 4 x-methodName: getPciQuestionnaire security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The legal entity ID of the individual who signed the PCI questionnaire. name: id in: path required: true schema: type: string - description: The unique identifier of the signed PCI questionnaire. name: pciid in: path 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' examples: get-legalEntities-id-pciQuestionnaires-pciid400Example: summary: Default get-legalEntities-id-pciQuestionnaires-pciid 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires-pciid401Example: summary: Default get-legalEntities-id-pciQuestionnaires-pciid 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires-pciid403Example: summary: Default get-legalEntities-id-pciQuestionnaires-pciid 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires-pciid422Example: summary: Default get-legalEntities-id-pciQuestionnaires-pciid 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-pciQuestionnaires-pciid500Example: summary: Default get-legalEntities-id-pciQuestionnaires-pciid 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/termsOfService: post: tags: - legalEntities summary: Adyen Get Terms of Service Document description: Returns the Terms of Service document for a legal entity. x-addedInVersion: '1' operationId: post-legalEntities-id-termsOfService x-sortIndex: 1 x-methodName: getTermsOfServiceDocument security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: createTermsofService: $ref: '#/components/examples/post-legalEntities-id-termsOfService-createTermsofService' schema: $ref: '#/components/schemas/GetTermsOfServiceDocumentRequest' parameters: - description: The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. name: id in: path required: true schema: type: string 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' examples: post-legalEntities-id-termsOfService400Example: summary: Default post-legalEntities-id-termsOfService 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-termsOfService401Example: summary: Default post-legalEntities-id-termsOfService 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-termsOfService403Example: summary: Default post-legalEntities-id-termsOfService 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-termsOfService422Example: summary: Default post-legalEntities-id-termsOfService 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: post-legalEntities-id-termsOfService500Example: summary: Default post-legalEntities-id-termsOfService 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/termsOfService/{termsofservicedocumentid}: patch: tags: - legalEntities summary: Adyen Accept Terms of Service description: Accepts Terms of Service. x-addedInVersion: '1' operationId: patch-legalEntities-id-termsOfService-termsofservicedocumentid x-sortIndex: 2 x-methodName: acceptTermsOfService security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: updateTermsofService: $ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService' schema: $ref: '#/components/schemas/AcceptTermsOfServiceRequest' parameters: - description: The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. name: id in: path required: true schema: type: string - description: The unique identifier of the Terms of Service document. name: termsofservicedocumentid in: path required: true schema: type: string responses: '200': content: application/json: examples: updateTermsofService: $ref: '#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200' schema: $ref: '#/components/schemas/AcceptTermsOfServiceResponse' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id-termsOfService-termsofservicedocumentid400Example: summary: Default patch-legalEntities-id-termsOfService-termsofservicedocumentid 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id-termsOfService-termsofservicedocumentid401Example: summary: Default patch-legalEntities-id-termsOfService-termsofservicedocumentid 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id-termsOfService-termsofservicedocumentid403Example: summary: Default patch-legalEntities-id-termsOfService-termsofservicedocumentid 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id-termsOfService-termsofservicedocumentid422Example: summary: Default patch-legalEntities-id-termsOfService-termsofservicedocumentid 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: patch-legalEntities-id-termsOfService-termsofservicedocumentid500Example: summary: Default patch-legalEntities-id-termsOfService-termsofservicedocumentid 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/termsOfServiceAcceptanceInfos: get: tags: - legalEntities summary: Adyen Get Terms of Service Information for a Legal Entity description: Returns Terms of Service information for a legal entity. x-addedInVersion: '1' operationId: get-legalEntities-id-termsOfServiceAcceptanceInfos x-sortIndex: 3 x-methodName: getTermsOfServiceInformationForLegalEntity security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. name: id in: path 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' examples: get-legalEntities-id-termsOfServiceAcceptanceInfos400Example: summary: Default get-legalEntities-id-termsOfServiceAcceptanceInfos 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceAcceptanceInfos401Example: summary: Default get-legalEntities-id-termsOfServiceAcceptanceInfos 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceAcceptanceInfos403Example: summary: Default get-legalEntities-id-termsOfServiceAcceptanceInfos 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceAcceptanceInfos422Example: summary: Default get-legalEntities-id-termsOfServiceAcceptanceInfos 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceAcceptanceInfos500Example: summary: Default get-legalEntities-id-termsOfServiceAcceptanceInfos 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /legalEntities/{id}/termsOfServiceStatus: get: tags: - legalEntities summary: Adyen Get Terms of Service Status description: Returns the required types of Terms of Service that need to be accepted by a legal entity. x-addedInVersion: '1' operationId: get-legalEntities-id-termsOfServiceStatus x-sortIndex: 4 x-methodName: getTermsOfServiceStatus security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. name: id in: path required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-legalEntities-id-termsOfServiceStatus-success-200' schema: $ref: '#/components/schemas/CalculateTermsOfServiceStatusResponse' description: OK - the request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceStatus400Example: summary: Default get-legalEntities-id-termsOfServiceStatus 400 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Bad Request - a problem reading or understanding the request. '401': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceStatus401Example: summary: Default get-legalEntities-id-termsOfServiceStatus 401 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unauthorized - authentication required. '403': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceStatus403Example: summary: Default get-legalEntities-id-termsOfServiceStatus 403 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Forbidden - insufficient permissions to process the request. '422': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceStatus422Example: summary: Default get-legalEntities-id-termsOfServiceStatus 422 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Unprocessable Entity - a request validation error. '500': content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: get-legalEntities-id-termsOfServiceStatus500Example: summary: Default get-legalEntities-id-termsOfServiceStatus 500 response x-microcks-default: true value: errorCode: CODE123 errorType: standard message: example_value pspReference: REF-001 status: 500 description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: examples: post-legalEntities-id-onboardingLinks-createOnboardingLink: summary: Create a hosted onboarding link description: Example request for creating a hosted onboarding link value: themeId: YOUR_THEME_ID redirectUrl: https://your.redirect-url.com/ locale: nl-NL post-legalEntities-id-checkVerificationErrors-checkVerificationErrors-200: summary: Verification errors for a legal entity description: Example response when checking the verification errors of a legal entity value: problems: - entity: id: LE00000000000000000000001 type: LegalEntity verificationErrors: - capabilities: - receivePayments - sendToTransferInstrument code: '2_8179' message: '''vatNumber'' was missing.' remediatingActions: - code: '2_158' message: Add 'organization.vatNumber' to legal entity. type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8067' message: '''Signatory'' was missing.' remediatingActions: - code: '2_124' message: Add 'organization.entityAssociations' of type 'signatory' to legal entity type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8189' message: '''UBO through control'' was missing.' remediatingActions: - code: '2_151' message: Add 'organization.entityAssociations' of type 'uboThroughControl' to legal entity type: dataMissing - capabilities: - receivePayments code: '2_8190' message: '''businessLine'' was missing.' remediatingActions: - code: '2_136' message: Add business line type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8021' message: '''individual.residentialAddress.postalCode'' was missing.' remediatingActions: - code: '2_108' message: Add 'individual.residentialAddress.postalCode' to legal entity type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8064' message: '''UBO through ownership'' was missing.' remediatingActions: - code: '2_123' message: Add 'organization.entityAssociations' of type 'uboThroughOwnership' to legal entity type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8141' message: '''Registration document'' was missing.' remediatingActions: - code: '1_501' message: Upload a registration document type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8019' message: '''individual.residentialAddress.street'' was missing.' remediatingActions: - code: '2_106' message: Add 'individual.residentialAddress.street' to legal entity type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8020' message: '''individual.residentialAddress.city'' was missing.' remediatingActions: - code: '2_107' message: Add 'individual.residentialAddress.city' to legal entity type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8045' message: '''organization.taxId'' was missing.' remediatingActions: - code: '2_118' message: Add 'organization.taxId' to legal entity type: dataMissing - capabilities: - receivePayments - sendToTransferInstrument code: '2_8043' message: '''organization.registrationNumber'' was missing.' remediatingActions: - code: '2_117' message: Add 'organization.registrationNumber' to legal entity type: dataMissing get-legalEntities-id-businessLines-success-200: summary: List of business lines for a legal entity description: Example response when getting the list of business lines for a legal entity value: businessLines: - service: banking industryCode: '55' legalEntityId: LE00000000000000000000001 sourceOfFunds: adyenProcessedFunds: false description: Funds from my flower shop business type: business webData: - webAddress: https://www.adyen.com webAddressId: SE577HA334222K5H8V87B3BPU id: SE322JV223222F5GVGMLNB83F - service: paymentProcessing industryCode: 339E legalEntityId: LE00000000000000000000001 salesChannels: - eCommerce - ecomMoto webData: - webAddress: https://yoururl.com webAddressId: SE908HJ723222F5GVGPNR55YH id: SE322JV223222F5GVGPNRB9GJ post-legalEntities-id-termsOfService-createTermsofService-200: summary: Terms of Service document returned description: Example response for getting a Terms of Service document value: id: LE00000000000000000000001 type: adyenIssuing language: en document: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC== termsOfServiceDocumentId: abc123 post-legalEntities-createTrustAU: summary: Create a legal entity for a trust in Australia description: Example request for creating a legal entity for a trust in Australia value: type: trust trust: name: Example Trust type: fixedUnitTrust doingBusinessAs: West's Store countryOfGoverningLaw: AU taxInformation: - country: AU type: ABN number: '12345678123' registeredAddress: street: Winfield Avenue city: Sydney postalCode: '1197' stateOrProvince: NSW country: AU undefinedBeneficiaryInfo: - description: My future children patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService-200: summary: Terms of Service document accepted description: Example response when accepting a Terms of Service document value: acceptedBy: LE00000000000000000000002 id: TOSA000AB00000000B2AAAB2BA0AA0 language: en termsOfServiceDocumentId: abc123 type: adyenIssuing post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire-200: summary: PCI questionnaires signed description: Example response for signing PCI questionnaires value: pciQuestionnaireIds: - PCID422GZ22322565HHMH48CW63CPH - PCID422GZ22322565HHMH49CW75Z9H post-legalEntities-createLegalEntityIndividualUS-200: summary: Individual legal entity created description: Example response for creating a legal entity for an individual residing in the US value: individual: email: s.eller@example.com phone: number: '+14153671502' type: mobile birthData: dateOfBirth: '1990-06-21' name: firstName: Shelly lastName: Eller residentialAddress: city: New York country: US postalCode: '10003' stateOrProvince: NY street: 71 5th Avenue street2: 11th floor type: individual id: LE00000000000000000000001 post-legalEntities-createLegalEntityOrganizationUS: summary: Create a legal entity for an organization in the US description: Example request for creating a legal entity for an organization operating in the US value: type: organization organization: legalName: Explorer Company based in US registrationNumber: '101002749' type: privateCompany registeredAddress: city: New York country: US postalCode: '10003' stateOrProvince: NY street: 71 5th Avenue street2: 11th floor patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService: summary: Accept the Terms of Service document description: Example request for accepting the Terms of Service document value: acceptedBy: LE00000000000000000000002 patch-legalEntities-id-updateTrustMember: summary: Associate a trust member with a trust description: Example request associating a trust member with a trust value: entityAssociations: - legalEntityId: LE00000000000000000000002 type: protector post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200: summary: PCI questionnaires returned description: Example response for getting PCI questionnaires value: content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC== language: fr pciTemplateReferences: - PCIT-T7KC6VGL - PCIT-PKB6DKS4 post-legalEntities-createLegalEntityOrganizationUS-200: summary: Organization legal entity created description: Example response for creating a legal entity for an organization operating in the US value: organization: legalName: Explorer Company based in US registrationNumber: '101002749' registeredAddress: city: New York country: US postalCode: '10003' stateOrProvince: NY street: 71 5th Avenue street2: 11th floor type: privateCompany type: organization id: LE00000000000000000000001 post-legalEntities-id-onboardingLinks-createOnboardingLink-200: summary: Hosted onboarding link created description: Example response for a hosted onboarding link value: url: https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL patch-legalEntities-id-changeLegalEntityType: summary: Change a legal entity from an organization to an individual description: Example request when changing the legal entity type value: type: individual get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200: summary: Terms of Service information for a legal entity description: Example response when getting Terms of Service information for a legal entity value: data: - acceptedBy: LE00000000000000000000002 acceptedFor: LE00000000000000000000001 createdAt: '2022-12-05T13:36:58.212253Z' id: TOSA000AB00000000B2AAAB2BA0AA0 type: adyenIssuing post-legalEntities-createLegalEntitySolePropNL: summary: Create a legal entity for a Dutch sole proprietor description: Example request for creating a legal entity for a sole proprietor operating in the Netherlands value: type: soleProprietorship soleProprietorship: name: Shelly Seller Sole Trader countryOfGoverningLaw: NL registeredAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 post-legalEntities-id-termsOfService-createTermsofService: summary: Get the Terms of Service document description: Example request for getting the Terms of Service document value: type: adyenIssuing language: en post-legalEntities-createLegalEntityIndividualNL-200: summary: Individual legal entity created description: Example response for creating a legal entity for an individual residing in the Netherlands value: individual: email: s.eller@example.com birthData: dateOfBirth: '1990-06-21' name: firstName: Shelly lastName: Eller residentialAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 type: individual id: LE00000000000000000000001 get-legalEntities-id-termsOfServiceStatus-success-200: summary: Terms of Service status for a legal entity description: Example response when getting the type of Terms of Service value: termsOfServiceTypes: - adyenIssuing patch-legalEntities-id-updateLegalEntitySoleProp-200: summary: Entity association added to a sole proprietorship description: Example response for adding an entity association to a sole proprietorship value: entityAssociations: - associatorId: LE00000000000000000000001 entityType: soleProprietorship legalEntityId: LE00000000000000000000002 type: soleProprietorship individual: email: s.eller@example.com birthData: dateOfBirth: '1990-06-21' name: firstName: Shelly lastName: Eller residentialAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 type: individual id: LE00000000000000000000001 get-legalEntities-id-pciQuestionnaires-pciid-success-200: summary: Details of a PCI questionnaire description: Example response when getting the details of a PCI questionnaire value: content: JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC== createdAt: '2023-03-02T17:54:19.538365Z' id: PCID422GZ22322565HHMH48CW63CPH validUntil: '2024-03-01T17:54:19.538365Z' patch-legalEntities-id-updateTrustMemberExempt-200: summary: Exempt settlor associated description: Example response for associating an exempt settlor with a trust value: entityAssociations: - associatorId: LE00000000000000000000001 legalEntityId: LE00000000000000000000002 type: settlor entityType: individual settlorExemptionReason: - deceased - professionalServiceProvider trust: name: Example Trust type: fixedUnitTrust doingBusinessAs: West's Store countryOfGoverningLaw: AU taxInformation: - country: AU type: ABN number: '12345678901' registeredAddress: street: Winfield Avenue city: Sydney postalCode: '1197' stateOrProvince: NSW country: AU undefinedBeneficiaryInfo: - description: My future children type: trust id: LE00000000000000000000001 post-legalEntities-createLegalEntitySolePropNL-200: summary: Sole proprietor legal enity created description: Example response for creating a legal entity for a sole proprietor operating in the Netherlands value: type: soleProprietorship soleProprietorship: name: Shelly Seller Sole Trader countryOfGoverningLaw: NL registeredAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 id: LE00000000000000000000001 patch-legalEntities-id-updateLegalEntitySoleProp: summary: Add entity associations to a sole proprietorship description: Example request adding an entity association to a sole proprietorship value: entityAssociations: - legalEntityId: LE00000000000000000000002 type: soleProprietorship patch-legalEntities-id-updateLegalEntityOrganization-200: summary: Entity associations added description: Example response for adding an entity association to an organization value: entityAssociations: - associatorId: LE00000000000000000000001 entityType: individual jobTitle: CEO legalEntityId: LE00000000000000000000002 name: Simone Hopper type: uboThroughControl organization: email: john.doe@adyen.com phone: countryCode: NL number: '646467363' type: mobile description: FinTech doingBusinessAs: Adyen BV legalName: Adyen BV registeredAddress: city: AMS country: NL postalCode: 1234EE stateOrProvince: NH street: Simon Carmiggeltstraat 6 - 50 registrationNumber: '' stockData: marketIdentifier: ADYN stockNumber: NL012345ABC4 tickerSymbol: ADYN.M type: listedPublicCompany type: organization id: LE00000000000000000000001 post-legalEntities-createLegalEntityOrganizationNL: summary: Create a legal entity for a Dutch organization description: Example request for creating a legal entity for an organization operating in the Netherlands value: type: organization organization: legalName: Explorer Company based in NL doingBusinessAs: API Company Trading type: privateCompany registeredAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 registrationNumber: '34179503' email: organization@example.com entityAssociations: - jobTitle: CEO legalEntityId: LE00000000000000000000001 type: signatory post-legalEntities-createLegalEntitySolePropUS: summary: Create a legal entity for a sole proprietor in the US description: Example request for creating a legal entity for a sole proprietor operating in the US value: type: soleProprietorship soleProprietorship: name: Shelly Eller Sole Trader countryOfGoverningLaw: US registeredAddress: city: New York country: US postalCode: '10003' stateOrProvince: NY street: 71 5th Avenue street2: 11th floor patch-legalEntities-id-changeLegalEntityType-200: summary: Legal entity type changed description: Example response when changing the legal entity type value: individual: name: firstName: Explorer lastName: Company based in US residentialAddress: country: US type: individual id: LE00000000000000000000001 post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire: summary: Generate PCI questionnaires description: Example request for generating PCI questionnaires in French value: language: fr post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire: summary: Sign PCI questionnaires description: Example request for signing PCI questionnaires value: signedBy: LE00000000000000000000002 pciTemplateReferences: - PCIT-T7KC6VGL - PCIT-PKB6DKS4 post-legalEntities-id-confirmDataReview-confirmDataReview-200: summary: Data review for a legal entity description: Example response when reviewing the data for a legal entity value: dataReviewedAt: '2023-11-13T15:19:02Z' patch-legalEntities-id-updateTrustMember-200: summary: Trust member associated description: Example response for associating a trust member with a trust value: entityAssociations: - associatorId: LE00000000000000000000001 legalEntityId: LE00000000000000000000002 name: Simone Hopper type: protector trust: name: Example Trust type: fixedUnitTrust doingBusinessAs: West's Store countryOfGoverningLaw: AU taxInformation: - country: AU type: ABN number: '12345678901' registeredAddress: street: Winfield Avenue city: Sydney postalCode: '1197' stateOrProvince: NSW country: AU undefinedBeneficiaryInfo: - description: My future children type: trust id: LE00000000000000000000001 post-legalEntities-createLegalEntitySolePropUS-200: summary: Sole proprietor legal enity created description: Example response for creating a legal entity for a sole proprietor operating in the US value: type: soleProprietorship soleProprietorship: name: Shelly Eller Sole Trader countryOfGoverningLaw: US registeredAddress: city: New York country: US postalCode: '10003' stateOrProvince: NY street: 71 5th Avenue street2: 11th floor id: LE00000000000000000000001 patch-legalEntities-id-updateLegalEntityOrganization: summary: Add entity associations to an organization description: Example request adding entity associations to a legal entity value: entityAssociations: - jobTitle: CEO legalEntityId: LE00000000000000000000002 type: uboThroughControl get-legalEntities-id-success-200: summary: Details of a legal entity description: Example response when getting the details of a legal entity value: capabilities: sendToTransferInstrument: allowed: false requested: true transferInstruments: - allowed: false id: SE322KH223222F5GXZFNM3BGP requested: true verificationStatus: pending verificationStatus: pending receivePayments: allowed: false requested: true verificationStatus: pending sendToBalanceAccount: allowed: false requested: true verificationStatus: pending receiveFromPlatformPayments: allowed: false requested: true verificationStatus: pending receiveFromBalanceAccount: allowed: false requested: true verificationStatus: pending individual: email: s.hopper@example.com birthData: dateOfBirth: '1990-06-21' name: firstName: Simone lastName: Hopper residentialAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 street2: '274' type: individual id: YOUR_LEGAL_ENTITY transferInstruments: - id: SE322KH223222F5GXZFNM3BGP accountIdentifier: NL**ABNA******0123 trustedSource: false post-legalEntities-createTrustAU-200: summary: Trust legal entity created description: Example response for creating a legal entity for a trust in Australia value: trust: countryOfGoverningLaw: AU doingBusinessAs: West's Store name: Example Trust registeredAddress: city: Sydney country: AU postalCode: '1197' stateOrProvince: NSW street: Winfield Avenue taxInformation: - country: AU number: '12345678901' type: ABN type: fixedUnitTrust undefinedBeneficiaryInfo: - description: My future children reference: SE322KH223222J5HJ6JRB75HQ type: trust id: LE322KH223222J5HJ6JRB75C5 get-legalEntities-id-pciQuestionnaires-success-200: summary: Details of PCI questionnaires signed by a user description: Example response when getting the list of PCI questionnaires value: data: - createdAt: '2023-03-02T17:54:19.538365Z' id: PCID422GZ22322565HHMH48CW63CPH validUntil: '2024-03-01T17:54:19.538365Z' - createdAt: '2023-03-02T17:54:19.538365Z' id: PCID422GZ22322565HHMH49CW75Z9H validUntil: '2024-03-01T17:54:19.538365Z' post-legalEntities-createLegalEntityIndividualNL: summary: Create a legal entity for an individual residing in the Netherlands description: Example request for creating a legal entity for an individual residing in the Netherlands value: type: individual individual: residentialAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 name: firstName: Shelly lastName: Eller birthData: dateOfBirth: '1990-06-21' email: s.eller@example.com patch-legalEntities-id-updateTrustMemberExempt: summary: Associate an exempt settlor with a trust description: Example request associating an exempt settlor with a trust value: entityAssociations: - legalEntityId: LE00000000000000000000002 type: settlor entityType: individual settlorExemptionReason: - deceased - professionalServiceProvider post-legalEntities-createLegalEntityOrganizationNL-200: summary: Organization legal entity created description: Example response for creating a legal entity for an organization operating in the Netherlands value: entityAssociations: - associatorId: LE00000000000000000000002 entityType: individual jobTitle: CEO legalEntityId: LE00000000000000000000001 name: Simone Hopper type: signatory organization: email: organization@example.com doingBusinessAs: API Company Trading legalName: Explorer Company based in NL registeredAddress: city: Amsterdam country: NL postalCode: 1011DJ street: Simon Carmiggeltstraat 6 - 50 registrationNumber: '34179503' type: privateCompany type: organization id: LE00000000000000000000002 post-legalEntities-createLegalEntityIndividualUS: summary: Create a legal entity for an individual residing in the US description: Example request for creating a legal entity for an individual residing in the US value: type: individual individual: residentialAddress: city: New York country: US postalCode: '10003' stateOrProvince: NY street: 71 5th Avenue street2: 11th floor phone: number: '+14153671502' type: mobile name: firstName: Shelly lastName: Eller birthData: dateOfBirth: '1990-06-21' email: s.eller@example.com schemas: 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 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 BusinessLines: properties: businessLines: description: List of business lines. items: $ref: '#/components/schemas/BusinessLine' type: array required: - businessLines type: object DataReviewConfirmationResponse: properties: dataReviewedAt: description: Date when data review was confirmed. 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: description: Information about the individual. Required if `type` is **individual**. $ref: '#/components/schemas/Individual' organization: description: Information about the organization. Required if `type` is **organization**. $ref: '#/components/schemas/Organization' reference: description: Your reference for the legal entity, maximum 150 characters. maxLength: 150 type: string soleProprietorship: x-addedInVersion: '2' description: Information about the sole proprietorship. Required if `type` is **soleProprietorship**. $ref: '#/components/schemas/SoleProprietorship' trust: description: Information about the trust. Required if `type` is **trust**. $ref: '#/components/schemas/Trust' type: description: 'The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**.' enum: - individual - organization - soleProprietorship - trust - unincorporatedPartnership type: string unincorporatedPartnership: description: Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**. $ref: '#/components/schemas/UnincorporatedPartnership' verificationPlan: description: A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). type: string 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. Possible value: **en** for English.' type: string type: description: 'The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** ' enum: - adyenAccount - adyenCapital - adyenCard - adyenForPlatformsAdvanced - adyenForPlatformsManage - adyenFranchisee - adyenIssuing type: string required: - type - language type: object GeneratePciDescriptionRequest: properties: additionalSalesChannels: description: 'An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/create-stores/) and [add payment methods](https://docs.adyen.com/marketplaces-and-platforms/payment-methods/) before you generate the questionnaires. Possible values: * **eCommerce** * **pos** * **ecomMoto** * **posMoto** ' items: enum: - eCommerce - ecomMoto - pos - posMoto type: string type: array 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 BirthData: properties: dateOfBirth: description: The individual's date of birth, in YYYY-MM-DD format. type: string type: object GetTermsOfServiceAcceptanceInfosResponse: properties: data: description: The Terms of Service acceptance information. items: $ref: '#/components/schemas/TermsOfServiceAcceptanceInfo' type: array 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 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 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. If the transfer instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding), and it is a virtual bank account, these digits may be different from the last four digits of the masked account number. type: string trustedSource: description: Identifies if the bank account was created through [instant bank verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding). readOnly: true type: boolean required: - id - accountIdentifier type: object Trust: properties: countryOfGoverningLaw: description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country. type: string dateOfIncorporation: x-addedInVersion: '2' description: The date when the legal arrangement was incorporated in YYYY-MM-DD format. type: string description: x-addedInVersion: '3' description: Short description about the trust. type: string doingBusinessAs: description: The registered name, if different from the `name`. type: string name: description: The legal name. type: string principalPlaceOfBusiness: description: The business address. Required if the principal place of business is different from the `registeredAddress`. $ref: '#/components/schemas/Address' registeredAddress: description: The address registered at the registrar, such as the Chamber of Commerce. $ref: '#/components/schemas/Address' registrationNumber: description: The registration number. type: string taxInformation: x-addedInVersion: '2' description: The tax information of the entity. items: $ref: '#/components/schemas/TaxInformation' type: array type: description: 'Type of trust. Possible values for Australian trusts: **cashManagementTrust**, **corporateUnitTrust**, **deceasedEstate**, **discretionaryInvestmentTrust**, **discretionaryServicesManagementTrust**, **discretionaryTradingTrust**, **firstHomeSaverAccountsTrust**, **fixedTrust**, **fixedUnitTrust**, **hybridTrust**, **listedPublicUnitTrust**, **otherTrust**, **pooledSuperannuationTrust**, **publicTradingTrust**, **unlistedPublicUnitTrust**.' enum: - cashManagementTrust - corporateUnitTrust - deceasedEstate - discretionaryInvestmentTrust - discretionaryServicesManagementTrust - discretionaryTradingTrust - firstHomeSaverAccountsTrust - fixedTrust - fixedUnitTrust - hybridTrust - listedPublicUnitTrust - otherTrust - pooledSuperannuationTrust - publicTradingTrust - unlistedPublicUnitTrust type: string undefinedBeneficiaryInfo: x-addedInVersion: '2' description: The undefined beneficiary information of the entity. items: $ref: '#/components/schemas/UndefinedBeneficiary' type: array vatAbsenceReason: description: 'The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.' enum: - industryExemption - belowTaxThreshold type: string vatNumber: description: The VAT number. type: string required: - name - countryOfGoverningLaw - registeredAddress - type 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 settlorExemptionReason: description: 'Defines the Kyc Exemption Reason for a Settlor associated with a trust. For example, **professionalServiceProvider**, **deceased**, or **contributionBelowThreshold**.' items: type: string readOnly: true type: array type: description: 'Defines the relationship of the legal entity to the current legal entity. Possible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**. Possible values for sole proprietorships: **soleProprietorship**. Possible value for trusts: **trust** Possible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.' enum: - definedBeneficiary - director - pciSignatory - protector - secondaryTrustee - settlor - signatory - soleProprietorship - trust - trustOwnership - uboThroughControl - uboThroughOwnership - ultimateParentCompany - undefinedBeneficiary type: string required: - legalEntityId - type 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 SourceOfFunds: properties: acquiringBusinessLineId: deprecated: true x-deprecatedInVersion: '3' x-deprecatedMessage: This field will be removed in v4. 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 Organization: properties: dateOfIncorporation: x-addedInVersion: '2' description: The date when the organization was incorporated in YYYY-MM-DD format. type: string 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: description: The phone number of the legal entity. $ref: '#/components/schemas/PhoneNumber' principalPlaceOfBusiness: description: The address where the organization operates from. Provide this if the principal place of business is different from the `registeredAddress`. $ref: '#/components/schemas/Address' registeredAddress: description: The address of the organization registered at their registrar (such as the Chamber of Commerce). $ref: '#/components/schemas/Address' registrationNumber: description: The organization's registration number. type: string stockData: description: Information about the organization's publicly traded stock. Provide this object only if `type` is **listedPublicCompany**. $ref: '#/components/schemas/StockData' taxInformation: x-addedInVersion: '2' description: The tax information of the organization. items: $ref: '#/components/schemas/TaxInformation' type: array taxReportingClassification: x-addedInVersion: '2' description: The tax reporting classification (FATCA/CRS self-certification) of the organization. $ref: '#/components/schemas/TaxReportingClassification' type: description: 'Type of organization. Possible values: **associationIncorporated**, **governmentalOrganization**, **listedPublicCompany**, **nonProfit**, **partnershipIncorporated**, **privateCompany**.' enum: - associationIncorporated - governmentalOrganization - listedPublicCompany - nonProfit - partnershipIncorporated - privateCompany type: string vatAbsenceReason: x-addedInVersion: '2' description: 'The reason the organization has not provided a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.' enum: - industryExemption - belowTaxThreshold type: string vatNumber: x-addedInVersion: '2' description: The organization's VAT number. type: string webData: deprecated: true x-deprecatedInVersion: '1' description: The website and app URL of the legal entity. $ref: '#/components/schemas/WebData' required: - legalName - registeredAddress 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 - dataReview - invalidInput - pendingStatus - rejected 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: description: The maximum amount a card holder can withdraw per day. $ref: '#/components/schemas/Amount' type: object TaxInformation: properties: country: description: The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. maxLength: 2 minLength: 2 type: string number: description: The tax ID number (TIN) of the organization or individual. type: string type: description: The TIN type depending on the country where it was issued. Provide only for countries that have multiple tax IDs, such as Sweden, the UK, or the US. For example, provide **SSN**, **EIN**, or **ITIN** for the US. type: string type: object GetTermsOfServiceDocumentResponse: properties: document: description: The Terms of Service document in Base64-encoded format. format: byte 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. Possible value: **en** for English.' type: string termsOfServiceDocumentId: description: The unique identifier of the Terms of Service document. type: string type: description: 'The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** ' enum: - adyenAccount - adyenCapital - adyenCard - adyenForPlatformsAdvanced - adyenForPlatformsManage - adyenFranchisee - adyenIssuing type: string type: object EntityReference: properties: id: description: The unique identifier of the resource. type: string type: object Individual: properties: birthData: description: The individual's birth information. $ref: '#/components/schemas/BirthData' email: description: The email address of the legal entity. type: string identificationData: description: Information about the individual's identification document. $ref: '#/components/schemas/IdentificationData' name: description: The individual's name. $ref: '#/components/schemas/Name' nationality: description: The individual's nationality. type: string phone: description: The phone number of the legal entity. $ref: '#/components/schemas/PhoneNumber' residentialAddress: description: The residential address of the individual. $ref: '#/components/schemas/Address' taxInformation: x-addedInVersion: '2' description: The tax information of the individual. items: $ref: '#/components/schemas/TaxInformation' type: array webData: deprecated: true x-deprecatedInVersion: '1' description: The website and app URL of the legal entity. $ref: '#/components/schemas/WebData' required: - name - residentialAddress type: object DocumentReference: properties: active: description: Identifies whether the document is active and used for checks. type: boolean description: description: Your description for the document. type: string fileName: description: Document name. type: string id: description: The unique identifier of the resource. type: string modificationDate: description: The modification date of the document. format: date-time type: string pages: description: List of document pages items: $ref: '#/components/schemas/DocumentPage' type: array type: description: Type of document, used when providing an ID number or uploading a document. type: string type: object SupportingEntityCapability: properties: allowed: description: 'Indicates whether the capability is allowed for the supporting entity. If a capability is allowed for a supporting entity but not for the parent legal entity, this means the legal entity has other supporting entities that failed verification. **You can use the allowed supporting entity** regardless of the verification status of other supporting entities.' readOnly: true 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 capability of the supporting entity. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability. ' readOnly: true type: string type: object DocumentPage: properties: pageName: type: string pageNumber: format: int32 type: integer type: enum: - BACK - FRONT - UNDEFINED type: string type: object CalculateTermsOfServiceStatusResponse: properties: termsOfServiceTypes: description: The type of Terms of Service that the legal entity needs to accept. If empty, no Terms of Service needs to be accepted. items: enum: - adyenAccount - adyenCapital - adyenCard - adyenForPlatformsAdvanced - adyenForPlatformsManage - adyenFranchisee - adyenIssuing type: string type: array type: object WebDataExemption: properties: reason: description: 'The reason why the web data was not provided. Possible value: **noOnlinePresence**.' enum: - noOnlinePresence - notCollectedDuringOnboarding type: string type: object UndefinedBeneficiary: properties: description: description: The details of the undefined beneficiary. type: string reference: description: The reference of the undefined beneficiary. type: string type: object PhoneNumber: properties: number: description: The full phone number, including the country code. For example, **+3112345678**. type: string type: description: "The type of phone number.\n Possible values: **mobile**, **landline**, **sip**, **fax.** " type: string required: - number 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 type: description: The type of error. enum: - dataMissing - dataReview - invalidInput - pendingStatus - rejected type: string remediatingActions: description: An object containing possible solutions to fix a verification error. items: $ref: '#/components/schemas/RemediatingAction' type: array required: [] type: object RemediatingAction: properties: code: type: string message: type: string type: object CapabilityProblemEntity: properties: documents: description: List of document IDs corresponding to the verification errors from capabilities. items: type: string type: array id: type: string owner: $ref: '#/components/schemas/CapabilityProblemEntity-recursive' type: enum: - BankAccount - Document - LegalEntity - product type: string type: object SoleProprietorship: properties: countryOfGoverningLaw: description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country. type: string dateOfIncorporation: x-addedInVersion: '2' description: The date when the legal arrangement was incorporated in YYYY-MM-DD format. type: string description: x-addedInVersion: '3' description: Short description about the Legal Arrangement. type: string doingBusinessAs: description: The registered name, if different from the `name`. type: string name: description: The legal name. type: string principalPlaceOfBusiness: description: The business address. Required if the principal place of business is different from the `registeredAddress`. $ref: '#/components/schemas/Address' registeredAddress: description: The address registered at the registrar, such as the Chamber of Commerce. $ref: '#/components/schemas/Address' registrationNumber: description: The registration number. type: string taxInformation: x-addedInVersion: '2' description: The tax information of the entity. items: $ref: '#/components/schemas/TaxInformation' type: array vatAbsenceReason: description: 'The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.' enum: - industryExemption - belowTaxThreshold type: string vatNumber: description: The VAT number. type: string required: - name - countryOfGoverningLaw - registeredAddress type: object UnincorporatedPartnership: properties: countryOfGoverningLaw: description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country. type: string dateOfIncorporation: x-addedInVersion: '2' description: The date when the legal arrangement was incorporated in YYYY-MM-DD format. type: string description: x-addedInVersion: '3' description: Short description about the Legal Arrangement. type: string doingBusinessAs: description: The registered name, if different from the `name`. type: string name: description: The legal name. type: string principalPlaceOfBusiness: description: The business address. Required if the principal place of business is different from the `registeredAddress`. $ref: '#/components/schemas/Address' registeredAddress: description: The address registered at the registrar, such as the Chamber of Commerce. $ref: '#/components/schemas/Address' registrationNumber: description: The registration number. type: string taxInformation: x-addedInVersion: '2' description: The tax information of the entity. items: $ref: '#/components/schemas/TaxInformation' type: array type: description: 'Type of Partnership. Possible values: * **limitedPartnership** * **generalPartnership** * **familyPartnership** * **commercialPartnership** * **publicPartnership** * **otherPartnership** * **gbr** * **gmbh** * **kgaa** * **cv** * **vof** * **maatschap** * **privateFundLimitedPartnership** * **businessTrustEntity** * **businessPartnership** ' enum: - limitedPartnership - generalPartnership - familyPartnership - commercialPartnership - publicPartnership - otherPartnership - gbr - gmbh - kgaa - cv - vof - maatschap - privateFundLimitedPartnership - businessTrustEntity - businessPartnership type: string vatAbsenceReason: description: 'The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**.' enum: - industryExemption - belowTaxThreshold type: string vatNumber: description: The VAT number. type: string required: - name - countryOfGoverningLaw - registeredAddress - type 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 documentDetails: x-addedInVersion: '2' description: List of documents uploaded for the legal entity. items: $ref: '#/components/schemas/DocumentReference' type: array documents: deprecated: true x-deprecatedInVersion: '1' x-deprecatedMessage: Use the `documentDetails` array instead. description: List of documents uploaded for the legal entity. items: $ref: '#/components/schemas/EntityReference' type: array 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: description: Information about the individual. Required if `type` is **individual**. $ref: '#/components/schemas/Individual' organization: description: Information about the organization. Required if `type` is **organization**. $ref: '#/components/schemas/Organization' problems: x-addedInVersion: '3' description: List of verification errors related to capabilities for the legal entity. items: $ref: '#/components/schemas/CapabilityProblem' type: array reference: description: Your reference for the legal entity, maximum 150 characters. maxLength: 150 type: string soleProprietorship: x-addedInVersion: '2' description: Information about the sole proprietorship. Required if `type` is **soleProprietorship**. $ref: '#/components/schemas/SoleProprietorship' transferInstruments: description: List of transfer instruments that the legal entity owns. items: $ref: '#/components/schemas/TransferInstrumentReference' readOnly: true type: array trust: description: Information about the trust. Required if `type` is **trust**. $ref: '#/components/schemas/Trust' type: description: 'The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**.' enum: - individual - organization - soleProprietorship - trust - unincorporatedPartnership type: string unincorporatedPartnership: description: Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**. $ref: '#/components/schemas/UnincorporatedPartnership' verificationDeadlines: x-addedInVersion: '3' description: List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved. items: $ref: '#/components/schemas/VerificationDeadline' readOnly: true type: array verificationPlan: description: A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). type: string required: - id type: object VerificationDeadline: properties: capabilities: description: The list of capabilities that will be disallowed if information is not reviewed by the time of the deadline 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 readOnly: true type: array entityIds: description: The unique identifiers of the bank account(s) that the deadline applies to items: type: string readOnly: true type: array expiresAt: description: The date that verification is due by before capabilities are disallowed. format: date-time readOnly: true type: string required: - expiresAt - capabilities type: object CapabilityProblemEntity-recursive: properties: documents: description: List of document IDs corresponding to the verification errors from capabilities. items: type: string type: array id: type: string type: enum: - BankAccount - Document - LegalEntity - product type: string required: [] 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: description: The settings that are allowed for the legal entity. readOnly: true $ref: '#/components/schemas/CapabilitySettings' requested: description: Indicates whether the capability is requested. To check whether the legal entity is permitted to use the capability, refer to the `allowed` field. readOnly: true 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: description: The settings that are requested for the legal entity. readOnly: true $ref: '#/components/schemas/CapabilitySettings' transferInstruments: x-addedInVersion: '2' description: The capability status of transfer instruments associated with the 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 AcceptTermsOfServiceRequest: properties: acceptedBy: description: 'The legal entity ID of the user accepting the Terms of Service. For organizations, this must be the individual legal entity ID of an authorized signatory for the organization. For sole proprietorships, this must be the individual legal entity ID of the owner.' type: string ipAddress: description: The IP address of the user accepting the Terms of Service. type: string required: - acceptedBy 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 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 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 IdentificationData: properties: cardNumber: description: The card number of the document that was issued (AU only). type: string expiryDate: description: The expiry date of the document, in YYYY-MM-DD format. type: string issuerCountry: deprecated: true x-deprecatedInVersion: '1' 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 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 identity data. For **individual**, the `type` value is **nationalIdNumber**. enum: - nationalIdNumber type: string required: - type 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: description: Information about the individual. Required if `type` is **individual**. $ref: '#/components/schemas/Individual' organization: description: Information about the organization. Required if `type` is **organization**. $ref: '#/components/schemas/Organization' reference: description: Your reference for the legal entity, maximum 150 characters. maxLength: 150 type: string soleProprietorship: x-addedInVersion: '2' description: Information about the sole proprietorship. Required if `type` is **soleProprietorship**. $ref: '#/components/schemas/SoleProprietorship' trust: description: Information about the trust. Required if `type` is **trust**. $ref: '#/components/schemas/Trust' type: description: "The type of legal entity.\n\n Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**." enum: - individual - organization - soleProprietorship - trust - unincorporatedPartnership type: string unincorporatedPartnership: description: Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**. $ref: '#/components/schemas/UnincorporatedPartnership' verificationPlan: description: A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). type: string required: - type 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 CapabilityProblem: properties: entity: $ref: '#/components/schemas/CapabilityProblemEntity' verificationErrors: items: $ref: '#/components/schemas/VerificationError' type: array type: object VerificationErrors: properties: problems: x-addedInVersion: '2' description: List of the verification errors. items: $ref: '#/components/schemas/CapabilityProblem' type: array type: object BusinessLine: properties: capability: deprecated: true x-deprecatedInVersion: '3' x-deprecatedMessage: Use `service` instead. description: 'The capability for which you are creating the business line. Possible values: **receivePayments**, **receiveFromPlatformPayments**, **issueBankAccount**' enum: - receivePayments - receiveFromPlatformPayments - issueBankAccount 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](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). 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 problems: x-addedInVersion: '3' description: The verification errors related to capabilities for this supporting entity. items: $ref: '#/components/schemas/CapabilityProblem' type: array 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 `service` **paymentProcessing**.' items: type: string type: array service: x-addedInVersion: '3' description: 'The service for which you are creating the business line. Possible values: * **paymentProcessing** * **banking** ' enum: - paymentProcessing - banking type: string sourceOfFunds: description: Contains information about the source of your user's funds. Required only for the `service` **banking**. $ref: '#/components/schemas/SourceOfFunds' webData: description: List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the `webDataExemption` object. items: $ref: '#/components/schemas/WebData' type: array webDataExemption: description: The reason why the web data is not provided. $ref: '#/components/schemas/WebDataExemption' required: - service - industryCode - legalEntityId - id 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. Possible value: **en** for English.' type: string termsOfServiceDocumentId: description: The unique identifier of the Terms of Service document. type: string type: description: 'The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** ' enum: - adyenAccount - adyenCapital - adyenCard - adyenForPlatformsAdvanced - adyenForPlatformsManage - adyenFranchisee - adyenIssuing type: string 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 GetPciQuestionnaireInfosResponse: properties: data: description: Information about the signed PCI questionnaires. items: $ref: '#/components/schemas/PciDocumentInfo' type: array 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). \n\nIf not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default." 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. Possible keys: By default, these values are set to **true**. Set to **false** to not allow the action. - **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. By default, these values are set to **false**. Set to **true** to allow the action. - **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable. - **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country than the country of their legal entity. By default, these value are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels. - **requirePciSignEcommerce** - **requirePciSignPos** - **requirePciSignEcomMoto** - **requirePciSignPosMoto** ' type: object themeId: description: The unique identifier of the hosted onboarding theme. 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. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** ' enum: - adyenAccount - adyenCapital - adyenCard - adyenForPlatformsAdvanced - adyenForPlatformsManage - adyenFranchisee - adyenIssuing type: string type: object GetPciQuestionnaireResponse: properties: content: description: The generated questionnaire in a base64 encoded format. format: byte 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 GeneratePciDescriptionResponse: properties: content: description: The generated questionnaires in a base64 encoded format. format: byte 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 TaxReportingClassification: properties: businessType: description: 'The organization''s business type. Possible values: **other**, **listedPublicCompany**, **subsidiaryOfListedPublicCompany**, **governmentalOrganization**, **internationalOrganization**, **financialInstitution**.' enum: - other - listedPublicCompany - subsidiaryOfListedPublicCompany - governmentalOrganization - internationalOrganization - financialInstitution. type: string financialInstitutionNumber: description: The Global Intermediary Identification Number (GIIN) required for FATCA. Only required if the organization is a US financial institution and the `businessType` is **financialInstitution**. type: string mainSourceOfIncome: description: 'The organization''s main source of income. Possible values: **businessOperation**, **realEstateSales**, **investmentInterestOrRoyalty**, **propertyRental**, **other**.' enum: - businessOperation - realEstateSales - investmentInterestOrRoyalty - propertyRental - other type: string type: description: 'The tax reporting classification type. Possible values: **nonFinancialNonReportable**, **financialNonReportable**, **nonFinancialActive**, **nonFinancialPassive**.' enum: - nonFinancialNonReportable - financialNonReportable - nonFinancialActive - nonFinancialPassive type: string type: object securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification