Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Users

View the SCA status of a User

Retrieve SCA and consent information for a Natural or Legal User.

This endpoint returns information for an OWNER user relating to:

  • Whether or not they are enrolled in SCA – but if they never triggered an SCA enrollment, the endpoint returns a 404
  • Their consent for your platform to take SCA-triggering actions by proxy, if activated for your platform
get/v2.01/{ClientId}/sca/users/{UserId}/sca-status

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

UserStatusstring

Returned values: PENDING_USER_ACTION, ACTIVE, CLOSED

The status of the user:

  • PENDING_USER_ACTION – The user must enroll in SCA before they can become ACTIVE.
  • ACTIVE – The user account is active and the user can access Mangopay features.
  • CLOSED – The user account is permanently closed. This value is used by Mangopay to close an account following the procedure outlined in the terms and conditions.
IsEnrolledboolean

Whether or not the User has been enrolled in SCA. This value is false before the User enrolls successfully for the first time. Once enrolled, this value remains true during re-enrollment (but the UserStatus changes to PENDING_USER_ACTION).

LastEnrollmentDatestring nullable

The date and time of the last successful SCA enrollment, whether for the first time or a re-enrollment. Not returned if the user has not yet completed enrollment

LastConsentCollectionDatestring nullable

The date and time of the last modification to any of the 4 scopes, whether to give or revoke consent.