Phone Validation API

Schemas

SinglePhoneValidationRequest

phone_number

string · required

Phone number in E.164 format or national format

Example: +38766000111

region

string

ISO 3166-1 alpha-2 region code, required for non-E.164 numbers

Example: BA

locale

string

Locale for geocoder and carrier mapping

Example: en

BulkPhoneValidationRequest

object[] · minItems: 1 · required

locale

string

Default locale for all items

Example: en

PhoneValidationResult

valid

boolean

possible

boolean

phone_number

string

national_format

string

country_code

string

calling_code

string

number_type

string

object

time_zones

string[]

object

SinglePhoneValidationSuccessResponse

success

boolean · enum · required

Enum values:

object · required

BulkPhoneValidationAcceptedResponse

success

boolean · enum · required

Enum values:

object · required

BulkPhoneValidationJobResponse

success

boolean · enum · required

Enum values:

object · required

ErrorResponse

success

boolean · enum · required

Enum values:

object · required

ServiceHealthResponse

ok

boolean · required

Whether the service is globally operational

timestamp

string · date-time · required

UTC timestamp of the health check

Phone Validation API

Schemas

SinglePhoneValidationRequest

phone_number

string · required

Phone number in E.164 format or national format

Example: +38766000111

region

string

ISO 3166-1 alpha-2 region code, required for non-E.164 numbers

Example: BA

locale

string

Locale for geocoder and carrier mapping

Example: en

BulkPhoneValidationRequest

object[] · minItems: 1 · required

locale

string

Default locale for all items

Example: en

PhoneValidationResult

valid

boolean

possible

boolean

phone_number

string

national_format

string

country_code

string

calling_code

string

number_type

string

object

time_zones

string[]

object

SinglePhoneValidationSuccessResponse

success

boolean · enum · required

Enum values:

object · required

BulkPhoneValidationAcceptedResponse

success

boolean · enum · required

Enum values:

object · required

BulkPhoneValidationJobResponse

success

boolean · enum · required

Enum values:

object · required

ErrorResponse

success

boolean · enum · required

Enum values:

object · required

ServiceHealthResponse

ok

boolean · required

Whether the service is globally operational

timestamp

string · date-time · required

UTC timestamp of the health check