Skip to main content
У цьому документі буде представлено інструкцію з інтеграції API для розпізнавання та перевірки інформації про посвідчення особи, яка дозволяє перевіряти справжність та відповідність імені та номера посвідчення особи шляхом введення зображення посвідчення або імені та номера посвідчення. Цей інтерфейс використовується для перевірки справжності та відповідності імені та номера посвідчення, ви можете надати необхідну інформацію для перевірки, ввівши ім’я та номер посвідчення або передавши фотографію особи на посвідченні.

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

Щоб використовувати API для розпізнавання та перевірки інформації про посвідчення особи, спочатку перейдіть до консолі Ace Data Cloud, щоб отримати ваш API Token, зберігши його для подальшого використання. Якщо ви ще не увійшли в систему або не зареєстровані, вас автоматично перенаправлять на сторінку входу, щоб запросити реєстрацію та вхід, після чого ви будете автоматично повернені на цю сторінку. Один API Token дозволяє викликати всі послуги платформи, не потрібно окремо запитувати для кожної послуги. Перший запит на отримання токена надає безкоштовний ліміт, щоб ви могли безкоштовно протестувати; якщо ліміт вичерпано, ви можете поповнити загальний баланс в консолі.
📘 Повна документація: API для розпізнавання та перевірки інформації про посвідчення особи →

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

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

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

Натисніть кнопку «Спробувати», щоб провести тестування, як показано на малюнку, тут ми отримали такі результати:
Повернуті результати містять кілька полів, описаних нижче:
  • result, код результату перевірки, умови оплати такі:
    • Код результату з оплатою:
      • 0: Ім’я та номер посвідчення збігаються
      • -1: Ім’я та номер посвідчення не збігаються
    • Код результату без оплати:
      • -2: Неправильний номер посвідчення (недостатня довжина, неправильна контрольна цифра тощо)
      • -3: Неправильне ім’я (недостатня довжина, неправильний формат тощо)
      • -4: Аномалія в службі бази документів
      • -5: У базі документів немає запису про це посвідчення
      • -6: Система авторитетного порівняння оновлюється, будь ласка, спробуйте пізніше
      • -7: Кількість перевірок перевищує добовий ліміт.
  • description, результат перевірки імені та номера посвідчення.
  • name, інформація про ім’я на посвідченні, якщо зображення посвідчення не було завантажено, то поле буде порожнім.
  • id_card, інформація про номер посвідчення на посвідченні, якщо зображення посвідчення не було завантажено, то поле буде порожнім.
  • sex, інформація про стать на посвідченні, якщо зображення посвідчення не було завантажено, то поле буде порожнім.
  • nation, інформація про національність на посвідченні, якщо зображення посвідчення не було завантажено, то поле буде порожнім.
  • birth, інформація про дату народження на посвідченні, якщо зображення посвідчення не було завантажено, то поле буде порожнім.
  • address, інформація про адресу проживання на посвідченні, якщо зображення посвідчення не було завантажено, то поле буде порожнім.
Можна побачити, що інформація про ім’я та номер посвідчення на посвідченні є узгодженою та дійсною, а також використано технологію OCR для витягнення іншої інформації та її відображення. Крім того, якщо ви хочете згенерувати відповідний код інтеграції, ви можете просто скопіювати його, наприклад, код CURL виглядає так:
Код інтеграції на Python виглядає так:

Перевірка користувацької інформації

Ми також пропонуємо спосіб перевірки, не розкриваючи інформацію про зображення посвідчення, можна передати лише ім’я name та номер посвідчення id_card для перевірки справжності та відповідності імені та номера посвідчення, нижче наведено конкретну інформацію:

Після натискання кнопки виконання отримано такі результати:
Таким чином, з результату не буде розкрито іншу конфіденційну інформацію, це також дозволяє завершити перевірку справжності та відповідності імені та номера посвідчення.

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

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

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

Висновок

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