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_ref for 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

NameTypeDescription
Authorization*StringBearer ${api_key} — your activated merchant API key.

Request Body

NameTypeDescription
user_nameStringThe name of the user.
emailStringThe user's email address.
kyc_tierStringKYC tier assigned to the user during creation.

Sample Request

{
  "user_name": "Test User",
  "email": "[email protected]",
  "kyc_tier": "TIER_1"
}

Response

200 OK

{
  "status": "success",
  "message": "Successfully created.",
  "data": {
    "user_ref": "USER-REF-001"
  }
}

Response Fields

KeyTypeDescription
user_refStringUnique reference assigned to the created user. Store this value for future user-level operations.

Did this page help you?