This module provides endpoints for managing the ongoing lifecycle of your users. Once a user is verified and active, you may need to update their personal details, temporarily restrict their access for security reasons, or permanently close their account.Data Maintenance: Updating user contact information (email, phone) or residential address.
Security Control: Instantly suspending users to prevent fraudulent activity.
Access Restoration: Reactivating accounts after security reviews.
Offboarding: Permanently deleting user accounts and associated data.
Core Endpoints#
Update Existing User
Modify user details such as email address, phone number, or street address.Delete User
Permanently remove a user account. This action is irreversible.Suspend User
Temporarily freeze a user's account to block all transactions and withdrawals.Unsuspend User
Restore full access and functionality to a previously suspended user.
Updating User Details#
Use the Update Existing User endpoint to keep your records in sync with the user's actual status. You can modify most data provided during account creation without affecting the separate identity verification records.Allowed Updates
You can freely update the following fields:Contact Info: Email address, phone number.
Address Details: Street, city, postal code (e.g., if the user moves).
Country: The user's country of residence cannot be changed once the account is created.
Identity Data: Data extracted during KYC verification (which is stored separately) remains immutable to ensure compliance integrity.
Security & Suspension#
If you detect suspicious activity, fraud, or a compliance breach, you should act immediately to secure the funds.Suspending an Account#
Calling Suspend User puts the account into a "Frozen" state.Effect: The user cannot perform deposits, withdrawals, exchanges, or card transactions.
Use Case: Fraud detection alerts, user report of a stolen account, or pending compliance review.
Restoring Access#
Once a security review is cleared, use Unsuspend User to restore full functionality. The user will immediately be able to transact again.
Account Closure (Deletion)#
The Delete User endpoint is used for permanent offboarding. This is typically invoked when a user requests to close their account (e.g., GDPR "Right to be Forgotten") or when you terminate a relationship with a client.This action is irreversible.
Deleting a user removes their access to the platform, clears their balances (ensure funds are withdrawn first), and removes their association with your partner account.
