Authentication

Log in

PATCH /user/login Authenticates a user and returns a JWT access token and refresh token pair.

This endpoint uses HTTP Basic Auth. Provide the user’s email as the username and their password as the password.

Request

No request body is required. Credentials are passed via the Authorization header.

Authorization

string

required

Basic Auth credentials encoded as Base64(email:password). Example: Basic dXNlckBleGFtcGxlLmNvbTpwYXNzd29yZA==

Response

Returns a 202 Accepted response with a token payload on success.

message

string

Human-readable status message. Example: "User logged in successfully"

data

object

Show properties

token_type

string

required

Always "bearer".

access_token

string

required

JWT access token used to authenticate subsequent requests.

access_token_expiration

string

required

Expiration datetime of the access token in YYYY-MM-DD HH:MM:SS format.

refresh_token

string

required

JWT refresh token used to obtain a new access token.

refresh_token_expiration

string

required

Expiration datetime of the refresh token in YYYY-MM-DD HH:MM:SS format.

Error codes

Code	Description
`400`	Malformed request or missing credentials.
`401`	Invalid email or password.
`404`	No account found for the provided email.
`500`	Internal server error.

Example

curl --request PATCH \
  --url https://api.example.com/user/login \
  --header 'Authorization: Basic dXNlckBleGFtcGxlLmNvbTpwYXNzd29yZA=='

Create a user

POST /user/create Creates a new user account. Credentials are supplied via Basic Auth and additional profile fields are provided in the request body.

This endpoint uses HTTP Basic Auth. Provide the new user’s email as the username and their desired password as the password.

Request

Authorization

string

required

Basic Auth credentials encoded as Base64(email:password). The email and password become the new user’s login credentials.

Body

first_name

string

User’s first name.

last_name

string

User’s last name.

phone_number

string

User’s phone number. Example: "1236547899"

Response

Returns a 201 Created response with the new user’s profile on success.

message

string

Human-readable status message. Example: "User created successfully"

data

object

Show properties

integer

required

Unique numeric identifier for the user.

first_name

string

User’s first name.

last_name

string

User’s last name.

string

required

User’s email address.

phone_number

string

User’s phone number.

status

string

Account status. Possible values: "Awaiting Verification: User must verify their email", "Active: Verified and allowed to log in", "Suspended: Temporarily disabled by admin", "Deactivated: User closed or deleted account", "Banned: Permanently removed for violating terms".

is_superuser

boolean

required

Whether the user has superuser privileges. Defaults to false.

Error codes

Code	Description
`400`	Malformed request body or validation error.
`401`	Missing or invalid Basic Auth credentials.
`404`	Resource not found.
`500`	Internal server error.

Example

curl --request POST \
  --url https://api.example.com/user/create \
  --header 'Authorization: Basic dXNlckBleGFtcGxlLmNvbTpwYXNzd29yZA==' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "Jane",
    "last_name": "Doe",
    "phone_number": "1236547899"
  }'

User Endpoints

Company Endpoints

Log in

Request

Response

Error codes

Example

Create a user

Request

Response

Error codes

Example

Build docs developers (and LLMs) love

User Endpoints

Company Endpoints

Documentation Index

​Log in

​Request

​Response

​Error codes

​Example

​Create a user

​Request

​Response

​Error codes

​Example

Build docs developers (and LLMs) love

Log in

Request

Response

Error codes

Example

Create a user

Request

Response

Error codes

Example