Інструкція з інтеграції API для перевірки фотографій на посвідченні особи

​

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

📘 Повна документація: API для перевірки фотографій на посвідченні особи →

​

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

• accept: формат відповіді, який ви хочете отримати, тут вказано application/json, тобто формат JSON.
• authorization: ключ для виклику API, після запиту ви можете вибрати його зі списку.

• image_url: посилання на зображення посвідчення, яке потрібно обробити.
• config: необов’язковий параметр конфігурації, булеве поле, за замовчуванням всі значення false, підтримує copy_warn, border_check_warn, reshoot_warn, detect_ps_warn, temp_id_warn, quality (поріг 0-100).

{
  "sim": 99.76,
  "result": "Успіх",
  "description": "Успішно",
  "name": "Ім'я на посвідченні",
  "sex": "Стать на посвідченні",
  "nation": "Національність на посвідченні",
  "birth": "Дата народження на посвідченні",
  "address": "Адреса на посвідченні",
  "id_num": "Номер на посвідченні",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}

• sim, схожість, діапазон значень [0.00, 100.00]. Рекомендується вважати, що схожість більше або дорівнює 70 свідчить про те, що це одна і та ж особа, поріг можна налаштувати відповідно до конкретного сценарію (помилковий прохід при порозі 70 становить одну тисячу, при порозі 80 - одну десяту тисячі).
• result, код помилки бізнесу, у випадку успіху повертає Success, у випадку помилки дивіться нижче в списку кодів помилок у частині FailedOperation.
• description, результат перевірки імені та номера посвідчення.
• name, інформація про ім’я на посвідченні, якщо зображення посвідчення не було завантажено, то поле порожнє.
• sex, інформація про стать на посвідченні, якщо зображення посвідчення не було завантажено, то поле порожнє.
• nation, інформація про національність на посвідченні, якщо зображення посвідчення не було завантажено, то поле порожнє.
• birth, інформація про дату народження на посвідченні, якщо зображення посвідчення не було завантажено, то поле порожнє.
• address, інформація про адресу на посвідченні, якщо зображення посвідчення не було завантажено, то поле порожнє.
• id_num, інформація про номер на посвідченні, якщо зображення посвідчення не було завантажено, то поле порожнє.
• portrait, base64-код фотографії з обличчям на посвідченні, якщо вирізання зображення не вдалося, буде використано все зображення посвідчення для порівняння, і повернеться порожнє.
• warnings, інформація про попередження, коли в конфігурації налаштовано попередження, порівняння облич не буде, результат поверне помилку (FailedOperation.OcrWarningOccurred) і міститиме цю інформацію про попередження.
• quality, оцінка якості зображення, цей параметр має значення лише тоді, коли в конфігурації запиту налаштовано попередження про розмитість зображення, діапазон значень (0-100), наразі поріг за замовчуванням становить 50, нижче 50 спрацює попередження про розмитість.
• encryption, інформація про шифрування чутливих даних.

curl -X POST 'https://api.acedata.cloud/identity/idcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'

import requests

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

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)

​

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

• 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"
}

​

Висновок