Skip to main content
POST
/
merchant
/
user
/
new
New User
curl --request POST \
  --url https://api.unibee.dev/merchant/user/new \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "address": "<string>",
  "externalUserId": "<string>",
  "firstName": "<string>",
  "language": "<string>",
  "lastName": "<string>",
  "password": "<string>",
  "phone": "<string>"
}
'
{
  "code": 123,
  "data": {
    "user": {
      "address": "<string>",
      "avatarUrl": "<string>",
      "billingType": 123,
      "birthday": "<string>",
      "city": "<string>",
      "companyName": "<string>",
      "countryCode": "<string>",
      "countryName": "<string>",
      "createTime": 123,
      "custom": "<string>",
      "email": "<string>",
      "externalUserId": "<string>",
      "facebook": "<string>",
      "firstName": "<string>",
      "gatewayId": 123,
      "gatewayPaymentType": "<string>",
      "gender": "<string>",
      "id": 123,
      "isRisk": 123,
      "isSpecial": 123,
      "language": "<string>",
      "lastLoginAt": 123,
      "lastName": "<string>",
      "linkedIn": "<string>",
      "merchantId": 123,
      "metadata": {},
      "mobile": "<string>",
      "otherSocialInfo": "<string>",
      "paymentMethod": "<string>",
      "phone": "<string>",
      "recurringAmount": 123,
      "registrationNumber": "<string>",
      "school": "<string>",
      "state": "<string>",
      "status": 123,
      "subscriptionId": "<string>",
      "subscriptionName": "<string>",
      "subscriptionStatus": 123,
      "taxPercentage": 123,
      "telegram": "<string>",
      "tikTok": "<string>",
      "timeZone": "<string>",
      "type": 123,
      "userName": "<string>",
      "vATNumber": "<string>",
      "version": 123,
      "weChat": "<string>",
      "whatsAPP": "<string>",
      "zipCode": "<string>"
    }
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint Overview

POST https://api.unibee.dev/merchant/user/new User Creation If Not Exist

​
Authorization

All UniBee Merchant API requests require authentication via API key.
HeaderRequiredDescription
AuthorizationYesBearer <your_api_key>
Content-TypeYesapplication/json (for request body)

​
Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

​
Request body

NameTypeRequiredDescription
addressstringNoAddress
emailstringYesEmail
externalUserIdstringNoExternalUserId
firstNamestringNoFirst Name
languagestringNoLanguage
lastNamestringNoLast Name
passwordstringNoPassword
phonestringNoPhone

​
Request examples

​
cURL

curl -X POST "https://api.unibee.dev/merchant/user/new" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "",
  "email": "user@example.com",
  "externalUserId": "id_example",
  "firstName": "",
  "language": "",
  "lastName": "",
  "password": "",
  "phone": ""
}'

​
Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/user/new" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "address": "",
  "email": "user@example.com",
  "externalUserId": "id_example",
  "firstName": "",
  "language": "",
  "lastName": "",
  "password": "",
  "phone": ""
}'

​
Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.
FieldTypeDescription
codeintegerResponse code. 0 = success
dataobjectResponse payload
data.userobject
messagestringHuman-readable message
requestIdstringRequest ID for support

​
Error handling

HTTP statusMeaning
400Bad request — invalid or missing parameters. Check message in the body.
401Unauthorized — missing or invalid API key.
404Not found — invalid path or resource.
500Server error — retry with backoff.
When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

User Creation If Not Exist

​
email
string<string>
required

Email

​
address
string<string>

Address

​
externalUserId
string<string>

ExternalUserId

​
firstName
string<string>

First Name

​
language
string<string>

Language

​
lastName
string<string>

Last Name

​
password
string<string>

Password

​
phone
string<string>

Phone

Response

200 - application/json
​
code
integer<int>
​
data
object
​
merchantId
integer<int64>
​
message
string<string>
​
redirect
string<string>
​
requestId
string<string>