openapi-directory/api/adyen.com/LegalEntityService.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.1.0","servers":[{"url":"https://kyc-test.adyen.com/lem/v3"}],"info":{"contact":{"name":"Adyen Developer Experience team","url":"https://github.com/Adyen/adyen-openapi","x-twitter":"Adyen"},"description":"The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \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 \"X-API-Key: YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v3/legalEntities\n```\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n","termsOfService":"https://www.adyen.com/legal/terms-and-conditions","title":"Legal Entity Management API","version":"3","x-apisguru-categories":["payment"],"x-logo":{"url":"https://twitter.com/Adyen/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/Adyen/adyen-openapi/main/json/LegalEntityService-v3.json","version":"3.1"}],"x-preferred":true,"x-providerName":"adyen.com","x-publicVersion":true,"x-serviceName":"LegalEntityService"},"tags":[{"name":"Legal entities"},{"name":"Transfer instruments"},{"name":"Business lines"},{"name":"Documents"},{"name":"Terms of Service"},{"name":"Hosted Onboarding"},{"name":"PCI questionnaires"}],"paths":{"/businessLines":{"post":{"description":"Creates a business line. \n\nThis resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n","operationId":"post-businessLines","requestBody":{"content":{"application/json":{"examples":{"createBusinessLines-businessAccounts":{"$ref":"#/components/examples/post-businessLines-createBusinessLines-businessAccounts"},"createBusinessLines-receive":{"$ref":"#/components/examples/post-businessLines-createBusinessLines-receive"}},"schema":{"$ref":"#/components/schemas/BusinessLineInfo"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"createBusinessLines-businessAccounts":{"$ref":"#/components/examples/post-businessLines-createBusinessLines-businessAccounts-200"},"createBusinessLines-receive":{"$ref":"#/components/examples/post-businessLines-createBusinessLines-receive-200"}},"schema":{"$ref":"#/components/schemas/BusinessLine"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create a business line","tags":["Business lines"],"x-addedInVersion":"1","x-methodName":"createBusinessLine","x-sortIndex":12}},"/businessLines/{id}":{"delete":{"description":"Deletes a business line.\n\n >If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.","operationId":"delete-businessLines-id","parameters":[{"description":"The unique identifier of the business line to be deleted.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content - look at the actual response code for the status of the request. "},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Delete a business line","tags":["Business lines"],"x-addedInVersion":"1","x-methodName":"deleteBusinessLine","x-sortIndex":14},"get":{"description":"Returns the detail of a business line.","operationId":"get-businessLines-id","parameters":[{"description":"The unique identifier of the business line.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-businessLines-id-success-200"}},"schema":{"$ref":"#/components/schemas/BusinessLine"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a business line","tags":["Business lines"],"x-addedInVersion":"1","x-methodName":"getBusinessLine","x-sortIndex":13},"patch":{"description":"Updates a business line.","operationId":"patch-businessLines-id","parameters":[{"description":"The unique identifier of the business line.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"updateBusinessLine":{"$ref":"#/components/examples/patch-businessLines-id-updateBusinessLine"}},"schema":{"$ref":"#/components/schemas/BusinessLineInfoUpdate"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"updateBusinessLine":{"$ref":"#/components/examples/patch-businessLines-id-updateBusinessLine-200"}},"schema":{"$ref":"#/components/schemas/BusinessLine"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Update a business line","tags":["Business lines"],"x-addedInVersion":"2","x-methodName":"updateBusinessLine","x-sortIndex":15}},"/documents":{"post":{"description":"Uploads a document for verification checks.\n\n Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents.\n\n You should only upload documents when Adyen requests additional information for the legal entity.\n\n >You can upload a maximum of 15 pages for photo IDs.","operationId":"post-documents","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":13008,"in":"header","name":"x-requested-verification-code","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"uploadDocument":{"$ref":"#/components/examples/post-documents-uploadDocument"}},"schema":{"$ref":"#/components/schemas/Document"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"uploadDocument":{"$ref":"#/components/examples/post-documents-uploadDocument-200"}},"schema":{"$ref":"#/components/schemas/Document"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Upload a document for verification checks","tags":["Documents"],"x-addedInVersion":"1","x-methodName":"uploadDocumentForVerificationChecks","x-sortIndex":4}},"/documents/{id}":{"delete":{"description":"Deletes a document.","operationId":"delete-documents-id","parameters":[{"description":"The unique identifier of the document to be deleted.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content - look at the actual response code for the status of the request. "},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Delete a document","tags":["Documents"],"x-addedInVersion":"1","x-methodName":"deleteDocument","x-sortIndex":7},"get":{"description":"Returns a document.","operationId":"get-documents-id","parameters":[{"description":"The unique identifier of the document.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Do not load document content while fetching the document.","in":"query","name":"skipContent","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-documents-id-success-200"}},"schema":{"$ref":"#/components/schemas/Document"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a document","tags":["Documents"],"x-addedInVersion":"1","x-methodName":"getDocument","x-sortIndex":5},"patch":{"description":"Updates a document.\n\n >You can upload a maximum of 15 pages for photo IDs.","operationId":"patch-documents-id","parameters":[{"description":"The unique identifier of the document to be updated.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.","example":1,"in":"header","name":"x-requested-verification-code","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"updateDocument":{"$ref":"#/components/examples/patch-documents-id-updateDocument"}},"schema":{"$ref":"#/components/schemas/Document"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"updateDocument":{"$ref":"#/components/examples/patch-documents-id-updateDocument-200"}},"schema":{"$ref":"#/components/schemas/Document"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Update a document","tags":["Documents"],"x-addedInVersion":"1","x-methodName":"updateDocument","x-sortIndex":6}},"/legalEntities":{"post":{"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","operationId":"post-legalEntities","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":13004,"in":"header","name":"x-requested-verification-code","schema":{"type":"string"}}],"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"}}}},"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"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Create a legal entity","tags":["Legal entities"],"x-addedInVersion":"1","x-methodName":"createLegalEntity","x-sortIndex":1}},"/legalEntities/{id}":{"get":{"description":"Returns a legal entity.","operationId":"get-legalEntities-id","parameters":[{"description":"The unique identifier of the legal entity.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-legalEntities-id-success-200"}},"schema":{"$ref":"#/components/schemas/LegalEntity"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a legal entity","tags":["Legal entities"],"x-addedInVersion":"1","x-methodName":"getLegalEntity","x-sortIndex":2},"patch":{"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.","operationId":"patch-legalEntities-id","parameters":[{"description":"The unique identifier of the legal entity.","in":"path","name":"id","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":1,"in":"header","name":"x-requested-verification-code","schema":{"type":"string"}}],"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"}}}},"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"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Update a legal entity","tags":["Legal entities"],"x-addedInVersion":"1","x-methodName":"updateLegalEntity","x-sortIndex":3}},"/legalEntities/{id}/businessLines":{"get":{"description":"Returns the business lines owned by a legal entity.","operationId":"get-legalEntities-id-businessLines","parameters":[{"description":"The unique identifier of the legal entity.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-legalEntities-id-businessLines-success-200"}},"schema":{"$ref":"#/components/schemas/BusinessLines"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get all business lines under a legal entity","tags":["Legal entities"],"x-addedInVersion":"1","x-methodName":"getAllBusinessLinesUnderLegalEntity","x-sortIndex":4}},"/legalEntities/{id}/checkVerificationErrors":{"post":{"description":"Returns the verification errors for a legal entity and its supporting entities.","operationId":"post-legalEntities-id-checkVerificationErrors","parameters":[{"description":"The unique identifier of the legal entity.","in":"path","name":"id","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"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Check a legal entity's verification errors","tags":["Legal entities"],"x-addedInVersion":"3","x-methodName":"checkLegalEntitysVerificationErrors","x-sortIndex":2}},"/legalEntities/{id}/confirmDataReview":{"post":{"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.","operationId":"post-legalEntities-id-confirmDataReview","parameters":[{"description":"The unique identifier of the legal entity.","in":"path","name":"id","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"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Confirm data review","tags":["Legal entities"],"x-addedInVersion":"3","x-methodName":"confirmDataReview","x-sortIndex":22}},"/legalEntities/{id}/onboardingLinks":{"post":{"description":"Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n","operationId":"post-legalEntities-id-onboardingLinks","parameters":[{"description":"The unique identifier of the legal entity","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"createOnboardingLink":{"$ref":"#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink"}},"schema":{"$ref":"#/components/schemas/OnboardingLinkInfo"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"createOnboardingLink":{"$ref":"#/components/examples/post-legalEntities-id-onboardingLinks-createOnboardingLink-200"}},"schema":{"$ref":"#/components/schemas/OnboardingLink"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a link to an Adyen-hosted onboarding page","tags":["Hosted Onboarding"],"x-addedInVersion":"1","x-methodName":"getLinkToAdyenhostedOnboardingPage","x-sortIndex":1}},"/legalEntities/{id}/pciQuestionnaires":{"get":{"description":"Get a list of signed PCI questionnaires.","operationId":"get-legalEntities-id-pciQuestionnaires","parameters":[{"description":"The unique identifier of the legal entity to get PCI questionnaire information.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-legalEntities-id-pciQuestionnaires-success-200"}},"schema":{"$ref":"#/components/schemas/GetPciQuestionnaireInfosResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get PCI questionnaire details","tags":["PCI questionnaires"],"x-addedInVersion":"1","x-methodName":"getPciQuestionnaireDetails","x-sortIndex":3}},"/legalEntities/{id}/pciQuestionnaires/generatePciTemplates":{"post":{"description":"Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).","operationId":"post-legalEntities-id-pciQuestionnaires-generatePciTemplates","parameters":[{"description":"The unique identifier of the legal entity to get PCI questionnaire information.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"createPciQuestionnaire":{"$ref":"#/components/examples/post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire"}},"schema":{"$ref":"#/components/schemas/GeneratePciDescriptionRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"createPciQuestionnaire":{"$ref":"#/components/examples/post-legalEntities-id-pciQuestionnaires-generatePciTemplates-createPciQuestionnaire-200"}},"schema":{"$ref":"#/components/schemas/GeneratePciDescriptionResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Generate PCI questionnaire","tags":["PCI questionnaires"],"x-addedInVersion":"1","x-methodName":"generatePciQuestionnaire","x-sortIndex":1}},"/legalEntities/{id}/pciQuestionnaires/signPciTemplates":{"post":{"description":"Signs the required PCI questionnaire.","operationId":"post-legalEntities-id-pciQuestionnaires-signPciTemplates","parameters":[{"description":"The legal entity ID of the user that has a contractual relationship with your platform.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"signPciQuestionnaire":{"$ref":"#/components/examples/post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire"}},"schema":{"$ref":"#/components/schemas/PciSigningRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"signPciQuestionnaire":{"$ref":"#/components/examples/post-legalEntities-id-pciQuestionnaires-signPciTemplates-signPciQuestionnaire-200"}},"schema":{"$ref":"#/components/schemas/PciSigningResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Sign PCI questionnaire","tags":["PCI questionnaires"],"x-addedInVersion":"1","x-methodName":"signPciQuestionnaire","x-sortIndex":2}},"/legalEntities/{id}/pciQuestionnaires/{pciid}":{"get":{"description":"Returns the signed PCI questionnaire.","operationId":"get-legalEntities-id-pciQuestionnaires-pciid","parameters":[{"description":"The legal entity ID of the individual who signed the PCI questionnaire.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the signed PCI questionnaire.","in":"path","name":"pciid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-legalEntities-id-pciQuestionnaires-pciid-success-200"}},"schema":{"$ref":"#/components/schemas/GetPciQuestionnaireResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get PCI questionnaire","tags":["PCI questionnaires"],"x-addedInVersion":"1","x-methodName":"getPciQuestionnaire","x-sortIndex":4}},"/legalEntities/{id}/termsOfService":{"post":{"description":"Returns the Terms of Service document for a legal entity.","operationId":"post-legalEntities-id-termsOfService","parameters":[{"description":"The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"createTermsofService":{"$ref":"#/components/examples/post-legalEntities-id-termsOfService-createTermsofService"}},"schema":{"$ref":"#/components/schemas/GetTermsOfServiceDocumentRequest"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"createTermsofService":{"$ref":"#/components/examples/post-legalEntities-id-termsOfService-createTermsofService-200"}},"schema":{"$ref":"#/components/schemas/GetTermsOfServiceDocumentResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get Terms of Service document","tags":["Terms of Service"],"x-addedInVersion":"1","x-methodName":"getTermsOfServiceDocument","x-sortIndex":1}},"/legalEntities/{id}/termsOfService/{termsofservicedocumentid}":{"patch":{"description":"Accepts Terms of Service.","operationId":"patch-legalEntities-id-termsOfService-termsofservicedocumentid","parameters":[{"description":"The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.","in":"path","name":"id","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the Terms of Service document.","in":"path","name":"termsofservicedocumentid","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"updateTermsofService":{"$ref":"#/components/examples/patch-legalEntities-id-termsOfService-termsofservicedocumentid-updateTermsofService"}},"schema":{"$ref":"#/components/schemas/AcceptTermsOfServiceRequest"}}}},"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"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Accept Terms of Service","tags":["Terms of Service"],"x-addedInVersion":"1","x-methodName":"acceptTermsOfService","x-sortIndex":2}},"/legalEntities/{id}/termsOfServiceAcceptanceInfos":{"get":{"description":"Returns Terms of Service information for a legal entity.","operationId":"get-legalEntities-id-termsOfServiceAcceptanceInfos","parameters":[{"description":"The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-legalEntities-id-termsOfServiceAcceptanceInfos-success-200"}},"schema":{"$ref":"#/components/schemas/GetTermsOfServiceAcceptanceInfosResponse"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get Terms of Service information for a legal entity","tags":["Terms of Service"],"x-addedInVersion":"1","x-methodName":"getTermsOfServiceInformationForLegalEntity","x-sortIndex":3}},"/legalEntities/{id}/termsOfServiceStatus":{"get":{"description":"Returns the required types of Terms of Service that need to be accepted by a legal entity.","operationId":"get-legalEntities-id-termsOfServiceStatus","parameters":[{"description":"The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner.","in":"path","name":"id","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"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get Terms of Service status","tags":["Terms of Service"],"x-addedInVersion":"1","x-methodName":"getTermsOfServiceStatus","x-sortIndex":4}},"/themes":{"get":{"description":"Returns a list of hosted onboarding page themes.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n","operationId":"get-themes","responses":{"200":{"content":{"application/json":{"examples":{"success":{"$ref":"#/components/examples/get-themes-success-200"}},"schema":{"$ref":"#/components/schemas/OnboardingThemes"}}},"description":"OK - the request has succeeded."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Bad Request - a problem reading or understanding the request."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unauthorized - authentication required."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Forbidden - insufficient permissions to process the request."},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Unprocessable Entity - a request validation error."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}},"description":"Internal Server Error - the server could not process the request."}},"security":[{"BasicAuth":[]},{"ApiKeyAuth":[]}],"summary":"Get a list of hosted onboarding page themes","tags":["Hosted Onboarding"],"x-addedInVersion":"1","x-methodName":"listHostedOnboardingPageThemes","x-sortIndex":2}},"/themes/{id}":{"get":{"description":"Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n","operationId":"get-themes-id","parameters":[{"description":"The unique identifier of the theme","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"applic