Idtbeyond Active Documentation for /v1
Browse all Idtbeyond APIs★ Only Publicly Available OpenAPI DocumentPaymentsPayouts TransfersapiKey15 EndpointsREST
For Agents
Send international mobile airtime top-ups, validate phone numbers, and pull top-up history reports through IDT Beyond's prepaid mobile network.
Use for: I want to top up a prepaid mobile phone in another country, Check the available balance on my IDT Beyond account, Validate that a phone number is reachable for a top-up, List all top-up products available for a specific mobile operator
Not supported: Does not handle card payments, identity verification, or postpaid mobile billing — use for prepaid mobile airtime top-ups only.
Jentic publishes the only available OpenAPI specification for Active Documentation for /v1, keeping it validated and agent-ready. The IDT Beyond /v1 API exposes mobile airtime top-up and prepaid product distribution operations across IDT's global mobile operator network. Agents can check account balance, validate destination mobile numbers, list available top-up products and promotions, submit top-up transactions, and retrieve charges and topup history as JSON or CSV reports. The interface is RESTful over HTTPS with JSON payloads, scoped to airtime top-up workflows.
Install Jentic One Beta
Connect the Active Documentation for /v1 to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Active Documentation for /v1, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Active Documentation for /v1 API.
Submit a mobile airtime top-up to a destination phone number via /iatu/topups
Validate a destination mobile number before issuing a top-up via /iatu/number-validator
List available top-up products and current promotions across mobile operators
Retrieve account balance to confirm funds before submitting a top-up
Pull JSON or CSV reports of charges and topup transactions for reconciliation
Estimate the local-currency value delivered to the recipient before topping up
Use Cases
Patterns agents use Active Documentation for /v1 API for, with concrete tasks.
★ International Airtime Top-Up
Send prepaid mobile airtime to phone numbers worldwide through IDT Beyond's mobile operator network. The API validates the destination number, returns the available top-up products and the local-currency value delivered, then submits the transaction via /iatu/topups. Useful for remittance apps, gifting flows, and humanitarian airtime distribution where the sender needs predictable settlement.
Validate the number +447700900123, list available products, then submit a $10 USD top-up via POST /iatu/topups.
Top-Up Reconciliation Reporting
Pull historical top-up transactions and account charges as JSON or CSV to reconcile against internal ledgers. The /iatu/topups/reports/all and /iatu/charges/reports/all endpoints return paginated transaction history that finance teams or agents can ingest into accounting systems for daily settlement.
Fetch the CSV charges report for the last 30 days from /iatu/charges/reports/all.csv and summarise total spend by destination country.
AI Agent Airtime Distribution
An AI agent embedded in a customer support or rewards workflow can offer airtime as an instant gift or compensation. Through Jentic, the agent searches for the top-up operation, validates the recipient number, picks the right product, and submits the topup without the developer wiring auth or pagination by hand.
Use Jentic to call POST /iatu/topups for a 5 EUR top-up to a validated MSISDN and confirm success in the response.
Key Endpoints
15 endpoints — jentic publishes the only available openapi specification for active documentation for /v1, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/iatu/topups
Submit an airtime top-up to a mobile number
GET
/iatu/balance
Retrieve current account balance
GET
/iatu/number-validator
Validate a destination mobile number
GET
/iatu/products/reports/all
List available top-up products
GET
/iatu/products/promotions
List current promotional top-up offers
GET
/iatu/topups/reports/all
List historical topup transactions
GET
/iatu/charges/reports/all.csv
Export charges history as CSV
POST
/iatu/topups
Submit an airtime top-up to a mobile number
GET
/iatu/balance
Retrieve current account balance
GET
/iatu/number-validator
Validate a destination mobile number
GET
/iatu/products/reports/all
List available top-up products
GET
/iatu/products/promotions
List current promotional top-up offers
GET
/iatu/topups/reports/all
List historical topup transactions
GET
/iatu/charges/reports/all.csv
Export charges history as CSV
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
IDT Beyond API keys are stored encrypted in the Jentic vault. Agents receive scoped execution access only — the raw key never enters the agent's context window.
Intent-based discovery
Agents search by intent (e.g., 'top up a mobile phone') and Jentic returns the matching IDT Beyond operation with its input schema, so the agent calls the right endpoint without browsing the docs.
Time to first call
Direct IDT Beyond integration: 1-2 days for auth, product lookup, and reconciliation. Through Jentic: under 1 hour — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Complementary
Stripe API
Stripe collects payment from the end user before the topup is funded.
Use Stripe upstream to charge the customer's card, then call IDT Beyond to deliver the airtime.
FAQs
Specific to using Active Documentation for /v1 API through Jentic.
Why is there no official OpenAPI spec for Active Documentation for /v1?
IDT Beyond does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the IDT Beyond /v1 API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the IDT Beyond /v1 API use?
The IDT Beyond /v1 API uses an API key passed in request headers. Through Jentic, the key is held in the Jentic vault and injected at execution time so the agent never sees the raw secret.
Can I top up a mobile phone in another country with this API?
Yes. POST /iatu/topups submits an airtime top-up to a destination MSISDN; before calling it, use GET /iatu/number-validator to confirm the number is valid and GET /iatu/products/reports/all to pick the correct product for that operator.
How do I check my IDT Beyond account balance before submitting a topup?
Call GET /iatu/balance. The response returns the current account balance so an agent can confirm there are sufficient funds before posting to /iatu/topups.
What are the rate limits for the IDT Beyond /v1 API?
Rate limits are not declared in the OpenAPI spec; IDT Beyond enforces account-level transaction limits set in the partner agreement. Inspect 429 responses and back off if encountered.
How do I send a topup through Jentic?
Run pip install jentic, then use Jentic's search to find 'send a mobile top-up', load the schema for POST /iatu/topups, and execute with the destination MSISDN, product code, and amount.
GET STARTED