Create User
A user must be created under the merchant account before LedgerBlock can perform user-level operations such as KYC verification, wallet creation, PIN setup, and transactions.
Creating the user generates a unique user_ref. This reference identifies the user across subsequent API operations and should be stored securely.
Why Create a User?
A merchant creates a user to:
- Establish an individual user under the merchant account.
- Obtain a unique
user_reffor identifying the user in subsequent API requests. - Specify the user's KYC tier during account creation.
- Enable the user to proceed through KYC and wallet setup.
- Associate future accounts, wallets, and transactions with the correct user.
Sample Request — Create User
POST {{base_url}}/api/v1/merchant/user
Request Headers
| Name | Type | Description |
|---|---|---|
Authorization* | String | Bearer ${api_key} — your activated merchant API key. |
Request Body
| Name | Type | Description |
|---|---|---|
user_name | String | The name of the user. |
email | String | The user's email address. |
kyc_tier | String | KYC tier assigned to the user during creation. |
Sample Request
{
"user_name": "Test User",
"email": "[email protected]",
"kyc_tier": "TIER_1"
}Response
200 OK
200 OK{
"status": "success",
"message": "Successfully created.",
"data": {
"user_ref": "USER-REF-001"
}
}Response Fields
| Key | Type | Description |
|---|---|---|
user_ref | String | Unique reference assigned to the created user. Store this value for future user-level operations. |
Updated about 2 months ago
Did this page help you?
