Skip to main content
POST
/
api
/
contacts
/
verify-email
Initiate contact email verification
curl --request POST \
  --url https://core-api.getaptly.com/api/contacts/verify-email \
  --header 'Content-Type: application/json' \
  --header 'x-token: <api-key>' \
  --data '
{
  "email": "jane@example.com",
  "emailSubject": "Your access code",
  "replyTo": "support@example.com",
  "emailHtml": "<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>"
}
'
{
  "requestId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "verifyUrl": "/api/contacts/verify-email/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/confirm"
}

Authorizations

​
x-token
string
header
required

Body

application/json
​
email
string
required

The email address to verify.

​
emailSubject
string

Subject line for the verification email. Defaults to "Your verification code".

​
replyTo
string

Reply-To address for the verification email.

​
emailHtml
string

Custom HTML body for the verification email. Supports two placeholders: {{ verificationCode }} — replaced with the 6-digit code. {{ expirationTime }} — replaced with the expiry duration (e.g. "10 minutes").

Response

Verification initiated — code sent to the email address.

​
requestId
string

Opaque ID used to complete the verification.

​
verifyUrl
string

API path to POST the code to (relative URL).