POST /groups

Метод позволяет отправить запрос на групповую проверку

Заголовки

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

Тело запроса

Название Тип Формат Обязательность Описание
externalId string ^\w{1,256}$ false Клиентский идентификатор проверки. Заполняется клиентом. Система контролирует уникальность идентификатора. Необходим для дедубликации запросов. По нему можно искать запросы
requests array CheckRequest true Параметры проверяемых объектов

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

Набор проверок для ФЛ определяется автоматически на основании введенных пользователем данных

Обязательные поля для выполнения проверок:

  • Проверка исполнительных производств в ФССП: ФИО и дата рождения
  • Проверка судебных дел физического лица: ФИО
  • Проверка на наличие процедуры банкротства: ФИО и дата рождения или ИНН
  • Проверка по спискам террористов/экстремистов/распространители массового оружия: ФИО
  • Проверка на наличие коммерческой деятельности: ИНН
  • Проверка арбитражных дел: ФИО и дата рождения или ИНН
  • Проверка паспорта: ФИО, дата рождения и реквизиты паспорта (серия, номер, дата выдачи, код подразделения)
  • Проверка СНИЛС: ФИО, дата рождения и СНИЛС

Пример

  POST /realty/assessment/v1/groups
  Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
  Content-Type: application/json
{
  "externalId": "4f8e9e60-74f9-4e00-9fae-abf021ea0314",
  "requests": [
    {
      "subject": {
          "subjectId": "3f813a2f-958b-499b-90c7-a038d98955c0"
      }
    },
    {
      "estate": {
         "cadastralNumber": "54:23:121746:22"
      }
    } 
  ]
}

Ответы

201

Тело ответа

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

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

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

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

  HTTP 201
  Content-Type: Application/json
{
  "groupId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
  "externalId": "4f8e9e60-74f9-4e00-9fae-abf021ea0314",
  "createdAt": "2011-01-01T15:03:01.012345Z",
  "progress": {
    "processed": 0,
    "total": 10
  },
  "objects": [
    {
      "request": {
        "subject": {
          "subjectId": "3f813a2f-958b-499b-90c7-a038d98955c0"
        }
      },
      "checks": [
        {
          "checkId": "a0a3cae0-ba58-11ec-bf84-0800200c9a66",
          "corelationId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
          "checkType": "Fssp",
          "checkState": "Processing",
          "creationDate": "2011-01-01T15:03:01.012345Z",
          "fssp": {
            "subjectId": "3f813a2f-958b-499b-90c7-a038d98955c0"
          }
        },
        {
          "checkId": "c6bb8830-ba58-11ec-bf84-0800200c9a66",
          "corelationId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
          "checkType": "Courts",
          "checkState": "Processing",
          "creationDate": "2011-01-01T15:03:01.012345Z",
          "courts": {
            "subjectId": "3f813a2f-958b-499b-90c7-a038d98955c0"
          }
        },
        ...
      ]
    },
    {
      "request": {
        "estate": {
          "cadastralNumber": "54:23:121746:22"
        }
      },
      "checks": [
        {
          "checkId": "e289c1d0-ba58-11ec-bf84-0800200c9a66",
          "corelationId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
          "checkType": "Fssp",
          "checkState": "Processing",
          "creationDate": "2011-01-01T15:03:01.012345Z",
          "realEstateInfo": {
            "cadastralNumber": "54:23:121746:22"
          }
        },
        {
          "checkId": "e86b7e90-ba58-11ec-bf84-0800200c9a66",
          "corelationId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
          "checkType": "Courts",
          "checkState": "Processing",
          "creationDate": "2011-01-01T15:03:01.012345Z",
          "realEstateOwnership": {
            "cadastralNumber": "54:23:121746:22"
          }
        },
        ...
      ]
    }
  ]
}

400

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

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

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

  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 указан тип контента, который не поддерживается для данного метода