v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

userRegulatoryStatus

View a User Regulatory Status

get/v2.01/{ClientId}/users/{UserId}/regulatory

Path parameters

ClientIdstring required

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

UserIdstring required

The unique identifier of the user.

Headers

Authorizationstring required

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.

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.

Idstring

The unique identifier of the user.