APIHub
Back to Explore

Active Documentation for /v1

Our active docs provide the ability to test out your account and to see the responses to your queries. The services are RESTful, and are accessed using standard HTTP methods over a secure HTTPS channel. Requests and responses are currently sent in JSON format, and have a base URL of /v1.

Telecom
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

47ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/iatu/balance

Account balance

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
GET

/iatu/charges/reports/all

List of account charges in JSON

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
  • date_from (query, required) — The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
  • date_to (query, required) — The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
GET

/iatu/charges/reports/all.csv

List of account charges in CSV

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
  • date_from (query, required) — The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
  • date_to (query, required) — The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
GET

/iatu/number-validator

Mobile number validation

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
  • country_code (query, required) — 2-digit code of the country in ISO 3166 format. 'BR'
  • mobile_number (query, required) — The mobile number you would like to validate. '5521983115555'
GET

/iatu/products/promotions

Current promotions

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
GET

/iatu/products/reports/all

Get a list of products in JSON format

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
GET

/iatu/products/reports/all.csv

Get a list of products in CSV format

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
GET

/iatu/products/reports/local-value

Get the estimated Local Value of a product

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
  • country_code (query, required) — 2-digit code of the country in ISO 3166 format. 'GT'
  • carrier_code (query, required) — Name of the mobile carrier. 'Claro'
  • amount (query, required) — This is the amount, in cents, of the product you are purchasing. '500' = $5.00
  • currency_code (query, required) — The currency code (ISO 4217) on the product you are querying. 'USD'
POST

/iatu/topups

Topup a mobile phone

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
POST

/iatu/topups/reports

Search topups transactions

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
GET

/iatu/topups/reports/all

List of account topups in JSON

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
  • date_from (query, required) — The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
  • date_to (query, required) — The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
GET

/iatu/topups/reports/all.csv

List of account topups in CSV

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
  • date_from (query, required) — The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
  • date_to (query, required) — The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
GET

/iatu/topups/reports/totals

Summary of account topups in JSON

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
  • date_from (query, required) — The beginning date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
  • date_to (query, required) — The ending date of the search IN YYYY-MM-DD format (America/New_York timezone). '2016-01-28'
POST

/iatu/topups/reverse

Reversal of a Topup

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use
GET

/status

Status check

  • x-idt-beyond-app-id (header, required) — Application ID you would like to use
  • x-idt-beyond-app-key (header, required) — Application KEY you would like to use

15 endpoints auto-detected

curl -X GET \
  "https://api.idtbeyond.com/v1/iatu/balance"

api.idtbeyond.com · HTTPS only