Получить список заявок на создание КСКПЭП

Возвращает список заявок на создание КСКПЭП.

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

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

GET https://api.ofd.yandex.net/{v1}/applications/sign_regs
Path-параметры
v1Номер версии API ОФД.

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

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

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

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

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

[
  {
    "id": {number},
    "message": "{string}",
    "status": "{string}", 
    "data": {
      "kpp": "{string}",
      "legal_address": {
        "postal_code": "{string}",
        "region": {number},
        "city": "{string}",
        "area": "{string}",
        "settlement": "{string}",
        "street": "{string}",
        "house": "{string}",
        "block": "{string}",
        "building": "{string}",
        "flat": "{string}"
      },        
      "member": {
        "gender": "{string}",
        "citizenship": "{string}",
        "birth_date": "{string}",
        "birth_place": "{string}",
        "name": {
          "first": "{string}",
          "middle": "{string}",
          "last": "{string}"
        },
        "post": "{string}",
        "qualification": "{string}",
        "snils": "{string}",
        "mobile_phone": "{string}",
        "email": "{string}",
        "passport": {
          "type": "{string}",
          "serial": "{string}",
          "number": "{string}",
          "date": "{string}",
          "unit": "{string}",
          "comment": "{string}"
        }
      },
      "owner": {
        "name": {
          "first": "{string}",
          "middle": "{string}",
          "last": "{string}"
        },
        "based_on": "{string}"
      },
      "short_name": "{string}",
      "full_name": "{string}",
      "inn": "{string}" 
    },
    "application_doc": {
      "id": {number},
      "created_at": "{string}",
      "status": "{string}"
    },
    "passport_doc": {
      "id": {number},
      "created_at": "{string}",
      "status": "{string}"
    },
    "selfie_doc": {
      "id": {number},
      "created_at": "{string}",
      "status": "{string}"
    },
    "certificate_doc": {
      "id": {number},
      "created_at": "{string}",
      "status": "{string}"
    },
    "sign_id": {number}
  }
]
id

Идентификатор заявки.

message

Причина возврата заявки со статусом error.

status
Статус заявки. Возможные значения:
  • waiting_response — заявка находится на рассмотрении в сервисе получения электронной подписи;
  • error — ошибка. Описание ошибки содержится в параметре message;
  • ok — КСКПЭП создан;
  • need_documents — необходимо загрузить скан-копии документов в Яндекс.ОФД;
  • need_certificate — необходимо загрузить скан-копию подписанного сертификата Яндекс.ОФД;
  • ready_to_send_documents — заявка готова к отправке на сервис получения электронной подписи;
  • ready_to_send_certificate — скан-копия подписанного сертификата готова к отправке на сервис получения электронной подписи.
data

Данные заявки.

kpp

КПП компании.

legal_address *

Юридический адрес компании.

postal_code

Почтовый индекс.

region

Код региона.

city

Город.

area

Область.

settlement

Поселение.

street

Улица.

house

Дом.

block

Корпус.

building

Строение.

flat

Квартира.

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

Кем выдан.

owner *

Информация о владельце компании.

name

ФИО.

first

Имя.

middle

Отчество.

last

Фамилия

based_on

Действует на основании.

short_name

Сокращенное название компании.

full_name

Полное название компании.

inn *

ИНН компании. Является уникальным в рамках партнера.

application_doc

Информация о подписанной скан-копии заявки на создание КСКПЭП.

id

Идентификатор.

created_at

Дата загрузки документа.

status

Статус. Возможное значение — sent — документ загружен в систему Яндекс.ОФД.

passport_doc

Информация о скан-копии паспорта подписанта.

id

Идентификатор.

created_at

Дата загрузки документа.

status

Статус. Возможное значение — sent — документ загружен в систему Яндекс.ОФД.

selfie_doc

Информация о скан-копии фотографии подписанта с паспортом.

id

Идентификатор.

created_at

Дата загрузки документа.

status

Статус. Возможное значение — sent — документ загружен в систему Яндекс.ОФД.

certificate_doc

Информация о подписанной скан-копии сертификата КСКПЭП.

id

Идентификатор.

created_at

Дата загрузки документа.

status

Статус. Возможное значение — sent — документ загружен в систему Яндекс.ОФД.

sign_id

Идентификатор КСКПЭП. Возвращается, если КСКПЭП уже получен.

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

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

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

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

Ответ:

[
    {
        "status": "need_documents",
        "application_doc": null,
        "data": {
            "legal_address": {
                "building": "2",
                "street": "ул Садовническая",
                "city": "Москва",
                "house": "82",
                "flat": "916",
                "region": 77,
                "postal_code": "115035"
            },
            "full_name": "Общество с ограниченной ответственностью Тест",
            "ogrn": "1027739596686",
            "kpp": "999999999",
            "member": {
                "post": "Бухгалтер",
                "mobile_phone": "70123456789",
                "snils": "111-111-111 11",
                "gender": "0",
                "email": "mail@example.com",
                "birth_date": "11.11.1111",
                "birth_place": "г. Москва, Российская Федерация",
                "citizenship": "RUS",
                "passport": {
                    "type": "21",
                    "serial": "1111",
                    "date": "11.11.1111",
                    "comment": "Отделением УФМС России",
                    "unit": "111-111",
                    "number": "111111"
                },
                "name": {
                    "last": "Иванов",
                    "middle": "Иванович",
                    "first": "Иван"
                }
            },
            "inn": "9604340310",
            "owner": {
                "name": {
                    "last": "Иванов",
                    "middle": "Иванович",
                    "first": "Иван"
                }
            },
            "short_name": "ООО Tест"
        },
        "id": 343,
        "message": null,
        "selfie_doc": null,
        "passport_doc": null
    }
]