Delete user-consent(s)
Yapily API provides you with two ways of managing the user and user-consent deletion as part of our consent management capability.
1. Delete your application user’s consent
When your application user on your frontend chooses to revoke consent to one of their banks (e.g User ABC wants to revoke their HSBC) when they feel appropriate to do so, you can use to delete only one particular consent using the endpoint - DELETEhttps://api.yapily.com/consents/{{consent-id}}
Delete Consent API will respond with the deleteStatus
, institutionId
, institutionConsentId
(if supported by the bank) among other useful identifiers and date fields.
2. Delete your application user (thereby, deleting their consent too)
However, in scenarios where your user completely leaves your application, you are required by the PSD2 and GDPR to remove all their existing consents and their unique identification.
We provide one simple endpoint to do this task for you - DELETEhttps://api.yapily.com/users/{{user-uuid}}
By deleting the user, you can dynamically delete all the linked user-consent and get a confirmation from the delete user API response as seen in the screenshot below
- confirmation that user with the id mentioned is deleted
- confirmation that user’s consents are also deleted, which is returned with the array of said consents with details on the status, institution and consent creation date.
API Reference: https://docs.yapily.com, refer the endpoints below