Legal Entity Management API (v3)

Number of APIs: 29

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" \n-H "Content-Type: application/json" \n...

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" \n-H "Content-Type: application/json" \n...

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

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.

1. Legal entities-/legalEntities - Create a legal entity for a trust in Australia

POST {{baseUrl}}/legalEntities

---

2. Legal entities-/legalEntities/:id - Get a legal entity

GET {{baseUrl}}/legalEntities/:id

---

3. Legal entities-/legalEntities/:id - Associate an exempt settlor with a trust

PATCH {{baseUrl}}/legalEntities/:id

---

4. Legal entities-/legalEntities/:id/businessLines - Get all business lines under a legal entity

GET {{baseUrl}}/legalEntities/:id/businessLines

---

5. Legal entities-/legalEntities/:id/checkVerificationErrors - Check a legal entity's verification errors

POST {{baseUrl}}/legalEntities/:id/checkVerificationErrors

---

6. Legal entities-/legalEntities/:id/confirmDataReview - Confirm data review

POST {{baseUrl}}/legalEntities/:id/confirmDataReview

---

7. Hosted Onboarding-/legalEntities/:id/onboardingLinks - Create a hosted onboarding link

POST {{baseUrl}}/legalEntities/:id/onboardingLinks

---

8. Hosted Onboarding-/themes/:id - Get an onboarding link theme

GET {{baseUrl}}/themes/:id

---

9. Business lines-/businessLines - Create a business line for receiving payments

POST {{baseUrl}}/businessLines