v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Users

Manage proxy consent for a User

Allow a user to give or revoke consent for proxy actions.

This endpoint allows your platform to manage consent given by the end user for SCA-triggering actions taken under proxy.

Your platform needs to retrieve the returned PendingUserAction.RedirectUrl, add an encoded returnUrl query parameter for them to be returned to after the SCA session, and redirect the user (read more about SCA redirection).

On the SCA session link in the response, the user can:

  • Give consent for the first time
  • Give consent to additional actions included by your platform
  • Revoke consent (which your platform must allow at any time)

Read more about proxy consent for SCA-triggering actions "

post/v2.01/{ClientId}/sca/users/{UserId}/consent

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

UserIdstring required

The unique identifier of the user.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Response

Success