B2BH2H

Получение статуса самозанятого из ФНС

Песочница
GET https://sandbox.alfabank.ru/api/semp/v1/selfemployed/taxpayer-statuses/{requestId}
Пром
GET https://baas.alfabank.ru/api/semp/v1/selfemployed/taxpayer-statuses/{requestId}
Scope

as-selfemployed-fts-status

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

HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringoptional

application/json

PATH
Атрибут
Описание
requestId
stringrequired

Уникальный идентификатор запроса

QUERY
Атрибут
Описание
limit
integeroptional

Количество объектов на одной странице

offset
integeroptional

Количество объектов в списке, которые необходимо пропустить

Пример запроса
1curl -X GET https://baas.alfabank.ru/api/semp/v1/selfemployed/taxpayer-statuses/4e817e78-5876-4608-a873-bcc141454045?limit=1000&offset=0 \
2  -H 'Accept: application/json' \
3  -H 'Authorization: Bearer {access-token}' \
4  -H 'Content-Type: application/json'

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

Пример ответа 200 (ОК)
1{
2  "pagination": {
3    "limit": 1000,
4    "offset": 0,
5    "totalCount": 10000
6  },
7  "requestId": "4e817e78-5876-4608-a873-bcc141454045",
8  "externalId": "a607d9aC-5BFC-dFC1-b8AE-A7AEB9F1D44d",
9  "taxpayerStatusList": [
10    {
11      "vatin": "112233445566",
12      "status": "TAXPAYER_BOUND"
13    }
14  ]
15}
objectoptional

Данные пагинации

limit
integeroptional

Количество записей на одной странице

offset
integeroptional

Количество записей в списке, которые были пропущены

totalCount
integeroptional

Общее количество записей

requestId
stringoptional

Уникальный идентификатор запроса

externalId
stringoptional

Внешний идентификатор запроса, переданный Клиентом

array of objectoptional

Список статусов самозанятого

vatin
stringoptional

ИНН самозанятого

status
stringoptional

Статус самозанятого в ФНС. Принимает возможные значения: TAXPAYER_BOUND - налогоплательщик состоит на учёте в налоговом органе в качестве самозанятого и передал права банку; TAXPAYER_UNBOUND - самозанятый не привязан к банку-партнёру; TAXPAYER_UNREGISTERED - налогоплательщик не стоит на учёте как самозанятый

Пример ответа 200 (ОК)
1{
2  "pagination": {
3    "limit": 1000,
4    "offset": 0,
5    "totalCount": 10000
6  },
7  "requestId": "4e817e78-5876-4608-a873-bcc141454045",
8  "externalId": "a607d9aC-5BFC-dFC1-b8AE-A7AEB9F1D44d",
9  "taxpayerStatusList": [
10    {
11      "vatin": "112233445566",
12      "status": "TAXPAYER_BOUND"
13    }
14  ]
15}
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}
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}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - при запросе кода авторизации не были переданы все необходимые scopes. Необходимо переподписать договор согласия, повторно отправив запрос на получение кода авторизации с указанием всех доступных scopes и параметра prompt=consent; 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}
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}
Нет тела ответа
error
stringrequired

Код ошибки. Принимает возможные значения: internal_error - внутренняя ошибка сервиса при выполнении обработки запроса

error_description
stringoptional

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

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_error",
3  "error_description": "Internal server error"
4}
Нет тела ответа

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