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	Description	Test Value
key	Your unique licence key (find on Portal credentials) Type: string required
secret	Your unique secret key from Portal Credentials. You can also pass your secret key into the Authorization header of the request. Only required for server-to-server calls. Type: string
format	The required format of the response. Default value: json Type: string	-- Select --jsonxml
phone_number	The phone number to be verified. Type: string required
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. Type: string
default_country_code	The iso2 country code to be used by default when the phone number does not include a country calling code. Type: string required
mobile_only	Require that the supplied number is a mobile phone. Type: boolean
timeout	Maximum wait time permitted when verifying the number. If exceeded, will return a status of indeterminate. Type: number
allowed_country_codes	Require that the supplied phone number is registered in one of these supplied countries (comma separated using iso2 codes). Type: string

Responses

200 OK

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

400 Bad request

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

See API Error Reference for details.