Legal Entity Management API
The Legal Entity Management API enables you to manage legal entities that contain information required for verification. Authentication Each request to the…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Legal Entity Management API enables you to manage legal entities that contain information required for verification.
Authentication
Each request to the Legal Entity Management API must be signed with an API key. Generate an API key in your Customer Area if you have a platform setup or marketplace setup.
If you have an Adyen Issuing integration, generate an API key in your Balance Platform Customer Area.
To connect to the API, add an X-API-Key header with the API key as the value. For example:
curl
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
...Versioning
The Legal Entity Management API supports versioning using a version suffix in the endpoint URL. This suffix has the following format: "vXX", where XX is the version number.
For example:
https://kyc-test.adyen.com/lem/v4/legalEntitiesRate limits
We enforce rate limits on Legal Entity Management API endpoints. When the number of requests you send exceeds a threshold within a time frame, additional requests are blocked until the time frame ends. Current limits:
- Live environments: 700 requests per 5 seconds.
- Test environments: 200 requests per 5 seconds.
- Failed requests are subject to a limit of 5 failures per 10 seconds.
Going live
When going live, generate an API key in your live Customer Area if you have an Adyen for Platforms integration or live Balance Platform Customer Area if you have an Adyen Issuing integration.You can then use the API key to send requests to https://kyc-live.adyen.com/lem/v4.
Endpoints 34
Legal entities
- POSTCreate a legal entity
/legalEntitiesCreates a legal entity. This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform… - GETGet a legal entity
/legalEntities/:idReturns a legal entity. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments: 200 requests… - PATCHUpdate a legal entity
/legalEntities/:idUpdates a legal entity. >To change the legal entity type, include only the new type in your request. If you need to update information for the legal entity,… - GETGet all business lines under a legal entity
/legalEntities/:id/businessLinesReturns the business lines owned by a legal entity. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test… - POSTCheck a legal entity's verification errors
/legalEntities/:id/checkVerificationErrorsReturns the verification errors for a legal entity and its supporting entities. Requests to this endpoint are subject to rate limits: Live environments: 700… - POSTConfirm data review
/legalEntities/:id/confirmDataReviewConfirms 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… - POSTRequest periodic data review.
/legalEntities/:id/requestPeriodicReviewRequests a periodic data review for the legal entity of the user specified in the path.
Transfer instruments
- POSTCreate a transfer instrument
/transferInstrumentsCreates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument… - GETGet a transfer instrument
/transferInstruments/:idReturns the details of a transfer instrument. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test… - DELETEDelete a transfer instrument
/transferInstruments/:idDeletes a transfer instrument. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments: 200… - PATCHUpdate a transfer instrument
/transferInstruments/:idUpdates a transfer instrument. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments: 200…
Business lines
- POSTCreate a business line
/businessLinesCreates a business line. This resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses… - GETGet a business line
/businessLines/:idReturns the detail of a business line. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments:… - DELETEDelete a business line
/businessLines/:idDeletes a business line. >If you delete a business line linked to a payment method, it can affect your merchant account's ability to use the payment method.… - PATCHUpdate a business line
/businessLines/:idUpdates a business line. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments: 200 requests…
Documents
- POSTUpload a document for verification checks
/documentsUploads a document for verification checks. Adyen uses the information from the legal entity to run automated verification checks. If these checks fail, you… - GETGet a document
/documents/:id?skipContent=trueReturns a document. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments: 200 requests per 5… - DELETEDelete a document
/documents/:idDeletes a document. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments: 200 requests per 5… - PATCHUpdate a document
/documents/:idUpdates a document. >You can upload a maximum of 15 pages for photo IDs. Requests to this endpoint are subject to rate limits: Live environments: 700 requests…
Terms of Service
- GETGet accepted Terms of Service document
/legalEntities/:id/acceptedTermsOfServiceDocument/:termsofserviceacceptancereference?termsOfServiceDocumentFormat=stringReturns the accepted Terms of Service document for a legal entity. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5… - POSTGet Terms of Service document
/legalEntities/:id/termsOfServiceReturns the Terms of Service document for a legal entity. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds.… - PATCHAccept Terms of Service
/legalEntities/:id/termsOfService/:termsofservicedocumentidAccepts Terms of Service. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments: 200 requests… - GETGet Terms of Service information for a legal entity
/legalEntities/:id/termsOfServiceAcceptanceInfosReturns Terms of Service information for a legal entity. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds.… - GETGet Terms of Service status
/legalEntities/:id/termsOfServiceStatusReturns the required types of Terms of Service that need to be accepted by a legal entity. Requests to this endpoint are subject to rate limits: Live…
PCI questionnaires
- GETGet PCI questionnaire details
/legalEntities/:id/pciQuestionnairesGet a list of signed PCI questionnaires. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test… - POSTGenerate PCI questionnaire
/legalEntities/:id/pciQuestionnaires/generatePciTemplatesGenerates the required PCI questionnaires based on the user's salesChannel. Requests to this endpoint are subject to rate limits: Live environments: 700… - POSTSign PCI questionnaire
/legalEntities/:id/pciQuestionnaires/signPciTemplatesSigns the required PCI questionnaire. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments:… - POSTCalculate PCI status of a legal entity
/legalEntities/:id/pciQuestionnaires/signingRequiredCalculate PCI status of a legal entity. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test… - GETGet PCI questionnaire
/legalEntities/:id/pciQuestionnaires/:pciidReturns the signed PCI questionnaire. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test environments:…
Tax eDelivery consent
- POSTCheck the status of consent for electronic delivery of tax forms
/legalEntities/:id/checkTaxElectronicDeliveryConsentReturns the consent status for electronic delivery of tax forms. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5… - POSTSet the consent status for electronic delivery of tax forms
/legalEntities/:id/setTaxElectronicDeliveryConsentSet the consent status for electronic delivery of tax forms. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5…
Hosted Onboarding
- POSTGet a link to an Adyen-hosted onboarding page
/legalEntities/:id/onboardingLinksReturns a link to an Adyen-hosted onboarding page where you need to redirect your user. Requests to this endpoint are subject to rate limits: Live… - GETGet a list of hosted onboarding page themes
/themesReturns a list of hosted onboarding page themes. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds. Test… - GETGet an onboarding link theme
/themes/:idReturns the details of the theme identified in the path. Requests to this endpoint are subject to rate limits: Live environments: 700 requests per 5 seconds.…
API details
- Base URL
https://kyc-test.adyen.com/lem/v4- Authentication
- An API key in the X-API-Key header
HTTP Basic authentication (username and password) - Operations
- 34 operations on 27 pathsPOST 14GET 12PATCH 5DELETE 3
- Main resources
- Legal entities 7PCI questionnaires 5Terms of Service 5Business lines 4Documents 4Transfer instruments 4Hosted Onboarding 3Tax eDelivery consent 2
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
4 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Adyen's published OpenAPI description (Adyen/adyen-openapi) (MIT)
How to test the Legal Entity Management API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Legal Entity Management API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create a legal entity” (POST /legalEntities), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Legal Entity Management API?
The Legal Entity Management API enables you to manage legal entities that contain information required for verification. Authentication Each request to the… It is listed under Payments and has 34 endpoints.
Who publishes the Legal Entity Management API?
It is listed from Adyen's public API description (an OpenAPI document), not published by Adyen on Swastik Codes. Anyone who controls adyen.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Legal Entity Management API?
Requests go to https://kyc-test.adyen.com/lem/v4. Endpoint paths are added to this base URL.
How do I authenticate with the Legal Entity Management API?
It accepts 2 methods: an API key in the X-API-Key header; HTTP Basic authentication (username and password).
How many endpoints does the Legal Entity Management API have?
34 operations on 27 paths (14 POST, 12 GET, 5 PATCH, 3 DELETE). The largest groups are Legal entities, PCI questionnaires, Terms of Service, Business lines.
Is forking the Legal Entity Management API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.