v1
latestOpenAPI 3.1.22026-08-062223.0 KBValidate a phone number
This is the Global Phone single request.
Note: A License Key and Phone Number are both required for this request.
Query parameters
This is a string value that serves as a unique identifier for this set of records. It is returned as sent.
Required. The License Key issued by Melissa.
Options - Pass in options you want to set for the request.
List options in the format OptionName:Parameter, with multiple options delimited with a ,. For example: OptionName:Parameter,OptionName:Parameter
- CallerID:< False | True > - Adds the CallerID to the queried phone, if we found it to be valid (US and Canada Only). Default is False.
- DefaultCallingCode:<Country-Calling-Code> - The sequence of digits found after the leading +. Blank by Default. This is used when the country could not be detected from the phone number or country input.
- EnableBatchSuggestion:< False | True > - (Batch Mode Only) Enables records to be corrected using the suggestions engine when there is exactly only 1 suggestion found. Default is False.
- PreferDialingCode:< False | True > - When there is a mismatch between a phone dialing code (the “+” prefix in a phone number) and country name this controls which is prioritized. Default is True.
- TimeToWait:< [1-30] > - Select how long (in seconds) that you would like our Cloud API to wait on a single request before it times out. Select a smaller number if time is of essence, or longer if you would prefer more accurate results. Default set to 2.
- VerifyPhone:< Express | Premium > - This sets the level of verification to be done on a phone check.
- Express - Quickly validates against database of known phone numbers. This is the default option.
- Premium - Validates against a database of known phone numbers. If a number was last real-time validated more than 180 days ago, or has not been real-time validated before, then a real-time check will be performed. Line Type Result Codes (Cell, Landline and VOIP) are available only available in Premium Mode and for US/CA only.
Required. The phone number to be verified.
The suspected country of the input phone number as the official country name or the ISO2 code.
The country from where the verification is being done as the official country name or the ISO2 code. If the Country of Origin differs from the Country, then the outputted phone number will be changed to a callable format from the country of origin.
Headers
Format of the response.
Format of the request.
Response
Global Phone Response