Legal Entity Management API

https://kyc-test.adyen.com/lem/v3
Click to copy

The Legal Entity Management API enables you to manage legal entities that contain information required for verification.

Authentication

Your 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:

curl
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
...

Alternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:

curl
-U "ws_123456@Scope.Company_YOUR_COMPANY_ACCOUNT":"YourWsPassword" \
-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/v3/legalEntities

If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.

Going live

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

Create a business line
Get a business line
Delete a business line
Update a business line
Upload a document for verification checks
Get a document
Delete a document
Update a document
Create a legal entity
Get a legal entity
Update a legal entity
Get all business lines under a legal entity
Check a legal entity's verification errors
Get a link to an Adyen-hosted onboarding page
Get PCI questionnaire details
Get Terms of Service document
Get Terms of Service information for a legal entity
Get Terms of Service status
Get a list of hosted onboarding page themes
Get an onboarding link theme
Create a transfer instrument
Get a transfer instrument
Delete a transfer instrument
Update a transfer instrument