Подписание

Электронные подписи: запросы, проверка, отзыв.

Создать запрос на подпись

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

deadline?string

Срок подписания, ISO 8601

Форматdate-time

documentId*string

Подписываемый документ

Форматuuid

documentTitle*string

Название документа для писем и списков

Длина1 <= length

enableAiSummary?boolean

Показать подписантам ИИ-сводку документа

enableComments?boolean

Разрешить комментарии подписантов

letterhead?unknown

Фирменный бланк для итогового PDF

message?string

Сообщение подписантам в приглашении

metadata?

Метаданные подписания

outputFolderId?string

Папка для подписанного документа

Форматuuid

participants*array<>

Подписанты, минимум один

Элементы1 <= items

signatureOrder?string

Порядок подписания (устаревшее поле, используйте type)

type?string

Порядок: sequential — по очереди, parallel — одновременно

Значение в"sequential" | "parallel"

`application/json`

curl -X POST "https://loading/api/v1/signatures" \  -H "Content-Type: application/json" \  -d '{    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",    "documentTitle": "string",    "participants": [      {        "email": "user@example.com",        "userId": "string",        "userName": "string"      }    ]  }'

{
  "completedAt": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deadline": "string",
  "documentId": "string",
  "documentTitle": "string",
  "id": "string",
  "message": "string",
  "participants": [
    {
      "email": "string",
      "method": "string",
      "order": 0,
      "status": "string",
      "userId": "string",
      "userName": "string",
      "property1": null,
      "property2": null
    }
  ],
  "status": "string",
  "type": "string",
  "property1": null,
  "property2": null
}

Входящие запросы на подпись

`application/json`

curl -X GET "https://loading/api/v1/signatures/inbox"

[
  {
    "completedAt": "string",
    "createdAt": "string",
    "createdBy": "string",
    "deadline": "string",
    "documentId": "string",
    "documentTitle": "string",
    "id": "string",
    "message": "string",
    "participants": [
      {
        "email": "string",
        "method": "string",
        "order": 0,
        "status": "string",
        "userId": "string",
        "userName": "string",
        "property1": null,
        "property2": null
      }
    ],
    "status": "string",
    "type": "string",
    "property1": null,
    "property2": null
  }
]

Отправленные запросы на подпись

`application/json`

curl -X GET "https://loading/api/v1/signatures/sent"

[
  {
    "completedAt": "string",
    "createdAt": "string",
    "createdBy": "string",
    "deadline": "string",
    "documentId": "string",
    "documentTitle": "string",
    "id": "string",
    "message": "string",
    "participants": [
      {
        "email": "string",
        "method": "string",
        "order": 0,
        "status": "string",
        "userId": "string",
        "userName": "string",
        "property1": null,
        "property2": null
      }
    ],
    "status": "string",
    "type": "string",
    "property1": null,
    "property2": null
  }
]

Получить запрос на подпись

`application/json`

curl -X GET "https://loading/api/v1/signatures/string"

{
  "completedAt": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deadline": "string",
  "documentId": "string",
  "documentTitle": "string",
  "id": "string",
  "message": "string",
  "participants": [
    {
      "email": "string",
      "method": "string",
      "order": 0,
      "status": "string",
      "userId": "string",
      "userName": "string",
      "property1": null,
      "property2": null
    }
  ],
  "status": "string",
  "type": "string",
  "property1": null,
  "property2": null
}

Переименовать запрос на подпись

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

documentTitle*string

Новое название подписания

Длина1 <= length

`application/json`

`application/problem+json`

curl -X PATCH "https://loading/api/v1/signatures/string" \  -H "Content-Type: application/json" \  -d '{    "documentTitle": "string"  }'

{
  "completedAt": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deadline": "string",
  "documentId": "string",
  "documentTitle": "string",
  "id": "string",
  "message": "string",
  "participants": [
    {
      "email": "string",
      "method": "string",
      "order": 0,
      "status": "string",
      "userId": "string",
      "userName": "string",
      "property1": null,
      "property2": null
    }
  ],
  "status": "string",
  "type": "string",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Удалить запрос на подпись

`application/json`

curl -X DELETE "https://loading/api/v1/signatures/string"

{
  "success": true
}

Список комментариев к подписанию

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/signatures/string/comments"

[
  {
    "authorName": "string",
    "createdAt": "string",
    "id": "string",
    "text": "string",
    "property1": null,
    "property2": null
  }
]

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Добавить комментарий (инициатор)

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

mentionedUserIds?array<>

Упомянутые через @ пользователи

text*string

Текст комментария, до 4000 символов

Длина1 <= length <= 4000

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/signatures/string/comments" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'

{
  "authorName": "string",
  "createdAt": "string",
  "id": "string",
  "text": "string",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Получить документ для предпросмотра (актуальный или подписанный snapshot)

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/signatures/string/document"

{
  "blocks": [
    {
      "indentLevel": 0,
      "label": "string",
      "number": "string",
      "text": "string",
      "type": "string"
    }
  ],
  "signings": [
    {
      "documentSnapshotHash": "string",
      "evidence": null,
      "id": "string",
      "method": "string",
      "shortId": "string",
      "signedAt": "string",
      "signerEmail": "string",
      "signerName": "string",
      "status": "string"
    }
  ],
  "source": "frozen-request",
  "title": "string"
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Дублировать запрос на подпись

`application/json`

curl -X POST "https://loading/api/v1/signatures/string/duplicate"

{
  "completedAt": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deadline": "string",
  "documentId": "string",
  "documentTitle": "string",
  "id": "string",
  "message": "string",
  "participants": [
    {
      "email": "string",
      "method": "string",
      "order": 0,
      "status": "string",
      "userId": "string",
      "userName": "string",
      "property1": null,
      "property2": null
    }
  ],
  "status": "string",
  "type": "string",
  "property1": null,
  "property2": null
}

Экспорт PDF для конкретного запроса подписания (snapshot + signings ЭТОГО request)

`application/pdf`

`application/problem+json`

curl -X GET "https://loading/api/v1/signatures/string/export/pdf"

"string"

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Отклонить подпись

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

reason?string

Причина отказа от подписания

`application/json`

curl -X POST "https://loading/api/v1/signatures/string/reject" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true
}

Отправить напоминание подписанту

`application/json`

curl -X POST "https://loading/api/v1/signatures/string/remind"

{
  "success": true
}

Отозвать подпись

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

reason?string

Причина отзыва подписания

`application/json`

curl -X POST "https://loading/api/v1/signatures/string/revoke" \  -H "Content-Type: application/json" \  -d '{}'

{
  "success": true
}

Отправить OTP-код подписанту

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/signatures/string/send-otp"

{
  "channel": "string",
  "sent": true
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Подписать документ

Тело запроса

application/json

TypeScript-определения

Используйте тип request body в TypeScript.

actions?array<>

Заполненные элементы документа

drawing?string

Рисованная подпись в base64 (для ar_sign)

method*string

Способ подписания: ar_sign — рисованная подпись, facsimile — факсимиле, ukep/unep — квалифицированная/неквалифицированная ЭП, email_code/sms_code/telegram_code/alpha_code — код подтверждения, face_id — биометрия

otpCode?string

Шестизначный код подтверждения (для *_code)

Длина6 <= length <= 6

ukepCertificate?

Данные сертификата УКЭП/УНЭП (для ukep/unep)

Тело ответа

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/signatures/string/sign" \  -H "Content-Type: application/json" \  -d '{    "method": "ar_sign"  }'

{
  "completedAt": "string",
  "createdAt": "string",
  "createdBy": "string",
  "deadline": "string",
  "documentId": "string",
  "documentTitle": "string",
  "id": "string",
  "message": "string",
  "participants": [
    {
      "email": "string",
      "method": "string",
      "order": 0,
      "status": "string",
      "userId": "string",
      "userName": "string",
      "property1": null,
      "property2": null
    }
  ],
  "status": "string",
  "type": "string",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Получить snapshot документа для подписи

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Идентификатор подписания

Тело ответа

`application/json`

`application/problem+json`

curl -X GET "https://loading/api/v1/signatures/string/snapshot-to-sign"

{
  "contentBase64": "string",
  "contentHash": "string"
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Загрузить видео верификации

Авторизация

АвторизацияBearer <токен>

В: header

Параметры пути

id*string

Идентификатор подписания

Тело запроса

multipart/form-data

TypeScript-определения

Используйте тип request body в TypeScript.

challenges?string

Выполненные challenge-задания (JSON)

video*file

Видео биометрической проверки

Форматbinary

Тело ответа

`application/json`

`application/problem+json`

curl -X POST "https://loading/api/v1/signatures/string/verification" \  -F video="string"

{
  "uploaded": true
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

{
  "code": "string",
  "detail": "string",
  "errors": [
    {
      "name": "string",
      "pointer": "string",
      "reason": "string",
      "rule": "string"
    }
  ],
  "instance": "string",
  "request_id": "string",
  "status": 0,
  "title": "string",
  "trace_id": "string",
  "type": "http://example.com",
  "property1": null,
  "property2": null
}

Подписание

201application/json

200application/json

200application/json

200application/json

200application/json

400application/problem+json

404application/problem+json

200application/json

200application/json

404application/problem+json

201application/json

400application/problem+json

404application/problem+json

200application/json

404application/problem+json

500application/problem+json

200application/json

200application/pdf

404application/problem+json

500application/problem+json

200application/json

200application/json

200application/json

200application/json

400application/problem+json

403application/problem+json

404application/problem+json

500application/problem+json

200application/json

400application/problem+json

403application/problem+json

404application/problem+json

500application/problem+json

200application/json

404application/problem+json

500application/problem+json

200application/json

400application/problem+json

404application/problem+json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/pdf`

`application/problem+json`

`application/problem+json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/json`

`application/problem+json`

`application/problem+json`