Documentation API

Method: test

This method is used to test the API connection. It verifies that your API key is valid and that the service is reachable. If everything is configured correctly, the API will return a successful response.

Request example

{
    "method": "test"
}

Successful response

{
  "error": 0,
  "message": "Yippee-ki-yay"
}

Response fields
error — error code (0 means the request was successful)
message — response message from the API

Method: info

The info method returns information about your account and the current subscription, including the number of API requests used.

Request example

{
    "method": "info"
}

Successful response

{
    "error": 0,
    "name": "John",
    "surname": "Smith",
    "email": "[email protected]",
    "subscription": "Growth",
    "count_request": 2349
}

Response fields
error — error code (0 means the request was successful)
name — account owner's first name
surname — account owner's last name
email — account email address
subscription — current subscription plan
count_request — number of API requests used in the current subscription period

Method: verify

The verify method checks a phone number and returns detailed validation information.

Phone numbers can be provided in any format. The API automatically handles characters such as (, ), -, + and spaces.

Request example

{
  "phone": "491609502065",
  "method": "verify"
}

Successful response

{
  "error": 0,
  "request_phone": "491609502065",
  "valid_phone": true,
  "type": "mobile",
  "format": {
    "local": "01609502065",
    "international": "+491609502065"
  },
  "country": {
    "code": "DE",
    "name": "Germany (Federal Republic of)",
    "prefix": "+49"
  },
  "requests": {
    "subscription": "Growth",
    "count": 2,
    "start": "2026-04-06 10:29:40",
    "finish": "2026-10-06 10:29:40",
    "limit": 9000
  }
}

Response fields
error — error code (0 means the request was successful)
request_phone — phone number sent in the request
valid_phone — validation result (true if the number is valid)
type — phone number type (e.g., mobile, landline, etc.)

Format object
local — phone number in local format
international — phone number in international format

Country object
code — ISO country code
name — country name
prefix — international dialing prefix

Requests object
Information about your current subscription usage.
subscription — active subscription plan
count — number of requests already used
start — start date of the subscription period
finish — end date of the subscription period
limit — maximum number of requests allowed in the subscription period