Skip to main content
POST

Endpoint

Headers

string
required
Your application API key
string
required
Your application secret key
string
default:"application/json"
Content type of the request body

Body Parameters

string
required
Your own identifier for this user in your system. Use it to reconcile HOST Pay users with your database. Accepts any string identifier (e.g. user_123, a UUID, or a plain number). For backward compatibility a numeric value is also accepted and stored as its string form (1001 becomes "1001"). It cannot be changed after the user is created.
string
required
Full name of the user
string
required
Phone number with country code (e.g., +23279123456)
string
Email address of the user (optional)
string
Optional username for the user
boolean
default:"true"
Whether the user is active on creation

Response

string
HOST Pay’s unique identifier for the user (UUID)
string
The identifier you supplied when creating the user. Always returned as a string.
string
User’s full name
string
User’s email address
string
User’s phone number
boolean
Whether the user account is active (default: true)
string
ISO 8601 timestamp of creation
string
ISO 8601 timestamp of last update

Notes

After creating a user, you need to create a wallet for them using the Create Wallet endpoint. You can then retrieve it using the Get Wallet endpoint.
Email addresses must be unique within your application’s schema. Attempting to create a user with an existing email will result in a 400 error.

Next Steps

Create User Wallet

Create a wallet for the new user

Make a Deposit

Add funds to the user’s wallet