Skip to main content
POST
/
v1
/
auth
/
register
/
email
/
send
Send Registration Email
curl --request POST \
  --url https://api.example.com/v1/auth/register/email/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'
{
  "contactVerificationId": "<string>"
}

​
Overview

First step of user registration. Sends a verification code to the user’s email address. The user will receive an email with a 6-digit code that must be verified in the next step. This creates a temporary contact verification record that expires after a set time period (typically 10-15 minutes).

​
Request

​
Body

​
email
string
required
User’s email address for registrationFormat: Valid emailExample: hello@example.com

​
Response

​
contactVerificationId
string
Verification ID to use in subsequent stepsStore this value - required for email verificationExample: US_100a99cf-f4d3-4fa1-9be9-2e9828b20ebb

​
Code Examples

curl -X POST "https://dev.api.baanx.com/v1/auth/register/email/send" \
  -H "x-client-key: your-client-key" \
  -H "Content-Type: application/json" \
  -d '{"email": "hello@example.com"}'

​
Next Steps

Verify Email Code

Verify the code received by email to create user account