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

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

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

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

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

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

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

url = "https://api.acedata.cloud/identity/idcard/ocr"

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

payload = {
    "image_url": {image_url}
}

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

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

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

Після натискання кнопки виконання отримано наступний результат: 
{
    "address": "",
    "birth": "",
    "description": "Ім'я та номер посвідчення збігаються",
    "id_card": "Номер посвідчення",
    "name": "Ім'я на посвідченні",
    "nation": "",
    "result": "0",
    "sex": ""
 }
Таким чином, з результату не буде розкрито іншу приватну інформацію, це також дозволяє перевірити справжність та відповідність імені та номера посвідчення.

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

При виклику 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": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Висновок

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