Phone Verification API

The Phone Verification API verifies a supplied number through a process which involves syntax and range checks prior to a network check for a connection status.

Endpoint

Global

https://api.addressfinder.io/api/phone/v1/verification

Parameters

Parameter	Default	Description
`key`		Your unique licence key (find on Portal credentials) Required string
`secret`		Your unique secret key (find on Portal credentials). This required when calling API endpoints without a referer. Optional string
`format`	`json`	The required format of the response. Optional string
`phone_number`		The phone number to be verified. Required string
`domain`		Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. Optional string
`default_country_code`		The iso2 country code to be used by default when the phone number does not include a country calling code. Required string
`mobile_only`		Require that the supplied number is a mobile phone. Optional boolean
`timeout`		Maximum wait time permitted when verifying the number. If exceeded, will return a status of indeterminate. Optional number
`allowed_country_codes`		Require that the supplied phone number is registered in one of these supplied countries (comma separated using iso2 codes). Optional string

Responses

200 OK

Name	Type	Description	Example
`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.	false
`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 whitespace and punctuation.	(02) 8503 8000
`raw_international`	string	The international phone number in E.164 format.	61285038000
`formatted_international`	string	The formatted international phone number including country-specific whitespace.	+61 2 8503 8000
`not_verified_code`	string	A code indicating why the number did not verify.	LINE_DISCONNECTED
`not_verified_reason`	string	If the number did not verify, this will contain a short description of the failure reason.	Phone number is not connected
`success`	boolean	Indicates if the request was successful or not	true

400 Bad request

Name	Type	Description	Example
`completions`	array	An empty array will be returned due to the error	-
`error_code`	string	A unique numerical value identifying the error that occured	1004
`message`	string	An informative message describing the error that occured	Secret not provided
`success`	boolean	Indicates if the request was successful or not	false

See API Error Reference for details.