Initiate Revoke Consent

Start a task to remove consent and remove Bud’s ability to download further information for a specified customer account.

This will revoke all the consents for the specified provider associated to the customer.

To check the status of this task, use the Retrieve Revoke Consent Status using the returned task_id.

Alternatively, there is a Open Banking Consent Revoked webhook that will trigger per consent successfully revoked. As such this task could generate multiple of these.

Body Params
string
required

The name of the provider (ASPSP) the Customer is requesting to have their consent revoked for

Headers
string
required

The API Client Identifier (Service Application Identifier).

uuid
required

A unique identifier for a Customer, as registered on Bud's platform.

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

Responses

400

Bad Request that fails validations on headers & payload

401

Unauthorized (BearerToken in 'Authorization' header fails the authentication)

5XX

An unexpected error occurred on the server side

Callback
Language
Credentials
OAuth2
Response
Choose an example:
application/json