Skip to navigation

Manage proxy consent for a User

Allows a user to give or revoke consent for SCA-triggering actions taken under proxy.

Before redirecting the user on the PendingUserAction.RedirectUrl returned, ensure you add an encoded returnUrl query parameter – read more about SCA redirection.

On the SCA session, 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)

This endpoint also allows a user to enroll if they aren’t already.

Read more about proxy consent for SCA-triggering actions →”

Authentication

AuthorizationBearer

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.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
UserIdstringRequired
The unique identifier of the user.

Response

Success
PendingUserActionobjectOptional

Object containing the RedirectUrl needed for SCA redirection if triggered by the API call (otherwise returned null).

Errors

400
Bad Request Error