User verification

Email and phone verification

Confirm a user owns an email address or phone number.

Codes are 6 digits, valid for 10 minutes, with 5 tries. Sending is rate limited per address.

#Email

POST/v3/email/send/{email, vendor_data}

POST/v3/email/check/{email, code}

bash

curl -X POST https://{{HOST}}/v3/email/send/ -H "x-api-key: sk_test_..." -H "Content-Type: application/json" -d '{"email":"[email protected]","vendor_data":"user-1"}'
curl -X POST https://{{HOST}}/v3/email/check/ -H "x-api-key: sk_test_..." -H "Content-Type: application/json" -d '{"email":"[email protected]","code":"123456"}'

#Phone

POST/v3/phone/send/{phone} in E.164 format, such as +447700900123

POST/v3/phone/check/{phone, code}

The check answers Approved, Declined or Expired. Test keys get the code back as sandbox_code. Add the email or phone node to a workflow to ask for the code inside the flow.