Перейти к основному содержимому

Электронная регистрация

Далее описаны методы для работы с заявкой на электронную регистрацию от М2.

Загрузка документов для регистрации​

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

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/upload HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  {
    "documentId": "string",
    "documentType": "DDU",        // тип документа
    "clients": [                  // набор ссылок на клиентов
      {                           // которые должны подписать документ
        "id": "string"
      }
    ],
    "documentNumber": "string",   // номер документа
    "dateOfIssue": "string"       // дата документа
  }
}
Справка

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

  • DDU - ДДУ (Договор долевого участия)
  • DKP - ДКП (Договор купли продажи)
  • DUPT - ДУПТ (Договор уступки прав требования)
  • DZ - ДЗ (Договор займа)
  • MORTGAGE - Закладная
  • TRANSFER_ACT - Передаточный акт
  • MARRIAGE_CONTRACT - Брачный договор
  • ADDITIONAL_AGREEMENT - Дополнительное соглашение
  • LOAN_AGREEMENT - Кредитный договор
  • MARRIAGE_CERTIFICATE - Свидетельство о заключении брака
  • CONSENT_SPOUSE - Согласие супруга на совершение сделки
  • TERMINATION_AGREEMENT - Соглашение о расторжении договора
  • EREGISTRATION_OTHER - Сопутствующие дополнительные документы

Удаление документа из заявления ЭР​

Если необходимо удалить ранее добавленный документ из заявления ЭР, то можно воспользоваться следующим методом.

Пример запроса
DELETE https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/{fileId} HTTP/1.1
Authorization: Bearer
Важно

Документы возможно удалить, только если заявление находится на этапе черновика.
Документ не удаляется из хранилища полностью, а только открепляется от конкретного заявления.

Генерация документов и отправка на подписание​

Данный метод переводит заявление ЭР на следующий этап - подписание документов.
Во время его выполнения генерируются дополнительные документы, необходимые для отправки в Росреестр. Метод не содержит тело запроса и дополнительных параметров.

Пример запроса
PUT https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/signing HTTP/1.1
Authorization: Bearer
Важно

Процесс генерации документов и перевода заявления на этап подписания ассинхронный и в среднем занимает несколько секунд. Т.е после вызова метода необходимо учесть таймаут перед выполнением дальнейших операций.
Получение актуального статуса заявления ЭР возможно с помощью этого метода. В случае успешного перевода на этап подписания поле status принимает значение SIGNING.

Перевод заявления ЭР на этап черновика​

Метод используется для внесения изменений в заявление ЭР, если заявление уже было переведено на подписание.

Пример запроса
PUT https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/draft HTTP/1.1
Authorization: Bearer
Важно

Перевод на этап черновика также является ассинхронным и возможен только до отправки в Росреестр.

Важно

Если участнику сделки уже была выпущена УКЭП, то редактировать карточку данного участника сделки нельзя. Необходимо будет открепить УКЭП из этой карточки участника сделки, внести изменения с помощью метода изменения участников и с корректными данными выпустить новую УКЭП другого УЦ.

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

Получение информации о заявлении ЭР​

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

Пример запроса
GET https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId} HTTP/1.1
Authorization: Bearer

Получение информации о состоянии подписания​

Метод возвращает информацию по состоянию подписания и содержимое пакета подписания с привязкой к конкретному участнику. Из ответа должно быть понятно кто и что должен подписать и в каком состоянии находится подписание.

Важно

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

Пример запроса
GET https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/signing-pack HTTP/1.1
Authorization: Bearer
Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json
{
  "signingPack": {
    "id": "d66fb186-33dd-4d42-96a8-2b76b6300558",
    "clients": [
      {
        "id": "70e4081a-a6fa-44dc-8d2c-ee80f7b740b9",
        "signerName": "ООО 'Мудрый выбор'. (Представитель Савельев Евгений Игоревна)",
        "documents": [
          {
            "originalFileId": "62b9d3586361a52075430fb5",
            "displayName": "Доверенность Савельев Евгений.pdf",
            "signFileId": "",
            "type": "POWER_OF_ATTORNEY",
            "status": "NOT_SIGNED",
            "statusUpdateTimestamp": "2022-06-27T15:57:27.820Z"
          },
          {
            "originalFileId": "62b9d3676361a52075430fb8",
            "displayName": "Сгенерированное заявление (ООО 'Мудрый выбор')",
            "signFileId": "",
            "type": "ORDINARY_DOCUMENT",
            "status": "NOT_SIGNED",
            "statusUpdateTimestamp": "2022-06-27T15:57:27.820Z"
          },
          {
            "originalFileId": "62b9d35e6361a52075430fb6",
            "displayName": "1_veniam",
            "signFileId": "",
            "type": "ORDINARY_DOCUMENT",
            "status": "NOT_SIGNED",
            "statusUpdateTimestamp": "2022-06-27T15:57:27.820Z"
          },
          {
            "originalFileId": "62b9d3676361a52075430fb9",
            "displayName": "1_Техническое описание пакета электронных документов",
            "signFileId": "",
            "type": "ORDINARY_DOCUMENT",
            "status": "NOT_SIGNED",
            "statusUpdateTimestamp": "2022-06-27T15:57:27.820Z"
          }
        ]
      },
      {
        "id": "1ba0b2e0-832c-400f-97e0-5f08fec2a992",
        "signerName": "Орехов Григорий Назаровна",
        "documents": [
          {
            "originalFileId": "62b9d3666361a52075430fb7",
            "displayName": "Сгенерированное заявление (Орехов Григорий Назаровна)",
            "signFileId": "",
            "type": "ORDINARY_DOCUMENT",
            "status": "NOT_SIGNED",
            "statusUpdateTimestamp": "2022-06-27T15:57:27.820Z"
          },
          {
            "originalFileId": "62b9d35e6361a52075430fb6",
            "displayName": "2_veniam",
            "signFileId": "",
            "type": "ORDINARY_DOCUMENT",
            "status": "NOT_SIGNED",
            "statusUpdateTimestamp": "2022-06-27T15:57:27.820Z"
          },
          {
            "originalFileId": "62b9d3676361a52075430fb9",
            "displayName": "2_Техническое описание пакета электронных документов",
            "signFileId": "",
            "type": "ORDINARY_DOCUMENT",
            "status": "NOT_SIGNED",
            "statusUpdateTimestamp": "2022-06-27T15:57:27.820Z"
          }
        ]
      }
    ],
    "packNumber": "06-27-06590"
  }
}

Подписание документов в сделке​

Для отправки заявления и регистрации сделки в Росреестре документы должны быть подписаны участниками сделки с помощью УКЭП. Для подписания есть 3 основных пути через API:

  • Добавление файла подписи к документу. Доступно, в случае если документ уже подписан и имеется связанный sig файл подписи.
  • Подписание облачной УКЭП. Удаленное подписание документов участниками сделки доступно только в случае, если к карточке клиента привязана облачная УКЭП одного из УЦ, подробнее про облачную УКЭП описано в разделе.
  • Подписание USB-токеном. Доступно, если у лица имеется физический носитель с УКЭП и имеется доступ к ПК с установленным ПО КриптоПро.

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

Для добавления файла подписи к документу необходимо предварительно:

  • загрузить документ и файл подписи в систему. Подробнее про загрузку документов и файлов описано в разделе
  • добавить документ в ЭР на этапе черновика (файл подписи на этом этапе добавлять не нужно) и выбрать подписантов для данного документа
  • после перевода заявления на этап подписания, необходимо вызвать следующий метод
Пример запроса
POST https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/signing-pack/{clientId}/{originalDocumentId}/attach-sign HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "documentSignId": "string"
}

Для добавления файла необходимо указать клиента clientId, чья подпись имеется в добавляемом файле, а также идентификатор документа originalDocumentId, к которому добавляется файл.

Справка

Если файл добавился успешно и прошел необходимую валидацию на наличие атрибутов подписи и сопоставление с участником сделки, то при запросе информации о заявлении или при запросе данных о состоянии подписания, у связанного изначального файла значение поля status будет равно SIGNED.

Запрос облачной подписи​

Метод используется, если у партнера подключен выпуск облачной подписи: Sign.me, ЕЭТП DSS или Госключ. Запрос на подписание отправляется в мобильном приложении клиенту, которому предварительно привязали выпущенный УКЭП. Подпись должна быть заранее выпущена.

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/signing-pack/{clientId}/send-for-signing HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "filesIds": [
    "string"
  ]
}
Заметка

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

Получение ссылки на удаленное подписание USB-токеном​

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/signing-pack/{clientId}/remote-usb-sign-url HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "fileIds": [
    "string"
  ]
}
Заметка

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

Полученную ссылку нужно использовать для подписания токеном на отдельном ПК, с установленным необходимым ПО. В ответ на запрос ссылки придет один URL, вне зависимости от количества документов, для которых запрашивается ссылка на подпись.

Отправка ссылки на удаленное подписание USB-токеном на email​

Если ссылку необходимо отправить клиенту на email, то можно воспользоваться следующим методом.

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/signing-pack/{clientId}/remote-usb-sign-url HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "fileIds": [
    "string"
  ],
  "email": "test@mail.ru"
}
Заметка

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

Отправка в Росреестр​

Если все документы подписаны и имеют соответствующий статус, то заявление можно отправить в Росреестр

Пример запроса
PUT https://m2.ru/api/public/deal-api/v1/deals/{id}/eregistration/{erId}/send HTTP/1.1 
Authorization: Bearer
Важно

Отправка заявления в РР также является ассинхронной командой, в процессе выполнения которой выполняются смежные подготовительные действия. Учитывайте это при интеграции.

Если метод выполнен успешно, и заявление имеет соответствующий статус SENT дальше можно мониторить состояние регистрации и ожидать ее успешное завершение для получения результата.

Получение информации о прогрессе регистрации и о результатах​

Получить информацию о ходе регистрации и ее текущем статусе можно несколькими способами:

  • в составе всей сделки, метод
  • отдельно статус заявления ЭР, метод

Результат с архивом от РР можно получить из ответа в составе всей сделки, этот документ будет иметь тип ER_RESULT.