Enroll a User in SCA
Obtain an SCA redirection link to enroll an Owner user
If UserCategory
is OWNER
, this endpoint allows you to enroll a user in SCA. 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 →
You can use this endpoint to obtain a new session RedirectUrl
. This is useful to:
- Enroll Owners created without SCA enrollment
- Retry enrollment if a previous session was unsuccessful or expired (after 10 minutes)
Calling this endpoint creates a new valid session that can be used, even if there is one already in progress for the user. Calling this endpoint also doesn’t change the user’s UserStatus
, even if the session expires or is unsuccessful.
Note – This endpoint doesn’t change UserStatus
Calling this endpoint does not change the user’s status to PENDING_USER_ACTION
(it stays as ACTIVE
) and no USER_ACCOUNT_VALIDATION_ASKED
webhook notification is sent.
This ensures that legacy users do not become blocked if they are unable to complete SCA successfully.
Path parameters
The unique identifier of the user.
Responses
200
200
Object containing the link needed for SCA redirection if triggered by the API call (otherwise returned null
).
400 - Endpoint not allowed if category is PAYER
400 - Endpoint not allowed if category is PAYER
To enroll a user whose UserCategory
is PAYER
in SCA, use the endpoints PUT Categorize a Natural User or PUT Categorize a Legal User.