View the SCA status of a User

GET

/v2.01/:ClientId/sca/users/:UserId/sca-status

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

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](/guides/sca/proxy-management), if activated for your platform

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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) 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

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 or null

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 or null

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

ConsentScopeobject

Whether or not the user has given consent to the [proxy action scope](/guides/sca/proxy-management) via the SCA hosted experience: - `ACTIVE` - The user has given consent by checking the corresponding checkbox. - `INACTIVE` - The user has not yet given consent or has revoked consent. - `null` – The 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](/api-reference/users/manage-proxy-consent) endpoint, then re-try the action with `ScaContext` set to `USER_NOT_PRESENT`.

Errors

400

Bad Request Error

404

Not Found Error

1	{
2	"UserStatus": "PENDING_USER_ACTION",
3	"IsEnrolled": false,
4	"LastEnrollmentDate": null,
5	"LastConsentCollectionDate": null,
6	"ConsentScope": {
7	"ContactInformationUpdate": null,
8	"RecipientRegistration": null,
9	"Transfer": null,
10	"ViewAccountInformation": null
11	}
12	}