Phone Verification API

Build
Send
Response
Errors

The phone verification API is currently in a beta state. It can be used in production but may be adjusted and improved. Please let us know if you wish to use the service so that we can keep you up-to-date on any changes being made.

The Phone Verification API acts to verify a supplied number through a process which involves syntax and range checks prior to a network check for a connection status. The API returns the verified number, line type, connection status and other metadata.

Build the GET request URL

Use the form below to build your request URL from the available parameters. The URL string will be generated and can be sent to the API in order to provide insight into how the API works and the response it returns. Or, if you are using Postman for your investigation, development and testing, include the desired parameters and copy and paste the request URL below into Postman's GET request URL field.

Field Name	Value	Type	Description
key *		String	Your unique licence key (find on Portal credentials).
secret *		String	Your unique secret key (find on Portal credentials). Alternatively, you can pass your secret key into the Authorization header of the request as such: `Authorization: your-secret`. FAQ: Learn more about authenticating direct API calls in request headers
phone_number *		String	Phone number either in e164 format or domestic format (using the `default_country_code`). The number may be hand entered with additional spaces, brackets or hyphens.
format		String	The format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
domain		String	Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. Learn more.
default_country_code *		String	The iso2 country code (eg, NZ) to be used by default when the phone number does not include a country calling code
mobile_only		Boolean	Require that the supplied number is a mobile phone
timeout		Number	Maximum wait time permitted when verifying the number. If exceeded, will return a status of indeterminate.
allowed_country_codes		String	Require that the supplied phone number is registered in one of these supplied countries (comma separated using iso2 codes).

* Parameters marked with an asterisk are mandatory for this API call.

Request URL

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

      
        /* Click the button above to see a real API response here */
        {
          "success": true
        }

Response Specification

The API response will include all the attributes associated with the email address in the format requested in the API request.

Field 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 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

Errors

Below are the possible errors that can be returned by the API.