Terminate user's consent

delete

https://example.com/tpp/v1/users/{userId}/consents/{consentId}

Updates user's specific consent's status to terminatedByTpp.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userId

string

required

ID of the addressed user. Consists of the sub + @ + tpp_id.

consentId

string

required

length ≤ 523

Resource ID of the addressed consent.

Query Params

transactionId

string

In case the request processing took longer than X-Request-Wait milliseconds,
this value will be used for resuming the past request.

reason

string

enum

String. The field indicates why the Consent is going to be terminated. There will be a closed list
of options.

clientDisconnectedFromDigital - Client disconnected from digital.
terminatedDueToTechnicalProblem - Terminated due to technical problem.
allUserAccountsWereClosed - All the user's accounts were closed.
terminatedByTpp - The banker/support of the TPP terminated consent.

Allowed:

Headers

X-Trace-Id

string

X-Request-Wait

integer

≥ 0

Defaults to 10

In case the request processing requires calls to external resources (as ASPSPs),
this value will define the maximum number of milliseconds
in which the API server will wait for all external resources' responses to complete.
If not present, the default configured duration will be used.

X-Psu-IP-Address

string

length ≤ 15

In case if end user is online, this header should be present and contain an IP address of the user.

X-Tpp-Id

string

Contains TPP name

Origin

string

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

204No Content - consent deleted

400Provided Consent termination reason is not valid

404User not found

410Consent not found. When returned from accounts endpoints, it can also mean the related consent isn't valid nor suspended.

500Failed to delete consent.