Profile Statuses
There are two types of statuses related to the User profile:
- KYC status
- User Profile status
User Profile Status
PATCH /v1/users/{userId} to manage user profile status
| Active |
User is allowed to use system functionalities.
Status applies when:
"paramType": "ACTIVE",
"paramValue": true,
"paramType": "FROZEN",
"paramValue": false,
"user": {
"banned": false,
"banExpiryDate": "2025-01-01T07:15:50.555Z"
|
| Inactive |
User profile was deactivated.
The user can’t log in to the system. Other operations are not limited, for example, the user can receive income transfer.
Status applies when:
"paramType": "ACTIVE",
"paramValue": false,
"paramType": "FROZEN",
"paramValue": false,
"user": {
"banned": false,
"banExpiryDate": "2025-01-01T07:15:50.555Z"
|
| Banned |
User profile was automatically banned due to login attempt limit exceeding.
The user can’t log in to the system. Other operations are not limited, for example, the user can receive income transfer.
Status applies when:
"paramType": "ACTIVE",
"paramValue": true,
"paramType": "FROZEN",
"paramValue": false,
"user": {
"banned": true,
"banExpiryDate": "2025-01-01T07:15:50.555Z"
OR
"paramType": "ACTIVE",
"paramValue": true,
"paramType": "FROZEN",
"paramValue": true,
"user": {
"banned": true,
"banExpiryDate": "2025-01-01T07:15:50.555Z"
Use API to unban:
{
"user": {
"banned": false,
"banExpiryDate": "2025-01-01T07:15:50.555Z",
|
| Frozen |
User profile was frozen due to compliance reasons (e.g. AML, etc.)
If the User has the FROZEN: true prohibit for a user to:
- perform transfer from their wallets
- receive transfers to their wallets
- perform transfer between their wallets
- perform Top up/Withdrawal to/from their wallets
- perform currency exchange
All other actions are allowed, for example the following:
- logged in
- view Tx history
- view profile
- uploading required documents availability depends on the identification and document status
- etc.
Status applies when:
- “paramType”: “ACTIVE”,
- “paramValue”: false,
- “paramType”: “FROZEN”,
- “paramValue”: true,
- “user”: {
- “banned”: false,
- “banExpiryDate”: “2025-01-01T07:15:50.555Z”
Use API to unfreeze:
"paramType": "FROZEN",
"paramValue": false,
|
