Документация API¶

Контур.Реестро предназначен для онлайн взаимодействия с Росреестром в части регистрации прав и получения сведений.

Базовым уровнем интеграции с Реестро является его HTTP-API интерфейс.

адрес тестовой площадки: https://api.testkontur.ru

адрес боевой площадки: https://api.kontur.ru

Порядок работы с API¶

На изображении представлен алгоритм работы с API контур Реестро. Детальное описание методов представлено ниже.

ДО - документооборот

Подсказка

Если вы интегрируетесь для отправки запросов на получение сведений из ЕГРН (выписки) - вас интересуют только пункты «Авторизация», «Создание документооборота», «Актуализация состояния документооборота», «Обработка результатов».

Авторизация¶

Для работы с методами API необходима Авторизация.

В случае успешной авторизации пользователь может инициировать создание ДО, иначе необходимо авторизоваться заново.

Создание документооборота¶

Создание документооборота инициализирует процесс работы API Котнур.Реестро с документооборотом. Получение ДО API Котнур.Реестро не отождествляется с его отправкой в Росреестр.

После создания ДО API Контур.Реестро на основании полученных данных проверяет наличие требований (requirements) к данному ДО.

в случае их отсутствия ДО становится в очередь на отправку (HTTP возврата 200);

если они определены, то пользователю возвращаются Requirements к документообороту (HTTP возврата 201).

Подписание¶

Если после того, как вы создали ДО, он переходит в статус suspend -> ДО присвоено требование signature.

signature - требование (Requirements) подписать заявления участниками документооборота.

Примечание

Данное требование возникает до момента отправки ДО в Росреестр, в связи c необходимостью создания электронной версии заявления на регистрационное действие.

Для обработки данного требования необходимо осуществить Добавление подписи на каждый файл. Когда все документы будут подписаны, можно переходить к отправке ДО.

Отправка документооборота¶

После подписания заявлений участниками документооборота, необходимо использовать метод Отправка документооборота.

При получении запроса на отправку, он помещается в очередь проверки количества приложенных подписей для каждого документа и их верификации.

Предупреждение

В случае, если подписей недостаточно либо они не корректны, то будет сгенерировано событие, содержащее описание соответствующей ошибки.

Актуализация состояния документооборота¶

После создания документооборота, его состояние может измениться в связи с его обработкой API Реестро, затем Росреестром. Документообороту могут быть присвоены следующие статусы:

queued: ожидает отправки

sent: отправлен в Росреестр

suspended: требуются дополнительные действия

completed: исполнено

error: ошибка обработки

Для получения информации о событиях по документообороту необходимо периодически:

использовать метод Вычитывание новостей;

использовать метод Запрос описания документооборота.

Оплата пошлины¶

После успешной отправки ДО запрос поступает в обработку системой Росреестра. Начисление гос. пошлин для заявки происходит до инициализации обработки заявки сотрудником Росреестра.

Подсказка

Государственная пошлина начисляется за каждое регистрационное действие, которое предусматривает оплату каждому участнику документооборота индивидуально, учитывая льготы.

В случае, необходимости оплаты гос. пошлины, документооборот переходит в состояние suspend и формируется требование (Requirements) payment, содержащее УИН и сумму для оплаты.

Для продолжения работы с заявкой - необходимо оплатить все начисленные гос. пошлины для данной заявки. Информация об оплате государственной пошлины поступает в Росреестр автоматически в течении суток с момента оплаты.

Обработка результатов¶

После выполнения всех требований (если они были), необходимо продолжить процесс актуализации документооборота до получения статуса completed. Если документооборот в состоянии completed, то ответ будет содержать результат обработки документооборота (Result).

Чтобы получить результирующие документы, необходимо выполнить Запрос содержимого файла.

Примечание

Для каждого типа запроса результат будет содержать индивидуальный набор файлов.

Методы¶

Авторизация

Создание документооборота

Запрос описания документооборота

Запрос содержимого файла

Вычитывание новостей

Отправка документооборота

Добавление подписи

Загрузка контента

Получение контента

Получение контента

Добавить подпись на заявление (ссылка на файл)

Авторизация¶

Имя ресурса: /auth

HTTP метод: POST

В тело метода должен быть помещен json запроса, в котором содержатся

login: логин пользователя

password: пароль пользователя

accountId: идентификатор аккаунта.

POST /realty/v1/auth HTTP/1.0
Host: api.kontur.ru
Content-Type: application/json

{
"login": "email@yandex.ru",
"password": "123",
"accountId": "5ee84ac0-eb9a-4b42-b814-2f5f7c27c255"
}

В случае успешной авторизации:

API возвращает пользователю ответ: 200 OK, где в теле ответа указываются

userId: идентификатор пользователя

sessionId: идентификатор сессии.

HTTP/1.0 200 OK
Content-Type: application/json

{
"userId": "5ee84ac0-eb9a-4b42-b814-2f5f7c27c255",
"sessionId": "38f31d7246b148c8abcdf0e240a5e39d"
}

Возможные HTTP-коды возврата:

400 - если были введены неверные данные авторизации.
200 - в случае успешной авторизации

Создание документооборота¶

Имя ресурса: /docflows/{docflowType}

HTTP метод: POST

Создание документооборота осуществляется методом POST /docflows/{docflowType}.

docflowType – тип документооборота.

В тело метода должен быть помещен json запроса, в котором содержатся необходимые данные для инициализации документооборота. Json запроса для каждого типа документооборота состоит из

requestId - опциональный внешний идентификатор запроса клиента

options - параметры документооборота, которые определяются его типом POST /docflows/{docflowType}

Примечание

Описание параметров докумнтооборотов располагается на странице Типы документооборотов (ДО)

Пример содания документооборота

POST /realty/v1/docflows/{docflowType} HTTP/1.0
Host: api.kontur.ru
Content-Type: application/json
Content-Length: 123
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

{
  "requestId": "client-request-12345",
  "options": {
      //параметры  тип документооборота docflowType
  }
}

В случае успешного создания возвращается идентификатор docflowId, тип type`и состояние документооборота :doc:`docflowNewsItem.

При неудачном создании возвращается описание ошибки Error в формате json. Ошибка может возникнуть в случае, если был указан некорректный либо не полный набор данных (options).

Возможные HTTP-коды возврата:

200 - документооборот успешно создан и переходит в состояние «queued» ;
201 - документооборот успешно создан и переходит в состояние «suspended»;
400 - ошибка отправки;
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен;
501 - послан запрос в систему ЕГРОН (временно не поддерживается, текущий статус в процессе интеграции с системой).

Запрос описания документооборота¶

Имя ресурса: /docflow/{docflowId}

HTTP метод: GET

Запрос документооборота позволяет получить события по конкретному запрашиваемому документообороту. Осуществляется методом GET/docflows/{docflowId}:

docflowId: идентификатор документооборота.

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

GET /realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417 HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

При успешном поиске возвращается объект документооборота DocflowNewsItem в формате Json, где содержится метаинформация, параметры, указанные при генерации запроса (options).

DocflowNewsItem так же может содержать:

Result - результат запроса в Росреестр
Error - описание возникшей ошибки
Requirements - описание действий, которые нужно совершить для продолжения обработки запроса

Возможные HTTP-коды возврата:

200 - успешный поиск;
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен;
404 - отсутствие документооборота с указанным docflowId.

Запрос содержимого файла¶

Имя ресурса: /docflows/{docflowId}/files/{fileId}

HTTP метод: GET

Позволяет запросить содержимое каждого полученного файла. Осуществляется методом GET /docflows/{docflowId}/files/{fileId}, где:

docflowId: идентификатор документооборота;

fileId: идентификатор файла.

Пример:

GET /realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/d4959ec6-47e6-4b5a-99ae-9591ec1918ad HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

Возможные HTTP-коды возврата:

200 - содержимое файла;
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен;
404 - отсутствие документооборота с указанным docflowId или fileId.

Вычитывание новостей¶

Имя ресурса: /news

HTTP метод: GET

Вычитывание новостей позволяет получить события по документооборотам. Осуществляется методом GET /news?after={after}

after: токен (lastToken) последнего обработанного события.

Если токен не указан, то вычитывание начинается с текущего момента времени.

Алгоритм вычитывания новостей:

Отправляем запрос без параметра after. В ответе получаем идентификатор lastToken, с которого будем продолжать вычитывание.
Регистрируем один или несколько ДО на отправку.
Отправляем запрос, в котором параметр after принимает значение lastToken из предыдущего ответа (или идентификатор последней обработанной новости). Если появились новости с последнего запроса новостей, то ответ будет содержать описание новостей и новый идентификатор lastToken.
Если при обработке новостей случилась ошибка на стороне клиента, то клиент должен запомнить token последнего обработанного события и передать его в параметр запроса after, чтобы продолжить обработку новостей.

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

GET /realty/v1/news?after=3254tsadf5 HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

В ответ возвращается список новостей по документооборотом и токен для продолжения вычитывания. Новости содержат набор событий на изменение статуса документооборота. Событие на изменение статуса ДО может содержать одно из:

Result - результат запроса в Росреестр
Error - описание возникшей ошибки
Requirements - описание действий, которые нужно совершить для продолжения обработки запроса

Возможные HTTP-коды возврата:

200 - успешная отправка
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен.

Отправка документооборота¶

Имя ресурса: /docflow/{docflowId}

HTTP метод: POST

Инициировать отправку запроса в Росреестр можно методом: POST /docflows/{docflowId}.

docflowId: идентификатор документооборота

Пример:

POST /realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417 HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

В случае успешной отправки:

API возвращает пользователю ответ: 200 OK, где в теле ответа указываются:

requestId: опциональный внешний идентификатор запроса клиента

docflowId: идентификатор документооборота.

docflowType: тип документооборота.

state: статус документооборота.

Возможные HTTP-коды возврата:

200 - успешная отправка;
400 - ошибка при отправки документооборота - в теле ответа приходит описание ошибки Error;
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен.

Добавление подписи¶

Имя ресурса: /docflows/{docflowId}/files/{fileId}/signatures

HTTP метод: POST

Метод POST /docflows/{docflowId}/files/{fileId}/signatures позволяет добавить подпись на файл, где

docflowId: идентификатор документооборота

fileId: идентификатор файла

В теле запроса прилагаются бинарные данные подписи.

Пример:

POST /realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/ c5e78cb0-5234-4bae-9300-9b6d926afbe1/signature HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

Возможные HTTP-коды возврата:

204 - подпись добавлена;
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен;
404 - отсутствие документооборота с указанным docflowId или fileId.

Добавить подпись на заявление (ссылка на файл)¶

Имя ресурса: /docflows/{docflowId}/files/{fileId}/signatures/{signatureId}

HTTP метод: POST

Параметры:

docflowId: идентификатор документооборота

fileId: идентификатор файла заявления

signatureId: идентификатор файла подписи

Чтобы использовать данный метод для добавления подписи к заявлению, необходимо:

предварительно загрузить файл подписи методом Загрузка контента

в данном методе указать идентификатор ранее загруженной подписи.

Пример:

POST /realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/c5e78cb0-5234-4bae-9300-9b6d926afbe1/signature/65157a54-9f59-434f-9e19-9cac35b8094c HTTP/1.0
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

Возможные HTTP-коды возврата:

201 - подпись на заявление добавлена;
400 - ошибки валидации запроса;
401 - ошибка авторизации: пользователь не прикреплен к указанной организации;
403 - ошибка авторизации: пользователь не авторизован;
404 - docflowId или fileId или signatureId не найдены.

Загрузка контента¶

Имя ресурса: /contents

HTTP метод: POST

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

В теле запроса прилагаются бинарные данные контента.

Заголовки запроса

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

Допустимые значения Content-Type:

application/pdf;

application/xml;

application/x-pkcs7-signature;

application/pgp-signature.

Пример:

POST /realty/v1/contents
Content-Type: Application/pdf
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

В случае успешной загрузки контента в теле ответа содержится указатель на содержимое файла ContentPointer . В заголовке ответа Location находится Ссылка на контент

Возможные HTTP-коды возврата:

201 - контент успешно загружен;
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен.

Получение контента¶

Имя ресурса: /contents/{contentId}

HTTP метод: GET

Метод позволяет получить содержимое ранее загруженного контента методом: GET /contents/{contentId}, где:

contentId - Идентификатор файла

Пример:

GET /realty/v1/contents/d20bd506-6325-43e1-b2e4-105ec5d63417
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

Возможные HTTP-коды возврата:

200 - содержимое контента получено;
401 - при запросе методов API в случае отсутствия заголовка Authorization или при некорректном значении последнего;
403 - если для данного accountId доступ ограничен.
404 - указаный contentId не найден.

Типы документооборотов (ДО)¶

Тип документооборота соотвтествует виду регистрационного действия или государственной услуге, которая предоставляется в электронном виде через сервис прямого взаимодействия Росреестра.

На данный момент API поддерживает следующие типы документооборотов:

object_request - Запрос выписки из ЕГРП

equity_agreement_registration_request - Регистрация договора долевого участия в строительстве

right_assignment_request - Регистрация договора уступки права

right_movement_request - Регистрация перехода права

ecumbrance_request - Обременение объекта недвижимости

cessation_encumbrance_request - Снятие обременения с объекта недвижимости

additional_package_request - Отправка дополнительного пакета

Запрос выписки из ЕГРП¶

Тип Документооборота (docflowType): object_request

Описание: запрос выписки на объект недвижимости из ЕГРН

Параметры (options) документооборота object_request включают в себя следующие данные:

type – тип запрашиваемой выписки.

cadastralNumber – кадастровый номер объекта недвижимости CadastralNumber

API Контур.Реестро предоставляет следующие типы выписок:

Тип выписки	Описание
info	Расширенная выписка об основных характеристиках и зарегистрированных правах на объект недвижимости
base	Базовая выписка об основных характеристиках и зарегистрированных правах на объект недвижимости
ownership	Выписка о переходе прав на объект недвижимости

Пример:

POST /realty/v1/docflows/object_request HTTP/1.0
Host: api.kontur.ru
Content-Type: application/json
Content-Length: 123
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

{
  "requestId": "client-request-12345",
  "options": {
     "type": "info",
     "cadastralNumber": "47:14:1203001:814"
   }
}

Алгоритм Работы с документооборотом¶

Для документооборота ObjectRequestPost этапа работы с требованиями (requirements) нет, данный документооборот сразу переходит в очередь на отправку в Росреестр. (После создания необходимо актуализировать состояние документооборота до получения статуса “completed”).

Результирующие документы¶

В ответ на запрос из росереестра могут придти следующие типы файлов в ответе:

Тип документа	Формат	Описание
egrn:outdoc	ZIP	Архив документов, полученный от системы ЕГРН нового формата.
outdoc	ZIP	Архив документов, полученный от системы ЕГРН старого формата.
egrn:extract_info:xml	XML	Документ с выпиской об основных характеристиках и зарегистрированных правах на объект недвижимости ЕГРН нового формата.
extract_info:xml	XML	Документ с выпиской об основных характеристиках и зарегистрированных правах на объект недвижимости ЕГРН старого формата.
extract_info:pdf	PDF	Выписка об основных характеристиках и зарегистрированных правах на объект недвижимости в формате PDF.
egrn:extract_ownership:xml	XML	Документ с выпиской о переходе прав на объект недвижимости ЕГРН нового формата.
extract_ownership:xml	XML	Документ с выпиской о переходе прав на объект недвижимости ЕГРН старого формата.
extract_ownership:pdf	PDF	Выписка о переходе прав на объект недвижимости в формате PDF.

Тип документа (старый или новый формат) зависит от региона, на который отправлена выписка. Тип выписки зависит от заказываемого.

Регистрация договора долевого участия в строительстве¶

Тип Документооборота docflowType: equity_agreement_registration_request

Параметры options документооборота equity_agreement_registration_request включают в себя следующие данные:

Значение			Тип	Обязательность	Описание
object			Object []	required	описание земельных участков (достаточно указать кадастровый номер и адрес для каждого объекта)
developer			object	required	сведения об организации, являющейся застройщиком в соответствии 214-ФЗ
	developer		DocflowMember	required	сведения о застройщике как участнике сделки
	appliedDocuments		object	optional	заполняется в случае если ДДУ по данному объекту регистрируется впервые
		buildAgreement	AppliedDocument	required	разрешение на строительство
		projectDeclaration	AppliedDocument	optional	проектная декларация
		buildPlan	AppliedDocument	optional	план создаваемого объекта недвижимого имущества
buyer			object	required	сведения об участниках договора долевого строительства. Необходимо указать один из вложенных объектов
	individualOwnership		object	optional	заполняется, если предметом договора является передача недвижимого имущества в единоличную собственность
		owner	DocflowMember	required	сведения об участнике сделки, который является участником ДДУ
		mortgage	Mortgage	optional	заполняется, если объект по ДДУ приобретается с привлечением кредитных средств банка
	cooperativeOwnership		object	optional	заполняется, если предметом договора является передача недвижимого имущества в совместную собственность
		spouse1	DocflowMember	required	сведения об одном из супругов, который является участником ДДУ
		spouse2	DocflowMember	required	сведения об одном из супругов, который является участником ДДУ
		mortgage	Mortgage	optional	заполняется, если объект по ДДУ приобретается с привлечением кредитных средств банка
		marriageCertificate	AppliedDocument	optional	свидетельство о браке или брачный договор
	sharedOwnership		object	optional	заполняется, если предметом договора является передача недвижимого имущества в долевую собственность
		shares	Share []	required	сведения об участниках сделки, которые являются участниками ДДУ
appliedDocuments			object	required	описание документов, которые подтверждают аспекты регистрации
	equityAgreement		AppliedDocument	required	договор долевого участия
	other		AppliedDocument []	optional	массив других документов

Результирующие документы¶

В ответ на запрос из росереестра могут придти следующие типы файлов в ответе:

Тип документа	Формат	Описание
egrn:outdoc	ZIP	Архив документов, полученный от системы ЕГРН нового формата.
outdoc	ZIP	Архив документов, полученный от системы ЕГРН старого формата.

Тип документа (старый или новый формат) зависит от региона, на который отправлен запрос.

Пример¶

POST https://api.testkontur.ru/realty/v1/docflows/equity_agreement_registration_request
Content-Type application/json
Host api.kontur.ru
Authorization auth.sid 38f31d7246b148c8abcdf0e240a5e39d

  {
  "requestId": "3ca70b51-cbc9-43fd-81c0-2b1621f4b27a",
  "options": {
    "object": [{
      "objectType": "flat",
      "cadastralNumber": "54:35:021060:1733",
      "address": {
        "region": "Новосибирская область",
        "city" :{
          "abbreviation": "г",
          "name": "Новосибирск"
        },
        "street" :{
          "abbreviation": "ул",
          "name": "Челюскинцев"
        },
        "house": {
          "type": "д",
          "name": "14"
        },
        "apartment": {
          "type": "кв",
          "name": "81"
        }
     }
   }],
   "developer": {
     "developer": {
        "organization": {
          "name": "Тестовая строительная компания",
          "inn": "7017096688",
          "kpp": "701701001",
          "ogrn": "1162801051005",
          "regDate": "2018-09-04",
          "address": {
            "region": "Новосибирская область",
            "city" :{
              "abbreviation": "г",
              "name": "Новосибирск"
            },
            "street" :{
              "abbreviation": "ул",
              "name": "Челюскинцев"
            },
            "house": {
              "type": "д",
              "name": "14"
            },
            "apartment": {
              "type": "кв",
              "name": "81"
           }
         }
       },
       "representative": {
         "representativeType": "authorized",
         "person": {
           "name": "Тест",
           "surname": "Тестов",
           "dateBirth": "2018-09-04",
           "birthPlace": "Новосибирск",
           "snils": "000-000-000 55",
           "gender": "female",
           "identityDocument": {
             "documentType" : "russPassport",
             "series": "1234",
             "number": "123456",
             "issueDate": "2018-09-04",
             "issuer": {
               "code": "123-123",
               "name": "кто-то"
             }
          },
          "citizenship": "росийская федерация",
          "address": {
            "region": "Новосибирская область",
            "city" :{
               "abbreviation": "г",
               "name": "Новосибирск"
            },
           "street" :{
              "abbreviation": "ул",
              "name": "Челюскинцев"
           },
           "house": {
             "type": "д",
             "name": "14"
           },
          "apartment": {
            "type": "кв",
            "name": "81"
          }
        }
      }
    }
  }
},
"buyer": {
  "individualOwnership": {
    "owner": {
      "person": {
        "name": "Тест",
        "surname": "Тестов",
        "dateBirth": "2018-09-04",
        "birthPlace": "Новосибирск",
        "snils": "000-000-000 55",
        "gender": "female",
        "identityDocument": {
          "documentType" : "russPassport",
          "series": "1234",
          "number": "123456",
          "issueDate": "2018-09-04",
          "issuer": {
            "code": "123-123",
            "name": "кто-то"
          }
        },
        "citizenship": "Российская Федерация",
        "address": {
          "region": "Новосибирская область",
          "city" :{
            "abbreviation": "г",
            "name": "Новосибирск"
          },
          "street" :{
            "abbreviation": "ул",
            "name": "Челюскинцев"
          },
          "house": {
            "type": "д",
            "name": "14"
          },
          "apartment": {
            "type": "кв",
            "name": "81"
          }
        }
      }
    },
    "mortgage": {
      "loanAgreement": {
         "documentType": "loanAgreement",
         "content": {
           "info": {
             "type": "pdf",
             "contentPointer": {
               "id": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
               "contentLink": "https://api.testkontur.ru/realty/v1/contents/3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e"
             }
           },
           "signatures": [{
              "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
                               "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
           }]
         }
       }
     }
   }
 },
 "appliedDocuments": {
   "equityAgreement": {
     "documentType": "equityAgreement",
     "content": {
      "info": {
             "type": "pdf",
             "contentPointer": {
               "id": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
               "contentLink": "https://api.testkontur.ru/realty/v1/contents/3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e"
             }
           },
           "signatures": [{
             "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
             "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
           }]
         }
       }
     }
   }
 }

Регистрация договора уступки права¶

Тип Документооборота (docflowType): right_assignment_request

Параметры (options) документооборота right_assignment_request включают в себя следующие данные:

Значение			Тип	Обязательность	Описание
object			Object []	required	сведения об объектах недвижимости
seller			object	required	сведения о цеденте - лице, которе уступает права. Необходимо указать минимум один из вложенных объектов
	individualOwnership		object	optional	заполняется, если право требования приобреталось цедентом в единоличную собственность
		owner	DocflowMember	required	сведения об участнике сделки
	cooperativeOwnership		object	optional	заполняется, если право требования приобреталось цедентом в совместную собственность
		spouse1	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
		spouse2	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
	sharedOwnership		object	optional	заполняется, если право требования приобреталось цедентом в долевую собственность
		shares	Share []	required	сведения об участнике(ах) сделки
buyer			object	required	сведения цессионарии - покупателе права требования. Необходимо указать один из вложенных объектов
	individualOwnership		object	optional	заполняется, если цессионарий приобретает право требования в единоличную собственность
		owner	DocflowMember	required	сведения об участнике сделки
		mortgage	Mortgage	optional	заполняется, если право приобретается с привлечением кредитных средств банка
	cooperativeOwnership		object	optional	заполняется, если цессионарий приобретает право требования в совместную собственность
		spouse1	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
		spouse2	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
		mortgage	Mortgage	optional	заполняется, если право приобретается с привлечением кредитных средств банка
	sharedOwnership		object	optional	заполняется, если цессионарий приобретает право требования в долевую собственность
		shares	Share []	required	сведения об участниках сделки
appliedDocuments			object	required	описание документов, которые подтверждают аспекты регистрации
	rightTransferAgreement		AppliedDocument	required	соглашение об уступке прав требования по договору
	other		AppliedDocument []	optional	массив других документов

Результирующие документы¶

В ответ на запрос из росереестра могут придти следующие типы файлов в ответе:

Тип документа	Формат	Описание
egrn:outdoc	ZIP	Архив документов, полученный от системы ЕГРН нового формата.
outdoc	ZIP	Архив документов, полученный от системы ЕГРН старого формата.

Тип документа (старый или новый формат) зависит от региона, на который отправлен запрос.

Пример¶

POST https://api.testkontur.ru/realty/v1/docflows/right_assignment_request
Content-Type application/json
Host api.kontur.ru
Authorization auth.sid 38f31d7246b148c8abcdf0e240a5e39d

  {
  "options": {
    "object": [{
      "objectType": "flat",
      "cadastralNumber": "54:35:021060:1733",
      "address": {
            "region": "Новосибирская область",
            "city" :{
                  "abbreviation": "г",
                  "name": "Новосибирск"
            },
            "street" :{
                  "abbreviation": "ул",
                  "name": "Челюскинцев"
            },
            "house": {
                  "type": "д",
                  "name": "14"
            },
            "apartment": {
                  "type": "кв",
                  "name": "81"
            }
      }
    }],
    "seller": {
      "individualOwnership":{
            "owner": {
                  "organization": {
                    "name": "Тестовая строительная компания",
                    "inn": "7017096688",
                    "kpp": "701701001",
                    "ogrn": "5137746242937",
                    "regDate": "2018-09-04",
                    "address": {
                          "region": "Новосибирская область",
                          "city" :{
                            "abbreviation": "г",
                            "name": "Новосибирск"
                          },
                          "street" :{
                            "abbreviation": "ул",
                            "name": "Челюскинцев"
                          },
                          "house": {
                            "type": "д",
                            "name": "14"
                          },
                          "apartment": {
                            "type": "кв",
                            "name": "81"
                          }
                    }
                  },
                  "representative": {
                    "representativeType": "authorized",
                          "person": {
                            "name": "Тест",
                            "surname": "Тестов",
                            "dateBirth": "2018-09-04",
                            "birthPlace": "Новосибирск",
                            "snils": "000-000-000 57",
                            "gender": "female",
                            "identityDocument": {
                                  "documentType" : "russPassport",
                                  "series": "1234",
                                  "number": "123456",
                                  "issueDate": "2018-09-04",
                                  "issuer": {
                                    "code": "123-123",
                                    "name": "кто-то"
                                  }
                            },
                            "citizenship": "росийская федерация",
                            "address": {
                                  "region": "Новосибирская область",
                                  "city" :{
                                    "abbreviation": "г",
                                    "name": "Новосибирск"
                                  },
                                  "street" :{
                                    "abbreviation": "ул",
                                    "name": "Челюскинцев"
                                  },
                                  "house": {
                                    "type": "д",
                                    "name": "14"
                                  },
                                  "apartment": {
                                    "type": "кв",
                                    "name": "81"
                                  }
                            }
                      }
                    }
             }
      }
    },
    "buyer": {
      "cooperativeOwnership": {
            "spouse1": {
                  "person": {
                    "name": "Тест",
                    "surname": "Тестов",
                    "dateBirth": "2018-09-04",
                    "birthPlace": "Новосибирск",
                    "snils": "000-000-000 55",
                    "gender": "female",
                    "identityDocument": {
                          "documentType" : "russPassport",
                          "series": "1234",
                          "number": "123456",
                          "issueDate": "2018-09-04",
                          "issuer": {
                            "code": "123-123",
                            "name": "кто-то"
                          }
                    },
                    "citizenship": "росийская федерация",
                    "address": {
                          "region": "Новосибирская область",
                          "city" :{
                            "abbreviation": "г",
                            "name": "Новосибирск"
                          },
                          "street" :{
                            "abbreviation": "ул",
                            "name": "Челюскинцев"
                          },
                          "house": {
                            "type": "д",
                            "name": "14"
                          },
                          "apartment": {
                            "type": "кв",
                            "name": "81"
                          }
                    }
                  }
            },
            "spouse2": {
                  "person": {
                    "name": "Тест",
                    "surname": "Тестов",
                    "dateBirth": "2018-09-04",
                    "birthPlace": "Новосибирск",
                    "snils": "000-000-000 22",
                    "gender": "male",
                    "identityDocument": {
                          "documentType" : "russPassport",
                          "series": "1234",
                          "number": "123456",
                          "issueDate": "2018-09-04",
                          "issuer": {
                            "code": "123-123",
                            "name": "кто-то"
                          }
                    },
                    "citizenship": "росийская федерация",
                    "address": {
                          "region": "Новосибирская область",
                          "city" :{
                            "abbreviation": "г",
                            "name": "Новосибирск"
                          },
                          "street" :{
                            "abbreviation": "ул",
                            "name": "Челюскинцев"
                          },
                          "house": {
                            "type": "д",
                            "name": "14"
                          },
                          "apartment": {
                            "type": "кв",
                            "name": "81"
                          }
                    }
                  }
            },
            "mortgage": {
                  "loanAgreement": {
                    "documentType": "loanAgreement",
                    "content": {
                          "info": {
                    "type": "pdf",
                    "contentPointer": {
                          "id": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
                          "contentLink": "https://api.testkontur.ru/realty/v1/contents/3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e"
                    }
                          },
                          "signatures": [{
                            "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
                    "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
                          },
                          {
                            "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
                    "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
                          },
                          {
                            "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
                    "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
                          }]
                    }
                  }
            }
      }
    },
    "appliedDocuments": {
      "rightTransferAgreement": {
            "documentType": "rightTransferAgreement",
            "content": {
              "info": {
            "type": "pdf",
            "contentPointer": {
              "id": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
              "contentLink": "https://api.testkontur.ru/realty/v1/contents/3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e"
            }
          },
          "signatures": [{
                "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
             "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
          }]
        }
      },
      "other": [{
            "documentType": "marriageCertificate",
            "content": {
              "info": {
            "type": "pdf",
            "contentPointer": {
              "id": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
              "contentLink": "https://api.testkontur.ru/realty/v1/contents/3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e"
            }
          },
          "signatures": [{
                "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
            "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
          },
          {
                "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
            "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
          }]
        }
      }]
    }
  }
}

Регистрация перехода права¶

Тип Документооборота (docflowType): right_movement_request

Параметры (options) документооборота right_movement_request включают в себя следующие данные:

Значение			Тип	Обязательность	Описание
rightMovementType			enum	required	основание для перехода права. На данный момент доступен тип `sale` - договор купли-продажи
object			Object	required	сведения об объекте недвижимости
seller			object	required	сведения о продавце объекта недвижимости. Необходимо указать минимум один из вложенных объектов
	individualOwnership		object	optional	заполняется, если объект недвижимости находится в единоличной собственности
		owner	DocflowMember	required	сведения об участнике сделки
	cooperativeOwnership		object	optional	заполняется, если объект недвижимости находится в совместной собственности
		spouse1	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
		spouse2	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
	sharedOwnership		object	optional	заполняется, если объект недвижимости находится в долевой собственности
		shares	Share []	required	сведения об участнике(ах) сделки
	evidenceOfOwnership		object	optional	заполняется, если требуется подтверждение права собственности продавца, возникшего до 1998 г
		documents	AppliedDocument []	required	набор документов, подтверждающих право собственности продавца
buyer			object	required	сведения о покупателе объекта недвижимости. Необходимо указать один из вложенных объектов
	individualOwnership		object	optional	заполняется, если объект недвижимости приобретается в единоличную собственность
		owner	DocflowMember	required	сведения об участнике сделки
		mortgage	Mortgage	optional	заполняется, если объект приобретается с привлечением кредитных средств банка
	cooperativeOwnership		object	optional	заполняется, если объект недвижимости приобретается в совместную собственность
		spouse1	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
		spouse2	DocflowMember	required	сведения об одном из супругов, как об участнике сделки
		mortgage	Mortgage	optional	заполняется, если объект приобретается с привлечением кредитных средств банка
		marriageCertificate	AppliedDocument	optional	свидетельство о браке или брачный договор
	sharedOwnership		object	optional	заполняется, если предметом договора является передача недвижимого имущества в долевую собственность
		shares	Share []	required	сведения об участниках сделки
appliedDocuments			object	required	описание документов, которые подтверждают аспекты регистрации
	contractOfSale		AppliedDocument	required	договор купли продажи
	other		AppliedDocument []	optional	массив других документов

Результирующие документы¶

В ответ на запрос из росереестра могут придти следующие типы файлов в ответе:

Тип документа	Формат	Описание
egrn:outdoc	ZIP	Архив документов, полученный от системы ЕГРН нового формата.
outdoc	ZIP	Архив документов, полученный от системы ЕГРН старого формата.

Тип документа (старый или новый формат) зависит от региона, на который отправлен запрос.

Пример¶

POST https://api.testkontur.ru/realty/v1/docflows/right_movement_request
Content-Type: application/json
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

{
"requestId": "client-request-12345",
"options": {
  "rightMovementType": "sale",
  "object": {
    "objectType":"flat",
    "usagePurpose": "dwellingApartment",
    "cadastralNumber": "54:35:021060:1683",
    "address":{
      "region": "Новосибирская область",
      "city": {
        "abbreviation": "г",
        "name":"Новосибирск"
      },
      "street": {
        "abbreviation": "ул",
        "name":"Челюскинцев"
      },
      "house": {
        "type": "д",
        "name":"14"
      },
      "apartment": {
        "type": "кв",
        "name":"81"
        }
      },
    "registration":{
      "number": "2001-118586",
      "date": "2001-12-11"
    },
    "area": {
      "value": "58",
      "unit": "кв.м"
    }
  },
  "seller": {
    "individualOwnership": {
      "owner": {
        "person":{
          "name": "Виталий",
          "surname": "Тестов",
          "patronymic": "Иванович",
          "dateBirth": "1971-01-10",
          "birthPlace": "Иваново",
          "snils": "000-000-000 55",
          "gender": "male",
          "identityDocument": {
            "documentType": "russPassport",
            "series": "1234",
            "number": "123456",
            "issueDate": "2017-01-01",
            "issuer": {
              "code": "050-005",
              "name":"МВД"
            }
          },
          "citizenship": "Росийская",
          "address": {
            "region": "Новосибирская область",
            "city": {
              "abbreviation": "г",
              "name":"Новосибирск"
            },
            "street": {
              "abbreviation": "ул",
              "name":"Челюскинцев"
            },
            "house": {
              "type": "д",
              "name":"14"
            },
            "apartment": {
              "type": "кв",
              "name":"81"
            }
          }
        }
      }
    },
    "evidenceOfOwnership": {
      "objectType": "object",
      "documents": [{
        "documentType": "inheritanceByLaw",
        "number": "1990/1234566543",
        "issueDate": "1990-11-11",
        "issuer": {
          "code":"010-001",
          "name":"кем-то"
        },
        "content": {
          "info": {
            "type": "pdf",
            "contentPointer": {
              "id": "0068c15b-2880-4a36-aba2-fa0ad6fcd7de",
              "contentLink": "https://api.kontur.ru/realty/v1/contents/0068c15b-2880-4a36-aba2-fa0ad6fcd7de"
            }
          },
          "signatures": [{
            "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
            "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
          }]
        }
      }]
    }
  },
  "buyer": {
    "sharedOwnership": {
      "shares": [{
        "owner" : {
          "person": {
            "name": "Марина",
            "surname": "Тестова",
            "patronymic": "Сергеевна",
            "dateBirth": "1979-09-11",
            "birthPlace": "Новосибирск",
            "snils": "000-000-000 53",
            "gender": "female",
            "identityDocument": {
              "documentType": "russPassport",
              "series": "2345",
              "number": "123498",
              "issueDate": "2017-01-01",
              "issuer": {
                "code": "050-005",
                "name":"МВД"
              }
            },
            "citizenship": "Росийская Федерация",
            "address": {
              "region": "Новосибирская область",
              "city": {
                "abbreviation": "г",
                "name":"Новосибирск"
              },
              "street": {
                "abbreviation": "ул",
                "name":"Ленина"
              },
              "house": {
                "type": "д",
                "name":"12"
              },
              "apartment": {
                "type": "кв",
                "name":"1"
              }
            }
          }
        },
        "share" : {
          "numerator":"1",
          "denominator": "2"
        }
      },
      {
        "owner": {
          "person": {
            "name": "Иван",
            "surname": "Иванов",
            "patronymic": "Иванович",
            "dateBirth": "1970-01-12",
            "birthPlace": "Новосибирск",
            "snils": "000-000-000 33",
            "gender": "male",
            "identityDocument": {
              "documentType": "russPassport",
              "series": "7654",
              "number": "049586",
              "issueDate": "2012-03-05",
              "issuer": {
                "code": "650-065",
                "name":"МВД"
              }
            },
            "citizenship": "Росийская Федерация",
            "address": {
              "region": "Новосибирская область",
              "city": {
                "abbreviation": "г",
                "name":"Новосибирск"
              },
              "street": {
                "abbreviation": "ул",
                "name":"Станиславского"
              },
              "house": {
                "type": "д",
                "name":"16"
              },
              "apartment": {
                "type": "кв",
                "name":"1"
              }
            }
          }
        },
        "share": {
          "numerator":"1",
          "denominator": "2"
        }
      }]
    }
  },
  "appliedDocuments": {
    "contractOfSale": {
      "documentType": "contractOfSale",
      "number": "2018/3456787654",
      "issueDate": "2018-05-05",
      "issuer": {
        "code":"540-021",
        "name":"кем-то"
      },
      "content": {
        "info": {
          "type": "pdf",
          "contentPointer": {
            "id": "4bbfef7f-725f-43a6-bf5a-fb4c85c0ccc8",
            "contentLink": "https://api.kontur.ru/realty/v1/contents/4bbfef7f-725f-43a6-bf5a-fb4c85c0ccc8"
          }
        },
        "signatures": [{
          "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
          "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
        },
        {
          "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
          "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
        }]
      }
    },
    "other": [{
      "documentType": "other",
      "content": {
        "info": {
          "type": "pdf",
          "contentPointer": {
            "id": "4bbfef7f-725f-43a6-bf5a-fb4c85c0ccc8",
            "contentLink": "https://api.kontur.ru/realty/v1/contents/4bbfef7f-725f-43a6-bf5a-fb4c85c0ccc8"
          }
        },
        "signatures": [{
          "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
          "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
        }]
      }
    }]
  }
}}

Обременение объекта недвижимости¶

Тип Документооборота (docflowType): encumbrance_request

Параметры (options) документооборота encumbrance_request включают в себя следующие данные:

Значение			Тип	Обязательность	Описание
object			Object	required	описание обременяемого объекта недвижимости
encumbranceType			enum	required	тип обременения (доступен тип `mortgage` - ипотека в силу договора)
whoseRightRestricted			object	required	сторона сделки, лицо, чье право обременяется. Необходимо указать один из вложенных объектов
	individualOwnership		object	optional	заполняется, если правообладатель владеет объектом недвижимости единолично
		owner	DocflowMember	required	описание собственника
	cooperativeOwnership		object	optional	заполняется, если объект недвижимости находится в совместной собственности
		spouse1	DocflowMember	required	описание собственника супруга
		spouse2	DocflowMember	required	описание собственника супруга
whoUseRestriction			object	required	сведения о лице, в пользу которого ограничивается (обременяется) право
	encumbrancer		DocflowMember	required	залогодержатель
appliedDocuments			object	required	описание документов, которые подтверждают аспекты регистрации
	mortgageAgreement		AppliedDocument	required	договор ипотеки
	other		AppliedDocument []	optional	массив других документов

Результирующие документы¶

В ответ на запрос из росереестра могут придти следующие типы файлов в ответе:

Тип документа	Формат	Описание
egrn:outdoc	ZIP	Архив документов, полученный от системы ЕГРН нового формата.
outdoc	ZIP	Архив документов, полученный от системы ЕГРН старого формата.

Тип документа (старый или новый формат) зависит от региона, на который отправлен запрос.

Пример¶

POST https://api.testkontur.ru/realty/v1/docflows/encumbrance_request
Content-Type: application/json
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

  {
  "requestId": "client-request-12345",
  "options": {
    "encumbranceType": "mortgage",
    "object": {
      "objectType": "flat",
      "cadastralNumber": "47:14:1203001:814",
      "address": {
        "region": "Новосибирская",
        "city": {
          "name": "Новосибирск",
          "abbreviation": "г"
        },
        "street": {
          "name": "Челюскинцев",
          "abbreviation": "ул"
        },
        "house": {
          "name": "14",
          "type": "д"
        },
        "apartment": {
          "type": "кв",
          "name": "81"
        }
      },
      "area": {
        "value": "56",
        "unit": "кв.м"
      }
    },
    "whoseRightRestricted": {
      "individualOwnership": {
        "owner": {
          "person": {
            "name": "Тест",
            "surname": "Тестов",
            "patronymic": "Тестович",
            "dateBirth": "1990-01-01",
            "birthPlace": "Новосибирск",
            "snils": "000-000-000 55",
            "gender": "male",
            "identityDocument": {
              "documentType": "russPassport",
              "series": "1234",
              "number": "123456",
              "issueDate": "2001-01-01",
              "issuer": {
                "code": "010-001",
                "name": "МВД НСО"
              }
            },
            "citizenship": "Российская федерация",
            "address": {
              "region": "Новосибирская область",
              "city": {
                "name": "Новосибирск",
                "abbreviation": "г"
              },
              "street": {
                "name": "Челюскинцев",
                "abbreviation": "ул"
              },
              "house": {
                "name": "14",
                "type": "д"
              },
              "apartment": {
                "type": "кв",
                "name": "81"
              }
            }
          }
        }
      }
    },
    "whoUseRestriction": {
      "encumbrancer": [{
        "organization": {
          "name": "Себирские корни",
          "inn": "6663003127",
          "kpp": "660850001",
          "ogrn": "1026605606620",
          "regDate": "2001-01-01",
          "address": {
            "fiasId": "a6e699e0-c0c7-4126-88ca-88e6fbc98992"
          }
        },
        "representative": {
          "representativeType": "authorized",
          "person": {
            "name": "Иван",
            "surname": "Иванович",
            "patronymic": "Иванов",
            "dateBirth": "1990-01-01",
            "birthPlace": "Новосибирская область, поселок Криводановка",
            "snils": "00000000055",
            "gender": "male",
            "identityDocument": {
              "documentType": "russPassport",
              "type": "russPasport",
              "series": "1234",
              "number": "123456",
              "issueDate": "2001-01-01",
              "issuer": {
                "name": "МВД НСО"
              }
            },
            "citizenship": "Российская федерация",
            "address": {
              "fiasId": "a6e699e0-c0c7-4126-88ca-88e6fbc98992",
              "apartment": {
                "type": "кв",
                "name": "1"
              }
            }
          }
        }
      }]
    },
    "appliedDocuments": {
      "mortgageAgreement": {
        "documentType": "mortgageAgreement",
        "content": {
          "info": {
            "type": "pdf",
            "contentPointer": {
              "id": "b35ecbab-adde-488f-b01c-7133c90a261e",
              "contentLink": "https://api.kontur.ru/realty/v1/contents/b35ecbab-adde-488f-b01c-7133c90a261e"
            }
          },
          "signatures": [{
            "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
            "contentLink": "https://api.kontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
          },
          {
            "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
            "contentLink": "https://api.kontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
          }]
        }
      }
    }
  }
}

Снятие обременения с объекта недвижимости¶

Тип Документооборота docflowType: cessation_encumbrance_request

Параметры (options) документооборота cessation_encumbrance_request включают в себя следующие данные:

Значение			Тип	Обязательность	Описание
object			Object []	required	описание массива обременяемых объектов недвижимости
encumbranceType			enum	required	тип обременения: `mortgage` - ипотека в силу договора; `mortgageInLaw` - ипотека в силу закона
whoseRightRestricted			object	required	сторона сделки, лицо, чье право обременялось. Необходимо указать один из вложенных объектов
	individualOwnership		object	optional	заполняется, если правообладатель владеет объектом недвижимости единолично
		owner	DocflowMember	required	описание собственника
	cooperativeOwnership		object	optional	заполняется, если объект недвижимости находится в совместной собственности
		spouse1	DocflowMember	required	описание собственника супруга
		spouse2	DocflowMember	required	описание собственника супруга
whoUseRestriction			object	required	сведения о лице, в пользу которого обременялось право
	encumbrancer		DocflowMember	required	залогодержатель
appliedDocuments			object	required	описание документов, которые подтверждают аспекты регистрации
	other		AppliedDocument []	optional	массив других документов

Результирующие документы¶

В ответ на запрос из росереестра могут придти следующие типы файлов в ответе:

Тип документа	Формат	Описание
egrn:outdoc	ZIP	Архив документов, полученный от системы ЕГРН нового формата.
outdoc	ZIP	Архив документов, полученный от системы ЕГРН старого формата.

Тип документа (старый или новый формат) зависит от региона, на который был отправлен запрос.

Пример¶

POST https://api.testkontur.ru/realty/v1/docflows/cessation_encumbrance_request
Content-Type: application/json
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

{
"requestId": "request-M4M5",
"options": {
  "encumbranceType": "mortgage",
  "object": {
    "objectType":"flat",
    "cadastralNumber": "66:41:0704007:1391",
    "address":{
      "fiasId": "a6e699e0-c0c7-4126-88ca-88e6fbc98992",
      "apartment": {
        "type": "кв",
        "name":"81"
      }
    },
    "area": {
      "value": "58",
      "unit": "кв.м"
    }
  },
  "registrationRecord":{
    "number": "2001-118586",
    "date": "2001-12-11"
  },
  "whoseRightRestricted": {
    "individualOwnership": {
      "owner": {
        "person":{
          "name": "Виталий",
          "surname": "Тестов",
          "patronymic": "Иванович",
          "dateBirth": "1971-01-10",
          "birthPlace": "Иваново",
          "snils": "000-000-000 55",
          "gender": "male",
          "identityDocument": {
            "documentType": "russPassport",
            "series": "1234",
            "number": "123456",
            "issueDate": "2017-01-01",
            "issuer": {
              "code": "170-005",
              "name":"МВД"
            }
          },
          "citizenship": "Российская Федерация",
          "address":{
            "fiasId": "a6e699e0-c0c7-4126-88ca-88e6fbc98992",
            "apartment": {
              "type": "кв",
              "name":"81"
            }
          }
        }
      }
    }
  },
  "whoUseRestriction": {
    "encumbrancer":[
      {
        "organization": {
          "name": "Себирские корни",
          "inn": "6663003127",
          "kpp": "660850001",
          "ogrn": "1026605606620",
          "regDate": "2001-01-01",
          "address": {
            "fiasId": "a6e699e0-c0c7-4126-88ca-88e6fbc98992"
          }
        },
        "representative": {
          "person": {
            "name": "Иван",
            "surname": "Иванович",
            "patronymic": "Иванов",
            "dateBirth": "1990-01-01",
            "birthPlace": "Новосибирская область, поселок Криводановка",
            "snils": "00000000055",
            "gender": "male",
            "identityDocument": {
              "documentType": "russPassport",
              "type": "russPasport",
              "series": "1234",
              "number": "123456",
              "issueDate": "2001-01-01",
              "issuer": {
                "name": "МВД НСО"
              }
            },
            "citizenship": "Российская федерация",
            "address": {
              "fiasId": "a6e699e0-c0c7-4126-88ca-88e6fbc98992",
              "apartment": {
                "type": "кв",
                "name": "1"
              }
            }
          },
          "attorney": {
            "type": "powerOfAttorneyBankRepresentative",
            "appliedDocument": {
              "info": {
                "type": "pdf",
                "contentPointer": {
                  "id": "09f74e77-9722-4301-83cb-51de891f0802",
                  "contentLink": "https://api.kontur.ru/realty/v1/contents/09f74e77-9722-4301-83cb-51de891f0802"
                }
              },
              "signatures": [{
                "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
                "contentLink": "https://api.kontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
              }]
            }
          },
          "representativeType": "confidant"
        }
      }]
    }
  }
}

Отправка дополнительного пакета¶

Тип Документооборота (docflowType): additional_packet_request

Параметры (options) документооборота additional_packet_request включают в себя следующие данные:

docflowId Guid : идентификатор документооборота, к которому отправляет дополнительный пакет

additionalDocuments object : набор досылаемых документов от каждого участника сделки включает в себя:

docflowMember : описание участника документооборота DocflowMember, от лица которого подаются файлы

documents : - набор досылаемых файлов AppliedDocument []

Внимание

Отправка дополнительного пакета к документообороту возможна, если родительский документооборот находится в статусе «в обработке».

Пример¶

POST https://api.testkontur.ru/realty/v1/docflows/additional_packet_request
Content-Type: application/json
Host: api.kontur.ru
Authorization: auth.sid 38f31d7246b148c8abcdf0e240a5e39d

{
  "requestId": "client-request-12345",
  "options": {
    "docflowId": "39460b5e-2b0c-47bb-ad04-f680d32cc71b",
    "additionalDocuments": [{
      "docflowMember": {
        "person": {
          "name": "Иван",
          "surname": "Иванович",
          "patronymic": "Тестов",
          "dateBirth": "1993-01-01",
          "birthPlace": "Новосибирск",
          "snils": "000-000-000 55",
          "gender": "male",
          "identityDocument": {
            "documentType": "russPassport",
            "series": "1654",
            "number": "234984",
            "issueDate": "2001-02-02",
            "issuer": {
              "code": "098-988",
              "name": "Мвд"
            }
          },
          "citizenship": "Российская Федерация",
          "address": {
            "fiasId": "978545bc-f5db-4b4f-ae20-0093efe751dc",
            "apartment": {
              "type": "кв",
              "name": "4"
            }
          }
        }
      },
      "documents": [{
        "documentType": "other",
        "content": {
          "info": {
            "type": "pdf",
            "contentPointer": {
              "id": "763a6a87-cff0-44c8-8348-af3d266fa982",
              "contentLink": "https://api.kontur.ru/realty/v1/contents/763a6a87-cff0-44c8-8348-af3d266fa982"
            }
          },
          "signatures": [{
            "id": "22b2ec5c-8aef-4175-b11d-2e86c587f9a5",
            "contentLink": "https://api.kontur.ru/realty/v1/contents/22b2ec5c-8aef-4175-b11d-2e86c587f9a5"
          }]
        }
      }]
    }]
  }
}

Ответы¶

DocflowNews

DocflowNewsItem

Error

Result

Requirements

DocflowNews¶

Объект данных: DocflowNews

Содержит: Новости по изменению состояния документооборота

DocflowNews состоит:

docflowNewsItem - DocflowNewsItem [] из массива новостей по документооборотам

lastToken - токена, с которого необходимо продолжить вычитывание новостей

DocflowNewsItem¶

Объект данных: DocflowNewsItem

Содержит: Описание актуального события документооборота

Представляет собой следующий набор данных:

token - Токен актуального события документооборота

date - Дата и время события

docflow - Набор данных описывающие состояние документооборота

В объекте docflow содержится:

docflowId - Идентификатор документооборота

docflowType - Тип документооборота

userId - Идентификатор пользователя, который инициировал запрос

state - Статус документооборота

requestId - опциональный номер запроса клиента

Docflow так же может содержать:

error - описание ошибки Error, в случае возникновении ошибки при обработки запроса.

requirements - описание действий Requirements, которые нужно совершить для продолжения обработки запроса

result - результат обработки запроса в Росреестре Result, если документооборот находится в состоянии completed.

Error¶

Объект данных: Error

Содержит: Описание ошибки обработки запроса

Описание ошибки содержится в теле ответа в формате Json.

Описание ошибки может содержать:

code - код ошибки
message - описание ошибки
target - ресурс или тип, который инициировал ошибку
context - дополнительные атрибуты ошибки
errors - массив вложенных ошибок

Пример:

{
  "code": "validation",
  "message": "Failed to validate input request",
  "target": "api",
  "errors": [
    {
    "code": "validation",
    "message": "must not be null",
    "target": "objectRequest.options.cadastralNumber"
    }
  ]
}

Result¶

Объект данных: DocflowResult

Содержит: * Результат обработки документооборота*

Описание результатов содержится в теле ответа в формате Json.

Описание включает:

File[] - Набор файлов от Росреестра File

Пример:

{
  "result": {
    "files": [{
      "id": "d4959ec6-47e6-4b5a-99ae-9591ec1918ad",
      "type": "outdoc",
      "contentLink": "https://api.kontur.ru/realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/d4959ec6-47e6-4b5a-99ae-9591ec1918ad",
      "signatures": [{
        "id": "daf09150-c7d2-4b7c-b5c5-da0c08c6e516",
        "contentLink": "https://api.kontur.ru/realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/daf09150-c7d2-4b7c-b5c5-da0c08c6e516"
        }]
    }]
  }
}

Requirements¶

Объект данных: DocflowRequirements

Содержит: Требования, которые необходимо выполнить, чтобы продолжить документооборот

требования могут быть 2-х вдов:

signature - требуется подписать заявления участниками документооборота.
payment - требуется оплатить гос. пошлину.

signature¶

Представляет собой массив требований к подписанию. Каждый элемент массива представляет собой набор файлов для подписания, сгруппированых по заявителям. Для каждого заявителя может быть указано несколько файлов для подписи.

требоване signature Содержит:

person - физическое лицо Person , которое подает документы.

files[] - набор файлов FilePointer , которые требуется подписать.

Пример:

{
  "requirements":{
  "signature":[{
    "person": {
      "personId": "123",
      "name": "Тест",
      "surname": "Тестович",
      "patronymic": "Тестов",
      "dateBirth": "1972-04-07",
      "birthPlace":"Иркутск",
      "snils":"000-000-000-55",
      "gender":"male",
      "identityDocument":{
        "documentType": "russPassport",
        "series": "1234",
        "number": "123456",
        "issueDate": "2017-01-01",
        "issuer": {
          "code": "000-005",
          "name":"МВД"
        }
      },
      "citizenship": "Росийская Федерация",
      "address":{
        "kladr": "54018000032000100",
        "region": "Новосибирская область",
        "city": {
          "abbreviation": "г",
          "name":"Новосибирск"
        },
        "street": {
          "abbreviation": "ул",
          "name":"Челюскинцев"
        },
        "house": {
          "type": "д",
          "name":"14"
        },
        "apartment": {
          "type": "кв",
          "name":"81"
        },
        "note": ""
      }
    },
    "files": [{
      "id": "c5e78cb0-5234-4bae-9300-9b6d926afbe1",
      "type":"statement",
      "contentLink":"https://api.kontur.ru/realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/c5e78cb0-5234-4bae-9300-9b6d926afbe1"
    }]
  }]
}}

payment¶

Представляет собой массив реквизитов для оплаты государственной пошлины.

Элемент массива payment содержит:

uin - код для оплаты госпошлины

summ - сумма пошлины

Пример:

{
  "requirements":{
    "payment": [{
      "uin": "00000000700486290714",
      "summ": "700"
    }]
  }
}

Объекты данных¶

Address

AppliedDocument

CadastralNumber

Content

DocflowMember

File

FilePointer

Mortgage

Object

Organization

Person

Representative

Share

Address¶

Объект данных: Address

Содержит: Описание адреса

Для определения адреса можно указать либо идентификатор адресного объекта в системе ФИАС и описание адресного уровня квартиры, либо структурированное представление адреса до уровня дома.

Address состоит из следующих данных:

fiasId : Guid Идентификатор адресного объекта в системе ФИАС

kladr : string КЛАДР

region : string Регион

autonomy : AddressElement` Автономия

district : AddressElement Район

city : AddressElement Город

urbanDistrict : AddressElement Внутригородской район

locality : AddressElement Населённый пункт

street : AddressElement Улица

house : Информация о доме состоит из следующих данных:

type : AddressElementType Сокращенное наименование типа

name : string Наименование (Номер дома)

building : Информация о корпусе состоит из следующих данных:

type : AddressElementType Сокращенное наименование типа

name : string Наименование (Номер корпуса)

structure : Информация о стороении

type : AddressElementType Сокращенное наименование типа

name : string Наименование (Номер строения)

apartment : Информация о квартире состоит из следующих данных:

type : Сокращенное наименование типа. Росреестром определны слудующие сокращенич кв, бокс, ком, пом

name : string Номер квартиры

note string Неформализованное описание

AddressElement¶

Объект данных: AddressElement

Содержит: Описание адресного элемента

Адресный элемент представляет собой описание адресного уровня. В ФИАС предусмотрено больше десяти уровней адреса (регион, автономный округ, район и т.д.). Уровни адреса детализируют нахождение объекта до единицы детализации.

Адресный

abbreviation : string сокращенное наименование типа в соответствии с классификатором Росреестра.
name : string наименование адресного элемента

AddressElementType¶

Объект данных: AddressElementType

Содержит: Описание адресного типа после уровня дома

Справочник адресного типа после уровня дома содержит следующий набор наименований уровней. Он распространяется на следующие урони:

house

building

structure

Сокращение	Расшифровка
д	Дом
к	Корпус
литера	Литера
стр	Строение
срж	Сооружение
влд	Владение
двлд	Домовладение
срж	Сооружение
ГСК	Гаражно-строительный кооператив
гараж	Гараж

Пример заполнения структурированного представления адреса

{
"address": {
  "region": "Новосибирская область",
  "city" :{
    "abbreviation": "г",
    "name": "Новосибирск"
  },
  "street" :{
    "abbreviation": "ул",
    "name": "Челюскинцев"
   },
   "house": {
     "type": "д",
     "name": "14"
  },
  "apartment": {
    "type": "кв",
    "name": "81"
  }
}}

Пример заполнения адреса по коду ФИАС

{
    "address":{
    "fiasId": "2f745e33-020e-4e4b-8d3c-0b145fafc6c4",
    "apartment": {
      "type": "кв",
      "name":"81"
    }
  }
}

AppliedDocument¶

Объект данных: AppliedDocument

Содержит: Описание прикладываемых документов

AppliedDocument состоит из следующих данных:

documentType : string тип документа

series : string серия документа

number : string номер

issueDate : date-only дата выдачи

issuer : object организация, выдавшая документ, или автор документа. Содержит:

code ^\d{3}\-?\d{3}$ код подразделения

name string наименование организации

content: Content содержимое документа

Реквизиты документов: series, number, issueDate, issuer - не обязательны для заполнения

Росреестр определяет следующие типы документов documentType:

Документ	Описание
contractOfSale	Договор купли-продажи
evaluationReport	Документ, содержащий сведения о кадастровой стоимости объекта
mortgage	Закладная
loanAgreement	Кредитный договор
mortgageAgreement	Договор ипотеки
notarySpouseConsent	Согласие супругов на совершение сделки
permissionGuardianshipAuthority	Разрешение органа опеки
birthCertificate	Свидетельство о рождении
stateRegistrationCertificate	Свидетельство о государственной регистрации юридического лица
powerOfAttorney	Доверенность
powerOfAttorneyBankRepresentative	Доверенность представителя Банка,подписывающего кредитный договор
equityAgreement	Договор участия в долевом строительстве
acceptanceTransferAct	Передаточный акт
permissionForCommissioning	Разрешение на ввод объекта в эксплуатацию
balanceSheet	Бухгалтерский баланс
majorTransactionsApproval	Разрешение на проведение крупной сделки
refuseOfPurchase	Отказ от права преимущественной покупки
rightTransferAgreement	Соглашение об уступке прав требования по договору
statementFromHomeBook	Выписка из домовой книги
marriageContract	Брачный договор
inheritanceByLaw	Свидетельство о праве на наследство по закону
inheritanceByWill	Свидетельство о праве на наследство по завещанию
contractOfGift	Договор дарения
contractOfChange	Договор мены
investmentAgreement	Инвестиционный договор (договор об инвестировании)
contractOfPrivatization	Договор приватизации
lowAgreement	Решение суда
agreementOfShareAllocation	Соглашение о выделе доли
agreementOfShareDistribution	Соглашение об определении долей в праве общей долевой собственности
actOfDivisionOfProperty	Соглашение о разделе имущества
partnershipAgreement	Договор простого товарищества (договор о совместной деятельности)
indemnityAgreement	Соглашение об отступном
marriageCertificate	Свидетельство о браке
buildAgreement	разрешение на строительство
projectDeclaration	проектная декларация
buildPlan	Технический план здания, сооружения, помещения либо объекта незавершённого строительства
buildDescription	Описание объекта долевого строительства
cessationOfLoanAgreement	Соглашение о расторжении договора залога
other	Прочие

Пример

{"appliedDocuments":{
  "documentType": "marriageCertificate",
  "number": "123456",
  "issueDate": "2017-01-01",
  "issuer": {
      "code": "000-005",
      "name":"МВД"
  },
  "content": {
        "info": {
      "type": "pdf",
      "contentPointer": {
        "id": "3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e",
        "contentLink": "https://api.testkontur.ru/realty/v1/contents/3a8cf2b8-ee9e-47ca-9ff9-75efced2d52e"
      }
    },
    "signatures": [{
          "id": "d42a9a44-4ebb-40dd-9396-bf33dee9f95b",
     "contentLink": "https://api.testkontur.ru/realty/v1/contents/d42a9a44-4ebb-40dd-9396-bf33dee9f95b"
    }]
  }
}}

CadastralNumber¶

Объект данных: CadastralNumber

Содержит: Кадастровый номер

Кадастровый номер - это уникальный номер объекта недвижимости, присваиваемый ему при осуществлении кадастрового и технического учета.

Кадастровый номер представляет собой строку string и имеет следующую структуру: АА:ВВ:CCCCCC:КК, где

АА — кадастровый округ.

ВВ — кадастровый район.

CCCCCC — кадастровый квартал (иногда состоит из 7 цифр).

КК — номер типа объекта недвижимости (сооружения, помещения, здания, земельного участка)

(Номер типа может состоять из неограниченного количества символов)

Content¶

Объект данных: Content

Содержит: содержимое прикладываемого файла

Content состоит из следующих данных:

info : ContentInfo Информация о ранее загруженном в API контенте

signatures: ContentPointer[] Набор сигнатур

ContentInfo¶

Объект данных: ContentInfo

Содержит: Информацию о загружаемом контенте

ContentInfo состоит из следующих данных:

type : Тип содержимого. Для загрузки доступны следующие типы файлов: xml, pdf

contentPointer : ContentPointer[] Указатель на содержимое

ContentPointer¶

Объект данных: ContentPointer

Содержит: Указатель на содержимое файла

ContentPointer состоит из следующих данных:

id : string идентификатор файла

contentLink : Ссылка на содержимое https://api.kontur.ru/realty/v1/docflows/docflowsId/files/filesId

DocflowMember¶

Объект данных: DocflowMember

Содержит: Описание участников документооборота

Все данные для заполнения опциональные, однако необходимо обязательно заполнить или вложенный объект person или organization. Если заполнен объект organization , то объект representative также является обязательным для заполнения.

DocflowMember состоит из следующих данных:

benefitCategory string - льготная категория. benefitCategory может содержать следующие значения:

Значение	Расшифровка
usssrHero	Герои Советского Союза и РФ
cavalierOfGlory	Полные кавалеры ордена Славы
injuredByVov	Инвалиды ВОВ и участники ВОВ (Великой Отечественной Войны)

person: Person описание физического лица

organization: Organization описание организации

representative: Representative лицо, которое представляет интересы заявителя

File¶

Объект данных: File

Содержит: описание файла

Описание файла состоит из описания самого файла и набора прикладываемых к нему подписей.

File состоит из:

id: string идентификатор файла

type: string тип файла

contentLink: ссылка на содержимое файла /realty/v1/docflows/docflowId/files/fileId

signatures: FileSignatures[] набор подписей для файла

FileSignatures¶

Объект данных: FileSignatures

Содержит: описание подписи для файла

FileSignatures состоит из:

id: string идентификатор подписи

contentLink: ссылка на содержимое подписи /realty/v1/docflows/docflowId/files/fileId

Пример:

{
 "files": [{
   "id": "d4959ec6-47e6-4b5a-99ae-9591ec1918ad",
   "type": "outdoc",
   "contentLink": "https://api.kontur.ru/realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/d4959ec6-47e6-4b5a-99ae-9591ec1918ad",
   "signatures": [{
     "id": "daf09150-c7d2-4b7c-b5c5-da0c08c6e516",
     "contentLink": "https://api.kontur.ru/realty/v1/docflows/d20bd506-6325-43e1-b2e4-105ec5d63417/files/daf09150-c7d2-4b7c-b5c5-da0c08c6e516"
     }]
   }]
 }

FilePointer¶

Объект данных: FilePointer

Содержит: описание файла

FilePointer состоит из:

id: string идентификатор файла

type: string тип файла

contentLink: ссылка на содержимое файла /realty/v1/docflows/docflowId/files/fileId

Mortgage¶

Объект данных: Mortgage

Содержит: Описание документов, необходимых для регистрации ипотеки в силу закона.

Mortgage содержит следующие типы документов:

loanAgreement: AppliedDocument Кредитный договор

mortgage: AppliedDocument Закладная (Если указано в кредитном договоре)

evaluationReport: AppliedDocument Оценка рыночной стоимости недвижимости (обязательно при наличии закладной)

Object¶

Объект данных: Object

Содержит: описание объекта недвижимости

Object состоит из:

objectType: string тип объекта недвижимости

Поддерживаемые типы объектов недвижимости:

Значение	Описание
landPlot	Земельный участок
room	Комната
flat	Квартира
structure	Сооружение
unfinishedObject	Объект незавершенного строительства

cadastralNumber: CadastralNumber кадастровый номер объекта недвижимости

address: Address адрес объекта недвижимости

registration: свдеения о регистрации прав. Они не являются обязательными для заполнения. Однако, если их указать, регистрация сделки осуществится быстрее.

number: string номер регистрационной записи

date : date-only дата регистрации

area - площадь объекта. Сведения о площади не обязательны для заполнения.

value: string значение

unit: единица измерения площади. Может быть: кв.м или гa

Пример:

  {
  "objectType":"flat",
  "usagePurpose": "dwellingAppartment",
  "cadastralNumber": "54:35:021060:1683",
  "address":{
    "region": "Новосибирская область",
    "city": {
      "abbreviation": "г",
      "name":"Новосибирск"
    },
    "street": {
      "abbreviation": "ул",
      "name":"Челюскинцев"
    },
    "house": {
      "type": "д",
      "name":"14"
    },
    "apartment": {
      "type": "кв",
      "name":"81"
      }
    },
  "registration":{
    "number": "2001-118586",
    "date": "2001-12-11"
  },
  "area": {
    "value": "58",
    "unit": "кв.м"
  }
}

Organization¶

Объект данных: Organization

Содержит: Описание реквизитов юридического лица

Organization состоит из следующих данных:

Значение	Тип	Описание
name	string	Наименование организации
inn	string(10)	ИНН
kpp	string(9)	КПП
ogrn	string (15)	ОГРН
regDate	date-only	Дата регистрации
address	Address	Адрес организации

Все данные обязательны для заполнения.

Пример

{
"organisation": {
  "name":"Тестовый Банк",
  "inn":"1234567890",
  "kpp":"123456789",
  "ogrn":"123456789098765",
  "regDate":"2001-01-09",
  "address":{
    "region": "Новосибирская область",
    "city": {
      "abbreviation": "г",
      "name":"Новосибирск"
    },
    "street": {
      "abbreviation": "ул",
      "name":"Ленина"
    },
    "house":{
      "type": "д",
      "name":"51"
    },
    "apartment": {
      "type": "пом",
      "name":"505"
    }
  }
}}

Person¶

Объект данных: Person

Содержит: Описание реквизитов физического лица

Person состоит из слеюущих данных:

Значение	Тип	Описание
personId	string	Внешний опциональный идентификатор. Может быть использован для определения подписанта.
name	string	Имя
surname	string	Фамилия
patronymic	string	Отчество
dateBirth	date-only	Дата рождения
birthPlace	string	Место рождения
snils	string	СНИЛС формат: ``^d{3}-?d{3}-?d{3}s?d{2}$ ``
gender	string	Пол. Может принимать значения male (мужчина) female (женщина)
identityDocument	IdentityDocument	Данные документа удостоверяющего личность
citizenship	string	Гражданство
address	Address	Адрес места жительства или пребывания

snils Все данные, за исключением отчества patronymic, обязательны для заполнения.

Пример

{
"person": {
  "personId": "12345",
    "name": "Тест",
    "surname": "Тестов",
    "dateBirth": "2018-09-04",
    "birthPlace": "Новосибирск",
    "snils": "000-000-000 55",
    "gender": "female",
    "identityDocument": {
      "documentType": "russPassport",
      "number": "123456",
      "series": "1234",
      "issueDate": "2018-09-04",
      "issuer": {
        "code": "123-123",
        "name": "кто-то"
      }
    },
    "citizenship": "росийская федерация",
    "address": {
      "fiasId": "2db55560-13aa-423e-876e-d20beff2d75e",
      "kladr": "54000001000150600",
      "region": "Новосибирская",
      "city": {
        "name": "Новосибирск",
        "abbreviation": "г"
      },
      "street": {
        "name": "Челюскинцев",
        "abbreviation": "ул"
      },
      "house": {
        "name": "14",
        "type": "д"
      },
      "apartment": {
        "type": "кв",
        "name": "81"
      }
    }
  }}

IdentityDocument¶

Объект данных: IdentityDocument

Содержит: Описание документа, удостоверяющего личность физического лица.

IdentityDocument состоит из следующих данных:

documentType - тип документа

В качестве documentType документа, удостоверяющего личность физического лица, могут быть предоставлены:

Документ	Описание
russPassport	Паспорт гражданина РФ
inostrannyyPassport	Паспорт иностранного документа
vul	Временное удостоверение личности
voennyyBilet	Военный билет
birthCertificate	Свидетельство о рождении

series - серия документа (не обязательно для заполнение)

number - Номер

issueDate - Дата выдачи

issuer - : Организация, выдавшая документ, или автор документа, содержит:

code - код подразделения ^\d{3}\-?\d{3}$

name - наименование организации

Пример

{
  "identityDocument":{
    "documentType": "russPassport",
    "series": "1234",
    "number": "123456",
    "issueDate": "2017-01-01",
    "issuer": {
        "code": "000-005",
        "name":"МВД"
    }
  }
}

Representative¶

Объект данных: Representative

Содержит: Описание доверенного лица

Representative состоит из следующих данных:

representativeType - тип представителя

Представитель может относиться к одному из следующих типов representativeType:

Значение	Расшифровка
confidant	Доверенное лицо (представительство осуществляется на основании довернности или иного документа)
authorized	Уполномоченное лицо (представительство осуществляется на основании права)

person: Person описание реквизитов физического лица

attorney - сведения о документе, подтверждающем полномочия представителя:

type - тип документа (powerOfAttorney - доверенность)

appliedDocument: Content описание вложенного файла

Поиск кадастрового номера по структурированному адресу¶

Для работы с методами API необходима Авторизация.

Запрос¶

Для получения кадастрового номера пользователю необходимо направить запрос /realty/v1/location/cadastre/suggest методом POST

В теле запроса должен быть расположен JSON, содержащий описание структурированного уровня адресного объекта до дома или квартиры.

Адресный объект в базе ФИАС содержит следующие адресные уровни:

region - регион ОН - является обязательным значением для индетификации адреса, должен содежать:

name - наименование региона Новосибирская область

autonomousCounty - автономная область ОН, элемент должен содежать:

name - наименование автономии Республика Крым

district - район расположения ОН, элемент должен содежать:

name - наименование района Ханты-Мансийский

city - город расположения ОН, элемент должен содежать:

name - наименование города Екатеринбург

settlement - населенный пункет ОН, содежит:

name - наименование населенного пункта село Базьяны

street - улица, описание которой содежит:

name - наименование улицы Ленина

house - описание дома состоит из 3х уровней детализации:

number - номер дома 5

buildingNumber - номера здания (корпус) 1

sructureNumber - номера строения (литера) А

room - описание помещения помещения состоит из

number - номер офиса/квартиры 120

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

POST /v1/cadastre/suggest
Content-Type: application/json

{
 "region": {
   "name": "Новосибирский"
 },
 "city": {
   "name": "Новосибирск"
 },
 "street" : {
   "name" : "Татьяны Снежиной"
 },
 "house" : {
   "number" : "39",
 },
 "room" : {
   "number" : "120"
 }
}

Ответ¶

Ответ содержит массив объектов, советующих заданным в запросе параметрам.

Параметр	Описание
objectId	Код объекта
subjectId	Код субъекта
regionId	Код региона
settlementId	Код населенного пунка
srcObject	Код типа объекта
objectCn	Кадастровый номер
street	Название улицы
house	Описание дома
apartment	Номер помещения
addressNotes	Неструктурированное описание адреса

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

HTTP/1.0 200 OK
Content-Type: application/json

 [
  {
    "objectId":"54:35:0:5911",
    "subjectId":150000000000,
    "regionId":150401000000,
    "settlementId":150401379000,
    "srcObject":1,
    "regionKey":154,
    "objectCn":"54:35:000000:5911",
    "street":"ТАТЬЯНЫ СНЕЖИНОЙ|УЛ",
    "house":"39||",
    "apartment":"120",
    "addressNotes":"г Новосибирск, ул Татьяны Снежиной, д. 39, 120"
  },
  {
    "objectId":"54:35:0:5013",
    "subjectId":150000000000,
    "regionId":150401000000,
    "settlementId":150401379000,
    "srcObject":1,
    "regionKey":154,
    "objectCn":"54:35:000000:5013",
    "street":"ТАТЬЯНЫ СНЕЖИНОЙ|УЛ",
    "house":"39/1||",
    "apartment":"120",
    "addressNotes":"г Новосибирск, ул Татьяны Снежиной, д. 39/1, 120"
  }
]

Возможные HTTP-коды возврата:

400 - один из параметров запроса был указан в неверном формате,
200 - выполнение запроса завершилось успешно.

Документация API¶

Порядок работы с API¶

Авторизация¶

Создание документооборота¶

Подписание¶

Отправка документооборота¶

Актуализация состояния документооборота¶

Оплата пошлины¶

Обработка результатов¶

Методы¶

Авторизация¶

Создание документооборота¶

Запрос описания документооборота¶

Запрос содержимого файла¶

Вычитывание новостей¶

Отправка документооборота¶

Добавление подписи¶

Добавить подпись на заявление (ссылка на файл)¶

Загрузка контента¶

Получение контента¶

Типы документооборотов (ДО)¶

Запрос выписки из ЕГРП¶

Алгоритм Работы с документооборотом¶

Результирующие документы¶

Регистрация договора долевого участия в строительстве¶

Результирующие документы¶

Пример¶

Регистрация договора уступки права¶

Результирующие документы¶

Пример¶

Регистрация перехода права¶

Результирующие документы¶

Пример¶

Обременение объекта недвижимости¶

Результирующие документы¶

Пример¶

Снятие обременения с объекта недвижимости¶

Результирующие документы¶

Пример¶

Отправка дополнительного пакета¶

Пример¶

Ответы¶

DocflowNews¶

DocflowNewsItem¶

Error¶

Result¶

Requirements¶

signature¶

payment¶

Объекты данных¶

Address¶

AddressElement¶

AddressElementType¶

AppliedDocument¶

CadastralNumber¶

Content¶

ContentInfo¶

ContentPointer¶

DocflowMember¶

File¶

FileSignatures¶

FilePointer¶

Mortgage¶

Object¶

Organization¶

Person¶

IdentityDocument¶

Representative¶

Share¶

Поиск кадастрового номера по структурированному адресу¶

Запрос¶

Ответ¶