Skip to content
Authrim

Send an email verification code.

POST
/api/auth/email-codes/send
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/auth/email-codes/send \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]" }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
email
required
string format: email
name
string
custom_fields
object
key
additional properties
Example 
{
  "email": "[email protected]"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
required
boolean
message
required
string
messageId
string
Example 
{
  "success": true,
  "message": "Verification code sent to your email",
  "messageId": "msg_123"
}