Skip to main content
POST
/
api
/
canary
/
authentication
/
sign-up
/
email
Sign up with email
curl --request POST \
  --url https://api.cashful.africa/api/canary/authentication/sign-up/email \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "email": "john.doe@example.com",
  "password": "StrongPassword123!"
}
'
{
  "user": {
    "id": "<string>",
    "email": "<string>",
    "emailVerified": true,
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "image": "<string>",
    "role": "<string>",
    "banned": true,
    "banReason": "<string>",
    "banExpires": "2023-11-07T05:31:56Z",
    "isAnonymous": true,
    "username": "<string>",
    "displayUsername": "<string>",
    "phoneNumber": "<string>",
    "phoneNumberVerified": true
  },
  "token": "<string>"
}

Body

application/json
name
string
required

The name of the user

Example:

"John Doe"

email
string
required

The email address of the user

Example:

"john.doe@example.com"

password
string
required

The password for the user account

Example:

"StrongPassword123!"

image
string

Optional URL to the user's profile image

Example:

"https://www.cashful.africa/avatar.jpg"

callbackURL
string
default:https://api.cashful.africa/auth/callback

Optional callback URL after successful sign-up

Example:

"https://www.cashful.africa/auth/callback"

rememberMe
boolean

Optional flag to indicate if the user should be remembered

Example:

true

Response

User created successfully

user
object
required

User object created successfully

token
string

Authentication token for the session