Adyen-for-platform icon

LEM API changelog v3 and v4

See what has changed in recent versions of the Legal Entity Management API.

If you are currently using onboarding v2, and plan to update your onboarding version to v4, see here for a comprehensive list of changes between v2 and v4.

See breaking changes for more information about how we define breaking changes in our APIs.

Endpoint Description What's new in v4? What's new in v3?
POST
  /businessLines		 Creates a business line. 6 breaking changes 2 breaking changes
GET
  /businessLines		 Returns the detail of a business line. 3 breaking changes 1 breaking change
PATCH
  /businessLines		 Updates a business line. 7 breaking changes 1 breaking change
POST
  /documents		 Uploads a document for verification checks. 1 breaking change 1 breaking change
GET
  /documents/{id}		 Returns a document. 1 breaking change 1 breaking change
PATCH
  /documents/{id}		 Updates a document. 1 breaking change 1 breaking change
POST
  /legalEntities		 Creates a legal entity. No breaking changes 1 breaking change
GET
  /legalEntities/{id}		 Returns a legal entity. No breaking changes 1 breaking change
PATCH
  /legalEntities/{id}		 Updates a legal entity. No breaking changes 1 breaking change
GET
  /legalEntities/{id}/businessLines		 Returns the business lines owned by a legal entity. 4 breaking changes 1 breaking change
POST
  /checkVerificationErrors		 Returns the verification errors for a legal entity and its supporting entities. No changes New endpoint
POST
  /confirmDataReview		 Confirms that your user has reviewed the data for the legal entity specified in the path. No changes New endpoint
POST
  /transferInstruments		 Creates a transfer instrument. No changes 2 breaking changes
GET
  /transferInstruments/{id}		 Returns the details of a transfer instrument. No changes 1 breaking change
PATCH
  /transferInstruments/{id}		 Updates a transfer instrument. No changes 2 breaking changes

Creates a business line.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/businessLines

V4 changelog

New

Request

  • You can now set the sourceOfFunds.type field in the POST/businessLines request to:
    • adyenProcessed
    • assetSale
    • business
    • cryptocurrencyIncome
    • dividendIncome
    • donations
    • employment
    • financialAid
    • gamblingWinnings
    • inheritance
    • insuranceSettlement
    • loans
    • pensionIncome
    • rentalIncome
    • royaltyIncome
    • thirdPartyFunding

Response

  • Breaking
    The sourceOfFunds.type field in the POST/businessLines response now contains one of the following values:
    • adyenProcessed
    • assetSale
    • business
    • cryptocurrencyIncome
    • dividendIncome
    • donations
    • employment
    • financialAid
    • gamblingWinnings
    • inheritance
    • insuranceSettlement
    • loans
    • pensionIncome
    • rentalIncome
    • royaltyIncome
    • thirdPartyFunding

Changed

Request

  • Breaking
    The sourceOfFunds.type field is now required in the POST/businessLines request.
  • Breaking
    The sourceOfFunds.adyenProcessedFunds field is now required in the POST/businessLines request.

Response

  • Breaking
    The POST/businessLines response now contains the sourceOfFunds.type field.
  • Breaking
    The POST/businessLines response now contains the sourceOfFunds.adyenProcessedFunds field.

Removed

Request

  • Breaking
    The capability field is deprecated.

  • Breaking
    The sourceOfFunds.acquiringBusinessLineId field is deprecated.

Response

  • Breaking
    The POST/businessLines response no longer contains:
    • capability
    • sourceOfFunds.acquiringBusinessLineId

V3 changelog

New

Request

This version does not introduce any new fields to the POST/businessLines request.

Response

  • The POST/businessLines response can now contain the problems array.

Changed

Request

  • Breaking
    The service field is now required in the POST/businessLines request.
  • The capability field in the POST/businessLines request became optional.

Response

  • Breaking
    The capability field in the POST/businessLines response became optional.
  • The POST/businessLines response now contains service.

Returns the detail of a business line.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/businessLines/{id}

V4 changelog

New

Request

This version does not introduce any changes to the GET/businessLines/{id} request.

Response

  • Breaking
    The sourceOfFunds.type field in the GET/businessLines/{id} response now contains one of the following values:
    • adyenProcessed
    • assetSale
    • cryptocurrencyIncome
    • dividendIncome
    • donations
    • employment
    • financialAid
    • gamblingWinnings
    • inheritance
    • insuranceSettlement
    • loans
    • pensionIncome
    • rentalIncome
    • royaltyIncome
    • thirdPartyFunding

  • Breaking
    The service field in the GET/businessLines/{id} response can now contain issuing.


  • The GET/businessLines/{id} response can now include:
    • sourceOfFunds.amount
    • sourceOfFunds.assetMonthsHeld
    • sourceOfFunds.cryptocurrencyExchange
    • sourceOfFunds.dateOfFundsReceived
    • sourceOfFunds.dateOfSourceEvent
    • sourceOfFunds.financiers
    • sourceOfFunds.originatorLegalEntityId
    • sourceOfFunds.originatorSourceOfFundsType
    • sourceOfFunds.purpose
    • sourceOfFunds.relationship
    • sourceOfFunds.website

Changed

Request

This version does not introduce any changes to the GET/businessLines/{id} request.

Response

  • The sourceOfFunds.type field is no longer optional, and the field is returned in the GET/businessLines/{id} response.
  • The sourceOfFunds.adyenProcessedFunds field is required, and the field is returned in the GET/businessLines/{id} response.

Removed

Request

This version does not remove any fields from the GET/businessLines/{id} request.

Response

  • Breaking
    The GET/businessLines/{id} response no longer contains:
    • capability
    • sourceOfFunds.acquiringBusinessLineId

V3 changelog

New

Request

This version does not introduce any changes to the GET/businessLines/{id} request.

Response

  • The GET/businessLines/{id} response can now contain the problems array.

Changed

Request

This version does not introduce any changes to the GET/businessLines/{id} request.

Response

  • Breaking
    The capability field in the POST/businessLines response became optional.
  • The POST/businessLines response now contains service.

Updates a business line.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/businessLines/{id}

V4 changelog

New

Request

  • You can now include the following fields in the PATCH/businessLines/{id} request:
    • sourceOfFunds.amount
    • sourceOfFunds.assetMonthsHeld
    • sourceOfFunds.cryptocurrencyExchange
    • sourceOfFunds.dateOfFundsReceived
    • sourceOfFunds.dateOfSourceEvent
    • sourceOfFunds.financiers
    • sourceOfFunds.originatorLegalEntityId
    • sourceOfFunds.originatorSourceOfFundsType
    • sourceOfFunds.purpose
    • sourceOfFunds.relationship
    • sourceOfFunds.website

Response

  • Breaking
    The sourceOfFunds.type field in the PATCH/businessLines/{id} response now contains one of the following values:
    • adyenProcessed
    • assetSale
    • cryptocurrencyIncome
    • dividendIncome
    • donations
    • employment
    • financialAid
    • gamblingWinnings
    • inheritance
    • insuranceSettlement
    • loans
    • pensionIncome
    • rentalIncome
    • royaltyIncome
    • thirdPartyFunding

Changed

Request

  • Breaking
    The sourceOfFunds.type field is now required in the PATCH/businessLines/{id} request.
  • Breaking
    The sourceOfFunds.adyenProcessedFunds field is now required in the PATCH/businessLines/{id} request.

Response

  • Breaking
    The PATCH/businessLines/{id} response now contains the sourceOfFunds.type field.

Removed

Request

  • Breaking
    The capability field is deprecated.

  • Breaking
    The sourceOfFunds.acquiringBusinessLineId field is deprecated.

Response

  • Breaking
    The PATCH/businessLines/{id} response no longer contains:
    • capability
    • sourceOfFunds.acquiringBusinessLineId

V3 changelog

New

Request

This version does not introduce any new fields to the PATCH/businessLines/{id} request.

Response

  • The PATCH/businessLines/{id} response can now contain the problems array.

Changed

Request

This version does not introduce any changes to the PATCH/businessLines/{id} request.

Response

  • Breaking
    The capability field in the PATCH/businessLines/{id} response became optional.
  • The PATCH/businessLines/{id} response now contains service.

Uploads a document for verification checks.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/documents

V4 changelog

New

Request

  • The type field in the POST/documents response can now be set to proofOfDirector.

Response

  • Breaking
    The type field in the POST/documents response can now contain proofOfDirector.

V3 changelog

New

Request

  • The type field in the POST/documents request can now be set to proofOfRelationship.

Response

  • Breaking
    The type field in the POST/documents response can contain proofOfRelationship.

Returns a document.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/documents/{id}

V4 changelog

New

Request

This version does not introduce any changes to the GET/documents/{id} request.

Response

  • Breaking
    The type field in the GET/documents/{id} response can contain proofOfDirector.

V3 changelog

New

Request

This version does not introduce any changes to the GET/documents/{id} request.

Response

  • Breaking
    The type field in the GET/documents/{id} response can now contain proofOfRelationship.

Updates a document.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/documents/{id}

V4 changelog

New

Request

  • The type field in the PATCH/documents/{id} request can now be set to proofOfDirector.

Response

  • Breaking
    The type field in the PATCH/documents/{id} response can now contain proofOfDirector.

V3 changelog

New

Request

  • The type field in the PATCH/documents/{id} request can now be set to proofOfRelationship.

Response

  • Breaking
    The type field in the PATCH/documents/{id} response can now contain proofOfRelationship.

Creates a legal entity.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/legalEntities

V4 changelog

New

Request

  • You can now include the following fields in the POST/legalEntities request:
    • organization.doingBusinessAsAbsent
    • soleProprietorship.doingBusinessAsAbsent
    • trust.doingBusinessAsAbsent
    • unincorporatedPartnership.doingBusinessAsAbsent
    • individual.support
    • organization.support
    • individual.taxInformation.numberAbsent
    • organization.taxInformation.numberAbsent
    • soleProprietorship.taxInformation.numberAbsent
    • trust.taxInformation.numberAbsent
    • unincorporatedPartnership.taxInformation.numberAbsent

Response

  • The POST/legalEntities response can now contain:
    • organization.doingBusinessAsAbsent
    • soleProprietorship.doingBusinessAsAbsent
    • trust.doingBusinessAsAbsent
    • unincorporatedPartnership.doingBusinessAsAbsent
    • individual.support
    • organization.support
    • individual.taxInformation.numberAbsent
    • organization.taxInformation.numberAbsent
    • soleProprietorship.taxInformation.numberAbsent
    • trust.taxInformation.numberAbsent
    • unincorporatedPartnership.taxInformation.numberAbsent

V3 changelog

New

Request

  • You can now include the following fields in the POST/legalEntities request.

    • organization.financialReports
    • soleProprietorship.financialReports
    • trust.description
    • unincorporatedPartnership.description

  • You can now set the entityAssociations.items.type field in the POST/legalEntities request to:

    • legalRepresentative
    • trustOwnership

Response

  • Breaking
    The entityAssociations.items.type field in the POST/legalEntities response can now contain one of the following values:
    • legalRepresentative
    • trustOwnership

  • The POST/legalEntities response can now contain:

    • organization.financialReports
    • soleProprietorship.financialReports
    • problems
    • trust.description
    • unincorporatedPartnership.description
    • verificationDeadlines

Returns a legal entity.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/legalEntities/{id}

V4 changelog

New

Request

This version does not introduce any changes to the GET/legalEntities/{id} request.

Response

  • The GET/legalEntities/{id} response can now include:
    • organization.doingBusinessAsAbsent
    • soleProprietorship.doingBusinessAsAbsent
    • trust.doingBusinessAsAbsent
    • unincorporatedPartnership.doingBusinessAsAbsent
    • individual.support
    • organization.support
    • individual.taxInformation.numberAbsent
    • organization.taxInformation.numberAbsent
    • soleProprietorship.taxInformation.numberAbsent
    • trust.taxInformation.numberAbsent
    • unincorporatedPartnership.taxInformation.numberAbsent

V3 changelog

New

Request

This version does not introduce any changes to the GET/legalEntities/{id} request.

Response

  • Breaking
    The entityAssociations.items.type field in the GET/legalEntities/{id} response can now contain one of the following values:
    • legalRepresentative
    • trustOwnership

  • The GET/legalEntities/{id} response can now contain:

    • organization.financialReports
    • soleProprietorship.financialReports
    • problems
    • trust.description
    • unincorporatedPartnership.description
    • verificationDeadlines

Updates a legal entity.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/legalEntities/{id}

V4 changelog

New

Request

  • You can now include the following fields in the PATCH/legalEntities/{id} request:
    • organization.doingBusinessAsAbsent
    • soleProprietorship.doingBusinessAsAbsent
    • trust.doingBusinessAsAbsent
    • unincorporatedPartnership.doingBusinessAsAbsent
    • individual.support
    • organization.support
    • individual.taxInformation.numberAbsent
    • organization.taxInformation.numberAbsent
    • soleProprietorship.taxInformation.numberAbsent
    • trust.taxInformation.numberAbsent
    • unincorporatedPartnership.taxInformation.numberAbsent

Response

  • The PATCH/legalEntities/{id} response can now contain:
    • organization.doingBusinessAsAbsent
    • soleProprietorship.doingBusinessAsAbsent
    • trust.doingBusinessAsAbsent
    • unincorporatedPartnership.doingBusinessAsAbsent
    • individual.support
    • organization.support

V3 changelog

New

Request

  • You can now include the following fields in the PATCH/legalEntities/{id} request.

    • organization.financialReports
    • soleProprietorship.financialReports
    • trust.description
    • unincorporatedPartnership.description

  • You can now set the entityAssociations.items.type field in the PATCH/legalEntities/{id} request to:

    • legalRepresentative
    • trustOwnership

Response

  • Breaking
    The entityAssociations.items.type field in the PATCH/legalEntities/{id} response can now contain one of the following values:
    • legalRepresentative
    • trustOwnership

  • The PATCH/legalEntities/{id} response can now contain:

    • organization.financialReports
    • soleProprietorship.financialReports
    • problems
    • trust.description
    • unincorporatedPartnership.description
    • verificationDeadlines

Returns the business lines owned by a legal entity.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/legalEntities/{id}/businessLines

V4 changelog

New

Request

This version does not introduce any changes to the GET/legalEntities/{id}/businessLines request.

Response

  • Breaking
    The businessLines.items.sourceOfFunds.type field in the GET/legalEntities/{id}/businessLines response now contains one of the following values:
    • adyenProcessed
    • assetSale
    • cryptocurrencyIncome
    • dividendIncome
    • donations
    • employment
    • financialAid
    • gamblingWinnings
    • inheritance
    • insuranceSettlement
    • loans
    • pensionIncome
    • rentalIncome
    • royaltyIncome
    • thirdPartyFunding

  • Breaking
    The 'businessLines.items.service field in the GET/legalEntities/{id}/businessLines response can now contain issuing.

  • The GET/legalEntities/{id}/businessLines response can now include:
    • businessLines.items.sourceOfFunds.amount
    • businessLines.items.sourceOfFunds.assetMonthsHeld
    • businessLines.items.sourceOfFunds.cryptocurrencyExchange
    • businessLines.items.sourceOfFunds.dateOfFundsReceived
    • businessLines.items.sourceOfFunds.dateOfSourceEvent
    • businessLines.items.sourceOfFunds.financiers
    • businessLines.items.sourceOfFunds.originatorLegalEntityId
    • businessLines.items.sourceOfFunds.originatorSourceOfFundsType
    • businessLines.items.sourceOfFunds.purpose
    • businessLines.items.sourceOfFunds.relationship
    • businessLines.items.sourceOfFunds.website

Changed

Request

This version does not introduce any changes to the GET/legalEntities/{id}/businessLines request.

Response

  • Breaking
    The GET/legalEntities/{id}/businessLines response now contains the businessLines.items.sourceOfFunds.type field.

Removed

Request

This version does not remove any fields from the GET/legalEntities/{id}/businessLines request.

Response

  • Breaking
    The GET/legalEntities/{id}/businessLines response no longer contains:
    • businessLines.items.capability
    • businessLines.items.sourceOfFunds.acquiringBusinessLineId

V3 changelog

New

Request

This version does not introduce any changes to the GET/legalEntities/{id}/businessLines request.

Response

  • The GET/legalEntities/{id}/businessLines response can now contain the following fields:
    • businessLines.items.problems
    • businessLines.items.service

Changed

Request

This version does not introduce any changes to the GET/legalEntities/{id}/businessLines request.

Response

  • Breaking
    The businessLines.items.capability field is now an optional field.

New endpoint in v3
Returns the verification errors for a legal entity and its supporting entities.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/legalEntities/{id}/checkVerificationErrors

V3 changelog

New

Request

  • The id field is a required path parameter for the POST/legalEntities/{id}/checkVerificationErrors request.

Response

  • The POST/legalEntities/{id}/checkVerificationErrors response contains the problems array.

New endpoint in v3
Confirms that your user has reviewed the data for the legal entity specified in the path.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/legalEntities/{id}/confirmDataReview

V3 changelog

New

Request

  • The id field is a required path parameter for the POST/legalEntities/{id}/confirmDataReview request.

Response

  • The POST/legalEntities/{id}/confirmDataReview response contains the dataReviewedAt field.

Creates a transfer instrument.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/transferInstruments

V3 changelog

New

Request

  • You can now include the bankAccount.accountIdentification field in the POST/transferInstruments request.

Response

  • The POST/transferInstruments response can now contain:
    • bankAccount.accountIdentification
    • capabilities
    • problems

Removed

Request

  • Breaking
    The following fields are removed from the POST/transferInstruments request:
    • bankAccount.currencyCode
    • bankAccount.accountNumber
    • bankAccount.bankBicSwift
    • bankAccount.bankCity
    • bankAccount.bankCode
    • bankAccount.branchCode
    • bankAccount.checkCode
    • bankAccount.currencyCode
    • bankAccount.iban

Response

  • Breaking
    The POST/transferInstruments response no longer contains:
    • bankAccount.currencyCode
    • bankAccount.accountNumber
    • bankAccount.bankBicSwift
    • bankAccount.bankCity
    • bankAccount.bankCode
    • bankAccount.branchCode
    • bankAccount.checkCode
    • bankAccount.currencyCode
    • bankAccount.iban

Returns the details of a transfer instrument.
Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/transferInstruments/{id}

V3 changelog

New

Request

This version does not introduce any changes to the GET/transferInstruments/{id} request.

Response

  • The GET/transferInstruments/{id} response can now contain:
    • bankAccount.accountIdentification
    • capabilities
    • problems

Removed

Request

This version does not introduce any changes to the GET/transferInstruments/{id} request.

Response

  • Breaking
    The GET/transferInstruments/{id} response no longer contains:
    • bankAccount.currencyCode
    • bankAccount.accountNumber
    • bankAccount.bankBicSwift
    • bankAccount.bankCity
    • bankAccount.bankCode
    • bankAccount.branchCode
    • bankAccount.checkCode
    • bankAccount.currencyCode
    • bankAccount.iban

Updates a transfer instrument.

Endpoint destination URL: https://kyc-test.adyen.com/lem/v3/transferInstruments/{id}

V3 changelog

New

Request

  • You can now include the bankAccount.accountIdentification field in the PATCH/transferInstruments/{id} request.

Response

  • The PATCH/transferInstruments/{id} response can now contain:
    • bankAccount.accountIdentification
    • capabilities
    • problems

Removed

Request

  • Breaking
    The following fields are removed from the PATCH/transferInstruments/{id} request:
    • bankAccount.currencyCode
    • bankAccount.accountNumber
    • bankAccount.bankBicSwift
    • bankAccount.bankCity
    • bankAccount.bankCode
    • bankAccount.branchCode
    • bankAccount.checkCode
    • bankAccount.currencyCode
    • bankAccount.iban

Response

  • Breaking
    The PATCH/transferInstruments/{id} response no longer contains:
    • bankAccount.currencyCode
    • bankAccount.accountNumber
    • bankAccount.bankBicSwift
    • bankAccount.bankCity
    • bankAccount.bankCode
    • bankAccount.branchCode
    • bankAccount.checkCode
    • bankAccount.currencyCode
    • bankAccount.iban