Phone Validation API
The Phone Validation API validates phone numbers and returns structured metadata about each number. Accept numbers in E.164 format or national format with an optional region code. Responses include validity, formatting, country, line type, carrier, geocoder data, and time zones.
Interactive reference, request/response schemas, and examples
Base URL: https://api.omaxtelecom.com/numbers/
What can you do?
| Capability | Endpoint | Description |
|---|---|---|
| Single validation | POST /phone-validation | Validate one phone number |
| Bulk validation | POST /phone-validation/bulk | Submit a batch validation job (async) |
| Job status | GET /phone-validation/bulk/{job_id} | Poll bulk job progress and results |
| Health | GET /phone-validation/health | Check service availability (no auth) |
Authentication
All endpoints except /phone-validation/health require OAuth 2.0 Client Credentials via OmaxTelecom ID:
Code
Obtain a token from the shared OmaxTelecom API auth endpoint. This is not under the Phone Validation base URL — see the Auth API reference:
Code
Get your client_id and client_secret from OmaxTelecom Console.
For M2M clients without an organization claim in the token, include:
Code
Billing
When price_per_validation is greater than zero for your organisation, each successful validation is charged via the Console Wallet API — including repeat validations for the same number.
| HTTP status | Error code | Meaning |
|---|---|---|
402 | INSUFFICIENT_BALANCE | Wallet balance too low |
403 | PHONE_VALIDATION_DISABLED | Phone validation not enabled for your organisation |
403 | BILLING_NOT_CONFIGURED | Billing is not configured |
403 | ORGANIZATION_NOT_FOUND | Organisation not registered |
422 | VALIDATION_ERROR | Invalid request body or phone number format |
Response envelope
Successful responses:
Code
Error responses:
Code
Validation result fields
| Field | Description |
|---|---|
valid | Whether the number is valid for the detected region |
possible | Whether the number could be valid with more digits |
phone_number | Normalized E.164 phone number |
national_format | Nationally formatted number |
country_code | ISO 3166-1 alpha-2 country code |
calling_code | International calling code |
number_type | Line type (e.g. MOBILE, FIXED_LINE) |
geocoder | Geographic description for the number |
time_zones | Associated time zones |
carrier | Carrier name when available |
Examples
Validate E.164 number
Code
Response 200 OK:
Code
Validate national number with region
Code
Returns the same normalized result as the E.164 example above.
Bulk validation
Code
Response 202 Accepted:
Code
Poll the job:
Code
Response 200 OK (processing):
Code
Health check
Code
Response 200 OK:
Code
Getting started
- Enable phone validation for your organisation in OmaxTelecom Console.
- Obtain an access token via OmaxTelecom ID using your
client_idandclient_secret. - Call
GET /phone-validation/healthto confirm the service is reachable. - Validate a single number with
POST /phone-validation. - Use bulk endpoints when you need to validate large lists asynchronously.
API Documentation
Complete API Reference
Explore all endpoints with interactive examples, schemas, and authentication details.
Need Help?
Contact [email protected] for integration support.