Phone verification extension contract reference

The phone verification extension enables real-time verification of a phone number entered by a recipient. Your extension app must perform validation itself or call an external service that verifies whether a phone number exists and is reachable.

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 Phone Number.

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

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.

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.

Action contracts

{
	"phoneNumber": "1234567890",
	"countryCode": "1"
}

{
   "verified": true,
   "responseCode": 'VERIFIED',
   "providerResponseCode": 'OK',
}

{
   "verified": false,
   "responseCode": 'NOT_VERIFIED',
   "providerResponseCode": 'FAILED_BECAUSE_REASONS',
}