Подписание заявки на подключение КЭП

Песочница

PATCH https://sandbox.alfabank.ru/api/jp/v3/signature/qes/requests/{Id}

Пром

PATCH https://baas.alfabank.ru/api/jp/v3/signature/qes/requests/{Id}

Scope

signature

Описание

Метод позволяет подписать заявку на подключение квалифицированной электронной подписи (КЭП). Перед использованием метода необходимо отправить заявку на подпись.

Параметры запроса

HEADERS

Атрибут

Описание

Authorization

stringrequired

Возможны два варианта:

•

Bearer {access_token}, полученный по Authorization Code Flow / Authorization Code Flow H2H
•

ApiKey {API Key}, полученный через Портал разработчика

stringrequired

application/json

Content-Type

stringrequired

application/json

PATH

Атрибут

Описание

stringrequired

Идентификатор заявки, полученный с помощью метода «Создание заявки на подключение КЭП»

BODY

Атрибут

Описание

requestType

stringrequired

Тип заявки. Возможные значения:

•

enableQesSignType - заявка на подключение способа подписи КЭП

signature

stringrequired

Значение электронной подписи с вложенным сертификатом, закодированное в base64 с помощью ПО программы-криптопровайдера - «КриптоПро CSP»

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

Язык

1curl --location --globoff --request PATCH 'https://baas.alfabank.ru/api/jp/v3/signature/qes/requests/{Id}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "requestType": "enableQesSignType",
7  "signature": "c2lnbmF0dXJlX2V4YW1wbGVfc3RyaW5n"
8}'

Параметры ответа

Пример ответа 200 (OK)

1{
2  "Id": "63160a37e27edd0c316567a6",
3  "requestType": "enableQesSignType",
4  "isSigned": true
5}

BODY

атрибут

описание

stringrequired

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

requestType

stringrequired

Тип заявки. Возможные значения:

•

enableQesSignType - заявка на подключение способа подписи КЭП

isSigned

booleanrequired

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

Пример ответа 200 (OK)

1{
2  "Id": "63160a37e27edd0c316567a6",
3  "requestType": "enableQesSignType",
4  "isSigned": true
5}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Возможные значения:

•

invalid_request - неверные входные параметры запроса

error_description

stringrequired

Описание ошибки

Пример ошибки 400 (Bad Request)

1{
2  "error": "invalid_request",
3  "error_description": "Parameter \\\"sub\\\" is not valid"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Возможные значения:

•

invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию

error_description

stringrequired

Описание ошибки

Пример ошибки 401 (Unauthorized)

1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Возможные значения:

•

insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent

error_description

stringrequired

Описание ошибки

Пример ошибки 403 (Forbidden)

1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}

Нет тела ответа

BODY

атрибут

описание

error

stringrequired

Код ошибки. Возможные значения:

•

internal_error - внутренняя ошибка сервиса при выполнении обработки запроса

error_description

stringrequired

Описание ошибки

Пример ошибки 500 (Internal Server Error)

1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}

Нет тела ответа