adyen.com – LegalEntityService
The Legal Entity Management API enables you to manage legal entities that contain information required for verification.
Authentication
To connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the . Use the web service user credentials to authenticate your request, for example:
Note that when going live, you need to generate new web service user credentials to access the .
Versioning
The Legal Entity Management API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
For example:
Going live
When going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to https://kyc-live.adyen.com/lem/v1.
https://kyc-test.adyen.com/lem/v1/legalEntities- Homepage
- https://api.apis.guru/v2/specs/adyen.com:LegalEntityService/1.json
- Provider
- adyen.com:LegalEntityService / LegalEntityService
- OpenAPI version
- 3.1.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/adyen.com/LegalEntityService/1/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/adyen.com/LegalEntityService/1/openapi.yaml
Tools (27)
Extracted live via the executor SDK.
-
businessLines.deleteBusinessLinesIdDeletes a business line.
If you delete a business line linked to a , it can affect your merchant account's ability to use the . The business line is removed from all linked merchant accounts.
-
businessLines.getBusinessLinesIdReturns the detail of a business line.
-
businessLines.postBusinessLinesCreates a business line.
This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.
-
documents.deleteDocumentsIdDeletes a document.
-
documents.getDocumentsIdReturns a document.
-
documents.patchDocumentsIdUpdates a document.
-
documents.postDocumentsUploads a document for verification checks.
Adyen uses the information from the to run automated verification checks. If these checks fail, you will be notified to provide additional documents.
You should only upload documents when Adyen requests additional information for the legal entity.
-
hostedOnboarding.getThemesReturns a list of hosted onboarding page themes.
-
hostedOnboarding.getThemesIdReturns the details of the theme identified in the path.
-
hostedOnboarding.postLegalEntitiesIdOnboardingLinksReturns a link to an Adyen-hosted onboarding page where you need to redirect your user.
-
legalEntities.getLegalEntitiesIdReturns a legal entity.
-
legalEntities.getLegalEntitiesIdBusinessLinesReturns the business lines owned by a legal entity.
-
legalEntities.patchLegalEntitiesIdUpdates a legal entity.
To change the legal entity type, include only the new
typein your request. To update theentityAssociationsarray, 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. -
legalEntities.postLegalEntitiesCreates a legal entity.
This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.
-
pciQuestionnaires.getLegalEntitiesIdPciQuestionnairesGet a list of signed PCI questionnaires.
-
pciQuestionnaires.getLegalEntitiesIdPciQuestionnairesPciidReturns the signed PCI questionnaire.
-
pciQuestionnaires.postLegalEntitiesIdPciQuestionnairesGeneratePciTemplatesGenerates the required PCI questionnaire based on the user's . If multiple questionnaires are required, this request creates a single consodilated document to be signed.
-
pciQuestionnaires.postLegalEntitiesIdPciQuestionnairesSignPciTemplatesSigns the required PCI questionnaire.
-
termsOfService.getLegalEntitiesIdTermsOfServiceAcceptanceInfosReturns Terms of Service information for a legal entity.
-
termsOfService.patchLegalEntitiesIdTermsOfServiceTermsofservicedocumentidAccepts Terms of Service.
-
termsOfService.postLegalEntitiesIdTermsOfServiceReturns the Terms of Service document for a legal entity.
-
transferInstruments.deleteTransferInstrumentsIdDeletes a transfer instrument.
-
transferInstruments.getTransferInstrumentsIdReturns the details of a transfer instrument.
-
transferInstruments.patchTransferInstrumentsIdUpdates a transfer instrument.
-
transferInstruments.postTransferInstrumentsCreates a transfer instrument.
A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses.
When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools