Adocs

Adocs

Публичное API для распознавания паспортов РФ

← Вернуться в кабинет

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

Все запросы к API требуют заголовка X-Api-Key. Ключ создаётся в личном кабинете и показывается только один раз.

Формат ключа: base64(key_id:secret)
Пример: MToxMjM0NTY3ODkwYWJjZGVm

📝 Распознавание паспорта

POST /v1/recognize

Отправляет изображение паспорта на распознавание. Списание средств происходит автоматически.

Заголовки

ЗаголовокОбязательныйОписание
X-Api-KeyДаВаш API-ключ
Idempotency-KeyНетУникальный ключ запроса (UUID). При повторной отправке в течение 24ч вернётся тот же результат без повторного списания.
Content-TypeДаmultipart/form-data

Тело запроса

Content-Type: multipart/form-data

file: <binary image data>  (JPEG, PNG, WebP, макс. 10 МБ)

Пример запроса (cURL)

curl -X POST https://api.adocs.ru/v1/recognize \
  -H "X-Api-Key: ВАШ_API_КЛЮЧ" \
  -H "Idempotency-Key: $(uuidgen)" \
  -F "file=@passport.jpg"

Успешный ответ (200 OK)

{
  "request_id": "req_1751234567890123456",
  "last_name": "Иванов",
  "first_name": "Иван",
  "middle_name": "Иванович",
  "birth_date": "15.03.1990",
  "series": "4515",
  "number": "123456",
  "issue_date": "20.05.2015",
  "issued_by": "ОТДЕЛОМ УФМС РОССИИ ПО Г. МОСКВЕ ПО РАЙОНУ ...",
  "division_code": "770-064",
  "registration_address": null
}

Описание полей ответа

ПолеТипОписание
request_idstringУникальный ID запроса
last_namestringФамилия
first_namestringИмя
middle_namestringОтчество
birth_datestringДата рождения (ДД.ММ.ГГГГ)
seriesstringСерия паспорта (4 цифры)
numberstringНомер паспорта (6 цифр)
issue_datestringДата выдачи (ДД.ММ.ГГГГ)
issued_bystringКем выдан
division_codestringКод подразделения (XXX-XXX)
registration_addressstring|nullАдрес регистрации (если распознан)

Ошибки

КодОписание
401 UnauthorizedОтсутствует или невалидный X-Api-Key
402 Payment RequiredНедостаточно средств на балансе
413 Payload Too LargeФайл больше 10 МБ
415 Unsupported Media TypeНеподдерживаемый формат файла (допустимы JPEG, PNG, WebP)
429 Too Many RequestsПревышен лимит 10 RPS на ключ

💰 Баланс и подписка

Ваши персональные данные аккаунта:

GET /v1/me

Возвращает текущий баланс и активную подписку.

Пример запроса

curl -X GET https://api.adocs.ru/v1/me \
  -H "X-Api-Key: ВАШ_API_КЛЮЧ"

Ответ

{
  "balance": {
    "account_id": 42,
    "real_balance_rub": 1500.00,
    "prepaid_balance_rub": 6000.00
  },
  "subscription": {
    "subscription_id": 7,
    "tariff_code": "pro",
    "tariff_name": "Pro",
    "status": "active",
    "expires_at": "2026-06-01T00:00:00Z"
  }
}

Ошибки

КодОписание
401 UnauthorizedОтсутствует или невалидный X-Api-Key
GET /v1/events

История операций (пополнения, списания, подписки).

Пример запроса

curl -X GET https://api.adocs.ru/v1/events \
  -H "X-Api-Key: ВАШ_API_КЛЮЧ"

Ответ

[{
  "id": 101,
  "type": "pay_as_you_go",
  "real_amount_rub": 7.00,
  "prepaid_amount_rub": 0,
  "created_at": "2026-05-20T14:32:00Z"
}]

Ошибки

КодОписание
401 UnauthorizedОтсутствует или невалидный X-Api-Key

📋 Коды ответов

200 OK
Успешное выполнение
401 Unauthorized
Отсутствует или невалидный X-Api-Key
402 Payment Required
Недостаточно средств на балансе
413 Payload Too Large
Файл больше 10 МБ
415 Unsupported Media Type
Неподдерживаемый формат файла
429 Too Many Requests
Превышен лимит 10 RPS на ключ

⚡ Quick Start

  1. Зарегистрируйтесь в личном кабинете
  2. Создайте API-ключ (раздел «Ключи доступа»)
  3. Пополните баланс через мок-платёж или ЮКассу
  4. Отправьте POST /v1/recognize с изображением паспорта
  5. Получите JSON с распознанными полями
Base URL: https://api.adocs.ru · Swagger UI · Личный кабинет