Phone metadata

The phone verification service returns the following metadata with each verified phone number.

Name	Type	Description	Example
success	Boolean	Indicates if the request was successful.	true
is_verified	Boolean	Indicates if the phone number is verified.	true
line_type	String	The type of phone line the number is connected to.	mobile
line_status	String	The connection status of the supplied number.	connected
line_status_reason	String	Insights of the line_status result.	timeout
country_code	String	The two character ISO code of the country of the phone number.	AU
calling_code	String	The country calling code of the phone number.	61
raw_national	String	The national phone number without any whitespace or punctuation.	0285038000
formatted_national	String	The formatted national phone number including country-specific punctuation.	(02) 8503 8000
raw_international	String	The international phone number in E.164 format.	+61285038000
formatted_international	String	The formatted international phone number with country-specific formatting.	+61 2 8503 8000
not_verified_code	String	A code indicating why the number did not verify.	LINE_DISCONNECTED
not_verified_reason	String	A short description of the failure reason, if the number did not verify.	Phone number is not connected

*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 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 widget's ability to collect and store the returned metadata.