POST /subjects

Метод позволяет сохранить данные физического или юридического лица, которые необходимы для его проверки.

Заголовки

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

Тело запроса

Название Тип Формат Обязательность Описание
externalId string ^\w{1,256}$ false Клиентский идентификатор субъекта. Заполняется клиентом. Сервис производит проверку на его уникальность.
person object Person false Описание персональных данных физического лица
organization object Organization false Описание реквизитов юридического лица

В запросе должен содержаться один из объектов person или organization

Пример

  1. Создание физического лица
  POST /realty/assessment/v1/subjects
  Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
  Content-Type: application/json
{
  "externalId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
  "person": {
    "name": "Анастасия",
    "surname": "Тарасова",
    "patronymic": "Константиновна",
    "birthDate": "1996-12-11"
  }
}
  1. Создание юридического лица
  POST /realty/assessment/v1/subjects
  Authorization: ReestroAuth apiKey=1269f58a-3d40-42e1-91ad-a4251566419c&portal.orgid=1269f58a-3d40-42e1-91ad-a4251566419c
  Content-Type: application/json
{
  "externalId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
  "organization": {
    "ogrn": "1027700132195"
  }
}

Ответы

201

Субъект успешно создан. Тело ответа будет содержать описание созданного субъекта Subject.

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

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

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

  HTTP 201
  Content-Type: Application/json
{
  "subjectId": "df1a5d92-7ec5-436c-be37-fc831f1715e3",
  "externalId": "7720902d-b025-4d9b-92a1-288a61e09b9d",
  "person": {
    "name": "Анастасия",
    "surname": "Тарасова",
    "patronymic": "Константиновна",
    "dateBirth": "1996-12-11"
  }
}

400

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

Код ошибки Описание
AbsenceOfRequiredField Не указано одно из обязательных полей
WrongFieldValue Значение поля не соответствует требуемому формату. Поле, формат которого не соответствует, указано в описании ошибки в message
DuplicatedExternalId Указанный в запросе внешний идентификатор уже был использован ранее
WrongSnils Указанный СНИЛС субъекта не прошел проверу на хэш сумму
WrongInn Указанный ИНН субъекта не прошел проверку
DissolvedOrganization Организация ликвидирована
WrongOrganization По указанным реквизитам организация не найдена

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

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

401

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

403

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

415

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