Перейти к основному содержимому

Запросить код подписания (УНЭП)

POST 
/api/v1/clients/:clientId/documents/:documentId/sign/nqes

Описание метода​

Инициализирует процесс подписания документа в системе. В результате должно быть отправлено СМС с кодом на номер телефон, который был указан при выпуске сертификата пользователя.

Валидации запроса​

  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа должен соответствовать формату UUID.
  • Тело запроса задано.
  • Клиент существует, не удалён, и к нему относится пользователь, выполняющий операцию.
  • Документ с заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. должен существовать.
  • Документ должен относиться к заданному клиенту.
  • Документ не является «Согласием на установление КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ.».
  • Документ не является базовым.
  • Документ не является черновиком.
  • Документ не удален.
  • Подписанты документа находятся в корректном состоянии для подписания.
  • Сертификат типа УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа. у пользователя по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сертификата должен существовать.
  • Сертификат пользователя не должен быть аннулирован.
  • Сертификат пользователя не истек.
  • Пользователь не имеет подтверждённой задачи на смену канала подписания УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа. в нетерминальной стадии.
  • Активных подтверждений подписания документа не должно существовать.
  • Правила проверки для провайдера выполнены.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. документа.
  • IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента соответствует формату UUID.
  • По заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента существует клиент.
  • Пользователь, выполняющий операцию, относится к клиенту.
  • Проверяет, что документ существует по заданным IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает документ, если он существует.
  • Проверяет, что документ относится к заданному клиенту.
  • Проверяет, что документ не является «Согласием на установление КЭДОКЭДО Кадровый электронный документооборот — подвид ЭДО для кадровых документов (трудовые договоры, приказы, заявления). Регулируется статьями 22.1–22.3 ТК РФ.».
  • Проверяет существование сертификата типа УНЭПУНЭП Усиленная неквалифицированная электронная подпись (CLOUD_NQES). Облачная подпись, обеспечивающая целостность документа. у пользователя по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. сертификата.
  • Проверяет, что сертификат пользователя не аннулирован.
  • Проверяет, что сертификат пользователя не истёк.
  • Проверяет, что не существует активных подтверждений подписания документа.
  • Проверяет, что текущий пользователь относится к заданному клиенту и возвращает пользователя клиента, если он существует.
  • Проверяет, что IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента, заданный в виде строки, соответствует формату, и возвращает типизированный IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. клиента.
  • Проверяет существование клиента по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. и возвращает клиента, если он существует.
  • Проверяет, что клиент не удален.
  • Проверяет существование документа по заданному IDid Внутренний идентификатор сущности в формате UUID, генерируемый HRlink при создании. Неизменяемый, используется во всех внутренних операциях. во внешней системе и возвращает документ, если он существует.
  • Проверяет существование заданного сертификата для заданного пользователя и возвращает данные сертификата, если он существует.

Request​

Responses​

Успешная операция.