Adyen · Schema
AccountHolderCapability
AccountHolderCapability schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| allowed | boolean | 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. |
| allowedLevel | string | The capability level that is allowed for the account holder. Possible values: **notApplicable**, **low**, **medium**, **high**. |
| allowedSettings | object | A JSON object containing the settings that are allowed for the account holder. |
| enabled | boolean | Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder. |
| problems | array | Contains verification errors and the actions that you can take to resolve them. |
| requested | boolean | Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field. |
| requestedLevel | string | The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increas |
| requestedSettings | object | A JSON object containing the settings that were requested for the account holder. |
| transferInstruments | array | Contains the status of the transfer instruments associated with this capability. |
| verificationStatus | string | 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 contain |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/configuration-account-holder-capability-schema.json",
"title": "AccountHolderCapability",
"description": "AccountHolderCapability schema from Adyen API",
"type": "object",
"properties": {
"allowed": {
"description": "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.",
"readOnly": true,
"type": "boolean"
},
"allowedLevel": {
"description": "The capability level that is allowed for the account holder.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.",
"enum": [
"high",
"low",
"medium",
"notApplicable"
],
"readOnly": true,
"type": "string"
},
"allowedSettings": {
"description": "A JSON object containing the settings that are allowed for the account holder.",
"readOnly": true,
"$ref": "#/components/schemas/CapabilitySettings"
},
"enabled": {
"description": "Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder.",
"type": "boolean"
},
"problems": {
"description": "Contains verification errors and the actions that you can take to resolve them.",
"items": {
"$ref": "#/components/schemas/CapabilityProblem"
},
"readOnly": true,
"type": "array"
},
"requested": {
"description": "Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field.",
"type": "boolean"
},
"requestedLevel": {
"description": "The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring.\n\nPossible values: **notApplicable**, **low**, **medium**, **high**.",
"enum": [
"high",
"low",
"medium",
"notApplicable"
],
"type": "string"
},
"requestedSettings": {
"description": "A JSON object containing the settings that were requested for the account holder.",
"readOnly": true,
"$ref": "#/components/schemas/CapabilitySettings"
},
"transferInstruments": {
"description": "Contains the status of the transfer instruments associated with this capability. ",
"items": {
"$ref": "#/components/schemas/AccountSupportingEntityCapability"
},
"readOnly": true,
"type": "array"
},
"verificationStatus": {
"description": "The status of the verification checks for the capability.\n\nPossible values:\n\n* **pending**: Adyen is running the verification.\n\n* **invalid**: The verification failed. Check if the `errors` array contains more information.\n\n* **valid**: The verification has been successfully completed.\n\n* **rejected**: Adyen has verified the information, but found reasons to not allow the capability.\n",
"enum": [
"invalid",
"pending",
"rejected",
"valid"
],
"readOnly": true,
"type": "string"
}
}
}