Users

View the SCA status of a User

Changed on

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

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/sca/users/{UserId}/sca-status
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

UserIdstring required

The unique identifier of the user.

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.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id view_user_sca_status removed and replaced with users_view_user_sca_status