Skip to main content
GET
/
v2.01
/
{ClientId}
/
sca
/
users
/
{UserId}
/
sca-status
// GET has no body parameters

{
    "UserStatus": "ACTIVE",
    "IsEnrolled": true,
    "LastEnrollmentDate": 1753385619,
    "LastConsentCollectionDate": null,
    "ConsentScope": {
        "ContactInformationUpdate": "INACTIVE",
        "RecipientRegistration": "INACTIVE",
        "Transfer": "INACTIVE",
        "ViewAccountInformation": "INACTIVE"
    }
}

Documentation Index

Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Path parameters

​
UserId
string
required
The unique identifier of the user.

​
Responses

200 - Response parameters

​
UserStatus
string
Returned values: PENDING_USER_ACTION, ACTIVE, CLOSEDThe 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.
​
IsEnrolled
boolean
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).
​
LastEnrollmentDate
Unix timestamp | null
The date and time of the last successful SCA enrollment, whether for the first time or a re-enrollment.
​
LastConsentCollectionDate
Unix timestamp | null
The date and time of the last modification to any of the 4 scopes, whether to give or revoke consent.
​
ConsentScope
object
Whether or not the user has given consent to the proxy action scope via the SCA hosted experience:
  • ACTIVE - The has given consent by checking the corresponding checkbox.
  • INACTIVE - The has not yet given consent or has revoked consent.
  • null – The corresponding scope corresponding scope does not have proxy management configured for your platform.
If a scope is ACTIVE, your platform can call the relevant endpoint with ScaContext set to USER_NOT_PRESENT to take the action under proxy.If a scope is INACTIVE, your platform has two options:
  • Call the relevant endpoint with the user on session to complete SCA by redirecting them using the returned PendingUserAction.RedirectUrl.
  • Ask the user to give consent using the PendingUserAction.RedirectUrl returned by the POST Manage proxy consent for a User endpoint, then re-try the action with ScaContext set to USER_NOT_PRESENT.
{
    "Message": "The ressource does not exist",
    "Type": "ressource_not_found",
    "Id": "ebaaf922-771a-4142-a7a2-59d6c1fb422e",
    "Date": 1770130888.0,
    "errors": null
}

{
    "Message": "This endpoint is not allowed for User categorized as PAYER",
    "Type": "not_allowed_for_user_category_payer",
    "Id": "8d708172-0196-47d1-be84-0c0a14aff2d8",
    "Date": 1765962571.0,
    "errors": null
}

{
    "UserStatus": "ACTIVE",
    "IsEnrolled": true,
    "LastEnrollmentDate": 1753385619,
    "LastConsentCollectionDate": null,
    "ConsentScope": {
        "ContactInformationUpdate": "INACTIVE",
        "RecipientRegistration": "INACTIVE",
        "Transfer": "INACTIVE",
        "ViewAccountInformation": "INACTIVE"
    }
}

// GET has no body parameters