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

Песочница

POST https://sandbox.alfabank.ru/api/jp/v2/signature/users/{sub}/qes/requests

Пром

POST https://baas.alfabank.ru/api/jp/v2/signature/users/{sub}/qes/requests

Scope

signature

Описание

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

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

HEADERS

Атрибут

Описание

Authorization

stringrequired

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

•

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

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

stringrequired

application/json

PATH

Атрибут

Описание

sub

stringrequired

Идентификатор субъекта, полученный при декодировании access_token. Как декодировать access_token, описано здесь

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

Язык

1curl --location --globoff --request POST 'https://baas.alfabank.ru/api/jp/v2/signature/users/{sub}/qes/requests' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'

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

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

1{
2  "id": "63160a37e27edd0c316567a6",
3  "type": "enableQesSignType",
4  "status": "CREATED",
5  "createdBy": "Дмитриев Денис Михайлович",
6  "createdAt": "2022-09-05T14:39:51.197Z"
7}

BODY

атрибут

описание

stringoptional

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

type

stringoptional

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

•

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

status

stringoptional

Статус заявки. Принимает возможные значения:

•

CREATED - создана

createdBy

stringoptional

ФИО создателя заявки

createdAt

stringoptional

Дата создания заявки в формате ISO 8601

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

1{
2  "id": "63160a37e27edd0c316567a6",
3  "type": "enableQesSignType",
4  "status": "CREATED",
5  "createdBy": "Дмитриев Денис Михайлович",
6  "createdAt": "2022-09-05T14:39:51.197Z"
7}

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 - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

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}

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