Получить информацию по заявке на изменение КСКПЭП

Возвращает подробную информацию по заявке на изменение КСКПЭП.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа
  4. Пример запроса

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

GET https://api.ofd.yandex.net/{v1}/applications/sign_edits/{sign_edit_id}
Path-параметры
v1Номер версии API ОФД.
sign_edit_idИдентификатор заявки на изменение КСКПЭП.

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

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

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

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

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

{
   "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

Идентификатор заявки на изменение КСКПЭП.

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

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

GET https://api.ofd.yandex.net/v1/applications/sign_edits/366
Заголовки запроса:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Пример запроса в формате cURL
curl -X GET \
  https://api.ofd.yandex.net/v1/applications/sign_edits/366 \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca'

Ответ:

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