Update a legal entity
Updates a legal entity.
To change the legal entity type, include only the new
typein your request.
If you need to update information for the legal entity, make a separate 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.
Requests to this endpoint are subject to rate limits:
- 
Live environments: 700 requests per 5 seconds. 
- 
Test environments: 200 requests per 5 seconds. 
- 
Failed requests are subject to a limit of 5 failures per 10 seconds. 
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.
The unique identifier of the legal entity.
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.
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.
The individual's job title if the type is uboThroughControl or signatory.
The unique identifier of the associated legal entity.
Default value: false
Set to true if the entity association type director, secondaryPartner or shareholder is also a nominee. Only applicable to New Zealand.
The individual's relationship to a legal representative if the type is legalRepresentative. Possible values: parent, guardian.
Defines the KYC exemption reason for a settlor associated with a trust. Only applicable to trusts in Australia.
For example, professionalServiceProvider, deceased, or contributionBelowThreshold.
Defines the relationship of the legal entity to the current legal entity.
Possible value for individuals: legalRepresentative.
Possible values for organizations: director, signatory, trustOwnership, uboThroughOwnership, uboThroughControl, 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 value for unincorporated partnership: unincorporatedPartnership.
Possible values for unincorporated partnership members: secondaryPartner, uboThroughControl, uboThroughOwnership
Information about the individual. Required if type is individual.
The individual's birth information.
The individual's date of birth, in YYYY-MM-DD format.
The email address of the legal entity.
Information about the individual's identification document.
The card number of the document that was issued (AU only).
The expiry date of the document, in YYYY-MM-DD format.
The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.
The state or province where the document was issued (AU only).
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.
The number in the document.
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 
The individual's name.
The individual's first name. Must not be blank.
The infix in the individual's name, if any.
The individual's last name. Must not be blank.
The individual's nationality.
The phone number of the legal entity.
The full phone number, including the country code. For example, +3112345678.
The type of phone number. Possible values: mobile, landline, sip, fax.
The residential address of the individual.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The tax information of the individual.
The tax ID number (TIN) of the organization or individual.
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.
The website and app URL of the legal entity.
The URL of the website or the app store URL.
Information about the organization. Required if type is organization.
The two-character ISO 3166-1 alpha-2 country code of the governing country.
The date when the organization was incorporated in YYYY-MM-DD format.
Your description for the organization.
The organization's trading name, if different from the registered legal name.
The email address of the legal entity.
The organization's legal name.
The phone number of the legal entity.
The full phone number, including the country code. For example, +3112345678.
The type of phone number. Possible values: mobile, landline, sip, fax.
The address where the organization operates from. Provide this if the principal place of business is different from the registeredAddress.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The address of the organization registered at their registrar (such as the Chamber of Commerce).
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The organization's registration number.
Information about the organization's publicly traded stock. Provide this object only if type is listedPublicCompany.
The four-digit Market Identifier Code of the stock market where the organization's stocks are traded.
The 12-digit International Securities Identification Number (ISIN) of the company, without dashes (-).
The stock ticker symbol.
The tax information of the organization.
The tax ID number (TIN) of the organization or individual.
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.
The tax reporting classification (FATCA/CRS self-certification) of the organization.
The organization's business type.
Possible values: other, listedPublicCompany, subsidiaryOfListedPublicCompany, governmentalOrganization, internationalOrganization, financialInstitution.
The Global Intermediary Identification Number (GIIN) required for FATCA. Only required if the organization is a US financial institution and the businessType is financialInstitution.
The organization's main source of income. Only required if businessType is other.
Possible values: businessOperation, realEstateSales, investmentInterestOrRoyalty, propertyRental, other.
The tax reporting classification type.
Possible values: nonFinancialNonReportable, financialNonReportable, nonFinancialActive, nonFinancialPassive.
Type of organization.
Possible values: associationIncorporated, governmentalOrganization, listedPublicCompany, nonProfit, partnershipIncorporated, privateCompany.
The reason the organization has not provided a VAT number.
Possible values: industryExemption, belowTaxThreshold.
The organization's VAT number.
The website and app URL of the legal entity.
The URL of the website or the app store URL.
Your reference for the legal entity, maximum 150 characters.
Information about the sole proprietorship. Required if type is soleProprietorship.
The two-character ISO 3166-1 alpha-2 country code of the governing country.
The date when the legal arrangement was incorporated in YYYY-MM-DD format.
The registered name, if different from the name.
The legal name.
The business address. Required if the principal place of business is different from the registeredAddress.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The address registered at the registrar, such as the Chamber of Commerce.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The registration number.
The tax information is absent.
The tax information of the entity.
The tax ID number (TIN) of the organization or individual.
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.
The reason for not providing a VAT number.
Possible values: industryExemption, belowTaxThreshold.
The VAT number.
Information about the trust. Required if type is trust.
The two-character ISO 3166-1 alpha-2 country code of the governing country.
The date when the legal arrangement was incorporated in YYYY-MM-DD format.
The registered name, if different from the name.
The legal name.
The business address. Required if the principal place of business is different from the registeredAddress.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The address registered at the registrar, such as the Chamber of Commerce.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The registration number.
The tax information of the entity.
The tax ID number (TIN) of the organization or individual.
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.
Type of trust.
See possible values for trusts in Australia and New Zealand.
The undefined beneficiary information of the entity.
The details of the undefined beneficiary.
The reason for not providing a VAT number.
Possible values: industryExemption, belowTaxThreshold.
The VAT number.
The type of legal entity.
Possible values: individual, organization, soleProprietorship, or trust.
Information about the unincorporated partnership. Required if type is unincorporatedPartnership.
The two-character ISO 3166-1 alpha-2 country code of the governing country.
The date when the legal arrangement was incorporated in YYYY-MM-DD format.
The registered name, if different from the name.
The legal name.
The business address. Required if the principal place of business is different from the registeredAddress.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The address registered at the registrar, such as the Chamber of Commerce.
The name of the city. Required if stateOrProvince is provided.
If you specify the city, you must also send postalCode and street.
The two-letter ISO 3166-1 alpha-2 country code.
The postal code. Required if stateOrProvince and/or city is provided.
When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA.
The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand.
If you specify the state or province, you must also send city, postalCode, and street.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The apartment, unit, or suite number.
The registration number.
The tax information of the entity.
The tax ID number (TIN) of the organization or individual.
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.
The reason for not providing a VAT number.
Possible values: industryExemption, belowTaxThreshold.
The VAT number.
A key-value pair that specifies the verification process for a legal entity. Set to upfront for upfront verification for marketplaces.
After submitting a call, you receive a response message to inform you that your request was received and processed.
Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.
HTTP Responses
- 200 - OK- The request has succeeded. capabilitiesobject- 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. allowedboolean- Indicates whether the capability is allowed. Adyen sets this to true if the verification is successful. allowedLevelstring- The capability level that is allowed for the legal entity. - Possible values: notApplicable, low, medium, high. allowedSettingsobject- The settings that are allowed for the legal entity. amountPerIndustryobject- The maximum amount a card holder can spend per industry. currencystring- The type of currency. Must be EUR (or EUR equivalent) valueinteger- Total value of amount. Must be >= 0 authorizedCardUsersboolean- The number of card holders who can use the card. fundingSourcearray[string]- The funding source of the card, for example debit. intervalstring- The period when the rule conditions apply. maxAmountobject- The maximum amount a card holder can withdraw per day. currencystring- The type of currency. Must be EUR (or EUR equivalent) valueinteger- Total value of amount. Must be >= 0 problemsarray[object]- Contains verification errors and the actions that you can take to resolve them. entityobjectdocumentsarray[string]- List of document IDs corresponding to the verification errors from capabilities. idstringownerobjectdocumentsarray[string]- List of document IDs corresponding to the verification errors from capabilities. idstringtypestringtypestringverificationErrorsarray[object]capabilitiesarray[string]- 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. codestring- The general error code. messagestring- The general error message. remediatingActionsarray[object]- An object containing possible solutions to fix a verification error. codestringmessagestringsubErrorsarray[object]- An array containing more granular information about the cause of the verification error. capabilitiesarray[string]- 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. codestring- The general error code. messagestring- The general error message. typestring- The type of error. - Possible values: - invalidInput
- dataMissing
- pendingStatus
- rejected
- dataReview
 remediatingActionsarray[object]- An object containing possible solutions to fix a verification error. codestringmessagestringtypestring- The type of error. - Possible values: - invalidInput
- dataMissing
- pendingStatus
- rejected
- dataReview
 requestedboolean- Indicates whether the capability is requested. To check whether the legal entity is permitted to use the capability, refer to the - allowedfield.requestedLevelstring- The requested level of the capability. Some capabilities, such as those used in card issuing, have different levels. Levels increase the capability, but also require additional checks and increased monitoring. - Possible values: notApplicable, low, medium, high. requestedSettingsobject- The settings that are requested for the legal entity. amountPerIndustryobject- The maximum amount a card holder can spend per industry. currencystring- The type of currency. Must be EUR (or EUR equivalent) valueinteger- Total value of amount. Must be >= 0 authorizedCardUsersboolean- The number of card holders who can use the card. fundingSourcearray[string]- The funding source of the card, for example debit. intervalstring- The period when the rule conditions apply. maxAmountobject- The maximum amount a card holder can withdraw per day. currencystring- The type of currency. Must be EUR (or EUR equivalent) valueinteger- Total value of amount. Must be >= 0 transferInstrumentsarray[object]- The capability status of transfer instruments associated with the legal entity. allowedboolean- Indicates whether the capability is allowed for the supporting entity. - If a capability is allowed for a supporting entity but not for the parent legal entity, this means the legal entity has other supporting entities that failed verification. - You can use the allowed supporting entity regardless of the verification status of other supporting entities. idstring- Supporting entity reference requestedboolean- Indicates whether the supporting entity capability is requested. verificationStatusstring- The status of the verification checks for the capability of the supporting entity. - Possible values: - 
pending: Adyen is running the verification. 
- 
invalid: The verification failed. Check if the errorsarray contains more information.
- 
valid: The verification has been successfully completed. 
- 
rejected: Adyen has verified the information, but found reasons to not allow the capability. 
 verificationStatusstring- The status of the verification checks for the capability. - Possible values: - 
pending: Adyen is running the verification. 
- 
invalid: The verification failed. Check if the errorsarray contains more information.
- 
valid: The verification has been successfully completed. 
- 
rejected: Adyen has verified the information, but found reasons to not allow the capability. 
 documentDetailsarray[object]- List of documents uploaded for the legal entity. activeboolean- Identifies whether the document is active and used for checks. descriptionstring- Your description for the document. fileNamestring- Document name. idstring- The unique identifier of the resource. modificationDatestring- The modification date of the document. pagesarray[object]- List of document pages pageNamestringpageNumberintegertypestringtypestring- Type of document, used when providing an ID number or uploading a document. documentsarray[object]Deprecated in version 1- Use the - documentDetailsarray instead.- List of documents uploaded for the legal entity. idstring- The unique identifier of the resource. entityAssociationsarray[object]- 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. associatorIdstring- The unique identifier of another legal entity with which the - legalEntityIdis associated. When the- legalEntityIdis associated to legal entities other than the current one, the response returns all the associations.entityTypestring- The legal entity type of associated legal entity. - For example, organization, soleProprietorship or individual. jobTitlestring- The individual's job title if the - typeis uboThroughControl or signatory.legalEntityIdstring- The unique identifier of the associated legal entity. namestring- The name of the associated legal entity. - For individual, name.firstNameandname.lastName.
- For organization, legalName.
- For soleProprietorship, name.
 nomineeboolean- Default value: false Set to true if the entity association - typedirector, secondaryPartner or shareholder is also a nominee. Only applicable to New Zealand.relationshipstring- The individual's relationship to a legal representative if the - typeis legalRepresentative. Possible values: parent, guardian.settlorExemptionReasonarray[string]- Defines the KYC exemption reason for a settlor associated with a trust. Only applicable to trusts in Australia. - For example, professionalServiceProvider, deceased, or contributionBelowThreshold. typestring- Defines the relationship of the legal entity to the current legal entity. - Possible value for individuals: legalRepresentative. - Possible values for organizations: director, signatory, trustOwnership, uboThroughOwnership, uboThroughControl, 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 value for unincorporated partnership: unincorporatedPartnership. - Possible values for unincorporated partnership members: secondaryPartner, uboThroughControl, uboThroughOwnership idstring- The unique identifier of the legal entity. individualobject- Information about the individual. Required if - typeis individual.birthDataobject- The individual's birth information. dateOfBirthstring- The individual's date of birth, in YYYY-MM-DD format. emailstring- The email address of the legal entity. identificationDataobject- Information about the individual's identification document. cardNumberstring- The card number of the document that was issued (AU only). expiryDatestring- The expiry date of the document, in YYYY-MM-DD format. issuerCountrystringDeprecated in version 1- The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US. issuerStatestring- The state or province where the document was issued (AU only). nationalIdExemptboolean- 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. numberstring- The number in the document. typestring- 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 
 nameobject- The individual's name. firstNamestring- The individual's first name. Must not be blank. infixstring- The infix in the individual's name, if any. lastNamestring- The individual's last name. Must not be blank. nationalitystring- The individual's nationality. phoneobject- The phone number of the legal entity. numberstring- The full phone number, including the country code. For example, +3112345678. phoneCountryCodestring- The two-letter ISO 3166-1 alpha-2 country code prefix of the phone number. For example, US or NL. - The value of the - phoneCountryCodeis determined by the country code digit(s) of- phone.numbertypestring- The type of phone number. Possible values: mobile, landline, sip, fax. residentialAddressobject- The residential address of the individual. citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. taxInformationarray[object]- The tax information of the individual. numberstring- The tax ID number (TIN) of the organization or individual. typestring- 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. webDataobjectDeprecated in version 1- The website and app URL of the legal entity. webAddressstring- The URL of the website or the app store URL. webAddressIdstring- The unique identifier of the web address. organizationobject- Information about the organization. Required if - typeis organization.countryOfGoverningLawstring- The two-character ISO 3166-1 alpha-2 country code of the governing country. dateOfIncorporationstring- The date when the organization was incorporated in YYYY-MM-DD format. descriptionstring- Your description for the organization. doingBusinessAsstring- The organization's trading name, if different from the registered legal name. emailstring- The email address of the legal entity. legalNamestring- The organization's legal name. phoneobject- The phone number of the legal entity. numberstring- The full phone number, including the country code. For example, +3112345678. phoneCountryCodestring- The two-letter ISO 3166-1 alpha-2 country code prefix of the phone number. For example, US or NL. - The value of the - phoneCountryCodeis determined by the country code digit(s) of- phone.numbertypestring- The type of phone number. Possible values: mobile, landline, sip, fax. principalPlaceOfBusinessobject- The address where the organization operates from. Provide this if the principal place of business is different from the - registeredAddress.citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registeredAddressobject- The address of the organization registered at their registrar (such as the Chamber of Commerce). citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registrationNumberstring- The organization's registration number. stockDataobject- Information about the organization's publicly traded stock. Provide this object only if - typeis listedPublicCompany.marketIdentifierstring- The four-digit Market Identifier Code of the stock market where the organization's stocks are traded. stockNumberstring- The 12-digit International Securities Identification Number (ISIN) of the company, without dashes (-). tickerSymbolstring- The stock ticker symbol. taxInformationarray[object]- The tax information of the organization. numberstring- The tax ID number (TIN) of the organization or individual. typestring- 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. taxReportingClassificationobject- The tax reporting classification (FATCA/CRS self-certification) of the organization. businessTypestring- The organization's business type. - Possible values: other, listedPublicCompany, subsidiaryOfListedPublicCompany, governmentalOrganization, internationalOrganization, financialInstitution. financialInstitutionNumberstring- The Global Intermediary Identification Number (GIIN) required for FATCA. Only required if the organization is a US financial institution and the - businessTypeis financialInstitution.mainSourceOfIncomestring- The organization's main source of income. Only required if - businessTypeis other.- Possible values: businessOperation, realEstateSales, investmentInterestOrRoyalty, propertyRental, other. typestring- The tax reporting classification type. - Possible values: nonFinancialNonReportable, financialNonReportable, nonFinancialActive, nonFinancialPassive. typestring- Type of organization. - Possible values: associationIncorporated, governmentalOrganization, listedPublicCompany, nonProfit, partnershipIncorporated, privateCompany. vatAbsenceReasonstring- The reason the organization has not provided a VAT number. - Possible values: industryExemption, belowTaxThreshold. vatNumberstring- The organization's VAT number. webDataobjectDeprecated in version 1- The website and app URL of the legal entity. webAddressstring- The URL of the website or the app store URL. webAddressIdstring- The unique identifier of the web address. referencestringMax length: 150- Your reference for the legal entity, maximum 150 characters. soleProprietorshipobject- Information about the sole proprietorship. Required if - typeis soleProprietorship.countryOfGoverningLawstring- The two-character ISO 3166-1 alpha-2 country code of the governing country. dateOfIncorporationstring- The date when the legal arrangement was incorporated in YYYY-MM-DD format. doingBusinessAsstring- The registered name, if different from the - name.namestring- The legal name. principalPlaceOfBusinessobject- The business address. Required if the principal place of business is different from the - registeredAddress.citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registeredAddressobject- The address registered at the registrar, such as the Chamber of Commerce. citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registrationNumberstring- The registration number. taxAbsentboolean- The tax information is absent. taxInformationarray[object]- The tax information of the entity. numberstring- The tax ID number (TIN) of the organization or individual. typestring- 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. vatAbsenceReasonstring- The reason for not providing a VAT number. - Possible values: industryExemption, belowTaxThreshold. vatNumberstring- The VAT number. transferInstrumentsarray[object]- List of transfer instruments that the legal entity owns. accountIdentifierstring- The masked IBAN or bank account number. idstring- The unique identifier of the resource. realLastFourstring- Four last digits of the bank account number. If the transfer instrument is created using instant bank account verification, and it is a virtual bank account, these digits may be different from the last four digits of the masked account number. trustedSourceboolean- Identifies if the bank account was created through instant bank verification. trustobject- Information about the trust. Required if - typeis trust.countryOfGoverningLawstring- The two-character ISO 3166-1 alpha-2 country code of the governing country. dateOfIncorporationstring- The date when the legal arrangement was incorporated in YYYY-MM-DD format. doingBusinessAsstring- The registered name, if different from the - name.namestring- The legal name. principalPlaceOfBusinessobject- The business address. Required if the principal place of business is different from the - registeredAddress.citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registeredAddressobject- The address registered at the registrar, such as the Chamber of Commerce. citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registrationNumberstring- The registration number. taxInformationarray[object]- The tax information of the entity. numberstring- The tax ID number (TIN) of the organization or individual. typestring- 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. typestring- Type of trust. - See possible values for trusts in Australia and New Zealand. undefinedBeneficiaryInfoarray[object]- The undefined beneficiary information of the entity. descriptionstring- The details of the undefined beneficiary. referencestring- The reference of the undefined beneficiary. vatAbsenceReasonstring- The reason for not providing a VAT number. - Possible values: industryExemption, belowTaxThreshold. vatNumberstring- The VAT number. typestring- The type of legal entity. - Possible values: individual, organization, soleProprietorship, or trust. unincorporatedPartnershipobject- Information about the unincorporated partnership. Required if - typeis unincorporatedPartnership.countryOfGoverningLawstring- The two-character ISO 3166-1 alpha-2 country code of the governing country. dateOfIncorporationstring- The date when the legal arrangement was incorporated in YYYY-MM-DD format. doingBusinessAsstring- The registered name, if different from the - name.namestring- The legal name. principalPlaceOfBusinessobject- The business address. Required if the principal place of business is different from the - registeredAddress.citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registeredAddressobject- The address registered at the registrar, such as the Chamber of Commerce. citystring- The name of the city. Required if - stateOrProvinceis provided.- If you specify the city, you must also send - postalCodeand- street.countrystring- The two-letter ISO 3166-1 alpha-2 country code. postalCodestring- The postal code. Required if - stateOrProvinceand/or- cityis provided.- When using alphanumeric postal codes, all letters must be uppercase. For example, 1234 AB or SW1A 1AA. stateOrProvincestring- The two-letter ISO 3166-2 state or province code. For example, CA in the US. Required for Australia and New Zealand. - If you specify the state or province, you must also send - city,- postalCode, and- street.streetstring- The name of the street, and the house or building number. Required if - stateOrProvinceand/or- cityis provided.street2string- The apartment, unit, or suite number. registrationNumberstring- The registration number. taxInformationarray[object]- The tax information of the entity. numberstring- The tax ID number (TIN) of the organization or individual. typestring- 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. typestring- Type of Partnership. - Possible values: - limitedPartnership
- generalPartnership
- familyPartnership
- commercialPartnership
- publicPartnership
- otherPartnership
- gbr
- gmbh
- kgaa
- cv
- vof
- maatschap
- privateFundLimitedPartnership
- businessTrustEntity
- businessPartnership
- limitedLiabilityPartnership
- eg
- cooperative
- vos
- comunidadDeBienes
- herenciaYacente
- comunidadDePropietarios
- sep
- sca
- bt
- kkt
- scs
- snc
 vatAbsenceReasonstring- The reason for not providing a VAT number. - Possible values: industryExemption, belowTaxThreshold. vatNumberstring- The VAT number. verificationPlanstring- A key-value pair that specifies the verification process for a legal entity. Set to upfront for upfront verification for marketplaces. 
- 400 - Bad Request- A problem reading or understanding the request. errorCodestring- The error code mapped to the error message. errorTypestring- The category of the error. messagestring- A short explanation of the issue. pspReferencestring- The PSP reference of the payment. statusinteger- The HTTP response status. 
- 401 - Unauthorized- Authentication required. errorCodestring- The error code mapped to the error message. errorTypestring- The category of the error. messagestring- A short explanation of the issue. pspReferencestring- The PSP reference of the payment. statusinteger- The HTTP response status. 
- 403 - Forbidden- Insufficient permissions to process the request. errorCodestring- The error code mapped to the error message. errorTypestring- The category of the error. messagestring- A short explanation of the issue. pspReferencestring- The PSP reference of the payment. statusinteger- The HTTP response status. 
- 422 - Unprocessable Entity- A request validation error. errorCodestring- The error code mapped to the error message. errorTypestring- The category of the error. messagestring- A short explanation of the issue. pspReferencestring- The PSP reference of the payment. statusinteger- The HTTP response status. 
- 500 - Internal Server Error- The server could not process the request. errorCodestring- The error code mapped to the error message. errorTypestring- The category of the error. messagestring- A short explanation of the issue. pspReferencestring- The PSP reference of the payment. statusinteger- The HTTP response status.