Verified emails

Verified Emails

Verified email webhooks are emitted by the Accounts API when verified email records are created or updated (POST /verified-emails, PUT /verified-emails/:email).

Events

Action Event name
creating a verified email (POST /verified-emails) verifiedEmails.created
updating a verified email (PUT /verified-emails/:verifiedEmail) verifiedEmails.updated

Payload example (verifiedEmails.created / verifiedEmails.updated)

{
  "id": "string",
  "attemptId": "string",
  "livemode": "boolean",
  "created": "int",
  "event": "verifiedEmails.created",
  "data": {
    "email": "user@example.com",
    "status": "WHITELISTED",
    "QEVResponse": {}
  }
}

Payload fields (verifiedEmails.created / verifiedEmails.updated)

Field Type Description
data.email string The verified email address
data.status string One of: BLACKLISTED, BLOCKED, WHITELISTED
data.QEVResponse object Optional QEV (Quick Email Verification) response payload