API CodexAPI Codex
WebsiteDashboardGet API Key
  • Documentation
  • All APIs
  • Changelog
Resources
  • Docs Home
  • API Catalog
  • API Codex Website
Platform
  • Get a free API key
  • Dashboard
  • APIs & Pricing

© 2026 API Codex. All rights reserved.

Information
Other endpoints
    Validate & Format (query params)getValidate & Format (JSON body)post
Schemas
powered by Zudoku
Phone Number Validation & Formatting API
Phone Number Validation & Formatting API

Schemas


ValidResult

Parsed result for a number that could be interpreted.
input
​string · required

The original number string as received.

Example: (415) 555-2671
valid
​boolean · required

Whether the number is fully valid for its detected region.

Example: true
possible
​boolean · required

Whether the number has a plausible length and shape for its region.

Example: true
e164
​string

Canonical international E.164 form.

Example: +14155552671
national
​string

Number formatted the way locals write it.

Example: (415) 555-2671
international
​string

Internationally formatted display form.

Example: +1 415 555 2671
rfc3966
​string

RFC3966 tel: URI.

Example: tel:+14155552671
uri
​string

tel: URI for click-to-call links.

Example: tel:+14155552671
country
​string | null

Detected ISO 3166-1 alpha-2 country code, or null.

Example: US
country_calling_code
​string

International dialing prefix without the plus sign.

Example: 1
type
​string | null

Line type (MOBILE, FIXED_LINE, FIXED_LINE_OR_MOBILE, etc.) or null.

Example: FIXED_LINE_OR_MOBILE
is_mobile
​boolean

Convenience flag derived from the line type.

Example: false
is_fixed_line
​boolean

Convenience flag derived from the line type.

Example: false

InvalidResult

Result for a string that could not be parsed as a phone number.
input
​string · required

The original number string as received.

Example: abcd
valid
​boolean · required
possible
​boolean · required

Error

error
​string · required

Error message.

Example: Missing required parameter: number
detail
​string

Optional additional detail about the error.

On this page
  • ValidResult
  • InvalidResult
  • Error