Verify (OTP)

API для створення та перевірки одноразових кодів верифікації (OTP) через SMS, Email та інші канали.

Запити POST відправляються із заголовком Content-Type: application/json. Перевірка коду (verify) підтримує також GET.

---

Створення коду — синхронний

Створює код верифікації та надсилає його через SMS або Email. Шлюз обробляє запит одразу та повертає verify_id.

URI: /api/verify.php

Метод: POST

Параметри запиту

authstringобов'язковий API-ключ з особистого кабінету

commandstringобов'язковий Має бути verify/create

phonestringобов'язковий* Номер телефону в будь-якому форматі (обов'язковий, якщо не вказано email)

emailstringобов'язковий* Email-адреса (обов'язкова, якщо не вказано phone)

typestringобов'язковий Тип верифікації: sms, hlr, rcs, email, viber

sender_namestring Підпис / бренд у SMS

langstring Мова повідомлення: uk, ru, en (за замовчуванням en)

code_lengthnumber Довжина коду (за замовчуванням 8, діапазон 1–10)

code_typestring Тип коду: numeric, alphabetic, alphanumeric, extended (за замовчуванням numeric)

service_idnumber ID сервісу верифікації

custom_idstring Користувацький ідентифікатор для зв'язку з вашою системою

hookstring URL webhook для сповіщень про статус верифікації

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

{
  "auth": "API_KEY",
  "command": "verify/create",
  "phone": "441501234567",
  "type": "sms",
  "sender_name": "MyBrand",
  "lang": "en",
  "code_length": 6,
  "code_type": "numeric",
  "service_id": 1,
  "custom_id": "abcdef1234567",
  "hook": "https://example.com/webhook"
}

Відповідь

successboolean Результат виконання запиту

verify_idstring ID верифікації (UUID)

Приклад відповіді:

{
  "success": true,
  "verify_id": "14fb5f3d-20be-41ef-b31a-b9f5e499bc7a"
}

Помилки HTTP: 400 (невірний формат/JSON), 401 (невірний auth), 413 (занадто велике тіло запиту).

---

Створення коду — асинхронний

Постановка створення коду в чергу для фонової обробки. Тіло запиту таке саме, як при синхронному створенні, але поле command необов'язкове (воркер автоматично встановлює verify/create).

URI: /v1/verify/create

Метод: POST

Content-Type: application/json

Приклад відповіді:

{
  "request_id": "cf-ray-1234567890-ABC",
  "success": true
}

verify_id у цій відповіді не повертається. Для оновлення статусу після обробки використовуйте URL з поля hook у запиті.

Коди помилок HTTP:

Code	Опис
400	Невірний JSON
401	Відсутній або невірний auth
405	Метод, відмінний від POST
413	Занадто велике тіло запиту
415	Відсутній або невірний Content-Type (має бути application/json)
503	Черга недоступна

---

Перевірка коду

URI: /api/verify.php

Перевіряє код, введений користувачем, і повертає статус верифікації (тільки синхронний API).

Параметри запиту

authstringобов'язковий API-ключ з особистого кабінету

commandstringобов'язковий Має бути verify

phonestringобов'язковий* Номер телефону (обов'язковий, якщо не вказано email)

emailstringобов'язковий* Email-адреса (обов'язкова, якщо не вказано phone)

codestringобов'язковий Код для перевірки

verify_idstring ID верифікації (UUID)

service_idnumber ID сервісу верифікації (якщо не вказано verify_id)

custom_idstring Користувацький ідентифікатор (якщо не вказано service_id і verify_id)

Приклад запиту (GET)

/api/verify.php?auth=API_KEY&command=verify&phone=380501234567&code=123456&verify_id=14fb5f3d-20be-41ef-b31a-b9f5e499bc7a

Приклад запиту (POST, JSON)

{
  "auth": "API_KEY",
  "command": "verify",
  "phone": "380501234567",
  "code": "123456",
  "verify_id": "14fb5f3d-20be-41ef-b31a-b9f5e499bc7a"
}

Відповідь

successboolean Результат запиту

verify_idstring ID верифікації

phonestring Номер телефону

typestring Тип каналу: sms, email, hlr, rcs, viber

statusstring Статус верифікації (див. нижче)

service_idnumber ID сервісу верифікації

Приклад успішної відповіді:

{
  "success": true,
  "verify_id": "14fb5f3d-20be-41ef-b31a-b9f5e499bc7a",
  "phone": "441501234567",
  "type": "sms",
  "status": "approved",
  "service_id": 1
}

Можливі значення status:

status	Опис
approved	Код вірний, верифікація успішна
pending	Код невірний, спроби ще залишились
expired	Код прострочений
blocked	Перевищено ліміт спроб

Коди помилок HTTP:

• 400 — невірний формат запиту або JSON
• 401 — відсутній або невірний auth
• 413 — занадто велике тіло запиту

---

Обмеження

• Час життя коду: за замовчуванням 300 секунд (5 хвилин), діапазон 60–3600 секунд.
• Максимальна кількість спроб: за замовчуванням 5.