Skip to main content

Send Verification Email

This request sends a verification email to the specified email address.

post /verification/email

Sample​

A sample POST request to send a verification email:

curl -X POST \
'https://api.carrierx.com/core/v2/verification/email' \
-H 'Content-Type: application/json' \
--data-binary '{"to_address": "jsmith@carrierx.com"}' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response​

200 status code with a serialized copy of the Verification Email object:

{
    "base_url": "https://www.carrierx.com/confirmed",
    "email_template_sid": "3e9e8c56-e1ee-4dcf-9e2b-abbd101139ba",
    "partner_sid": null,
    "status": "sent_email",
    "to_address": "jsmith@carrierx.com"
}

Required Scopes​

To create a Verification Email object, the partner must have one of the following scopes enabled:

  • verification.manage
  • verification.create

Body Arguments​

JSON representation of the fields and values of the Verification Email object to be created.

To send a verification email, to_address or partner_sid must be provided. If partner_sid is provided, the verification email will be sent to the owner_email of that partner.

Refer to this table to view all fields that appear in the Verification Email object.