View the Regulatory Status of a User

View the Regulatory Status of a User

Authentication

AuthorizationBearer
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
ActionCodestringOptional

Returned values: One of the action codes available in the Blocked users article.

Code indicating the reason for blocking the user, and steps you can take to get them unblocked.

ScopeBlockedobjectOptional
Information about which payment flows are blocked for the user.
KycInformationobjectOptional

Information about the Natural or Legal User’s upcoming KycRenewalDeadline and their LastKycDate, as part of Mangopay’s continuous KYC/KYB verification obligations.

If the User doesn’t renew their KYC/KYB verification before the KycRenewalDeadline, they are downgraded the day after (UTC) and their KYCLevel is changed to LIGHT.

IdstringOptional
The unique identifier of the user.