Account holder created
Adyen sends this webhook when you successfully create an account holder.
Request Parameters
Contains event details.
Contains information about the account holder resource that triggered the event.
The unique identifier of the balance platform to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms.
Contains key-value pairs that specify the actions that an account holder 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 and the account holder is permitted to use the capability.
The capability level that is allowed for the account holder.
Possible values: notApplicable, low, medium, high.
A JSON object containing the settings that are allowed for the account holder.
Indicates whether the capability is enabled. If false, the capability is temporarily disabled for the account holder.
Contains verification errors and the actions that you can take to resolve them.
Contains the type of the entity and the corresponding ID.
List of document IDs to which the verification errors related to the capabilities correspond to.
The ID of the entity.
Contains details about the owner of the entity that has an error.
List of document IDs to which the verification errors related to the capabilities correspond to.
The ID of the entity.
Type of entity.
Possible values: LegalEntity, BankAccount, Document.
Type of entity.
Possible values: LegalEntity, BankAccount, Document.
Contains information about the verification error.
Contains the capabilities that the verification error applies to.
The verification error code.
A description of the error.
Contains the actions that you can take to resolve the verification error.
The remediating action code.
A description of how you can resolve the verification error.
Contains more granular information about the verification error.
Contains the capabilities that the verification error applies to.
The verification error code.
A description of the error.
The type of error.
Possible values: invalidInput, dataMissing.
Contains the actions that you can take to resolve the verification error.
The remediating action code.
A description of how you can resolve the verification error.
The type of error.
Possible values: invalidInput, dataMissing.
Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the allowed field.
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.
A JSON object containing the settings that were requested for the account holder.
Contains the status of the transfer instruments associated with this capability.
Indicates whether the supporting entity capability is allowed. Adyen sets this to true if the verification is successful and the account holder is permitted to use the capability.
The capability level that is allowed for the account holder.
Possible values: notApplicable, low, medium, high.
Indicates whether the capability is enabled. If false, the capability is temporarily disabled for the account holder.
The ID of the supporting entity.
Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the allowed field.
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 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
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.
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.
Contact details of the account holder.
The address of the account holder.
The name of the city. Maximum length: 3000 characters.
The two-character ISO-3166-1 alpha-2 country code. For example, US.
If you don't know the country or are not collecting the country from the shopper, provide
countryasZZ.
The number or name of the house. Maximum length: 3000 characters.
A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
The two-character ISO 3166-2 state or province code. For example, CA in the US or ON in Canada.
Required for the US and Canada.
The name of the street. Maximum length: 3000 characters.
The house number should not be included in this field; it should be separately provided via
houseNumberOrName.
The email address of the account holder.
The phone number of the account holder.
The full phone number provided as a single string. For example, "0031 6 11 22 33 44", "+316/1122-3344",
or "(0031) 611223344".
Type of phone number. Possible values: Landline, Mobile.
The URL of the account holder's website.
Your description for the account holder.
The unique identifier of the account holder.
The unique identifier of the legal entity associated with the account holder. Adyen performs a verification process against the legal entity of the account holder.
A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired.
Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
The unique identifier of the migrated account holder in the classic integration.
The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request.
Your reference for the account holder.
The status of the account holder.
Possible values:
-
Active: The account holder is active. This is the default status when creating an account holder.
-
Inactive (Deprecated): The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details.
-
Suspended: The account holder is permanently deactivated by Adyen. This action cannot be undone.
-
Closed: The account holder is permanently deactivated by you. This action cannot be undone.
The time zone of the account holder. For example, Europe/Amsterdam. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the list of time zone codes.
List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.
The names of the capabilities to be disallowed.
The unique identifiers of the bank account(s) that the deadline applies to
The date that verification is due by before capabilities are disallowed.
The unique identifier of the balance platform.
The environment from which the webhook originated.
Possible values: test, live.
Type of webhook.
Response parameters
When you receive a webhook, you must respond with an HTTP status code.
HTTP Responses
200 - OK
The request has succeeded.
Show moreShow lessnotificationResponsestringRespond with any 2xx HTTP status code to accept the webhook.