Pricing Templates
Log in Sign up
Integrations / Adyen Legal Entity Management / ...

PATCH /legalEntities/{id}

Updates a legal entity.

To change the legal entity type, include only the new type in your request. To update the entityAssociations array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.

Servers

Path parameters

Name Type Required Description
id String Yes

The unique identifier of the legal entity.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"
x-requested-verification-code String No

Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.

Request body fields

Name Type Required Description
individual Object No

Information about the individual. Required if type is individual.
individual.residentialAddress Object Yes

The residential address of the individual.
individual.residentialAddress.street2 String No

The apartment, unit, or suite number.
individual.residentialAddress.postalCode String No

Postal code. Required if stateOrProvince and/or city is provided.
individual.residentialAddress.stateOrProvince String No

The two-letter ISO 3166-2 state or province code. For example, CA in the US.

If you specify the state or province, you must also send city, postalCode, and street.
individual.residentialAddress.country String Yes

The two-letter ISO 3166-1 alpha-2 country code.
individual.residentialAddress.street String No

The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
individual.residentialAddress.city String No

The name of the city. Required if stateOrProvince is provided.

If you specify the city, you must also send postalCode and street.
individual.email String No

The email address of the legal entity.
individual.name Object Yes

The individual's name.
individual.name.lastName String Yes

The individual's last name. Must not be blank.
individual.name.firstName String Yes

The individual's first name. Must not be blank.
individual.name.infix String No

The infix in the individual's name, if any.
individual.identificationData Object No

Information about the individual's identification document.
individual.identificationData.issuerState String No

The state or province where the document was issued (AU only).
individual.identificationData.number String No

The number in the document.
individual.identificationData.expiryDate String No

The expiry date of the document, in YYYY-MM-DD format.
individual.identificationData.nationalIdExempt Boolean No

Applies only to individuals in the US. Set to true if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document.
individual.identificationData.cardNumber String No

The card number of the document that was issued (AU only).
individual.identificationData.type String Yes

Type of identity data. For individuals, the following types are supported. See our onboarding guide for other supported countries.

  • Australia: driversLicense, passport

  • Hong Kong: driversLicense, nationalIdNumber, passport

  • New Zealand: driversLicense, passport

  • Singapore: driversLicense, nationalIdNumber, passport

  • All other supported countries: nationalIdNumber

Possible values:

  • "passport"
  • "driversLicense"
  • "nationalIdNumber"
  • "identityCard"
individual.identificationData.issuerCountry String No

The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.
individual.webData Object No

The website and app URL of the legal entity.
individual.webData.webAddress String No

The URL of the website or the app store URL.
individual.webData.webAddressId String No

The unique identifier of the web address.
individual.phone Object No

The phone number of the legal entity.
individual.phone.number String Yes

The full phone number, including the country code. For example, +3112345678.
individual.phone.type String No

The type of phone number. Possible values: mobile, landline, sip, fax.
individual.phone.phoneCountryCode String No

The two-letter ISO 3166-1 alpha-2 country code prefix of the phone number. For example, US or NL.

The value of the phoneCountryCode is determined by the country code digit(s) of phone.number
individual.nationality String No

The individual's nationality.
individual.taxInformation[] Array No

The tax information of the individual.
individual.taxInformation[].number String No

The tax ID number (TIN) of the organization or individual.
individual.taxInformation[].type String No

The TIN type depending on the country where it was issued. Only provide if the country has multiple tax IDs: Singapore, Sweden, the UK, or the US. For example, provide SSN, EIN, or ITIN for the US.
individual.taxInformation[].country String No

The two-letter ISO 3166-1 alpha-2 country code.
individual.birthData Object No

The individual's birth information.
individual.birthData.dateOfBirth String No

The individual's date of birth, in YYYY-MM-DD format.
entityAssociations[] Array No

List of legal entities associated with the current legal entity. For example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories.
entityAssociations[].name String No

The name of the associated legal entity.

  • For individual, name.firstName and name.lastName.
  • For organization, legalName.
  • For soleProprietorship, name.
entityAssociations[].settlorExemptionReason[] Array No

Defines the Kyc Exemption Reason for a Settlor associated with a trust.

For example, professionalServiceProvider, deceased, or contributionBelowThreshold.
entityAssociations[].entityType String No

The legal entity type of associated legal entity.

For example, organization, soleProprietorship or individual.
entityAssociations[].relationship String No

The individual's relationship to a legal representative if the type is legalRepresentative. Possible values: parent, guardian.
entityAssociations[].type String Yes

Defines the relationship of the legal entity to the current legal entity.

Possible value for individuals: legalRepresentative.

Possible values for organizations: uboThroughOwnership, uboThroughControl, director, signatory, or ultimateParentCompany.

Possible values for sole proprietorships: soleProprietorship.

Possible value for trusts: trust.

Possible values for trust members: definedBeneficiary, protector, secondaryTrustee, settlor, uboThroughControl, or uboThroughOwnership.

Possible values:

  • "protector"
  • "undefinedBeneficiary"
  • "immediateParentCompany"
  • "legalRepresentative"
  • "signatory"
  • "trust"
  • "ultimateParentCompany"
  • "uboThroughControl"
  • "definedBeneficiary"
  • "trustOwnership"
  • "director"
  • "uboThroughOwnership"
  • "pciSignatory"
  • "secondaryTrustee"
  • "settlor"
  • "soleProprietorship"
entityAssociations[].jobTitle String No

The individual's job title if the type is uboThroughControl or signatory.
entityAssociations[].legalEntityId String Yes

The unique identifier of the associated legal entity.
entityAssociations[].associatorId String No

The unique identifier of another legal entity with which the legalEntityId is associated. When the legalEntityId is associated to legal entities other than the current one, the response returns all the associations.
verificationPlan String No

A key-value pair that specifies the verification process for a legal entity. Set to upfront for upfront verification for marketplaces.
trust Object No

Information about the trust. Required if type is trust.
trust.doingBusinessAs String No

The registered name, if different from the name.
trust.registrationNumber String No

The registration number.
trust.description String No

A short description about the trust. Only applicable for charitable trusts in New Zealand.
trust.undefinedBeneficiaryInfo[] Array No

The undefined beneficiary information of the entity.
trust.undefinedBeneficiaryInfo[].description String No

The details of the undefined beneficiary.
trust.undefinedBeneficiaryInfo[].reference String No

The reference of the undefined beneficiary.
trust.registeredAddress Object Yes

The address registered at the registrar, such as the Chamber of Commerce.
trust.registeredAddress.street2 String No

The apartment, unit, or suite number.
trust.registeredAddress.postalCode String No

Postal code. Required if stateOrProvince and/or city is provided.
trust.registeredAddress.stateOrProvince String No

The two-letter ISO 3166-2 state or province code. For example, CA in the US.

If you specify the state or province, you must also send city, postalCode, and street.
trust.registeredAddress.country String Yes

The two-letter ISO 3166-1 alpha-2 country code.
trust.registeredAddress.street String No

The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
trust.registeredAddress.city String No

The name of the city. Required if stateOrProvince is provided.

If you specify the city, you must also send postalCode and street.
trust.vatNumber String No

The VAT number.
trust.principalPlaceOfBusiness Object No

The business address. Required if the principal place of business is different from the registeredAddress.
trust.principalPlaceOfBusiness.street2 String No

The apartment, unit, or suite number.
trust.principalPlaceOfBusiness.postalCode String No

Postal code. Required if stateOrProvince and/or city is provided.
trust.principalPlaceOfBusiness.stateOrProvince String No

The two-letter ISO 3166-2 state or province code. For example, CA in the US.

If you specify the state or province, you must also send city, postalCode, and street.
trust.principalPlaceOfBusiness.country String Yes

The two-letter ISO 3166-1 alpha-2 country code.
trust.principalPlaceOfBusiness.street String No

The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
trust.principalPlaceOfBusiness.city String No

The name of the city. Required if stateOrProvince is provided.

If you specify the city, you must also send postalCode and street.
trust.name String Yes

The legal name.
trust.type String Yes

Type of trust.

See possible values for trusts in Australia and New Zealand.

Possible values:

  • "unlistedPublicUnitTrust"
  • "familyTrust"
  • "listedPublicUnitTrust"
  • "publicTradingTrust"
  • "fixedUnitTrust"
  • "hybridTrust"
  • "discretionaryTrust"
  • "charitableTrust"
  • "deceasedEstate"
  • "firstHomeSaverAccountsTrust"
  • "businessTrust"
  • "discretionaryServicesManagementTrust"
  • "cashManagementTrust"
  • "pooledSuperannuationTrust"
  • "fixedTrust"
  • "discretionaryInvestmentTrust"
  • "corporateUnitTrust"
  • "discretionaryTradingTrust"
  • "otherTrust"
trust.countryOfGoverningLaw String Yes

The two-character ISO 3166-1 alpha-2 country code of the governing country.
trust.vatAbsenceReason String No

The reason for not providing a VAT number.

Possible values: industryExemption, belowTaxThreshold.

Possible values:

  • "industryExemption"
  • "belowTaxThreshold"
trust.dateOfIncorporation String No

The date when the legal arrangement was incorporated in YYYY-MM-DD format.
trust.taxInformation[] Array No

The tax information of the entity.
trust.taxInformation[].number String No

The tax ID number (TIN) of the organization or individual.
trust.taxInformation[].type String No

The TIN type depending on the country where it was issued. Only provide if the country has multiple tax IDs: Singapore, Sweden, the UK, or the US. For example, provide SSN, EIN, or ITIN for the US.
trust.taxInformation[].country String No

The two-letter ISO 3166-1 alpha-2 country code.
type String No

The type of legal entity.

Possible values: individual, organization, soleProprietorship, or trust.

Possible values:

  • "organization"
  • "unincorporatedPartnership"
  • "individual"
  • "soleProprietorship"
  • "trust"
reference String No

Your reference for the legal entity, maximum 150 characters.
organization Object No

Information about the organization. Required if type is organization.
organization.doingBusinessAs String No

The organization's trading name, if different from the registered legal name.
organization.registrationNumber String No

The organization's registration number.
organization.description String No

Your description for the organization.
organization.registeredAddress Object Yes

The address of the organization registered at their registrar (such as the Chamber of Commerce).
organization.registeredAddress.street2 String No

The apartment, unit, or suite number.
organization.registeredAddress.postalCode String No

Postal code. Required if stateOrProvince and/or city is provided.
organization.registeredAddress.stateOrProvince String No

The two-letter ISO 3166-2 state or province code. For example, CA in the US.

If you specify the state or province, you must also send city, postalCode, and street.
organization.registeredAddress.country String Yes

The two-letter ISO 3166-1 alpha-2 country code.
organization.registeredAddress.street String No

The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
organization.registeredAddress.city String No

The name of the city. Required if stateOrProvince is provided.

If you specify the city, you must also send postalCode and street.
organization.vatNumber String No

The organization's VAT number.
organization.legalName String Yes

The organization's legal name.
organization.principalPlaceOfBusiness Object No

The address where the organization operates from. Provide this if the principal place of business is different from the registeredAddress.
organization.principalPlaceOfBusiness.street2 String No

The apartment, unit, or suite number.
organization.principalPlaceOfBusiness.postalCode String No

Postal code. Required if stateOrProvince and/or city is provided.
organization.principalPlaceOfBusiness.stateOrProvince String No

The two-letter ISO 3166-2 state or province code. For example, CA in the US.

If you specify the state or province, you must also send city, postalCode, and street.
organization.principalPlaceOfBusiness.country String Yes

The two-letter ISO 3166-1 alpha-2 country code.
organization.principalPlaceOfBusiness.street String No

The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
organization.principalPlaceOfBusiness.city String No

The name of the city. Required if stateOrProvince is provided.

If you specify the city, you must also send postalCode and street.
organization.email String No

The email address of the legal entity.
organization.taxReportingClassification Object No

The tax reporting classification (FATCA/CRS self-certification) of the organization.
organization.taxReportingClassification.financialInstitutionNumber String No

The Global Intermediary Identification Number (GIIN) required for FATCA. Only required if the organization is a US financial institution and the businessType is financialInstitution.
organization.taxReportingClassification.businessType String No

The organization's business type.

Possible values: other, listedPublicCompany, subsidiaryOfListedPublicCompany, governmentalOrganization, internationalOrganization, financialInstitution.

Possible values:

  • "internationalOrganization"
  • "other"
  • "subsidiaryOfListedPublicCompany"
  • "listedPublicCompany"
  • "governmentalOrganization"
  • "financialInstitution"
organization.taxReportingClassification.type String No

The tax reporting classification type.

Possible values: nonFinancialNonReportable, financialNonReportable, nonFinancialActive, nonFinancialPassive.

Possible values:

  • "nonFinancialPassive"
  • "nonFinancialNonReportable"
  • "financialNonReportable"
  • "nonFinancialActive"
organization.taxReportingClassification.mainSourceOfIncome String No

The organization's main source of income. Only required if businessType is other.

Possible values: businessOperation, realEstateSales, investmentInterestOrRoyalty, propertyRental, other.

Possible values:

  • "realEstateSales"
  • "propertyRental"
  • "investmentInterestOrRoyalty"
  • "other"
  • "businessOperation"
organization.webData Object No

The website and app URL of the legal entity.
organization.webData.webAddress String No

The URL of the website or the app store URL.
organization.webData.webAddressId String No

The unique identifier of the web address.
organization.phone Object No

The phone number of the legal entity.
organization.phone.number String Yes

The full phone number, including the country code. For example, +3112345678.
organization.phone.type String No

The type of phone number. Possible values: mobile, landline, sip, fax.
organization.phone.phoneCountryCode String No

The two-letter ISO 3166-1 alpha-2 country code prefix of the phone number. For example, US or NL.

The value of the phoneCountryCode is determined by the country code digit(s) of phone.number
organization.stockData Object No

Information about the organization's publicly traded stock. Provide this object only if type is listedPublicCompany.
organization.stockData.marketIdentifier String No

The four-digit Market Identifier Code of the stock market where the organization's stocks are traded.
organization.stockData.stockNumber String No

The 12-digit International Securities Identification Number (ISIN) of the company, without dashes (-).
organization.stockData.tickerSymbol String No

The stock ticker symbol.
organization.type String No

Type of organization.

Possible values: associationIncorporated, governmentalOrganization, listedPublicCompany, nonProfit, partnershipIncorporated, privateCompany.

Possible values:

  • "nonProfit"
  • "associationIncorporated"
  • "listedPublicCompany"
  • "governmentalOrganization"
  • "privateCompany"
  • "partnershipIncorporated"
organization.countryOfGoverningLaw String No

The two-character ISO 3166-1 alpha-2 country code of the governing country.
organization.vatAbsenceReason String No

The reason the organization has not provided a VAT number.

Possible values: industryExemption, belowTaxThreshold.

Possible values:

  • "industryExemption"
  • "belowTaxThreshold"
organization.dateOfIncorporation String No

The date when the organization was incorporated in YYYY-MM-DD format.
organization.taxInformation[] Array No

The tax information of the organization.
organization.taxInformation[].number String No

The tax ID number (TIN) of the organization or individual.
organization.taxInformation[].type String No

The TIN type depending on the country where it was issued. Only provide if the country has multiple tax IDs: Singapore, Sweden, the UK, or the US. For example, provide SSN, EIN, or ITIN for the US.
organization.taxInformation[].country String No

The two-letter ISO 3166-1 alpha-2 country code.
capabilities Object No

Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, issueCard for Issuing.The value is an object containing the settings for the capability.
soleProprietorship Object No

Information about the sole proprietorship. Required if type is soleProprietorship.
soleProprietorship.doingBusinessAs String No

The registered name, if different from the name.
soleProprietorship.name String Yes

The legal name.
soleProprietorship.registrationNumber String No

The registration number.
soleProprietorship.registeredAddress Object Yes

The address registered at the registrar, such as the Chamber of Commerce.
soleProprietorship.registeredAddress.street2 String No

The apartment, unit, or suite number.
soleProprietorship.registeredAddress.postalCode String No

Postal code. Required if stateOrProvince and/or city is provided.
soleProprietorship.registeredAddress.stateOrProvince String No

The two-letter ISO 3166-2 state or province code. For example, CA in the US.

If you specify the state or province, you must also send city, postalCode, and street.
soleProprietorship.registeredAddress.country String Yes

The two-letter ISO 3166-1 alpha-2 country code.
soleProprietorship.registeredAddress.street String No

The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
soleProprietorship.registeredAddress.city String No

The name of the city. Required if stateOrProvince is provided.

If you specify the city, you must also send postalCode and street.
soleProprietorship.countryOfGoverningLaw String Yes

The two-character ISO 3166-1 alpha-2 country code of the governing country.
soleProprietorship.vatNumber String No

The VAT number.
soleProprietorship.vatAbsenceReason String No

The reason for not providing a VAT number.

Possible values: industryExemption, belowTaxThreshold.

Possible values:

  • "industryExemption"
  • "belowTaxThreshold"
soleProprietorship.dateOfIncorporation String No

The date when the legal arrangement was incorporated in YYYY-MM-DD format.
soleProprietorship.taxAbsent Boolean No

The tax information is absent.
soleProprietorship.taxInformation[] Array No

The tax information of the entity.
soleProprietorship.taxInformation[].number String No

The tax ID number (TIN) of the organization or individual.
soleProprietorship.taxInformation[].type String No

The TIN type depending on the country where it was issued. Only provide if the country has multiple tax IDs: Singapore, Sweden, the UK, or the US. For example, provide SSN, EIN, or ITIN for the US.
soleProprietorship.taxInformation[].country String No

The two-letter ISO 3166-1 alpha-2 country code.
soleProprietorship.principalPlaceOfBusiness Object No

The business address. Required if the principal place of business is different from the registeredAddress.
soleProprietorship.principalPlaceOfBusiness.street2 String No

The apartment, unit, or suite number.
soleProprietorship.principalPlaceOfBusiness.postalCode String No

Postal code. Required if stateOrProvince and/or city is provided.
soleProprietorship.principalPlaceOfBusiness.stateOrProvince String No

The two-letter ISO 3166-2 state or province code. For example, CA in the US.

If you specify the state or province, you must also send city, postalCode, and street.
soleProprietorship.principalPlaceOfBusiness.country String Yes

The two-letter ISO 3166-1 alpha-2 country code.
soleProprietorship.principalPlaceOfBusiness.street String No

The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
soleProprietorship.principalPlaceOfBusiness.city String No

The name of the city. Required if stateOrProvince is provided.

If you specify the city, you must also send postalCode and street.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2024 SimWorkflow
Terms of Service Privacy Policy