Создать заявку на изменение параметров КСКПЭП

Внимание

Новые ключи временно не выпускаются в связи с обновлением продукта.

Создает заявку на изменение параметров сертификата ключа проверки электронной подписи (КСКПЭП).

Примечание

По состоянию на февраль 2019 года можно изменить только номер телефона, на который высылается СМС с паролем для начала новой сессии.

Формат запроса

PATCH https://api.ofd.yandex.net/{v1}/companies/{company_id}/signs/{sign_id}
  ? 
  • v1
    Номер версии API ОФД.
  • company_id
    Идентификатор компании. Присваивается автоматически при регистрации компании в системе Яндекс ОФД.
  • sign_id
    Идентификатор КСКПЭП.

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

Заголовки запроса должны содержать ключи (см. раздел Доступ к API):

Заголовок Значение
X-Yandex-Key <аутентификационный ключ>
X-OFD-Key <авторизационный ключ>
Content-Type application/json

Тело запроса

{
    "mobile_phone": "{string}"
}
  • mobile_phone *
    Номер телефона подписанта. Необходим для получения оповещений о выпуске КСКПЭП и пароля для активации сессий электронной подписи.

* Обязательный параметр.

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

Формат ответа

{
   "data": {
      "member": {
         "email": "{string}",  
         "post": "{string}",
         "gender": "{string}",
         "birth_date": "{string}",
         "birth_place": "{string}",
         "name": {
            "first": "{string}",
            "middle": "{string}",
            "last": "{string}"
         },
         "mobile_phone": "{string}",
         "passport": {
            "type": "{string}",
            "serial": "{string}",
            "number": "{string}",
            "date": "{string}",
            "unit": "{string}",
            "comment": "{string}"
         },
         "snils": "{string}", 
         "citizenship": "{string}"
      },
      "ogrn": "{string}",
      "short_name": "{string}",
      "owner": {
         "name": {
            "first": "{string}",
            "middle": "{string}",
            "last": "{string}"
         }
       },
       "full_name": "{string}", 
       "legal_address": {
          "postal_code": "{string}",
          "region": {number},
          "city": "{string}",
          "area": "{string}",
          "settlement": "{string}",
          "street": "{string}",
          "house": "{string}",
          "block": "{string}",
          "building": "{string}",
          "flat": "{string}"
       },
       "kpp": "{string}",
       "inn": "{string}"
   },

   "status": "{string}",
   "message": "{string}",
   "id": {number}    
}
  • data
    Данные заявки.
    • member
      Информация о подписанте.
      • gender

        Пол. Возможные значения:

        • 0 — неизвестно;
        • 1 — мужчина;
        • 2 — женщина;
        • 9 — без пола.
      • citizenship
        Гражданство (код страны в формате ISO 3166-1 alpha-3(англ.)).
      • birth_date
        Дата рождения.
      • birth_place
        Место рождения.
      • name
        ФИО.
        • first
          Имя.
        • middle
          Отчество.
        • last
          Фамилия
      • post
        Занимаемая должность подписанта.
      • qualification

        Код квалификации КСКПЭП. Возможные значения:

        • 1 — директор;
        • 2 — бухгалтер;
        • 3 —директор и бухгалтер.
      • snils
        Номер СНИЛС.
      • mobile_phone
        Номер телефона подписанта. Необходим для получения оповещений о выпуске КСКПЭП и пароля для активации сессий электронной подписи.
      • email
        Адрес электронной почты подписанта.
      • passport
        Документ, удостоверяющего личность.
        • type

          Вид документа.

          Возможные значения
          • 21 — Паспорт гражданина РФ.
          • 10 — Паспорт иностранного гражданина.
          • 12 — Вид на жительство.
          • 14 — Временное удостоверение личности гражданина РФ.
          • 23 — Свидетельство о рождении, выданное уполномоченным органом иностранного государства.
          • 7 — Военный билет офицера запаса.
          • 01 — Паспорт гражданина СССР.
          • 02 — Загранпаспорт гражданина СССР.
          • 03 — Свидетельство о рождении.
          • 04 — Удостоверение личности.
          • 05 — Справка об освобождении.
          • 06 — Паспорт Минморфлота.
          • 07 — Военный билет.
          • 09 — Дипломатический паспорт гражданина РФ.
          • 11 — Свидетельство о регистрации ходатайства иммигранта о признании его беженцем.
          • 13 — Удостоверение беженца.
          • 22 — Загранпаспорт гражданина РФ.
          • 26 — Паспорт моряка.
          • 91 — Иные документы, выдаваемые органами МВД.
          • 15 — Разрешение на временное проживание лица без гражданства в Российской Федерации.
        • serial
          Серия.
        • number
          Номер.
        • date
          Дата выдачи.
        • unit
          Код подразделения.
        • comment
          Кем выдан.
    • ogrn
      ОГРН компании.
    • short_name
      Сокращенное название компании.
    • owner
      Информация о владельце компании.
      • name
        ФИО.
        • first
          Имя.
        • middle
          Отчество.
        • last
          Фамилия
      • based_on
        Действует на основании.
    • full_name
      Полное название компании.
    • legal_address
      Юридический адрес компании.
      • postal_code
        Почтовый индекс.
      • region
        Код региона.
      • city
        Город.
      • area
        Область.
      • settlement
        Поселение.
      • street
        Улица.
      • house
        Дом.
      • block
        Корпус.
      • building
        Строение.
      • flat
        Квартира.
    • inn
      ИНН компании.
    • kpp
      КПП компании.
  • status
    Статус заявки. Возможные значения:
    • ready_to_send — заявка создана и готова к отправке;
    • sending_queued — заявка отправлена;
    • waiting_response — заявка находится на рассмотрении;
    • error — ошибка. Описание ошибки содержится в параметре message;
    • ok — КСКПЭП изменен в соответствии с заявкой.
  • message
    Причина возврата заявки со статусом error.
  • id
    Идентификатор заявки на изменение КСКПЭП.

Коды ответа

Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.

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

Метод и адрес:

PATCH https://api.ofd.yandex.net/v1/companies/693/signs/245

Заголовки:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json

Тело:

{
    "mobile_phone": "+79175085043"
}
Пример запроса в формате cURL
curl -X PATCH \
  https://api.ofd.yandex.net/v1/companies/693/signs/245 \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d ' {
 	"mobile_phone": "+79175085043"
 }'

Ответ:

{
    "data": {
        "member": {
            "email": "mail@example.com",
            "post": "Бухгалтер",
            "gender": "0",
            "birth_date": "11.11.1980",
            "birth_place": "г. Москва, Российская Федерация",
            "name": {
                "middle": "Ивановна",
                "first": "Мария",
                "last": "Иванова"
            },
            "mobile_phone": "+79175085043",
            "passport": {
                "date": "11.11.2015",
                "serial": "1111",
                "type": "21",
                "unit": "111-111",
                "comment": "Отделением УФМС России",
                "number": "111111"
            },
            "snils": "126-885-793 15",
            "citizenship": "RUS"
        },
        "ogrn": "1027739596686",
        "short_name": "ООО Тест",
        "owner": {
            "name": {
                "middle": "Ивановна",
                "first": "Мария",
                "last": "Иванова"
            }
        },
        "full_name": "Общество с ограниченной ответственностью Тест",
        "legal_address": {
            "postal_code": "119034",
            "street": "ул Льва Толстого",
            "building": "2",
            "house": "16",
            "city": "Москва",
            "region": 77
        },
        "inn": "9605642994",
        "kpp": "999999999"
    },
    "status": "sending_queued",
    "message": null,
    "id": 365
}