# Account API

Use the Account API to keep track of your CheckMobi account — credit balance, subscription details, and usage across all products.

# Retrieve account details

This resource retrieves your account details, including your email, credit balance, subscription expiration date, and usage for the current billing period.

REQUEST
  • Resource: /my-account
  • Method: GET
  • Authentication: Authorization header
  • Success code: 200
RESPONSE
Property Description
email Registered account email address.
subscription Current subscription available object. More details below.
cli_validations The number of successfully validated numbers during the current billing period using Missed Call method.
sms_validations The number of SMS validation requests sent during the current billing period.
ivr_validations The number of IVR validation requests sent during the current billing period.
sms_api The number of SMS API requests sent during the current billing period.
voice_api The number of Voice API requests sent during the current billing period.
expiration_date UNIX Timestamp in seconds when the current subscription expires.
credit_balance The current credit balance in USD.
call_per_minute Indicates how many calls per minute the account can send.
sms_per_minute Indicates how many messages per minute the account can send.
max_concurrent_calls Indicates how many answered concurrent calls the account can have.
SUBSCRIPTION OBJECT
Property Description
id Subscription unique identifier. One of the following values: 0 => Trial Account, 1 => Startup, 2 => Growing Business, 3 => Big Business.
name Subscription name.
limit How many successful Missed Call validations the subscription can handle. 0 indicates no limit.
REQUEST
RESPONSE

# Utilities

A set of helper endpoints for working with phone numbers and CheckMobi's country coverage — check which validation methods are available for a number and their estimated cost before you use them, or pull the current list of supported countries and calling prefixes to keep your own data in sync.

# Check Number

This resource returns details about a phone number in E.164 format (opens new window) — country, carrier, and mobile status — together with the validation methods available for it and, where applicable, their estimated cost.

REQUEST
  • Resource: /checknumber
  • Method: POST
  • Authentication: Authorization header
  • Content-Type: application/json
  • Success code: 200
PARAMETERS
Property Type Required Description
number string ✓ The number that has to be checked in E.164 format (opens new window).
RESPONSE
Property Type Description
country_code string Country prefix from where the number belongs.
country_iso_code string The country code from where the number belongs in ISO 3166-1 alpha-2 format.
carrier string The name of the carrier from where the number belongs.
is_mobile bool Indicates if number is mobile or not.
e164_format string The number in E.164 format including + sign.
formatting string The number formatted in E.164 format.
validation_methods array Provides information about the validation methods available for a specific destination. For a cli validation, local_number is true when CheckMobi supports a local number for that region; otherwise the user needs to be able to call international numbers. For a reverse_cli validation (missed call), the min_rate, max_rate, and estimation_cost fields only apply if the user enters an incorrect number and the callee answers the call before CheckMobi hangs up — typically within 2-3 seconds. If the call isn't answered, no charge applies.
REQUEST
RESPONSE

# Get available countries

This resource retrieves a list of all supported countries, along with their calling codes and flag images.

REQUEST
  • Resource: /countries
  • Method: GET
  • Authentication: Authorization header
  • Success code: 200
RESPONSE

A list of items. Each item will have the following properties:

Property Type Description
iso2 string Country ISO code 2 digits.
name string Country name.
prefix string Country calling code.
flag_32 string URL to the flag location. Size 32x32 pixels.
flag_128 string URL to the flag location. Size 128x128 pixels.
REQUEST
RESPONSE

# Get available prefixes

This resource retrieves a list of all supported countries along with their calling prefixes.

REQUEST
  • Resource: /prefixes
  • Method: GET
  • Authentication: Authorization header
  • Success code: 200
RESPONSE

A list of items. Each item will have the following properties:

Property Type Description
iso2 string Country ISO code 2 digits.
name string Country name.
prefix integer Calling prefix for that country.
REQUEST
RESPONSE