Primus Documentation

Create User API

Welcome to the documentation for the User Creation API. This API helps you add a new user to an account.

Base URL

{baseURL}/v1/users/create | POST

Authorization

Include the following Authorization header in your HTTP requests using a Bearer token:

Authorization: Bearer YOUR_ACCESS_TOKEN

Request Payload

Field	Type	Source	Required	Description
first_name	string	body	✅ Yes	User's first name
last_name	string	body	✅ Yes	User's last name
email	string	body	✅ Yes	User's email address
phone_number	string	body	✅ Yes	User's phone number
role_id	ObjectID	body	✅ Yes	ID of user's assigned role
gender	string	body	✅ Yes	User's gender

Sample Request

curl -X POST {baseURL}/v1/users \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone_number": "1234567890",
    "role_id": "64e8b1de85671e19e26d717d",
    "gender": "male"
  }'

Sample 201 Response

{
  "message": "User created successfully",
  "data": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone_number": "07031832236",
    "role_id": "64e8b1de85671e19e26d717d",
    "is_verified": false,
    "account_id": "64d5673dc90a56305c9bf806",
    "organization_id": "64deca8564404c094c0545bd",
    "gender": "male",
    "is_2FA_enabled": false,
    "is_default_password": true,
    "status": "active",
    "_id": "64f38d955293bf824081191c",
    "security_questions": [],
    "createdAt": "2023-09-02T19:31:33.064Z",
    "updatedAt": "2023-09-02T19:31:33.345Z",
    "__v": 1
  },
  "success": true
}

Create Security Questions Email Verification