АПИ для поиска в ФССП
АПИ для поиска в ФССП позволяет искать исполнительные производства по ИНН организации, номеру производства, исполнительному документу, данным физического или юридического лица. Можно сохранять параметры поиска, повторно выполнять запросы, просматривать историю и выгружать результаты в Excel.
В веб-приложении этим возможностям соответствует страница /FsspServicePage — «Поиск в ФССП». Здесь можно выполнить самостоятельный поиск без предварительного добавления организации в мониторинг. Работа с уже накопленными результатами мониторинга описана отдельно: «АПИ для ФССП: мониторинг организаций».
Подключение и API KEY
Получите API KEY пользователя в разделе «Интеграция — API» системы СУДиДЕЛО. Инструкция: «Открытое API системы СУДиДЕЛО». Базовый адрес: https://api-sudodelo.torkndgov.ru. Схемы запросов и ответов доступны в Swagger, раздел FsspSearch.
Во всех методах ниже передавайте apiKey в строке запроса. Для POST с телом укажите Content-Type: application/json. Имена JSON-полей записываются в camelCase. Храните ключ на сервере интеграции и исключайте его из публичных ссылок и журналов.
Общая схема работы
- Выберите способ поиска и при необходимости получите справочники регионов и типов документов.
- Выполните разовый поиск и проверьте поле
errorв ответе. - Для повторных проверок сохраните параметры запроса.
- Выполните сохранённый запрос, получите идентификатор запуска и откройте его результаты.
- При необходимости скачайте результаты запуска в Excel.
1. Справочники регионов и типов документов
GET /api/FsspSearch/regions?apiKey=YOUR_API_KEY
GET /api/FsspSearch/document-types?apiKey=YOUR_API_KEY
Каждый метод возвращает JSON-массив элементов: value — строковый код для передачи в поисковый запрос, text — подпись для пользователя. Для regionId и idType используйте значения из справочников, а не отображаемые названия.
2. Разовый поиск
Следующие методы возвращают результат без создания сохранённого запроса и истории запусков. В каждом примере замените условные значения реальными поисковыми реквизитами и своим API KEY. Параметры numberPage и pageSize для этих методов не предусмотрены.
По ИНН юридического лица
GET /api/FsspSearch/organization?apiKey=YOUR_API_KEY&inn=ИНН_ОРГАНИЗАЦИИ
Передайте 10-значный ИНН организации. Пример curl:
curl --fail --get "https://api-sudodelo.torkndgov.ru/api/FsspSearch/organization" \
--data-urlencode "apiKey=YOUR_API_KEY" \
--data-urlencode "inn=ИНН_ОРГАНИЗАЦИИ"
Также доступен POST-вариант передачи ИНН в JSON:
POST /api/FsspSearch/inn?apiKey=YOUR_API_KEY
Content-Type: application/json
{"inn":"ИНН_ОРГАНИЗАЦИИ"}
В текущей реализации оба маршрута обращаются к поиску организации. Для поиска физического лица по персональным данным используйте метод individual, описанный ниже.
По номеру исполнительного производства
POST /api/FsspSearch/ip-number?apiKey=YOUR_API_KEY
Content-Type: application/json
{"ipNumber":"НОМЕР_ИСПОЛНИТЕЛЬНОГО_ПРОИЗВОДСТВА"}
ipNumber — номер ИП в формате источника, например 12345/26/77001-ИП. Это иллюстрация формата, а не запрос к конкретному производству.
По исполнительному документу
POST /api/FsspSearch/document?apiKey=YOUR_API_KEY
Content-Type: application/json
{
"regionId":"КОД_РЕГИОНА",
"idNumber":"НОМЕР_ДОКУМЕНТА",
"idType":"КОД_ТИПА_ДОКУМЕНТА",
"idIssuer":"НАИМЕНОВАНИЕ_ВЫДАВШЕГО_ОРГАНА"
}
idNumber обозначает номер исполнительного документа; regionId — территориальный орган; idType — тип документа; idIssuer — орган, выдавший документ. В модели API последние три поля допускают null; для точного поиска укажите известные реквизиты.
По физическому лицу
POST /api/FsspSearch/individual?apiKey=YOUR_API_KEY
Content-Type: application/json
{
"regionId":"КОД_РЕГИОНА",
"lastName":"ФАМИЛИЯ",
"firstName":"ИМЯ",
"patronymic":"ОТЧЕСТВО",
"birthDate":"ДД.ММ.ГГГГ"
}
lastName — фамилия; firstName — имя; patronymic — отчество; birthDate — дата рождения строкой в формате дд.мм.гггг. Регион, имя, отчество и дата рождения допускают null в модели запроса. Указывайте известные данные для уточнения совпадений.
По наименованию юридического лица
POST /api/FsspSearch/legal-entity?apiKey=YOUR_API_KEY
Content-Type: application/json
{
"regionId":"КОД_РЕГИОНА",
"companyName":"НАЗВАНИЕ_ОРГАНИЗАЦИИ",
"address":"АДРЕС_ОРГАНИЗАЦИИ"
}
companyName — наименование должника (не менее трёх символов); regionId и address уточняют поиск и допускают null в модели API.
3. Поля ответа разового поиска
Все методы разового поиска возвращают JSON-объект. Поля верхнего уровня обозначают:
inn— ИНН, если он присутствует в ответе источника;records— массив найденных записей;columnHeaders— заголовки колонок, если переданы источником;error— текст ошибки; проверяйте его даже при HTTP 200.
Каждый элемент records содержит строковые ячейки cell1–cell8. Их типовое назначение: должник, адрес, дата возбуждения, номер ИП, исполнительный документ, дата документа, номер документа, предмет исполнения. При отображении учитывайте columnHeaders и формат конкретного ответа источника.
Дополнительно доступны objectOfExecutiveDocuments (требования документа), objectExecution (предмет исполнения), amountPaid (сумма), departments (отдел приставов), addressDepartments (его адрес). Эти поля могут быть пустыми; суммы и даты передаются строками.
Непустое error означает ошибку поиска, а не отсутствие исполнительных производств. Пустой records без ошибки означает отсутствие найденных записей по заданным условиям; проверьте точность поисковых реквизитов.
4. Сохранить поисковый запрос
Поле name задаёт понятное пользователю название запроса, а целочисленное поле searchType выбирает один из пяти способов поиска. Ниже для каждого типа приведены назначение, параметры и пример вызова API сохранения запроса.
Все примеры используют POST /api/FsspSearch/saved-queries?apiKey=YOUR_API_KEY и JSON-тело. Команды curl записаны для Bash. Замените YOUR_API_KEY и значения-заполнители своими данными. Коды регионов и типов документов берите из справочников /api/FsspSearch/regions и /api/FsspSearch/document-types.
Успешное сохранение возвращает карточку с fsspSearchQueryId. Этот идентификатор используйте как {id} в методе выполнения. Само сохранение не запускает поиск; общий пример выполнения приведён после пяти типов.
4.1. По ИНН организации — searchType = 1
Используйте для повторной проверки юридического лица по 10-значному ИНН. Поле inn содержит ИНН организации. Сохранённый запрос выполняет тот же вид поиска, что GET /api/FsspSearch/organization.
Пример вызова API для сохранения запроса этого типа:
curl --fail --request POST "https://api-sudodelo.torkndgov.ru/api/FsspSearch/saved-queries?apiKey=YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"name": "Проверка организации по ИНН",
"searchType": 1,
"inn": "ИНН_ОРГАНИЗАЦИИ"
}'
4.2. По номеру исполнительного производства — searchType = 2
Используйте, если известен номер ИП. В поле ipNumber передайте полный номер в формате источника, например 12345/26/77001-ИП. Это иллюстрация формата. Разовый аналог — POST /api/FsspSearch/ip-number.
Пример вызова API для сохранения запроса этого типа:
curl --fail --request POST "https://api-sudodelo.torkndgov.ru/api/FsspSearch/saved-queries?apiKey=YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"name": "Проверка по номеру ИП",
"searchType": 2,
"ipNumber": "НОМЕР_ИСПОЛНИТЕЛЬНОГО_ПРОИЗВОДСТВА"
}'
4.3. По исполнительному документу — searchType = 3
Используйте для поиска по реквизитам исполнительного документа. idNumber — номер документа, docRegionId — код территориального органа из справочника регионов, idType — код типа документа из справочника, idIssuer — наименование выдавшего органа. Код региона, тип документа и выдавший орган допускают null в модели API. Разовый аналог — POST /api/FsspSearch/document; в нём регион передаётся в regionId.
Пример вызова API для сохранения запроса этого типа:
curl --fail --request POST "https://api-sudodelo.torkndgov.ru/api/FsspSearch/saved-queries?apiKey=YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"name": "Проверка по исполнительному документу",
"searchType": 3,
"docRegionId": "КОД_РЕГИОНА",
"idNumber": "НОМЕР_ДОКУМЕНТА",
"idType": "КОД_ТИПА_ДОКУМЕНТА",
"idIssuer": "НАИМЕНОВАНИЕ_ВЫДАВШЕГО_ОРГАНА"
}'
4.4. По физическому лицу — searchType = 4
Используйте для поиска по данным гражданина. lastName — фамилия, firstName — имя, patronymic — отчество, birthDate — дата рождения в формате дд.мм.гггг, indRegionId — код региона. Укажите известные данные для уточнения совпадений; регион, имя, отчество и дата рождения допускают null в модели API. Разовый аналог — POST /api/FsspSearch/individual, где регион передаётся в regionId.
Пример вызова API для сохранения запроса этого типа:
curl --fail --request POST "https://api-sudodelo.torkndgov.ru/api/FsspSearch/saved-queries?apiKey=YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"name": "Проверка физического лица",
"searchType": 4,
"indRegionId": "КОД_РЕГИОНА",
"lastName": "ФАМИЛИЯ",
"firstName": "ИМЯ",
"patronymic": "ОТЧЕСТВО",
"birthDate": "ДД.ММ.ГГГГ"
}'
4.5. По наименованию юридического лица — searchType = 5
Используйте для поиска организации по названию. companyName — наименование предприятия-должника (не менее трёх символов), legRegionId — код территориального органа, address — адрес для уточнения поиска. Регион и адрес допускают null в модели API. Разовый аналог — POST /api/FsspSearch/legal-entity, где регион называется regionId.
Пример вызова API для сохранения запроса этого типа:
curl --fail --request POST "https://api-sudodelo.torkndgov.ru/api/FsspSearch/saved-queries?apiKey=YOUR_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"name": "Проверка организации по названию",
"searchType": 5,
"legRegionId": "КОД_РЕГИОНА",
"companyName": "НАЗВАНИЕ_ОРГАНИЗАЦИИ",
"address": "АДРЕС_ОРГАНИЗАЦИИ"
}'
Заполняйте поля, соответствующие выбранному типу. Для сохранённых запросов регион называется docRegionId, indRegionId или legRegionId, а для разовых — regionId. Значение searchType должно быть от 1 до 5.
Повторный вызов создания может сохранить ещё один запрос. Для изменения существующего используйте POST /api/FsspSearch/saved-queries/{id}/update с полным набором нужных параметров.
5. Выполнить сохранённый запрос
POST /api/FsspSearch/saved-queries/{id}/execute?apiKey=YOUR_API_KEY
Для любого из пяти типов после сохранения выполните запрос следующей командой. Замените 12345 на полученный fsspSearchQueryId:
curl --fail --request POST "https://api-sudodelo.torkndgov.ru/api/FsspSearch/saved-queries/12345/execute?apiKey=YOUR_API_KEY"
Тело не требуется. Метод выполняет поиск и сохраняет запуск с результатами. Ответ содержит поля:
fsspSearchResultRunId— идентификатор запуска, используемый далее как{runId};runAt— время запуска;hasError— признак ошибки;error— описание ошибки;recordCount— количество записей результата.
Идентификатор запроса и идентификатор запуска — разные значения. Каждый повторный вызов execute создаёт новый запуск. Запуск может быть сохранён с ошибкой и нулевым количеством записей, поэтому проверяйте hasError и error.
6. Просмотреть запросы, историю и результаты
GET /api/FsspSearch/saved-queries?apiKey=YOUR_API_KEY&numberPage=1&pageSize=100
GET /api/FsspSearch/saved-queries/{id}?apiKey=YOUR_API_KEY
GET /api/FsspSearch/saved-queries/{id}/runs?apiKey=YOUR_API_KEY&numberPage=1&pageSize=100
GET /api/FsspSearch/runs/{runId}?apiKey=YOUR_API_KEY
Список запросов можно уточнить параметрами searchType и nameSearch (поиск по части названия). Сохранённые запросы и история доступны в рамках организации владельца API KEY.
Списки запросов и запусков возвращают поля numberPage, pageSize, returnedCount, totalCount, items. Номер страницы начинается с 1; размер по умолчанию — 100, максимум — 1000. Для обхода увеличивайте numberPage, пока не получите все записи или пустую страницу.
Карточка запроса содержит его параметры, systemInsDt и последние запуски recentRuns. Для полной истории используйте маршрут saved-queries/{id}/runs.
Детали запуска возвращают fsspSearchResultRunId, fsspSearchQueryId, runAt, error, recordCount и records. В записях находятся fsspSearchResultRecordId, rowIndex, ячейки cell1–cell8 и cellsJson. Параметров пагинации у деталей одного запуска нет.
cellsJson — строка с JSON дополнительных полей. Разбирайте её отдельно от внешнего JSON-ответа. В текущей реализации внутри строки используются имена ObjectOfExecutiveDocuments, ObjectExecution, AmountPaid, Departments, AddressDepartments с заглавной первой буквой. Формат сохранённой записи отличается от ответа разового поиска.
7. Выгрузить результаты запуска в Excel
GET /api/FsspSearch/runs/{runId}/export?apiKey=YOUR_API_KEY
Успешный ответ — файл .xlsx с типом application/vnd.openxmlformats-officedocument.spreadsheetml.sheet. Сначала сохраните и выполните запрос, затем используйте полученный идентификатор запуска. Экспорт не выполняет новый поиск.
curl --fail --get "https://api-sudodelo.torkndgov.ru/api/FsspSearch/runs/12345/export" \
--data-urlencode "apiKey=YOUR_API_KEY" \
--output "fssp-search.xlsx"
Замените 12345 на fsspSearchResultRunId нужного запуска. Проверяйте HTTP-статус перед сохранением файла.
8. Изменить или удалить сохранённый запрос
POST /api/FsspSearch/saved-queries/{id}/update?apiKey=YOUR_API_KEY
POST /api/FsspSearch/saved-queries/{id}/delete?apiKey=YOUR_API_KEY
Для обновления передайте JSON той же структуры, что при создании. Передавайте все нужные параметры: обновление заменяет поля карточки, а пропущенные значения могут быть очищены. Удаление не требует тела и удаляет запрос вместе с его запусками и записями результатов. Успешный ответ удаления содержит id и deleted.
Также предусмотрены PUT /api/FsspSearch/saved-queries/{id} и DELETE /api/FsspSearch/saved-queries/{id}. Если прокси возвращает 405 для PUT/DELETE, используйте соответствующие POST-маршруты выше.
Ошибки и пустые ответы
200— HTTP-запрос обработан; для поиска и запусков дополнительно проверяйтеerror.400— ошибка параметров или привязки запроса; отсутствие обязательного query-параметраapiKeyтакже может дать 400.401— ошибка авторизации при доступе к защищённым операциям.404— сохранённый запрос или запуск не найден либо недоступен организации пользователя.405— HTTP-метод заблокирован или не поддерживается; для обновления и удаления используйте POST-варианты.
Сбой внешнего поиска может возвращаться внутри JSON при HTTP 200. Не подменяйте такой результат сообщением «производств нет». После неоднозначного сбоя выполнения сохранённого запроса проверьте историю запусков перед повторным вызовом, чтобы не создавать лишние запуски.
Смотрите также: Поиск в ФССП — работа в интерфейсе, АПИ для ФССП: мониторинг организаций и Открытое API системы СУДиДЕЛО.