Skip to main content
POST
Create user (vendor-scoped)

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Body

application/json
email
string<email>
required

User email address

Example:

"user@example.com"

name
string

User full name

Example:

"John Doe"

password
string<password>

User password

Example:

"securePassword123"

type
enum<string>

User type

Available options:
vendor,
merchant,
admin
Example:

"vendor"

vendorId
string

Associated vendor ObjectId

Example:

"507f1f77bcf86cd799439011"

approved
boolean

Whether user is approved

Example:

true

Response

User created successfully

success
enum<boolean>
Available options:
true
data
object