{"title":"User capabilities","category":"default","creationDate":1671721620,"content":"<p>Every account holder has a list of capabilities that determine what they can do on your balance platform. You can edit a <a href=\"#capability-settings\">capability's settings<\/a> to change which actions the account holder has permission to do, for example, receive payments, send funds to a bank account, or <a href=\"#financial-product-capabilities\">use certain financial products<\/a>.<\/p>\n<p>In most cases, Adyen configures default capabilities for your business during the <a href=\"\/pt\/business-accounts\/get-started#design-implementation\">design phase<\/a>. These capabilities are automatically requested for your users when you create account holders for them. If a user needs a specific capability that is not part of their default configuration, you must <a href=\"\/pt\/business-accounts\/manage-account-holders#request-capability\">request the additional capability<\/a>. <\/p>\n<div class=\"notices green\">\n<p>It is possible that requesting additional capabilities prompts additional <a href=\"\/pt\/business-accounts\/verification-overview\">KYC checks<\/a> on your users. <\/p>\n<\/div>\n<h2>Business account capabilities<\/h2>\n<p>Adyen business accounts requires your user's account holders to have the following capabilities:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Capability name<\/th>\n<th style=\"text-align: left;\">Display name in the Customer Area<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>issueBankAccount<\/strong><\/span><\/td>\n<td style=\"text-align: left;\">Issue bank accounts<\/td>\n<td style=\"text-align: left;\">Allow users to have an Adyen business bank account.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>receiveFromThirdParty<\/strong><\/span><\/td>\n<td style=\"text-align: left;\">Receive funds from third-party bank accounts<\/td>\n<td style=\"text-align: left;\">Allows users to receive funds from third-party bank accounts. This capability is enabled by default when they have an <span translate=\"no\"><strong>issueBankAccount<\/strong><\/span> capability.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><span translate=\"no\"><strong>sendToThirdParty<\/strong><\/span><\/td>\n<td style=\"text-align: left;\">Send funds to third-party bank accounts<\/td>\n<td style=\"text-align: left;\">Allows users to send funds to third-party bank accounts. This capability is enabled by default when they have an <span translate=\"no\"><strong>issueBankAccount<\/strong><\/span> capability.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>General capabilities<\/h2>\n<p>In addition to the business account capabilities, your users also need <a href=\"\/pt\/platforms\/verification-overview\/capabilities#capabilities\">other capabilities<\/a> that allow them to perform actions in your balance platform. Some of these capabilities are requested automatically for new account holders, or you have to request them separately when needed.<\/p>\n<h2>Verification status of a capability<\/h2>\n<p>Verification status of a capability indicates whether a user has passed <a href=\"\/pt\/business-accounts\/verification-overview\">KYC checks<\/a> and meets requirements to use a specific capability. To get updates about the verification status of a capability, you can:<\/p>\n<ul>\n<li>Listen to <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.accountHolder.created\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.accountHolder.created<\/a> and <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.accountHolder.updated\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.accountHolder.updated<\/a> webhooks<\/li>\n<li>Make a GET <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform\/latest\/get\/accountHolders\/{id}\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/accountHolders\/{id}<\/a> request<\/li>\n<\/ul>\n<p>Here are the possible values for the capability verification status.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\"><div style=\"width:120px\">Status<\/div><\/th>\n<th style=\"text-align: left;\"><div style=\"width:50%\">Description<\/div><\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><code>pending<\/code><a id=\"pending\"><\/a><\/td>\n<td style=\"text-align: left;\">The <code>pending<\/code> status indicates that the verification is in progress. <\/br><\/br> At this verification phase, a capability requested for the first time is set to <a href=\"#requested\">\n  <code>requested<\/code>\n<\/a>: <strong>true<\/strong> and <a href=\"#allowed\">\n  <code>allowed<\/code>\n<\/a>: <strong>false<\/strong>. <\/br><\/br>If the capability has already been allowed, but some <a href=\"\/pt\/business-accounts\/verification-overview#when-users-change-their-data\">user data has changed<\/a> and needs to be verified, you may see that the capability verification status is <code>pending<\/code> and the capability is <a href=\"#allowed\">\n  <code>allowed<\/code>\n<\/a>: <strong>true<\/strong>. This means that the user is still allowed to use capability while Adyen performs the checks.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>valid<\/code><a id=\"valid\"><\/a><\/td>\n<td style=\"text-align: left;\">The <code>valid<\/code> status indicates that the verification is successfully completed and that the user meets the requirements to use a capability. <\/br><\/br> With this verification status, the user can use the capability. Adyen sets the capability to <a href=\"#allowed\">\n  <code>allowed<\/code>\n<\/a>: <strong>true<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>invalid<\/code><a id=\"invalid\"><\/a><\/td>\n<td style=\"text-align: left;\">The <code>invalid<\/code> status indicates that the verification failed, for example due to incorrect information or missing documents. In this case, the webhook or the API response contains the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/get\/accountHolders\/(id)#responses-200-capabilities-problems\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">problems<\/a> object, including the <code>verificationErrors<\/code>, <code>subErrors<\/code>, and <code>remediatingActions<\/code> arrays returned on the linked legal entity. If there are <a href=\"\/pt\/business-accounts\/kyc-verification-codes\">verification errors<\/a>, you must resolve them. <\/br><\/br> With this verification status, Adyen sets the capability to <a href=\"#allowed\">\n  <code>allowed<\/code>\n<\/a>: <strong>false<\/strong>. This means the user is not permitted to use the capability until all verification errors are resolved and the verification process is completed successfully. <\/br><\/br> If any <a href=\"\/pt\/business-accounts\/verification-overview#when-users-change-their-data\">user data changes or is missing<\/a> after the previous verification has been completed successfully, Adyen reverts the capability verification status to <code>invalid<\/code>. In such a scenario, the user must provide the necessary information within a specific deadline. During this period, the user can continue using the capability, and its setting remains as <a href=\"#allowed\">\n  <code>allowed<\/code>\n<\/a>: <strong>true<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><code>rejected<\/code><a id=\"rejected\"><\/a><\/td>\n<td style=\"text-align: left;\">The <code>rejected<\/code> status indicates that Adyen completed verification, but the user does not meet the requirements to use a capability based on the submitted information. This status is final and any errors cannot be resolved by updating data or uploading documents. <\/br><\/br> With this verification status, Adyen prohibits the user from performing the action and sets the capability to <a href=\"#allowed\">\n  <code>allowed<\/code>\n<\/a>: <strong>false<\/strong>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Capability settings<\/h2>\n<p>The settings of a capability determine if it is available to a user and they can use it. To get updates about the capability settings, you can:<\/p>\n<ul>\n<li>Listen to <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.accountHolder.created\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.accountHolder.created<\/a> and <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform-webhooks\/latest\/post\/balancePlatform.accountHolder.updated\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.accountHolder.updated<\/a> webhooks<\/li>\n<li>Make a GET <a href=\"https:\/\/docs.adyen.com\/api-explorer\/#\/balanceplatform\/latest\/get\/accountHolders\/{id}\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/accountHolders\/{id}<\/a> request. The API response contains the <a href=\"https:\/\/docs.adyen.com\/api-explorer\/balanceplatform\/latest\/get\/accountHolders\/_id_#responses-200-capabilities\" class=\"codeLabel external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">capabilities<\/a> object that shows whether the capability is <code>requested<\/code>, <code>allowed<\/code>, and <code>enabled<\/code>. Below are the explanations for each setting.<\/li>\n<\/ul>\n<table class=\"tg\">\n<thead>\n <tr>\n   <th scope=\"col\">Setting<\/th>\n   <th scope=\"col\">Possible\u00a0values<\/th>\n   <th scope=\"col\">Description<\/th>\n <\/tr>\n<\/thead>\n<tbody>\n  <tr>\n   <td>\n<p><a id=\"requested\"><code>requested<\/code><\/a><\/p>\n<\/td>\n   <td>\n<p><strong>true<\/strong>, <strong>false<\/strong><\/p>\n<\/td>\n   <td>\n   <table>\n       <tr>\n           <td>\n<p><strong>true<\/strong>: the capability has been requested. Default capabilities are requested automatically when you <a href=\"\/pt\/business-accounts\/onboard-users\">create an account holder<\/a>. You can also <a href=\"\/pt\/business-accounts\/manage-account-holders\/#request-capability\">request additional capabilities<\/a> by including this setting in your API request.<\/p>\n<\/td>\n       <\/tr>\n       <tr>\n           <td>\n<p><strong>false<\/strong>: the capability has not been requested yet.<\/p>\n<\/td>\n       <\/tr>\n   <\/table>\n<\/td>\n<\/tr>\n  <tr>\n   <td>\n<p><a id=\"allowed\"><code>allowed<\/code><\/a><\/p>\n<\/td>\n   <td>\n<p><strong>true<\/strong>, <strong>false<\/strong><\/p>\n<\/td>\n   <td>\n   <table>\n       <tr>\n           <td>\n<p><strong>true<\/strong>: the <a href=\"#valid\">verification is successful<\/a> and the user is permitted to use the capability. The capability can only be used when it is both allowed and enabled.<br><br>  In some scenarios, such as <a href=\"\/pt\/business-accounts\/verification-overview#when-users-change-their-data\">when a user changes their information<\/a>, the capability is set to <strong>true<\/strong> while the verification status is <a href=\"#pending\">\n  <code>pending<\/code>\n<\/a> or <a href=\"#invalid\">\n  <code>invalid<\/code>\n<\/a>. The user must provide updated information within the given deadline. During the deadline, the user can still use the capability while Adyen verifies the data.<\/p>\n<\/td>\n       <\/tr>\n       <tr>\n           <td>\n<p><strong>false<\/strong>: the verification is <a href=\"#pending\">\n  <code>pending<\/code>\n<\/a>, <a href=\"#invalid\">\n  <code>invalid<\/code>\n<\/a>, or <a href=\"#rejected\">\n  <code>rejected<\/code>\n<\/a>. The user is not permitted to use the capability.<\/p>\n<\/td>\n       <\/tr>\n   <\/table>\n   <\/td>\n <\/tr>\n  <tr>\n   <td>\n<p><a id=\"enabled\"><code>enabled<\/code><\/a><\/p>\n<\/td>\n   <td>\n<p><strong>true<\/strong>, <strong>false<\/strong><\/p>\n<\/td>\n   <td>\n<p>This setting allows you to <a href=\"\/pt\/business-accounts\/manage-account-holders\/?tab=ah-customer-area_2#deactivate-capability\">manage your users\u2019 access to capabilities<\/a>. Changing this setting does not trigger verification checks or prevent a capability from being requested. <br><br> Note that this capability can only be used if it is both enabled and allowed. <br><br> Set to <strong>true<\/strong> to offer the capability to the user. Set to <strong>false<\/strong> to prevent them from using the capability.<\/p>\n<\/td>\n <\/tr>\n<\/tbody>\n<\/table>","url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/verification-overview\/capabilities","articleFields":{"description":"Learn what capabilities your users can have in your platform","feedback_component":true,"last_edit_on":"20-02-2024 15:43","cache_enable":false,"parameters":{"directoryPath":"\/business-accounts","model":"balance platform"},"filters_component":false,"page_id":"42800084-6aaf-473a-b2a9-63e757776294","decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/verification-overview\/capabilities","title":"User capabilities","content":"Every account holder has a list of capabilities that determine what they can do on your balance platform. You can edit a capability's settings to change which actions the account holder has permission to do, for example, receive payments, send funds to a bank account, or use certain financial products.\nIn most cases, Adyen configures default capabilities for your business during the design phase. These capabilities are automatically requested for your users when you create account holders for them. If a user needs a specific capability that is not part of their default configuration, you must request the additional capability. \n\nIt is possible that requesting additional capabilities prompts additional KYC checks on your users. \n\nBusiness account capabilities\nAdyen business accounts requires your user's account holders to have the following capabilities:\n\n\n\nCapability name\nDisplay name in the Customer Area\nDescription\n\n\n\n\nissueBankAccount\nIssue bank accounts\nAllow users to have an Adyen business bank account.\n\n\nreceiveFromThirdParty\nReceive funds from third-party bank accounts\nAllows users to receive funds from third-party bank accounts. This capability is enabled by default when they have an issueBankAccount capability.\n\n\nsendToThirdParty\nSend funds to third-party bank accounts\nAllows users to send funds to third-party bank accounts. This capability is enabled by default when they have an issueBankAccount capability.\n\n\n\nGeneral capabilities\nIn addition to the business account capabilities, your users also need other capabilities that allow them to perform actions in your balance platform. Some of these capabilities are requested automatically for new account holders, or you have to request them separately when needed.\nVerification status of a capability\nVerification status of a capability indicates whether a user has passed KYC checks and meets requirements to use a specific capability. To get updates about the verification status of a capability, you can:\n\nListen to balancePlatform.accountHolder.created and balancePlatform.accountHolder.updated webhooks\nMake a GET \/accountHolders\/{id} request\n\nHere are the possible values for the capability verification status.\n\n\n\nStatus\nDescription\n\n\n\n\npending\nThe pending status indicates that the verification is in progress.  At this verification phase, a capability requested for the first time is set to \n  requested\n: true and \n  allowed\n: false. If the capability has already been allowed, but some user data has changed and needs to be verified, you may see that the capability verification status is pending and the capability is \n  allowed\n: true. This means that the user is still allowed to use capability while Adyen performs the checks.\n\n\nvalid\nThe valid status indicates that the verification is successfully completed and that the user meets the requirements to use a capability.  With this verification status, the user can use the capability. Adyen sets the capability to \n  allowed\n: true.\n\n\ninvalid\nThe invalid status indicates that the verification failed, for example due to incorrect information or missing documents. In this case, the webhook or the API response contains the  problems object, including the verificationErrors, subErrors, and remediatingActions arrays returned on the linked legal entity. If there are verification errors, you must resolve them.  With this verification status, Adyen sets the capability to \n  allowed\n: false. This means the user is not permitted to use the capability until all verification errors are resolved and the verification process is completed successfully.  If any user data changes or is missing after the previous verification has been completed successfully, Adyen reverts the capability verification status to invalid. In such a scenario, the user must provide the necessary information within a specific deadline. During this period, the user can continue using the capability, and its setting remains as \n  allowed\n: true.\n\n\nrejected\nThe rejected status indicates that Adyen completed verification, but the user does not meet the requirements to use a capability based on the submitted information. This status is final and any errors cannot be resolved by updating data or uploading documents.  With this verification status, Adyen prohibits the user from performing the action and sets the capability to \n  allowed\n: false.\n\n\n\nCapability settings\nThe settings of a capability determine if it is available to a user and they can use it. To get updates about the capability settings, you can:\n\nListen to balancePlatform.accountHolder.created and balancePlatform.accountHolder.updated webhooks\nMake a GET \/accountHolders\/{id} request. The API response contains the capabilities object that shows whether the capability is requested, allowed, and enabled. Below are the explanations for each setting.\n\n\n\n \n   Setting\n   Possible\u00a0values\n   Description\n \n\n\n  \n   \nrequested\n\n   \ntrue, false\n\n   \n   \n       \n           \ntrue: the capability has been requested. Default capabilities are requested automatically when you create an account holder. You can also request additional capabilities by including this setting in your API request.\n\n       \n       \n           \nfalse: the capability has not been requested yet.\n\n       \n   \n\n\n  \n   \nallowed\n\n   \ntrue, false\n\n   \n   \n       \n           \ntrue: the verification is successful and the user is permitted to use the capability. The capability can only be used when it is both allowed and enabled.  In some scenarios, such as when a user changes their information, the capability is set to true while the verification status is \n  pending\n or \n  invalid\n. The user must provide updated information within the given deadline. During the deadline, the user can still use the capability while Adyen verifies the data.\n\n       \n       \n           \nfalse: the verification is \n  pending\n, \n  invalid\n, or \n  rejected\n. The user is not permitted to use the capability.\n\n       \n   \n   \n \n  \n   \nenabled\n\n   \ntrue, false\n\n   \nThis setting allows you to manage your users\u2019 access to capabilities. Changing this setting does not trigger verification checks or prevent a capability from being requested.  Note that this capability can only be used if it is both enabled and allowed.  Set to true to offer the capability to the user. Set to false to prevent them from using the capability.\n\n \n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Business accounts","lvl2":"Verification process","lvl3":"User capabilities"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/business-accounts","lvl2":"https:\/\/docs.adyen.com\/pt\/business-accounts\/verification-overview","lvl3":"\/pt\/business-accounts\/verification-overview\/capabilities"},"levels":4,"category":"","category_color":"","tags":["capabilities"]}}
