Terminate an existing consent to stop further access to customer financial data
Revoke Consent API allows an application to terminate an existing consent previously granted by a customer. Once a consent is revoked, the application will no longer be able to access the customer’s financial data associated with that consent.
This API is typically used when a customer withdraws authorization, when access to financial data is no longer required, or when the application needs to ensure compliance with data privacy and regulatory requirements.
When the request is processed successfully, the consent is invalidated at the bank, preventing any further use of the associated Consent ID for retrieving account or transaction information.
This endpoint submits a consentId and to the system and returns its status to be revoked and preventing further access to previously authorized information.
Endpoint URL | Method |
|---|---|
| POST |
The following headers must be included when calling the Revoke Consent API.
Header parameter | Description |
|---|---|
| Access token used to authenticate the API request |
curl --request POST \
--url https://obsandbox.onesingleview.com/v2/api/observice/consent/delete \
--header 'authorization: Bearer asdrtyuiokjhgfrtyujhdd' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"dateTimeStamp": "2023-06-14T17:51:03",
"requestID": "db35902b-806a-4141-b1e2-e93f60c82f62",
"merchantId": "APIU-300356",
"banks": [
{
"code": "SABB",
"consentId": "urn:SABBSARI:kac-cd3b9a37-eb97-4a70-b268-38af9f2950b1"
}
]
}
'
Request parameters
Parameters | Requirement | Description | Data type | Data validation |
|---|---|---|---|---|
dateTimeStamp | Mandatory | Indicates the date and time when the request is created | Date | ISO 8601 format |
requestID | Mandatory | Unique identifier for the request used for tracking and traceability | Alphanumeric | UUID format |
merchantID | Mandatory | Identifier assigned to the merchant or client application initiating the request | String |
|
banks | Mandatory | List of banks for which the consent should be revoked | Array of objects |
|
code | Mandatory | Unique bank identifier code | Enum |
|
consentId | Mandatory | Unique identifier of the consent which is to be revoked | String |
|
{
"success": true,
"payload": [
{
"code": "SABB",
"consentId": "urn:SVMOB:kac-95bc6544-54ed-42ff-8096-38392f311560",
"success": true,
"message": "Successfully deleted the consent",
"status": "success"
}
]
}Response parameters
Parameter | Description | Data type | Data validation |
|---|---|---|---|
success | Indicates whether the consent revoke request was successfully processed | Enum |
|
payload | Contains bank-specific consent information returned by the Open Banking provider | Array of objects |
|
code | Unique bank code identifier for which the consent was created | Enum |
|
consentId | A unique identifier generated for the consent requested | String |
|
success | Indicates whether the consent revocation was successful for the specified bank | Enum |
|
message | Informational message describing the outcome of the revocation request | String |
|
status | Status of the revocation request | String |
|