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

Выпуск и работа с УКЭП

Общая информация​

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

  • Sign.me
  • ЕЭТП DSS
  • Госключ

Кроме того, документы можно подписать с помощью подписи на USB-токене.

Важно

Обратите внимание, что данные клиента, которые передаются при выпуске УКЭП должны полностью совпадать с данными в карточке клиента. В том числе, формат написания ФИО, email (строчные, заглавные буквы).

Заметка

На тестовом стенде для тестирования различных сценариев необходимо использовать для подписания документов УКЭП на USB-токене.

Выпуск УКЭП Sign.Me​

Возможно два варианта выпуска УКЭП Sign.Me:

  • Выпуск УКЭП без курьерской доставки с идентификацией клиента, заполнением и загрузкой документов на выпуск УКЭП в систему
  • Выпуск УКЭП с помощью курьера
Справка

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

Выпуск УКЭП Sign.Me с заполнением и загрузкой документов в систему​

Ручной выпуск УКЭП возможен в случае когда партнер самостоятельно идентифицирует личность того, для кого выпускается УКЭП.
Выпуск состоит из следующих шагов:

Создание черновика УКЭП Sign.Me​

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/signatures/sign-me/create-draft HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "clientId": "string"
}

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

Начать выпуск УКЭП Sign.Me​

Запуск процесса выпуска УКЭП на стороне УЦ. С этого момента данные клиента редактировать нельзя, т.к информация фиксируется в УЦ.

Пример запроса
PATCH https://m2.ru/api/public/deal-api/v1/signatures/sign-me/{signatureId}/start-creation HTTP/1.1
Authorization: Bearer

Получить заявление на выпуск УКЭП Sign.Me​

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

Пример запроса
GET https://m2.ru/api/public/deal-api/v1/signatures/sign-me/{signatureId}/order-form-file HTTP/1.1
Authorization: Bearer

Загрузить документы для выпуска Sign.Me​

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

Пример запроса
PATCH https://m2.ru/api/public/deal-api/v1/signatures/sign-me/{signatureId}/upload-document/{documentType} HTTP/1.1 
Authorization: Bearer
Content-type: application/json

{
  "fileId": "string"
}

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

  • Заполненное заявление (2 страницы) - SIGNME_ORDER_PAGE_1, SIGNME_ORDER_PAGE_2
  • Паспорт (2-3 страница (с фото) и 4-5 (прописка)) - PASSPORT_DATA, PASSPORT_ADDRESS
  • СНИЛС - SNILS
  • ИНН (если выпуск для ЮЛ) - LEGAL_INN
  • Фото клиента с заявлением на выпуск УКЭП (если требование о его наличии прописано в договоре с УЦ) - PHOTO

Активировать подпись Sign.Me​

Метод позволяет отправить подтверждающие документы в УЦ и активировать (разрешить выпускать на мобильном устройстве) УКЭП в УЦ.

Пример запроса
PATCH https://m2.ru/api/public/deal-api/v1/signatures/sign-me/{signatureId}/activate HTTP/1.1 
Authorization: Bearer

Выпуск УКЭП Sign.Me с помощью вызова курьера​

Выпуск УКЭП через курьерскую доставку не требует от партнера идентификации клиента и загрузки документов на выпуск УКЭП. Эти действия осуществляются курьером.

Метод позволяет заказать выпуск УКЭП Sign.Me через курьерскую доставку.
При выпуске УКЭП с помощью курьера, необходимо заполнять данные о месте встречи курьера с клиентом. В ответ возвращается структура с id УКЭП, текущим статусом выпуска и информацией о курьерской доставке.

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/signatures/sign-me/delivery HTTP/1.1 
Authorization: Bearer
Content-type: application/json

{
  "clientId": "string",
  "address": "string",
  "deliveryComment": "string"
}

Дополнительные методы для работы с подписями​

Поиск существующей подписи Sign.Me или ЕЭТП DSS​

Выпущенные ранее подписи Sign.Me и ЕЭТП DSS возможно переиспользовать. Подписи могли быть выпущены как в рамках платформы М2, так и в сторонних сервисах. Для таких случаев предусмотренна возможность получения информации по всем доступным УКЭП для пользователя.

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

Если УКЭП хоть в одном из УЦ будет найдена, то в ответ придет информация об этой УКЭП. Для ее использования в системе ее необходимо импортировать.

Импорт существующей подписи Sign.Me или ЕЭТП DSS​

Если ранее клиент уже выпускал подпись Sign.Me или ЕЭТП DSS, то ее не нужно выпускать заново.
Для таких случаев предусмотрена возможность переиспользовать существующую подпись в системе, если срок ее действия не истек. Для этого нужно указать тип УКЭП полученный из [запроса](#поиск-существующей-подписи-signme-или-ЕЭТП DSS) и затем выполнить запрос для ее привязки к клиенту.
После этого можно осуществлять полноценную работу с этой УКЭП.

Справка

Привязка подписи ЕЭТП DSS возможна только для УКЭП, которые были выпущены в офисах банка ВТБ или в М2.

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/signatures/import HTTP/1.1 
Authorization: Bearer
Content-type: application/json

{
  "clientId": "543f312e-c481-4994-8925-1283214b2672",
  "searchableSignatureType": "MYDSS_INTERNAL"
}

Импорт существующей подписи Sign.Me​

DEPRECATED

Устаревший метод, который работает только для УКЭП Sign.Me. Его можно использовать, но мы рекомендуем использовать [новый универсальный метод](#импорт-существующей-подписи-signme-или-ЕЭТП DSS), который подходит для подписей Sign.Me или ЕЭТП DSS.

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/signatures/sign-me/import HTTP/1.1 
Authorization: Bearer
Content-type: application/json

{
  "clientId": "543f312e-c481-4994-8925-1283214b2672"
}

Если ранее клиент уже выпускал УКЭП в системе Sign.Me, то ее не нужно выпускать заново, более того, УЦ не позволяет делать выпуск нескольких УКЭП на одни и те же персональные данные, в частности, СНИЛС, email и номер телефона. Для таких случаев предусмотрена возможность выполнить импорт УКЭП в систему. В случае успешного выполнения метода импортированная УКЭП будет привязана к клиенту.

Открепление подписи​

Открепление УКЭП позволяет убрать активную УКЭП у текущего клиента и воспользоваться другой активной УКЭП через ее импорт. Открепленная УКЭП не пропадает и остается такой же активной — в любой момент ее можно импортировать обратно и продолжить использование как раньше.

Пример запроса
PUT https://m2.ru/api/public/deal-api/v1/signatures/{clientId}/detach HTTP/1.1 
Authorization: Bearer

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

С помощью данного метода можно отслеживать актуальную информацию об УКЭП.

Пример запроса
GET https://m2.ru/api/public/deal-api/v1/signatures/{signatureId} HTTP/1.1 
Authorization: Bearer
Заметка

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

Отзыв УКЭП​

С помощью данного метода возможно выполнить отзыв УКЭП Sign.Me.

Пример запроса
DELETE https://m2.ru/api/public/deal-api/v1/signatures/sign-me/{signatureId}/revoke HTTP/1.1 
Authorization: Bearer
Важно

УКЭП можно сбросить до определенного этапа в процессе выпуска, когда этот этап пройден и УКЭП клиенту выпущена — сбросить ее уже не получится.

Ручной выпуск УКЭП Госключ общий процесс​

Создание черновика УКЭП Госключ​

Пример запроса
POST https://m2.ru/api/public/deal-api/v1/signatures/goskey/create-draft HTTP/1.1
Authorization: Bearer
Content-type: application/json

{
  "clientId": "string"
}

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

Начать выпуск УКЭП Госключ​

Пример запроса
PATCH https://m2.ru/api/public/deal-api/v1/signatures/goskey/{signatureId}/start-creation HTTP/1.1
Authorization: Bearer

Метод без параметров, запускает процесс выпуска УКЭП на стороне УЦ.

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

Получить информацию о текущем состоянии УКЭП можно с помощью данного метода.

Важно

Если УКЭП Госключ у клиента была выпущена ранее (не через сервис М2), система М2 не сможет получить данные о наличии у клиента УКЭП Госключ. Это связано с политикой Минцифры в части безопасности данных.

Если менеджер на сделке получил от клиента информацию о наличии у него подписи Госключ, то порядок действий будет такой:

  • сгенерировать документы на подписание и отправить клиенту — как описано здесь
  • клиент сможет подписать пакет документов, используя УКЭП Госключ.

Сброс УКЭП Госключ​

Пример запроса
DELETE https://m2.ru/api/public/deal-api/v1/signatures/goskey/{signatureId}/revoke HTTP/1.1 
Authorization: Bearer

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