Onboard new Company and Company's Admin

POST

/onboard

This API is used to Create new user and company on the platform by System Admin apiKey. The new user account created with the new company is the Company Admin by default.

Request

Authorization

API Key

Add parameter in header

apiKey

Example:

apiKey: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successful operation

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/onboard' \
--header 'apiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "user": {
        "email": "john.doe@example.com",
        "fullName": "John Doe",
        "password": "ThisIsASecretPassword"
    },
    "company": {
        "name": "Acme Commerce",
        "phone": "84799865522",
        "registrationNumber": "84799865522",
        "address": "123 Wall Street",
        "country": "US",
        "currency": "USD",
        "timezone": "America/New_York",
        "linkUrl": "https://www.John"
    }
}'

Response Example

{
    "company": {
        "publicId": "3cb69db1-c410-4b83-8d37-84b823be9c06"
    }
}

Modified at 2026-02-27 03:50:25

Onboard

Update company profile