Skip to main content
POST
/
merchant
/
auth
/
sso
/
register
Register
curl --request POST \
  --url https://api.unibee.dev/merchant/auth/sso/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "password": "<string>",
  "companyName": "<string>",
  "countryCode": "<string>",
  "countryName": "<string>",
  "metadata": {},
  "phone": "<string>",
  "userName": "<string>"
}
'
{
  "code": 123,
  "data": {},
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

​
Endpoint Overview

POST https://api.unibee.dev/merchant/auth/sso/register Register with owner permission, send email with OTP code

​
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
companyNamestringNoCompany Name
countryCodestringNoCountry Code
countryNamestringNoCountry Name
emailstringYesThe merchant owner’s email address
firstNamestringYesThe merchant owner’s first name
lastNamestringYesThe merchant owner’s last name
metadataobjectNoMetadata，Map
passwordstringYesThe owner’s password
phonestringNoThe owner’s Phone
userNamestringNoThe owner’s UserName

​
Request examples

​
cURL

curl -X POST "https://api.unibee.dev/merchant/auth/sso/register" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "companyName": "",
  "countryCode": "",
  "countryName": "",
  "email": "user@example.com",
  "firstName": "",
  "lastName": "",
  "metadata": {},
  "password": "",
  "phone": "",
  "userName": ""
}'

​
Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/auth/sso/register" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "companyName": "",
  "countryCode": "",
  "countryName": "",
  "email": "user@example.com",
  "firstName": "",
  "lastName": "",
  "metadata": {},
  "password": "",
  "phone": "",
  "userName": ""
}'

​
Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success. The response schema for this endpoint is shown below.

​
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

Register with owner permission, send email with OTP code

​
email
string<string>
required

The merchant owner's email address

​
firstName
string<string>
required

The merchant owner's first name

​
lastName
string<string>
required

The merchant owner's last name

​
password
string<string>
required

The owner's password

​
companyName
string<string>

Company Name

​
countryCode
string<string>

Country Code

​
countryName
string<string>

Country Name

​
metadata
object

Metadata，Map

​
phone
string<string>

The owner's Phone

​
userName
string<string>

The owner's UserName

Response

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