Register Staff

POST

/staffs/register

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢201New Request

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/staffs/register' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_number": "08155577013",
    "passcode": 1234,
    "email_address": "emmanuella@mycantant.com"
}'

Response Example

{
    "success": true,
    "message": {
        "user": {
            "_id": "64b1492b06a1fe2c7e4118a2",
            "first_name": "Ella",
            "last_name": "daranijo",
            "email_address": "emmanuella@mycantant.com",
            "gender": "",
            "phone_number": "08155577013",
            "state": "lagos",
            "business_type": "63cd339a1f8747b9bcc2c0ef",
            "business_name": "cantant",
            "role": "staff",
            "status": false,
            "staffs": [],
            "isSubscribed": true,
            "dial_code": "+234",
            "country": "nigeria",
            "currency": "NGN",
            "deleted": false,
            "deletedAt": null,
            "updatedAt": "2023-07-14T13:10:03.052Z",
            "createdAt": "2023-07-14T13:10:03.052Z",
            "logo": null,
            "tax": "0"
        },
        "staff": {
            "user": "64b1492b06a1fe2c7e4118a2",
            "business": {
                "_id": "64b146125fe65d50693b456a",
                "userId": "64b146115fe65d50693b4563",
                "business_name": "cantant",
                "business_type": null,
                "status": "active",
                "deleted": false,
                "deletedAt": null,
                "createdAt": "2023-07-14T12:56:50.078Z",
                "updatedAt": "2023-07-14T12:56:50.078Z",
                "__v": 0
            },
            "role": "staff",
            "permissions": [
                "create_all",
                "read_all",
                "update_all",
                "delete_all"
            ],
            "deletedAt": null,
            "_id": "64b1492b06a1fe2c7e4118a4",
            "createdAt": "2023-07-14T13:10:03.104Z",
            "updatedAt": "2023-07-14T13:10:03.104Z",
            "__v": 0
        }
    },
    "data": null
}

Modified at 2025-09-01 21:43:30

Validate Otp

Get User Staffs