Read user's consents details

get

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

Reads details about user's consents. We will include only VALID consents, unless explicitly requested otherwise.

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.

Query Params

preventUpdate

boolean

If contained, we won't update user's financial data (i.e. no account data requests will be made to the ASPSP).

withInvalid

boolean

If contained, we will include all consents. Otherwise, we will include only VALID consents.

transactionId

string

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

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

*/*

200OK

404User not found

500Request to an ASPSP failed