Skip to navigation

Email address verification extension contract reference

View as Markdown

This extension enables real-time verification of an email address. Your extension app must perform validation itself or call an external service that verifies the existence and deliverability of email addresses.

This extension verifies specific types of values. See Connected fields extension overview for information about an extension that can verify any type of value against an organization’s system of record.

You can include this extension when you register an extension app. If you register the extension app using a form, select the Data Verification extension in the form-based UI. Then select a verification type of Email.

Email address verification extension in form-based registration

If you register the extension app using an app manifest file, set the extensions.template value in your app manifest to Verify.Version2.Email.

This extension has one action. The action name you specify when you register an extension app depends on whether you register the app using a form or using an app manifest file. The app manifest file value listed here appears in the actions.template property.

Form-Based Action NameApp Manifest File Value
Verify EmailVerify.Version2.Email

You provide the details required for action execution when you register an extension app. See Update extension and action settings for information about defining actions using the form-based registration process. See Action schema for information about action properties in the app manifest file.

Required actions

This contract describes the parameters that Docusign will pass to the external email verification service as well as the parameters expected in the response. You specify the URL for the email verification service in the action definition in the form-based UI or in the extension app manifest.

Verify Email is the label for this action that appears when you register an extension app using a form. If you register your extension app using an app manifest file, the actions.template property value for this action is Verify.Version2.Email.

HTTP method

This action initiates a POST request to the external API service.

Request

{
"email": "francis@example.com"
}
PropertyTypeDescription
emailstringThe email address to verify.

Response

Successful case

{
"verified": true,
"responseCode": 'VERIFIED',
"providerResponseCode": 'OK',
}
Unsuccessful case
{
"verified": false,
"responseCode": 'NOT_VERIFIED',
"providerResponseCode": 'FAILED_BECAUSE_REASONS',
}
PropertyTypeOccurrenceDescription
verifiedbooleanRequiredWhether the email address was successfully verified.
responseCodestringRequiredContains a code that indicates the type of response. If verification failed, this code will contain an error code.
The following response codes are supported or phone verification:
  • ‘VERIFIED'
  • 'NOT_VERIFIED'
  • 'NETWORK_TYPE_MOBILE'
  • 'NETWORK_TYPE_LANDLINE'
  • 'NETWORK_TYPE_LANDLINE_PREMIUM'
  • 'NETWORK_TYPE_LANDLINE_TOLLFREE'
  • 'NETWORK_TYPE_VIRTUAL'
  • 'NETWORK_TYPE_UNKNOWN'
  • 'NETWORK_TYPE_PAGER'
  • 'NETWORK_TYPE_NULL'
  • 'INVALID_NETWORK'
  • 'CARRIER_UNAVAILABLE'
  • 'UNSUPPORTED_NETWORK_TYPE_MOBILE'
  • 'UNSUPPORTED_NETWORK_TYPE_LANDLINE'
  • 'UNSUPPORTED_NETWORK_TYPE_LANDLINE_PREMIUM'
  • 'UNSUPPORTED_NETWORK_TYPE_LANDLINE_TOLLFREE'
  • 'UNSUPPORTED_NETWORK_TYPE_VIRTUAL'
  • 'UNSUPPORTED_NETWORK_TYPE_UNKNOWN'
  • 'UNSUPPORTED_NETWORK_TYPE_PAGER'
  • 'UNSUPPORTED_NETWORK_TYPE_NULL'
  • 'INVALID_FORMAT'
  • 'INTERNAL_DECLINED'
  • 'SERVICE_ERROR’
providerResponseCodestringOptionalContains response code produced from the app indicating the reasons for success or failure.