\nThe response contains the authorization status, use this to determine what part of the authentication flow your account holder is currently in. See scaStatus<\/code> for all possible values.<\/p>\n\n\n\n| Parameter<\/th>\n | Description<\/th>\n<\/tr>\n<\/thead>\n |
\n\nscaStatus<\/code><\/td>\nStatus of authorization. Possible values: - scaMethodSelected<\/strong>: The account holder\/third-party provider has selected the related Strong Customer Authentication (SCA) routine.<\/li>
- started<\/strong>: The addressed SCA routine has been started.<\/li>
- finalised<\/strong>: The SCA routine has been finalized successfully (including a potential confirmation command). This is a final status of the authorization resource. <\/li>
- failed<\/strong>: The SCA routine failed. This is a final status of the authorization resource.<\/li><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n <\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\nCheck consent details of an account holder<\/h2>\nTo retrieve the details of a previously granted consent, such as the consent status, expiration date, scope, and other related information:<\/p>\n \n- \n
Make a GET \/consents\/{consent_id}<\/code> request, where consent_id<\/code> is a unique identifier for a specific consent.<\/p>\n\n <\/code-sample>\n<\/div>\n<\/li>\n- \n
Check the response for details about account access, validity period, consent status, and links to available resources.<\/p>\n \n <\/code-sample>\n<\/div>\n<\/li>\n<\/ol>\nDelete a consent<\/h2>\nRevoking consent withdraws the account holder's authorization to access account information or initiate payments. To revoke a previously granted consent:<\/p>\n \n- \n
Make a DELETE \/consents\/{consent_id}<\/code> request, where consent_id<\/code> is a unique identifier for a specific consent.<\/p>\n\n <\/code-sample>\n<\/div>\n<\/li>\n- \n
If the deactivation was successful, you'll get an HTTP 200 OK<\/strong> response. The revokedByPsu<\/code> status will appear in future calls when you check if the account holder granted consent<\/a>.<\/p>\n<\/li>\n<\/ol>","url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/consent","articleFields":{"description":"Learn how to manege user consent with our dedicated API endpoints.","feedback_component":true,"id":"31504141","type":"page","_expandable":{"operations":""},"status":"current","next_steps":[{"title":"AISP interface","description":"Learn how to consume our dedicated AISP endpoints.","url":"\/business-accounts\/aisp","required":false},{"title":"PISP interface","description":"Learn how to consume our dedicated PISP endpoints.","url":"\/business-accounts\/pisp","required":false},{"title":"PIISP interface","description":"Learn how to consume our dedicated PIISP endpoints.","url":"\/business-accounts\/piisp","required":false}],"parameters":{"directoryPath":"\/business-accounts","model":"balance platform"}},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/business-accounts\/consent","title":"Manage consent","content":"After an account holder gives their consent, the third-party provider can check if it is still valid and see what they consented to. If an account holder wants to withdraw their consent, the third party provider can make a call to revoke that consent.\nThis page explains how you, as a third-party provider, use the \/consents endpoint to:\n\nCheck if an account holder's consent is still valid and how a third party provider can use the consent.\nRevoke consent on the account holder's behalf.\n\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nNot applicable; this documentation is intended for third-party providers.\n\n\nSetup steps\nBefore you begin, you must: Complete the Adyen onboarding steps.Complete the get account holder consent steps..\n\n\n\nCheck if the account holder granted consent\nTo get the status of a previously granted consent:\n\n\nMake a GET \/consents\/{consent_id}\/status request, where consent_id is a unique identifier for a specific consent. This is the consent_id you saved in the create a consent step. In the headers, include a UUID for the X-Request-ID and the access_token you saved in the get and access token step.\n\n\n\n\n\nIn the response, check the consentStatus. This value indicates your current stage in the consent process. See the consentStatus for all possible values.\n\n\n\nParameter\nDescription\n\n\n\n\nconsentStatus\nStatus of consent. Possible values: received: The consent data have been received. The request will need to be repeated to check if its status updates to \"valid\" for use.rejected: The consent data have been rejected. This is a final status.valid: The consent is accepted and valid.revokedByPsu: The consent has been revoked by the account holder.expired: The consent expired.terminatedByTpp: The third-party provider has terminated the consent.\n\n\npsuMessage\nDetails regarding the account holder's consent.\n\n\n\n\n\n\n\n\nCheck the authorization status of an account holders consent\nTo get information about consent authorization and to determine where your account holder is in the authentication flow, for accessing account information, or to initiate payments:\n\n\nMake a GET \/consents\/{consentId}\/authorisations\/{authorization-id-consent} request, where consent_id is a unique identifier for a specific consent and authorization-id-consent is a unique identifier for a specific consent authorization.\n\nNote that this authorization-id-consent can be found in the create a consent response. This is the last set of characters at the end of thescaStatus link.\n\n\n\n\n\n\nThe response contains the authorization status, use this to determine what part of the authentication flow your account holder is currently in. See scaStatus for all possible values.\n\n\n\nParameter\nDescription\n\n\n\n\nscaStatus\nStatus of authorization. Possible values: scaMethodSelected: The account holder\/third-party provider has selected the related Strong Customer Authentication (SCA) routine.started: The addressed SCA routine has been started.finalised: The SCA routine has been finalized successfully (including a potential confirmation command). This is a final status of the authorization resource. failed: The SCA routine failed. This is a final status of the authorization resource.\n\n\n\n\n\n\n\n\nCheck consent details of an account holder\nTo retrieve the details of a previously granted consent, such as the consent status, expiration date, scope, and other related information:\n\n\nMake a GET \/consents\/{consent_id} request, where consent_id is a unique identifier for a specific consent.\n\n\n\n\n\nCheck the response for details about account access, validity period, consent status, and links to available resources.\n\n\n\n\n\nDelete a consent\nRevoking consent withdraws the account holder's authorization to access account information or initiate payments. To revoke a previously granted consent:\n\n\nMake a DELETE \/consents\/{consent_id} request, where consent_id is a unique identifier for a specific consent.\n\n\n\n\n\nIf the deactivation was successful, you'll get an HTTP 200 OK response. The revokedByPsu status will appear in future calls when you check if the account holder granted consent.\n\n","type":"page","locale":"pt","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Business accounts","lvl2":"Manage consent"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/business-accounts","lvl2":"\/pt\/business-accounts\/consent"},"levels":3,"category":"","category_color":"","tags":["Manage","consent"]}}
| |