POST /checks

Метод позволяет отправить запрос на проверку данных.

Заголовки

Название Описание
Content-Type Тип контента: application/json
Authorization Заголовок авторизации

Тело запроса

Запрос должен содержать объект Check.

Название Тип Формат Обязательность Описание
correlationId string ^\w{1,256}$ false Идентификатор группы отправленных запросов. Заполняется клиентом. Используется для связи нескольких запросов. По нему можно искать запросы.
externalId string ^\w{1,256}$ false Клиентский идентификатор проверки. Заполняется клиентом. Система контролирует уникальность идентификатора. Необходим для дедубликации запросов. По нему можно искать запросы.
fssp object Fssp false Проверка исполнительных производств в ФССП
courts object Court false Проверка на наличие судов общей юрисдикции
arbitration object Arbitration false Проверка арбитражных дел
bankruptcy object Bankruptcy false Проверка на наличие процедуры банкротсва
rosfinmonitoring object Rosfinmonitoring false Проверка на наличие субъекта в списках Росфинмонитринга (террористы и экстремисты, распространители массового оружия)
passport object Passport false Проверка реквизитов паспорта по базе МВД
snils object Snils false Проверка СНИЛС в базе ПФР на соответствие ФИО и дате рождению
commercialActivity object CommercialActivity false Проверка на наличие коммерческой деятельности у физического лица
powerOfAttorney object PowerOfAttorney false Проверка доверенности на действительность
realEstateInfo object RealEstateInfo false Проверка базовых характеристик объекта недвижимости
realEstateOwnership object RealEstateOwnership false Проверка истории владения объекта недвижимости
error object Error false Описание ошибки, которая произошла во время получения проверки

В объекте должны быть описаны данные для проверки, которую необходимо совершить. В одном запросе может содержаться только одна проверка. Для группировки проверок используйте correlationId.

Пример

  POST /realty/assessment/v1/checks
  Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
  Content-Type: application/json
{
  "corelationId": "fc88aa01-c2f2-4498-bbb2-5c7218e69585",
  "externalId": "4f8e9e60-74f9-4e00-9fae-abf021ea0314",
  "fssp": {
    "subjectId": "3f813a2f-958b-499b-90c7-a038d98955c0",
    "regions": [
      "54",
      "77"
    ]
  }
}

Ответы

201

Проверка успешно создана. В теле ответа содержится описание проверки Check.

Заголовки ответа

Название Описание
Content-Type Тип контента: application/json

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

  HTTP 201
  Content-Type: Application/json
{
  "checkId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
  "corelationId": "fc88aa01-c2f2-4498-bbb2-5c7218e69585",
  "externalId": "4f8e9e60-74f9-4e00-9fae-abf021ea0314",
  "checkType": "Fssp",
  "checkState": "Processing",
  "creationDate": "2011-01-01T15:03:01.012345Z",
  "fssp": {
    "subjectId": "3f813a2f-958b-499b-90c7-a038d98955c0",
    "regions": [
      "54",
      "77"
    ]
  }
}

400

Ошибки валидации запроса. В теле ответа содержится описание ошибки Error. Для данного метода возможны следующие ошибки:

Код ошибки Описание
WrongFieldValue Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message
AbsenceOfRequiredField Отсутствует одно из обязательных полей
DuplicatedExternalId Указанный в запросе внешний идентификатор уже был использован ранее
UnexistentSubject Указанный идентификатор субъекта не существует
UnsupportedSubjectType Тип субъекта не указан

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

  HTTP 400
  Content-Type Application/json
  {
      "code": "validation",
      "message": "Failed to validate request",
      "target": "api",
      "errors":
      [
        {
          "code": "AbsenceOfRequiredField",
          "message": "SubjectId is required",
          "target": "AssessmentApi"
        }
      ]
  }

401

Ошибка авторизации: пользователь не авторизован

403

Ошибка аутентификации: пользователь не имеет доступа к ресурсам организации, которая указана в заголовке авторизации

415

В заголовке Content-Type указан тип контента, который не поддерживается для данного метода

429

Слишком много параллельных запросов (больше 10 запросов в секунду)