Skip to main content
POST
/
sdk
/
{environmentId}
/
emailVerifications
/
create
Initialize email verification process
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/sdk/{environmentId}/emailVerifications/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "captchaToken": "<string>"
}
'
{
  "verificationUUID": "95b11417-f18f-457f-8804-68e361f9164f",
  "email": "jsmith@example.com"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

Email Verification data

​
email
string<email>
required

Email address to verify

Maximum string length: 255
Pattern: ^[^@]{1,64}@[^@]+$
​
captchaToken
string

When provided, used to verify that a captcha is valid and get the success/failure result from the captcha provider server-side.

Response

Successful response, that contains verification UUID.

​
verificationUUID
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
email
string<email>
required

Email address that the verification was sent to