Verification Email Object

The Verification Email object defines the parameters and status of a verification email sent through the CarrierX platform. It specifies the target address, the base URL used for the verification link, and the associated email template and partner identifiers.

Each verification email includes a unique token appended to the base_url, allowing recipients to confirm their email address upon clicking the link. The object also tracks the current verification status throughout its lifecycle.

Verification Email Object Attributes

This is the JSON response that gets returned when a request is successful.

Attribute	Data Type	Description
base_url create	string	URL to be added to the email before verification token. If not specified, the default is used.
email_template_sid create	string	The secure ID of the Email Template object on which this verification email is based.
partner_sid create	string	The secure ID of the partner associated with the verification email.
status read only	string	The status of the verification. Values accepted in this field are: created sent_email verified
to_address create	string	The email address to send the verification email.

Sample 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"
}