Version 1 Оновлено 2026-03-17

Документація API

Наш API швидкий та легкий для інтеграції — ви можете почати працювати менш ніж за 15 хвилин. Крім того, ви отримуєте 50 безкоштовних запитів щодня для початку роботи.

Основи

Всі запити до API повинні надсилатися методом POST. Базовий endpoint для всіх запитів:

https://numvalid.com/api/v1/[api_key]

Замініть [api_key] на ваш персональний API ключ. Всі параметри запиту повинні передаватися в тілі запиту у форматі JSON. Ваш API ключ можна отримати на панелі керування після реєстрації.

Тест

Метод: test

Цей метод використовується для перевірки підключення до API. Він перевіряє, чи ваш API ключ дійсний та чи сервіс доступний. Якщо все налаштовано правильно, API поверне успішну відповідь.

Приклад запиту

{
    "method": "test"
}

Успішна відповідь

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

Поля відповіді
error — код помилки (0 означає, що запит виконано успішно)
message — повідомлення відповіді від API

Інформація

Метод: info

Метод info повертає інформацію про ваш акаунт та поточну підписку, включаючи кількість використаних запитів API.

Приклад запиту

{
    "method": "info"
}

Успішна відповідь

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

Поля відповіді
error — код помилки (0 означає, що запит виконано успішно)
name — ім'я власника акаунта
surname — прізвище власника акаунта
email — email акаунта
subscription — поточний тарифний план
count_request — кількість запитів API, використаних у поточному періоді підписки

Верифікація

Метод: verify

Метод verify перевіряє номер телефону та повертає детальну інформацію про валідацію.

Номери телефонів можна передавати у будь-якому форматі. API автоматично обробляє символи такі як (, ), -, + та пробіли.

Приклад запиту

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

Успішна відповідь

{
  "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
  }
}

Поля відповіді
error — код помилки (0 означає, що запит виконано успішно)
request_phone — номер телефону, надісланий у запиті
valid_phone — результат валідації (true, якщо номер дійсний)
type — тип номера (наприклад, мобільний, стаціонарний тощо)

Об’єкт Формат
local — номер телефону у локальному форматі
international — номер телефону у міжнародному форматі

Об’єкт Країна
code — ISO код країни
name — назва країни
prefix — міжнародний телефонний префікс

Об’єкт Запити
Інформація про використання вашої поточної підписки.
subscription — активний тарифний план
count — кількість запитів, що вже використані
start — дата початку періоду підписки
finish — дата закінчення періоду підписки
limit — максимальна кількість запитів у періоді підписки

Питання щодо документації?

Є питання щодо документації API? Зв’яжіться з нами: