> ## Documentation Index > Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt > Use this file to discover all available pages before exploring further. # Paid HLR lookup for up to 3 numbers > Run a paid HLR (Home Location Register) lookup on 1–3 E.164 phone numbers, returning per-number live status (`present`: `yes` / `no` / `na`), home-network operator (`network`), line `type`, `ported`, and `mcc`/`mnc` identification. Wallet balance is pre-checked for the whole batch before any provider call is made; only successfully-resolved rows are billed — upstream timeouts, auth failures, rate limiting, and server errors are never charged. Valid partial states (error codes 191 / 192 / 193, `present: "na"`) are returned as labelled results, not errors. The endpoint is feature-flagged per workspace (`feature_hlr_lookup`) and priced from the admin-configured `hlr` rate — an unpriced workspace is rejected before any provider call. Scoped on the `numbers` resource (`numbers:read` or `numbers:write`). ## OpenAPI ````yaml /openapi.yaml post /api/v1/numbers/hlr-lookup openapi: 3.1.0 info: title: Devotel CPaaS API description: Orbit by Devotel — Communications Platform as a Service API version: 1.0.0 contact: name: Devotel url: https://devotel.io email: support@devotel.io license: name: Proprietary servers: - url: https://api.orbit.devotel.io description: Production security: - Bearer: [] - ApiKey: [] tags: - name: Messages description: >- Send and manage messages across all channels (SMS, WhatsApp, RCS, Email, Viber, etc.) - name: Agents description: AI agent creation, configuration, and execution - name: Voice description: Voice calls, IVR, conferencing, and SIP trunking - name: Webhooks description: Webhook endpoint management and delivery logs - name: Numbers description: Phone number search, provisioning, and configuration - name: Contacts description: Contact management, segmentation, and lifecycle tracking - name: Campaigns description: Marketing campaign orchestration and analytics - name: Flows description: Automation flow builder and execution engine - name: Templates description: Message template management and approval workflows - name: Settings description: Organization, channel, and user preference settings - name: Verify description: OTP generation and verification across channels - name: Push description: Push notification delivery via FCM and APNs - name: Telegram description: >- Telegram bring-your-own-bot channel: connect a bot, verify a chat against the shared sandbox bot, and read unified channel state. Production sends go through the Messaging API. - name: USSD description: >- Menu-driven USSD for feature phones: define a menu tree, simulate session steps, and host the tenant-scoped aggregator callback. - name: Integrations description: Third-party service connections and OAuth management - name: Files description: >- Server-to-server media upload, listing, retrieval, and deletion (signed-URL backed) - name: Messaging Services description: >- Twilio MessagingService-parity containers bundling sender pool, opt-out list, inbound webhook, and sticky-sender/geomatch flags - name: Sender Pools description: >- Group sending numbers into pools with a selection strategy (sticky / round-robin / random) for outbound sends - name: Opt-Out Lists description: >- Per-list STOP / HELP / START keyword sets and auto-response copy (Twilio Advanced Opt-Out parity) - name: SMPP description: Tenant BYO-SMPP bind credentials and upstream termination carriers - name: Commerce description: >- Unified omnichannel conversational-commerce: cart/checkout state machine, cross-channel payment reconciliation, hosted pay-by-link, native WhatsApp checkout, and agentic-checkout payment mandates - name: Orby description: >- In-dashboard Orby operator assistant: streamed assistant turns, conversation threads, product knowledge-base search, and the tool-action approval gate. Available to signed-in operators only (dashboard session auth — API-key requests are rejected). - name: Developer description: Download API contracts and developer tooling artifacts paths: /api/v1/numbers/hlr-lookup: post: tags: - Numbers summary: Paid HLR lookup for up to 3 numbers description: >- Run a paid HLR (Home Location Register) lookup on 1–3 E.164 phone numbers, returning per-number live status (`present`: `yes` / `no` / `na`), home-network operator (`network`), line `type`, `ported`, and `mcc`/`mnc` identification. Wallet balance is pre-checked for the whole batch before any provider call is made; only successfully-resolved rows are billed — upstream timeouts, auth failures, rate limiting, and server errors are never charged. Valid partial states (error codes 191 / 192 / 193, `present: "na"`) are returned as labelled results, not errors. The endpoint is feature-flagged per workspace (`feature_hlr_lookup`) and priced from the admin-configured `hlr` rate — an unpriced workspace is rejected before any provider call. Scoped on the `numbers` resource (`numbers:read` or `numbers:write`). operationId: createNumbersHlrLookup parameters: - $ref: '#/components/parameters/Idempotency-Key' - $ref: '#/components/parameters/X-Test-Mode' requestBody: required: true content: application/json: schema: type: object additionalProperties: true description: The batch of E.164 numbers to look up (1–3). properties: numbers: type: array items: type: string description: E.164 phone number (e.g. `+14155550100`). description: >- The phone numbers to look up, 1–3 per request (capped to bound cost and latency). example: numbers: - '+14155550100' - '+442071838750' description: The batch of E.164 numbers to look up (1–3). responses: '200': description: >- Per-number HLR results with batch totals. `charged_count` / `charged_cents` report how many rows were billed to the wallet. content: application/json: schema: type: object additionalProperties: true description: >- Per-number HLR results with batch totals. `charged_count` / `charged_cents` report how many rows were billed to the wallet. properties: data: type: object additionalProperties: true properties: results: type: array description: One row per submitted number. items: type: object additionalProperties: true properties: number: type: string valid: type: boolean present: type: - 'null' - string description: Live status — `yes` | `no` | `na`. present_label: type: string description: >- Human-readable live status (`Live status unavailable for this network` for `na`). type: type: - 'null' - string network: type: - 'null' - string description: Home-network operator name. ported: type: - 'null' - boolean mcc: type: - 'null' - string mnc: type: - 'null' - string cached: type: boolean status: type: integer error_code: type: integer note: type: - 'null' - string description: >- Human-readable label for the valid partial states (191 / 192 / 193), else null. total: type: integer description: Total numbers processed. charged_count: type: integer description: How many rows were billed to the wallet. charged_cents: type: integer description: >- Total wallet debit in cents (0 when nothing was billed). meta: type: object properties: request_id: type: string description: >- Unique request identifier (also returned in X-Request-Id header) timestamp: type: string format: date-time description: ISO 8601 UTC timestamp of the response example: data: results: - number: '14155550100' valid: true present: 'yes' present_label: Live on network type: mobile network: Verizon ported: false mcc: '310' mnc: '004' cached: false status: 0 error_code: 0 note: null total: 1 charged_count: 1 charged_cents: 1 meta: request_id: req_01J9Z8ABCDEF timestamp: '2026-09-27T12:00:00.000Z' headers: Idempotency-Replay: $ref: '#/components/headers/Idempotency-Replay' '400': $ref: '#/components/responses/StandardError' '401': $ref: '#/components/responses/StandardError' '402': description: >- The request was rejected. See the error envelope for the machine-readable `code` and details. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: >- Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation '403': $ref: '#/components/responses/StandardError' '404': description: Not found — no resource matches the supplied identifier. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: >- Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation '422': description: >- Unprocessable entity — the request was well-formed but semantically invalid. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: >- Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation '429': $ref: '#/components/responses/RateLimitedResponse' '500': $ref: '#/components/responses/StandardError' '502': description: Upstream provider error. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: >- Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation '503': description: Service unavailable — retry with backoff. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: >- Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation components: parameters: Idempotency-Key: name: Idempotency-Key in: header required: false description: >- Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the `Idempotency-Replay: true` response header. schema: type: string minLength: 1 maxLength: 255 X-Test-Mode: name: X-Test-Mode in: header required: false description: >- Sandbox opt-in for Clerk-session-authenticated requests — see [Test mode explained](/guides/sandbox-test-mode) for the full credential-header matrix and worked samples. Set to `true` to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response `meta.test_mode: true`. **Ignored for live API keys (`dv_live_sk_*`)** — server-to-server clients must use a test-prefixed key (`dv_test_sk_*`) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header. schema: type: string enum: - 'true' - 'false' headers: Idempotency-Replay: description: >- Set to `true` when the response is a cached replay of a prior request with the same `Idempotency-Key`. Absent (or `false`) on first-write responses. schema: type: string responses: StandardError: description: >- Standard error envelope. `error.code` is machine-readable; see the [error reference](https://docs.orbit.devotel.io/reference/error-codes) for the catalogue. content: application/json: schema: type: object properties: error: type: object required: - code - message - status properties: code: type: string description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER) message: type: string description: Human-readable error description status: type: integer description: HTTP status code details: type: object additionalProperties: true description: Additional context about the error meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri description: Link to relevant error documentation RateLimitedResponse: description: >- Rate limit exceeded. Wait `error.retry_after` seconds (or read the `Retry-After` header) before retrying. Returned when the request would exceed the bucket identified by `X-RateLimit-Bucket`. headers: X-RateLimit-Limit: description: Total request quota for the current window. schema: type: integer minimum: 0 X-RateLimit-Remaining: description: Requests remaining in the current window. schema: type: integer minimum: 0 X-RateLimit-Reset: description: >- Absolute unix-epoch-seconds timestamp at which the current window resets. schema: type: integer minimum: 0 X-RateLimit-Bucket: description: >- Name of the rate-limit bucket the request was bound by (e.g. `auth-write`, `money`, `agent-invoke`, or `custom:/`). Stripe-style — lets clients see which named cap they hit. schema: type: string RateLimit-Limit: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Limit`. Some SDKs read only this form. schema: type: integer minimum: 0 RateLimit-Remaining: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror of `X-RateLimit-Remaining`. schema: type: integer minimum: 0 RateLimit-Reset: description: >- draft-ietf-httpapi-ratelimit-headers no-prefix mirror — delta seconds from now until the window resets (NOT epoch). schema: type: integer minimum: 0 Retry-After: description: >- RFC 7231 §7.1.3 — number of seconds the client should wait before retrying. schema: type: integer minimum: 1 content: application/json: schema: type: object properties: error: type: object required: - code - message - status - retry_after properties: code: type: string enum: - RATE_LIMITED description: >- Always `RATE_LIMITED` — the global request-limiter 429. Distinct from `RATE_LIMIT_EXCEEDED`, the live per-recipient/per-tenant/per-resource frequency-cap 429 (not retired). message: type: string status: type: integer enum: - 429 retry_after: type: integer minimum: 1 description: >- Seconds to wait before retrying. Mirrors `Retry-After` header. meta: type: object properties: request_id: type: string timestamp: type: string format: date-time docs_url: type: string format: uri securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT description: Dashboard JWT token from Clerk ApiKey: type: apiKey name: X-API-Key in: header description: Server-to-server API key (dv_live_sk_*) ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.