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

Формат запроса
- Заголовок запроса
- Тело запроса
Формат ответа
Коды ответа
Пример запроса

Внимание

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

Создает заявку в системе Яндекс ОФД на формирование [КСКПЭП]{*КСКПЭП}.

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

POST https://api.ofd.yandex.net/{v1}/applications/sign_regs

v1

Номер версии API ОФД.

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

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

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

Тело запроса

{
  "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}"
  },
  "inn": "{string}",
  "pin_code": "{string}"
}

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 —директор и бухгалтер.
- 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

Действует на основании.
inn * ИНН компании.
pin_code * Пин-код ОФД (6 знаков). Назначается подписантом. Используется при регистрации кассы в ФНС ( запрос Отправить пин-код).

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

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

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

{
  "status": "{string}",
  "application_doc": {
     "id": {number},
     "created_at": "{string}",
     "status": "{string}"
  },
  "data": {
    "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}",        
    "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}" 
  },
  "id": {number},
  "message": "{string}",
  "selfie_doc": {
    "id": {number},
    "created_at": "{string}",
    "status": "{string}"
  },
  "passport_doc": {
    "id": {number},
    "created_at": "{string}",
    "status": "{string}"
  }
}

status
Статус заявки. Возможные значения:
- waiting_response — заявка находится на рассмотрении в сервисе получения электронной подписи;
- error — ошибка. Описание ошибки содержится в параметре message;
- ok — КСКПЭП создан;
- need_documents — необходимо загрузить скан-копии документов в Яндекс ОФД;
- need_certificate — необходимо загрузить скан-копию подписанного сертификата Яндекс ОФД;
- ready_to_send_documents — заявка готова к отправке на сервис получения электронной подписи;
- ready_to_send_certificate — скан-копия подписанного сертификата готова к отправке на сервис получения электронной подписи.
application_doc
Информация о подписанной скан-копии заявки на создание КСКПЭП.
- id
  
  Идентификатор.
- created_at
  
  Дата загрузки документа.
- status
  
  Статус. Возможное значение — sent — документ загружен в систему Яндекс ОФД.
data
Данные заявки.
- legal_address
  
  Юридический адрес компании.
  
  postal_code
  
  Почтовый индекс.
  
  region
  
  Код региона.
  
  city
  
  Город.
  
  area
  
  Область.
  
  settlement
  
  Поселение.
  
  street
  
  Улица.
  
  house
  
  Дом.
  
  block
  
  Корпус.
  
  building
  
  Строение.
  
  flat
  
  Квартира.
- kpp
  
  КПП компании.
- 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
  
  ИНН компании.
id

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

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

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

- id

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

- created_at

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

- status

Статус. Возможное значение — sent — документ загружен в систему Яндекс ОФД.
selfie_doc
Информация о скан-копии фотографии подписанта с паспортом.
- id
  
  Идентификатор.
- created_at
  
  Дата загрузки документа.
- status
  
  Статус. Возможное значение — sent — документ загружен в систему Яндекс ОФД.

Коды ответа

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

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

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

POST https://api.ofd.yandex.net/v1/applications/sign_regs

Заголовки:

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

Тело:

{
   "legal_address": {
      "postal_code": "115035",
      "region": 77,
      "city": "Москва",
      "street": "ул Садовническая",
      "house": "82",
      "building": "2",
      "flat": "916"
    },
   "member": {
    "gender": "0",
    "citizenship": "RUS",
    "birth_date": "11.11.1111",
    "birth_place": "г. Москва, Российская Федерация",
    "name": {
      "first": "Иван",
      "middle": "Иванович",
      "last": "Иванов"
    },
    "post": "Бухгалтер",
    "snils": "111-111-111 11",
    "mobile_phone": "+70123456789",
    "email": "mail@example.com",
    "passport": {
      "type": "21",
      "serial": "1111",
      "number": "111111",
      "date": "11.11.1111",
      "unit": "111-111",
      "comment": "Отделением УФМС России"
    }
  },
  "inn": "9604340310",
  "pin_code": "123456"
}

Пример запроса в формате cURL

curl -X POST \
  https://api.ofd.yandex.net/v1/applications/sign_regs \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
   "legal_address": {
      "postal_code": "115035",
      "region": 77,
      "city": "Москва",
      "street": "ул Садовническая",
      "house": "82",
      "building": "2",
      "flat": "916"
    },
   "member": {
    "gender": "0",
    "citizenship": "RUS",
    "birth_date": "11.11.1111",
    "birth_place": "г. Москва, Российская Федерация",
    "name": {
      "first": "Иван",
      "middle": "Иванович",
      "last": "Иванов"
    },
    "post": "Бухгалтер",
    "snils": "111-111-111 11",
    "mobile_phone": "+70123456789",
    "email": "mail@example.com",
    "passport": {
      "type": "21",
      "serial": "1111",
      "number": "111111",
      "date": "11.11.1111",
      "unit": "111-111",
      "comment": "Отделением УФМС России"
    }
  },
  "inn": "9604340310",
  "pin_code": "123456"
}'

Ответ:

{
    "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": "ООО Тест"
    },
    "id": 343,
    "message": null,
    "selfie_doc": null,
    "passport_doc": null
}

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

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

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

Тело запросаТело запроса

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

Коды ответаКоды ответа

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