Phone

Validate a phone number

Validate and enrich one phone number. GET requires api_key and phone_number in the query string. When country_code is omitted or set to none, send a full international number including its country calling code, preferably in E.164 form. A local or national number requires country_code. One credit is deducted from phoneapi_balance per successful validation.

get/phonevalidation

Request

  • Base URL: https://lookup.proweblook.com/api/v1
  • URL: https://lookup.proweblook.com/api/v1/phonevalidation
  • Auth: API key in query parameter api_key

Query parameters

phone_numberstring required

Phone number to validate. When country_code is omitted or set to none, send the complete international number, preferably in E.164 form, including the leading + and country calling code (for example, +14155552671). A local or national number requires country_code (for example, phone_number=9876543210 with country_code=IN). Percent-encode a leading + as %2B in a GET URL.

Example:+14155552671

Phone number to validate. URL-encode a leading + as %2B. A local/national value requires country_code.

country_codestring

Optional ISO 3166-1 alpha-2 country hint such as US, IN, or GB. This is a country identifier, not a numeric calling prefix such as +1 or +91. Omit it, or use the literal value none, only with a complete international phone_number.

Example:IN

Optional ISO country hint for a local or national phone number.

Response

Validation completed. INVALID is a completed validation result returned with HTTP 200, not an API error.

status'VALID_CONFIRMED' | 'INVALID' required

VALID_CONFIRMED for a confirmed number or INVALID when the supplied number could not be validated.

formatted_numberstring

Internationally formatted number returned by the API.

linetype'Mobile' | 'Fixed Line' | 'Fixed Line or Mobile' | 'Toll-Free' | 'Premium Rate' | 'Shared Cost' | 'VoIP' | 'Personal Number' | 'Pager' | 'Universal Access Number' | 'Voicemail' | 'Unknown'
carrierstring

Carrier/operator name. May be an empty string for landlines.

locationstring

Geographic description such as a city, region, or country.

countrycodenuminteger

Numeric country calling code.

countrycodestring

ISO 3166-1 alpha-2 country code.

countrynamestring

Full country name.

formatnationalstring

Phone number in national display format.

formatinternationalstring

Phone number in international display format.

timezonestring[]

Applicable IANA timezone identifiers.

ratelimit_remaininteger

Calls remaining in the current rate-limit window.

ratelimit_secondsinteger

Seconds until the current rate-limit window resets.

Example response

{
  "status": "VALID_CONFIRMED",
  "formatted_number": "+1 415 555 2671",
  "linetype": "Mobile",
  "carrier": "T-Mobile",
  "location": "California",
  "countrycodenum": 1,
  "countrycode": "US",
  "countryname": "United States",
  "formatnational": "(415) 555-2671",
  "formatinternational": "+1 415 555 2671",
  "timezone": [
    "America/Los_Angeles"
  ],
  "ratelimit_remain": 100,
  "ratelimit_seconds": 100
}

Changes

No recorded changes to this operation across all 1 revision of this API.