View a User Regulatory Status

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

ActionCodestring

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.

ScopeBlockedobject

Information about which payment flows are blocked for the user.

Idstring

The unique identifier of the user.

1	{
2	"ActionCode": 8710,
3	"ScopeBlocked": {
4	"Inflows": false,
5	"Outflows": true
6	},
7	"Id": "user_m_01KGJ26D0SFX7G5XC5EV13Y5MB"
8	}