Выявление мошенничества с документами API

Введение в API

Технология искусственного интеллекта, специализирующаяся на обнаружении подделки изображений, стала проще, чем когда-либо, с использованием API ImgAuth.com. Всего несколькими строками кода вы можете внедрить эту технологию в свое приложение.

Параметры Запроса: Данные изображения в Base64 с последующим URL-кодированием. Максимум 10 MB. Короткая сторона не менее 512 px, длинная сторона не более 8192 px. Поддерживаются jpg/jpeg/png/bmp. Передайте image или url.
Параметры ответа: Справочник полей ответа API

Введение в API

финансовые команды проверяют счета и квитанции
HR проверяет сертификаты и сканы
страховые команды проверяют документы по claims

Аутентификация

Замените {your-api-domain} на endpoint API, указанный в панели аккаунта.

Аутентифицируйте запросы с помощью endpoint API вашего аккаунта и Bearer-токена. После покупки API-кредитов вы сможете увидеть endpoint и токен в панели аккаунта. Храните токен в секрете и никогда не публикуйте его в открытых репозиториях.

POSThttps://api.imgauth.com/v1/document-fraud-detection

Authorization: Bearer {YOUR_API_TOKEN}
Content-Type: application/json; charset=UTF-8

Параметры Запроса

Параметр	Тип	✓	Описание
image	string	✓	Данные изображения в Base64 с последующим URL-кодированием. Максимум 10 MB. Короткая сторона не менее 512 px, длинная сторона не более 8192 px. Поддерживаются jpg/jpeg/png/bmp. Передайте image или url.
detect_proportion	boolean	—	Нужно ли возвращать уровень уверенности в подделке. По умолчанию false. true возвращает значение, false — нет.
return_heatmap	boolean	—	Нужно ли возвращать heatmap подделки. По умолчанию false. true возвращает heatmap в Base64, false — нет.
location	boolean	—	Используйте эти примеры для создания и отладки вашей интеграции

Пример HTTP Запроса

{
  "image": "<BASE64_IMAGE_WITHOUT_PREFIX>",
  "detect_proportion": true,
  "return_heatmap": true,
  "location": true
}

Параметры ответа

Параметр	Тип	Описание
code	integer	Справочник кодов ответов API
request_id	string	Используйте эти примеры для создания и отладки вашей интеграции
data.detection_result	"fake" \| "real"	Результат проверки: "fake" означает, что подделка обнаружена, "real" — что подделка не обнаружена.
data.tampered_proportion	number \| null	Уровень уверенности в подделке, возвращается при detect_proportion = true.
data.heatmap	string \| null	Heatmap в Base64 для поддельных областей, возвращается при return_heatmap = true.
data.tampered_location	array	Массив координат подозрительных областей, возвращается когда probability больше или равна restrict_probability. Каждый элемент содержит left, top, width, height и probability.

Примеры Ответов

{
  "code": 0,
  "request_id": "req_01...",
  "data": {
    "detection_result": "fake",
    "tampered_proportion": 0.82,
    "heatmap": "<BASE64_HEATMAP>",
    "tampered_location": [
      { "left": 124, "top": 86, "width": 220, "height": 74, "probability": 0.91 }
    ]
  }
}

Коды Ошибок

400INVALID_REQUESTAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

401INVALID_API_KEYAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

402CREDITS_EXHAUSTEDAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

403API_KEY_INACTIVE / API_KEY_EXPIREDAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

413PAYLOAD_TOO_LARGEAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

415UNSUPPORTED_IMAGEAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

502UPSTREAM_ERRORAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

504UPSTREAM_TIMEOUTAPI messages показываются как сырые значения upstream-сервиса, чтобы полностью совпадать с ответами в продакшене.

Примеры Кода

curl -X POST "https://api.imgauth.com/v1/document-fraud-detection" \
  -H "Authorization: Bearer rh_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "image": "<BASE64_IMAGE_WITHOUT_PREFIX>",
  "detect_proportion": true,
  "return_heatmap": true,
  "location": true
}'