Подписание заявки с помощью кода из СМС

Песочница

PUT https://sandbox.alfabank.ru/api/jp/v3/signature/requests/operations/{id}

Пром

PUT https://baas.alfabank.ru/api/jp/v3/signature/requests/operations/{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

Атрибут

Описание

code

stringrequired

Одноразовый код

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

Язык

1curl --location --globoff --request PUT 'https://baas.alfabank.ru/api/jp/v3/signature/requests/operations/{id}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "code": "64303380"
7}'

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

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

1{
2  "id": "c7eed091-fad4-4d15-a4a6-ec1e2de95292",
3  "isSigned": true,
4  "requestId": "62550ef50163785f2222707e",
5  "requestType": "issueRsaCertificate"
6}

BODY

атрибут

описание

stringrequired

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

isSigned

booleanrequired

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

requestId

stringrequired

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

requestType

stringrequired

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

•
issueRsaCertificate - тип заявки на выпуск RSA-сертификата;
•
activationRsaCertificate - тип заявки на активацию способа подписи RSA-сертификатом;
•
currentSignTypeRsa - тип заявки на изменение текущего способа подписи на RSA;
•
currentSignTypeQes - тип заявки на изменение текущего способа подписи на КЭП;
•
switchRsaCertificate - тип заявки на переключение на другой RSA-сертификат;
•
reissueRsaCertificate - тип заявки на перевыпуск RSA-сертификата;
•
revocationRsaCertificate - тип заявки на отзыв RSA-сертификата

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

1{
2  "id": "c7eed091-fad4-4d15-a4a6-ec1e2de95292",
3  "isSigned": true,
4  "requestId": "62550ef50163785f2222707e",
5  "requestType": "issueRsaCertificate"
6}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

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

error_description

stringoptional

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

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

1{
2  "error": "invalid_request",
3  "error_description": "Authorization header is not present in request headers"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•
invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description

stringoptional

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

Пример ошибки 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 - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope;
•
access_denied - доступ к счёту запрещён

error_description

stringoptional

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

Пример ошибки 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

Код ошибки. Принимает возможные значения:

•
unknown_endpoint - эндпоинт не найден или неактивен

error_description

stringoptional

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

Пример ошибки 404 (Not Found)

1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

•
Not valid pkcs10 DN - невалидный DN

error_description

stringoptional

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

Пример ошибки 422 (Unprocessable Entity)

1{
2  "error": "Not valid pkcs10 DN",
3  "error_description": "Wrong dn [DN(firstName=Евстафий, lastName=Жданов, fullName=Жданов Евстафий Юльевич, country=RU, area=Ленинградская обл., city=null, address=null, email=User513@pochtochka.com)] from pkcs10 for user [XBOXWG]"
4}

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

BODY

атрибут

описание

error

stringrequired

Код ошибки. Принимает возможные значения:

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

error_description

stringoptional

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

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

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

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

Значения параметров ошибок могут изменяться. Рекомендуем предусмотреть стандартную обработку ошибок, не описанных в текущей версии документации.