Перейти до основного вмісту
У цьому документі буде представлено інструкцію з інтеграції API перевірки особистої інформації та терміну дії, яка може бути використана для перевірки достовірності та узгодженості імені, номера посвідчення особи та терміну дії посвідчення.

​
Процес подачі заявки

Щоб використовувати API, спочатку потрібно перейти на відповідну сторінку API перевірки особистої інформації та терміну дії для подачі заявки на відповідну послугу. Після переходу на сторінку натисніть кнопку «Acquire», як показано на малюнку: Якщо ви ще не увійшли в систему або не зареєстровані, вас автоматично перенаправлять на сторінку входу, щоб запросити реєстрацію та вхід. Після входу або реєстрації ви будете автоматично повернені на поточну сторінку. При першій подачі заявки вам буде надано безкоштовний ліміт, який можна використовувати безкоштовно.

​
Основне використання

Спочатку ознайомтеся з основним способом використання, тобто введіть посилання на зображення посвідчення особи, щоб отримати оброблені результати перевірки. Спочатку потрібно просто передати поле name, після чого ми можемо заповнити відповідні дані на інтерфейсі, як показано на малюнку:

Ми бачимо, що тут ми налаштували заголовки запиту, включаючи:
  • accept: формат відповіді, який ви хочете отримати, тут вказано application/json, тобто формат JSON.
  • authorization: ключ для виклику API, після подачі заявки ви можете вибрати його зі списку.
Також налаштовано тіло запиту, яке включає:
  • name: ім’я.
  • id_card: номер посвідчення особи.
  • image_url: посилання на зображення обличчя, яке потрібно обробити.
  • validity_end: дата закінчення терміну дії посвідчення, формат: YYYYMMDD, для тривалого використання використовуйте «00000000»;
  • validity_begin: дата початку терміну дії посвідчення, формат: YYYYMMDD.
  • encryption: необов’язковий параметр шифрування для чутливих полів (якщо потрібно передати зашифровані дані).
Після вибору ви також можете побачити згенерований код праворуч, як показано на малюнку:

Натисніть кнопку «Try», щоб провести тестування, як показано на малюнку, і ви отримаєте наступний результат: 
{
  "result": "0",
  "description": "узгоджено"
}
Повернені результати містять кілька полів, описаних нижче:
  • result, код результату перевірки, умови оплати такі:
    • Код результату з оплатою:
      • 0: ім’я та номер посвідчення особи узгоджені
      • -1: ім’я та номер посвідчення особи не узгоджені
    • Код результату без оплати:
      • -2: незаконний номер посвідчення (довжина, контрольна цифра тощо неправильні)
      • -3: незаконне ім’я (довжина, формат тощо неправильні)
      • -4: аномалія в службі бази документів
      • -5: у базі документів немає запису про це посвідчення
      • -6: система авторитетного порівняння оновлюється, будь ласка, спробуйте пізніше
      • -7: кількість перевірок перевищує добовий ліміт.
  • description, результат перевірки імені та номера посвідчення.
Можна побачити, що ім’я, номер посвідчення та термін дії посвідчення мають достовірність та узгодженість. Крім того, якщо ви хочете згенерувати відповідний код інтеграції, ви можете просто скопіювати його, наприклад, код CURL виглядає так: 
curl -X POST 'https://api.acedata.cloud/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "id_card": "***",
  "validity_begin": "***",
  "validity_end": "***"
}'
Код інтеграції на Python виглядає так: 
import requests

url = "https://api.acedata.cloud/identity/idcard/check-2e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Обробка помилок

При виклику API, якщо виникає помилка, API поверне відповідний код помилки та інформацію. Наприклад:
  • 400 token_mismatched: Неправильний запит, можливо, через відсутні або недійсні параметри.
  • 400 api_not_implemented: Неправильний запит, можливо, через відсутні або недійсні параметри.
  • 401 invalid_token: Неавторизовано, недійсний або відсутній токен авторизації.
  • 429 too_many_requests: Занадто багато запитів, ви перевищили ліміт запитів.
  • 500 api_error: Внутрішня помилка сервера, щось пішло не так на сервері.

​
Приклад відповіді з помилкою

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не вдалося отримати"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Висновок

Завдяки цьому документу ви дізналися, як використовувати API перевірки особистої інформації та терміну дії для перевірки достовірності та узгодженості імені, номера посвідчення особи та терміну дії посвідчення. Сподіваємося, що цей документ допоможе вам краще інтегрувати та використовувати цей API. Якщо у вас є будь-які питання, будь ласка, звертайтеся до нашої команди технічної підтримки.