Phone metadata

The phone verification service returns useful information about each phone number.

Name	Type	Example	Description
success	Boolean	true	Returns true if the service ran successfully*
is_verified	Boolean	true	The number is valid and verified
not_verified_reason	String	The phone number format is incorrect	A short description of why is_verified is false
not_verified_code	String	FORMAT_INVALID	Error code if is_verified is false

*The success response only indicates if the verification process ran all checks without issues regardless of if the phone number is valid or not.

Collection phone metadata using the widget events

The widget can be configured to collect metadata from the Phone Verification API response and populate this into fields of your form (hidden or visible to the user). The widget returns two events that can be used for this purpose.

View this code example demonstrating the use of the widget events.