Verify (OTP check)

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

Endpoint: <ApiUrl/>/api/verify.php

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

---

Створення коду (verify/create)

Створює код верифікації та надсилає його за SMS або Email. Запит приймається у чергу для обробки; у відповідь відразу повертаються success та request_id.

Метод: 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 Результат прийому запиту

request_idstring Ідентифікатор запиту

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

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

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

---

Перевірка коду (verify)

Запит перевіряє введений користувачем код та повертає статус верифікації.

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

authstringrequired API ключ, який можна отримати в особистому кабінеті

commandstringrequired Має бути 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 - перевищений ліміт розміру тіла запиту

---

Приклади виклику (curl)

verify/create (SMS):

curl -X POST https://portal.interconnect.solutions/api/verify.php \
  -H "Content-Type: application/json" \
  -d '{
    "auth": "your-api-key",
    "command": "verify/create",
    "phone": "441501234567",
    "type": "sms",
    "sender_name": "MyBrand",
    "lang": "en",
    "code_length": 6
  }'

verify/create (Email):

curl -X POST https://portal.interconnect.solutions/api/verify.php \
  -H "Content-Type: application/json" \
  -d '{
    "auth": "your-api-key",
    "command": "verify/create",
    "email": "user@example.com",
    "type": "email",
    "lang": "en",
    "code_length": 8
  }'

verify (перевірка коду), GET:

curl "https://portal.interconnect.solutions/api/verify.php?auth=your-api-key&command=verify&phone=441501234567&code=123456&verify_id=14fb5f3d-20be-41ef-b31a-b9f5e499bc7a"

verify (перевірка коду), POST:

curl -X POST https://portal.interconnect.solutions/api/verify.php \
  -H "Content-Type: application/json" \
  -d '{
    "auth": "your-api-key",
    "command": "verify",
    "phone": "441501234567",
    "code": "123456",
    "verify_id": "14fb5f3d-20be-41ef-b31a-b9f5e499bc7a"
  }'

---

Обмеження

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