Подписать заявление на регистрацию с помощью КСКПЭП

Внимание

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

Подписывает заявление на регистрацию, используя КСКПЭП подписанта.

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

POST https://api.ofd.yandex.net/{v1}/cashboxes/{cashbox_id}/registration/{registration_id}/declaration/sign
  • v1
    Номер версии API ОФД.
  • cashbox_id
    Идентификатор ККТ.
  • registration_id
    Идентификатор регистрации.

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

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

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

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

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

{
   "error_description": "{string}",
   "error_reason_doc_id": {number},
   "need_pin_code": {boolean},
   "rnm": "{string}",
   "sign_id": {number},
   "cloud_sign_id": {number},
   "signer": {
      "name": {
         "first": "{string}",
         "middle": "{string}",
         "last": "{string}"
      },
      "position": "{string}",
      "address": "{string}",
      "email": "{string}",
      "phone": "{string}"
   },
   "irud_client": "{string}",
   "error_code": {number},
   "id": {number},
   "error_message": "{string}",
   "status": "{string}",
   "rnm_card_pdf_doc_id": {number},
   "kkt_card_pdf_doc_id": {number},
   "rnm_card_xml_doc_id": {number}
 }
  • error_description
    Причина возврата заявления со статусом error.
  • error_reason_doc_id
    Идентификатор документа от ФНС с сообщением об отказе (ошибке).
  • need_pin_code
    Признак необходимости отправить пин-код.
  • rnm
    Регистрационный номер ККТ в ФНС.
  • sign_id
    Идентификатор КСКПЭП.
  • cloud_sign_id
    Идентификатор КСКПЭП. Значение соответствует параметру sign_id.
  • signer
    Данные подписанта.
    • name
      ФИО.
      • first
        Имя.
      • middle
        Отчество.
      • last
        Фамилия
    • position
      Занимаемая должность подписанта.
    • address
      Юридический адрес компании.
    • email
      Адрес электронной почты подписанта.
    • phone
      Номер телефона подписанта. Используется для получения пароля активации сессий электронной подписи.
  • irud_client
    Идентификатор регистрации в ИРУД.
  • error_code
    Код ошибки. Возможные значения см. в описании параметра error_message.
  • id
    Идентификатор регистрации ККТ в ФНС.
  • error_message

    Текст сообщения об ошибке.

    Возможные значения
    Код Сообщение Описание
    1 IRUD error Ошибка ИРУД (ошибка проверка подписей или ошибка регистрации пользователей в ИРУД).
    2 Rejected to accept declaration Заявление на регистрацию кассы не принято ЭДО (система электронного документооборота).
    3 Rejected to register Заявление на регистрацию отклонено отделением ФНС.
    4 Rejected to accept Документ не принят ЭДО.
    5 Wrong report В ЭДО передан некорректный тип документа.
    6 Wrong fiscal sign error У отчета о регистрации указан невалидный фискальный признак.
  • status

    Статус регистрации. Возможные значения:

    • wait_decl_sign — ожидание подписи заявления на регистрацию;
    • wait_irud — ожидание ответа от ИРУД (Информационный реестр участников документооборота);
    • wait_rnm — ожидание ответа от ФНС о присвоении РНМ;
    • wait_report — ожидание отчета о регистрации, сформированного посредством ККТ;
    • wait_report_sign — ожидание подписи отчета о регистрации;
    • wait_final_response — ожидание финального ответа от ФНС с карточкой ККТ;
    • finished — карточка ККТ получена;
    • error — ошибка. Описание ошибки содержится в параметре error_description.
  • rnm_card_pdf_doc_id
    Идентификатор карточки РНМ в формате pdf.
  • kkt_card_pdf_doc_id
    Идентификатор карточки ККТ в формате pdf.
  • rnm_card_xml_doc_id
    Идентификатор карточки РНМ в формате xml.

Коды ответа

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

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

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

POST https://api.ofd.yandex.net/v1/cashboxes/1029/registration/742/declaration/sign

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

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae

Пример запроса в формате cURL
curl -X POST \
  https://api.ofd.yandex.net/v1/cashboxes/1029/registration/742/declaration/sign \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca'

Ответ:

{
    "rnm_card_pdf_doc_id": 1112,
    "cloud_sign_id": 245,
    "need_pin_code": false,
    "error_message": null,
    "rnm_card_xml_doc_id": 1113,
    "rnm": 55,
    "signer": {
        "name": {
            "last": "Иванова",
            "first": "Мария",
            "middle": "Ивановна"
        },
        "email": "mail@example.com",
        "phone": "79876543210",
        "address": "{'addr_building': '2', 'addr_region_code': 77, 'addr_house': '16', 'addr_street': 'ул Льва Толстого', 'addr_city': 'Москва', 'addr_postal_code': '119034'}",
        "position": "Бухгалтер"
    },
    "error_reason_doc_id": null,
    "status": "wait_irud",
    "error_code": null,
    "error_description": null,
    "sign_id": 245,
    "id": 742,
    "kkt_card_pdf_doc_id": null,
    "irud_client": 2345
}