Legal Entity Management v3 - Overview | Adyen API Explorer

https://kyc-test.adyen.com/lem/v3

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

Legal Entity Management v4 is currently in beta version. Please reach out to your Adyen contact for more information.

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/v3/legalEntities

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/v3.

post/businessLines

Create a business line

get/businessLines/{id}

Get a business line

delete/businessLines/{id}

Delete a business line

patch/businessLines/{id}

Update a business line

Upload a document for verification checks

get/documents/{id}

Get a document

delete/documents/{id}

Delete a document

patch/documents/{id}

Update a document

post/legalEntities

Create a legal entity

get/legalEntities/{id}

Get a legal entity

patch/legalEntities/{id}

Update a legal entity

get/legalEntities/{id}/acceptedTermsOfServiceDocument/{termsofserviceacceptancereference}

Get accepted Terms of Service document

get/legalEntities/{id}/businessLines

Get all business lines under a legal entity

post/legalEntities/{id}/checkTaxElectronicDeliveryConsent

Check the status of consent for electronic delivery of tax forms

post/legalEntities/{id}/checkVerificationErrors

Check a legal entity's verification errors

post/legalEntities/{id}/confirmDataReview

Confirm data review

post/legalEntities/{id}/onboardingLinks

Get a link to an Adyen-hosted onboarding page

get/legalEntities/{id}/pciQuestionnaires

Get PCI questionnaire details

post/legalEntities/{id}/pciQuestionnaires/generatePciTemplates

Generate PCI questionnaire

post/legalEntities/{id}/pciQuestionnaires/signPciTemplates

Sign PCI questionnaire

post/legalEntities/{id}/pciQuestionnaires/signingRequired

Calculate PCI status of a legal entity

get/legalEntities/{id}/pciQuestionnaires/{pciid}

Get PCI questionnaire

post/legalEntities/{id}/setTaxElectronicDeliveryConsent

Set the consent status for electronic delivery of tax forms

post/legalEntities/{id}/termsOfService

Get Terms of Service document

patch/legalEntities/{id}/termsOfService/{termsofservicedocumentid}

Accept Terms of Service

get/legalEntities/{id}/termsOfServiceAcceptanceInfos

Get Terms of Service information for a legal entity

get/legalEntities/{id}/termsOfServiceStatus

Get Terms of Service status

Get a list of hosted onboarding page themes

get/themes/{id}

Get an onboarding link theme

post/transferInstruments

Create a transfer instrument

get/transferInstruments/{id}

Get a transfer instrument

delete/transferInstruments/{id}

Delete a transfer instrument

patch/transferInstruments/{id}

Update a transfer instrument