Adyen-for-platform icon

LEM API changelog v2-v4

See what has changed between v2 and v4 of the Legal Entity Management API

For a list of changes in the Legal Entity Management API in both v3 and v4, see here.

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

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

Creates a business line.

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

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

  • You can now set the service field in the POST/businessLines request to issuing.

  • You can now include the following fields in the POST/businessLines 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 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

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

  • Breaking
    The service field in the POST/businessLines response can now contain issuing.

  • The POST/businessLines response can now contain:

    • sourceOfFunds.amount
    • sourceOfFunds.assetMonthsHeld
    • sourceOfFunds.cryptocurrencyExchange
    • sourceOfFunds.dateOfFundsReceived
    • sourceOfFunds.dateOfSourceEvent
    • sourceOfFunds.financiers
    • sourceOfFunds.originatorLegalEntityId
    • sourceOfFunds.originatorSourceOfFundsType
    • sourceOfFunds.purpose
    • sourceOfFunds.relationship
    • sourceOfFunds.website

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.
  • Breaking
    The service 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.
  • The POST/businessLines response now contains service.

Removed

Request

  • Breaking
    The capability field is removed.
  • Breaking
    The sourceOfFunds.acquiringBusinessLineId field is removed.

Response

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

Returns the detail of a business line.

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

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 contain the problems array.

  • 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 required, 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.
  • The POST/businessLines response now contains service.

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

Updates a business line.

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

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

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



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

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

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

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.
  • The PATCH/businessLines/{id} response now contains service.

Removed

Request

  • Breaking
    The capability field is removed.
  • Breaking
    The sourceOfFunds.acquiringBusinessLineId field is removed.

Response

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

Uploads a document for verification checks.

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

New

Request

  • The type field in the POST/documents response can now be set to proofOfDirector.
  • 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 now contain proofOfDirector.
  • Breaking
    The type field in the POST/documents response can contain proofOfRelationship.

Returns a document.

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

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.
  • 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/v4/documents/{id}

New

Request

  • The type field in the PATCH/documents/{id} request can now be set to proofOfDirector.
  • 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 proofOfDirector.
  • 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/v4/legalEntities

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
    • 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.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
    • organization.financialReports
    • soleProprietorship.financialReports
    • problems
    • trust.description
    • unincorporatedPartnership.description
    • verificationDeadlines

Returns a legal entity.

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

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 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
    • organization.financialReports
    • soleProprietorship.financialReports
    • problems
    • trust.description
    • unincorporatedPartnership.description
    • verificationDeadlines

Updates a legal entity.

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

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
    • 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.doingBusinessAsAbsent
    • soleProprietorship.doingBusinessAsAbsent
    • trust.doingBusinessAsAbsent
    • unincorporatedPartnership.doingBusinessAsAbsent
    • individual.support
    • organization.support
    • 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/v4/legalEntities/{id}/businessLines

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

  • 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 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

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/v4/legalEntities/{id}/checkVerificationErrors

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/v4/legalEntities/{id}/confirmDataReview

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/v4/transferInstruments

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/v4/transferInstruments/{id}

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/v4/transferInstruments/{id}

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