Interactive Playground credentials

Enter your Console OAuth credentials to test API requests in the playground below. Select OmaxTelecom Client Credentials as the auth identity before sending.

Client IDClient Secret

Number Lookup API

Download schema

Quick Start

Get your client_id and client_secret from OmaxTelecom Console
Run Auth → Get Access Token to obtain a Bearer token
All other endpoints use the access_token in the Authorization header

Authentication (OAuth 2.0)

This API uses the OAuth 2.0 Client Credentials grant type (RFC 6749 §4.4).

Token endpoint:

Code
POST https://api.omaxtelecom.com/auth/token

Send Authorization: Bearer <access_token> on all endpoints except health.

For M2M clients without an organization claim, include X-Organization-Id: <organization_id>.

Partner API for carrier number lookup. Phone numbers must be in E.164 format (for example +38766000111). Version 1 supports carrier lookup only.

Billing

When price_per_lookup > 0, each lookup is charged via Console Wallet API, including repeat lookups for the same number.

Response envelope

Success: { "success": true, "data": { ... } }

Error: { "success": false, "error": { "code": "...", "message": "..." } }

Bulk processing

Bulk lookups are asynchronous. Create a job with POST /number-lookup/bulk, then poll GET /number-lookup/bulk/{job_id} until status is completed or failed.