Skip to main content
POST
/
api
/
canary
/
authentication
/
sign-in
/
email
Sign in with email
curl --request POST \
  --url https://api.cashful.africa/api/canary/authentication/sign-in/email \
  --header 'Content-Type: application/json' \
  --data '
{
  "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>",
  "redirect": true,
  "url": "<string>"
}

Body

application/json
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!"

callbackURL
string

The URL to use for email verification callback

Example:

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

rememberMe
boolean

If this is false, the session will not be remembered. Default is true.

Example:

true

Response

User signed in successfully

user
object
required

User object

token
string
required

Session token

redirect
boolean
required

Whether to redirect

url
string

Redirect URL