Creates a legal entity.
This resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.
If you are using hosted onboarding, only use v2 for your API requests.
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 unique identifier of the associated legal entity.
Information about the individual. Required if type is individual.
The individual's birth information.
Information about the individual's identification document.
The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.
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.
Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.
When providing ID numbers:
type values can be driversLicense, identityCard, nationalIdNumber, or passport.When uploading photo IDs:
type values can be identityCard, driversLicense, or passport.When uploading other documents:
For organization, the type values can be proofOfAddress, registrationDocument, vatDocument, proofOfOrganizationTaxInfo, proofOfOwnership, proofOfIndustry, or proofOfFundingOrWealthSource.
For individual, the type values can be identityCard, driversLicense, passport, proofOfNationalIdNumber, proofOfResidency, proofOfIndustry, proofOfIndividualTaxId, or proofOfFundingOrWealthSource.
For soleProprietorship, the type values can be constitutionalDocument, proofOfAddress, or proofOfIndustry.
Use bankStatement to upload documents for a transfer instrument.
The individual's name.
The phone number of the legal entity.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The tax information of the individual.
The website and app URL of the legal entity.
Information about the organization. Required if type is organization.
The organization's trading name, if different from the registered legal name.
The phone number of the legal entity.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
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 tax information of the organization.
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.
The organization's main source of income.
Possible values: businessOperation, realEstateSales, investmentInterestOrRoyalty, propertyRental, other.
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 website and app URL of the legal entity.
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 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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The reason for not providing a VAT number.
Possible values: industryExemption, belowTaxThreshold.
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.
The request has succeeded.
Show more Show lessContains 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.
Indicates whether the capability is allowed. Adyen sets this to true if the verification is successful
The capability level that is allowed for the legal entity.
Possible values: notApplicable, low, medium, high.
The settings that were allowed for the Legal Entity.
The maximum amount a card holder can spend per industry.
The maximum amount a card holder can withdraw per day.
Indicates whether the capability is requested. To check whether the Legal Entity is permitted to use the capability,
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.
The settings that are requested for the Legal Entity.
The maximum amount a card holder can spend per industry.
The maximum amount a card holder can withdraw per day.
Capability status for transfer instruments associated with legal entity
Indicates whether the supporting entity capability is allowed.
If a supporting entity is allowed but its parent legal entity is not, it means there are other supporting entities that failed validation.
The allowed supporting entity can still be used
The status of the verification checks for the supporting entity capability.
Possible values:
pending: Adyen is running the verification.
invalid: The verification failed. Check if the errors array contains more information.
valid: The verification has been successfully completed.
rejected: Adyen has verified the information, but found reasons to not allow the capability.
The status of the verification checks for the capability.
Possible values:
pending: Adyen is running the verification.
invalid: The verification failed. Check if the errors array contains more information.
valid: The verification has been successfully completed.
rejected: Adyen has verified the information, but found reasons to not allow the capability.
List of documents uploaded for the legal entity.
List of documents uploaded for the legal entity.
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 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.
The legal entity type of associated legal entity.
For example, organization, soleProprietorship or individual.
The unique identifier of the associated legal entity.
The name of the associated legal entity.
name.firstName and name.lastName.legalName.name.Information about the individual. Required if type is individual.
The individual's birth information.
Information about the individual's identification document.
The two-character ISO 3166-1 alpha-2 country code where the document was issued. For example, US.
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.
Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.
When providing ID numbers:
type values can be driversLicense, identityCard, nationalIdNumber, or passport.When uploading photo IDs:
type values can be identityCard, driversLicense, or passport.When uploading other documents:
For organization, the type values can be proofOfAddress, registrationDocument, vatDocument, proofOfOrganizationTaxInfo, proofOfOwnership, proofOfIndustry, or proofOfFundingOrWealthSource.
For individual, the type values can be identityCard, driversLicense, passport, proofOfNationalIdNumber, proofOfResidency, proofOfIndustry, proofOfIndividualTaxId, or proofOfFundingOrWealthSource.
For soleProprietorship, the type values can be constitutionalDocument, proofOfAddress, or proofOfIndustry.
Use bankStatement to upload documents for a transfer instrument.
The individual's name.
The phone number of the legal entity.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The tax information of the individual.
The website and app URL of the legal entity.
Information about the organization. Required if type is organization.
The organization's trading name, if different from the registered legal name.
The phone number of the legal entity.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
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 tax information of the organization.
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.
The organization's main source of income.
Possible values: businessOperation, realEstateSales, investmentInterestOrRoyalty, propertyRental, other.
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 website and app URL of the legal entity.
List of the verification errors from capabilities for the legal entity.
List of document IDs corresponding to the verification errors from capabilities.
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.
An object containing possible solutions to fix a verification error.
An array containing more granular information about the cause of the verification error.
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.
An object containing possible solutions to fix a verification error.
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 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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
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 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.
The name of the street, and the house or building number. Required if stateOrProvince and/or city is provided.
The reason for not providing a VAT number.
Possible values: industryExemption, belowTaxThreshold.
List of transfer instruments that the legal entity owns.
Identifies if the bank account was created through instant bank verification.