Register OAuth - UniBee Documentation

curl --request POST \
  --url https://api.unibee.dev/merchant/auth/sso/oauth/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "companyName": "<string>",
  "countryCode": "<string>",
  "countryName": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "metadata": {},
  "password": "<string>",
  "phone": "<string>",
  "userName": "<string>"
}
'

{
  "code": 123,
  "data": {
    "merchantMember": {
      "MemberGroupPermission": {},
      "MemberRoles": [
        {
          "createTime": 123,
          "id": 123,
          "merchantId": 123,
          "permissions": [
            {
              "group": "<string>",
              "permissions": [
                "<string>"
              ]
            }
          ],
          "role": "<string>"
        }
      ],
      "createTime": 123,
      "currentDeviceIdentity": "<string>",
      "deviceList": [
        {
          "currentDevice": true,
          "identity": "<string>",
          "ipAddress": "<string>",
          "lastActiveTime": 123,
          "lastLoginTime": 123,
          "lastTotpVerificationTime": 123,
          "name": "<string>",
          "status": true
        }
      ],
      "email": "<string>",
      "firstName": "<string>",
      "id": 123,
      "isBlankPasswd": true,
      "isOwner": true,
      "lastName": "<string>",
      "merchantId": 123,
      "mobile": "<string>",
      "oauthAccounts": [
        {
          "email": "<string>",
          "emailVerified": true,
          "image": "<string>",
          "name": "<string>",
          "provider": "<string>",
          "providerId": "<string>"
        }
      ],
      "status": 123,
      "totpType": 123
    },
    "token": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

POST

merchant

auth

sso

oauth

curl --request POST \
  --url https://api.unibee.dev/merchant/auth/sso/oauth/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "companyName": "<string>",
  "countryCode": "<string>",
  "countryName": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "metadata": {},
  "password": "<string>",
  "phone": "<string>",
  "userName": "<string>"
}
'

{
  "code": 123,
  "data": {
    "merchantMember": {
      "MemberGroupPermission": {},
      "MemberRoles": [
        {
          "createTime": 123,
          "id": 123,
          "merchantId": 123,
          "permissions": [
            {
              "group": "<string>",
              "permissions": [
                "<string>"
              ]
            }
          ],
          "role": "<string>"
        }
      ],
      "createTime": 123,
      "currentDeviceIdentity": "<string>",
      "deviceList": [
        {
          "currentDevice": true,
          "identity": "<string>",
          "ipAddress": "<string>",
          "lastActiveTime": 123,
          "lastLoginTime": 123,
          "lastTotpVerificationTime": 123,
          "name": "<string>",
          "status": true
        }
      ],
      "email": "<string>",
      "firstName": "<string>",
      "id": 123,
      "isBlankPasswd": true,
      "isOwner": true,
      "lastName": "<string>",
      "merchantId": 123,
      "mobile": "<string>",
      "oauthAccounts": [
        {
          "email": "<string>",
          "emailVerified": true,
          "image": "<string>",
          "name": "<string>",
          "provider": "<string>",
          "providerId": "<string>"
        }
      ],
      "status": 123,
      "totpType": 123
    },
    "token": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/auth/sso/oauth/register Merchant OAuth Register. Pass OAuth token in request header (Auth.js JWT). Headers: X-Auth-JS-Token | X-Auth-Token | X-OAuth-Token

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
`Authorization`	Yes	Bearer `<your_api_key>`
`Content-Type`	Yes	`application/json` (for request body)

Parameters

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

Request body

Name	Type	Required	Description
`companyName`	string	No	Company Name
`countryCode`	string	No	Country Code
`countryName`	string	No	Country Name
`email`	string	Yes	The merchant member email address
`firstName`	string	No	The merchant owner’s first name
`lastName`	string	No	The merchant owner’s last name
`metadata`	object	No	Metadata，Map
`password`	string	No	The owner’s password
`phone`	string	No	The owner’s Phone
`userName`	string	No	The owner’s UserName

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/auth/sso/oauth/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/oauth/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.

Field	Type	Description
`code`	integer	Response code. `0` = success
`data`	object	Response payload
`data.merchantMember`	object
`data.token`	string	Access token of admin portal
`message`	string	Human-readable message
`requestId`	string	Request ID for support

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check `message` in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server 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

Merchant OAuth Register. Pass OAuth token in request header (Auth.js JWT). Headers: X-Auth-JS-Token | X-Auth-Token | X-OAuth-Token

string<string>

required

The merchant member email address

companyName

string<string>

Company Name

countryCode

string<string>

Country Code

countryName

string<string>

Country Name

firstName

string<string>

The merchant owner's first name

lastName

string<string>

The merchant owner's last name

metadata

object

Metadata，Map

Show child attributes

password

string<string>

The owner's password

phone

string<string>

The owner's Phone

userName

string<string>

The owner's UserName

Response

200 - application/json

code

integer<int>

data

object

Show child attributes

merchantId

integer<int64>

message

string<string>

redirect

string<string>

requestId

string<string>

Get Oauth Members OAuth Setup

​Endpoint Overview

​Authorization

​Parameters

​Request body

​Request examples

​cURL

​Sandbox

​Response

​Error handling

Authorizations

Body

Response

Endpoint Overview

Authorization

Parameters

Request body

Request examples

cURL

Sandbox

Response

Error handling