B2BH2H

Получение статуса добавления самозанятых в систему

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

as-operation-with-selfemployed

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

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/registries/add-selfemployed/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  "listStatus": "NEW",
10  "createdDate": "2023-03-28T10:22:08.076Z",
11  "selfemployedAccount": [
12    {
13      "selfemployed": {
14        "personalInformation": {
15          "vatin": "112233445566",
16          "surname": "Иванов",
17          "name": "Иван",
18          "patronymic": "Иванoвич"
19        },
20        "phone": "79130000011",
21        "birthDate": "2000-03-02",
22        "birthPlace": "Г. Иркутск",
23        "citizenship": "RU",
24        "passport": {
25          "series": "6953",
26          "number": "987435",
27          "dateOfIssue": "2022-03-02",
28          "codeOfIssue": "123-321",
29          "authority": "ОВД Иркутской области по Г. Иркутску по Октябрьскому району"
30        },
31        "address": "Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110",
32        "email": "IvanovIvan@mail.ru",
33        "idCard": {
34          "type": "migrationCard",
35          "number": "1234567",
36          "dateOfEffective": "2022-03-02",
37          "dateOfExpiry": "2024-03-02"
38        }
39      },
40      "status": "READY",
41      "updatedDate": "2023-03-28T10:22:08.076Z",
42      "errorRecord": [
43        {
44          "field": "Наименование поля в котором возникла ошибка",
45          "message": "Описание ошибки"
46        }
47      ]
48    }
49  ],
50  "error": {
51    "code": "Код ошибки",
52    "message": "Описание ошибки"
53  }
54}
objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

requestId
stringoptional

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

externalId
stringoptional

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

listStatus
stringoptional

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

  • •
    NEW - принят для последующей обработки;
  • •
    SUCCESS - успешно обработан;
  • •
    ERROR - ошибка в процессе обработки;
  • •
    IN_PROGRESS - в процессе обработки;
  • •
    TECHNICAL_ERROR - непредвиденная техническая ошибка;
  • •
    SIGNATURE_CHECKED - реестр прошёл проверку подписи (промежуточный статус)
createdDate
stringoptional

Дата и время создания запроса в системе

array of objectoptional

Список самозанятых

array of objectoptional

Данные самозанятого

objectoptional

Персональные данные самозанятого

vatin
stringoptional

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

surname
stringoptional

Фамилия

name
stringoptional

Имя

patronymic
stringoptional

Отчество

phone
stringoptional

Телефон

birthDate
stringoptional

Дата рождения

birthPlace
stringoptional

Место рождения

citizenship
stringoptional

Гражданство. Принимает возможные значения: RU - РФ; BY - Беларусь; AM - Армения; KZ - Казахстан; KG - Киргизия; UA - Украина

objectoptional

Паспорт

series
stringoptional

Серия паспорта РФ. Передаётся, если citizenship равен RU

number
stringoptional

Номер паспорта РФ (если citizenship равен RU) / Номер паспорта иностранного гражданина (если citizenship равен BY, AM, KZ, KG, UA)

dateOfIssue
stringoptional

Дата выдачи паспорта

codeOfIssue
stringoptional

Код подразделения, выдавшего паспорт. Передаётся, если citizenship равен RU

dateOfExpiry
stringoptional

Дата окончания действия паспорта. Передаётся, если citizenship равен BY, AM, KZ, KG, UA

authority
stringoptional

Орган, выдавший документ

address
stringoptional

Адрес проживания

email
stringoptional

Адрес электронной почты

array of objectoptional

Документ, подтверждающий право проживания на территории РФ. Передаётся, если citizenship равен AM, KZ, KG, UA

type
stringoptional

Тип документа, подтверждающего право проживания на территории РФ. Принимает возможные значения: residencePermit - вид на жительство; residenceCertificate - документ, удостоверяющий проживание; migrationCard - миграционная карта

number
stringoptional

Номер документа, подтверждающего право проживания

dateOfEffective
stringoptional

Дата начала действия документа, подтверждающего право проживания

dateOfExpiry
stringoptional

Дата окончания действия документа, подтверждающего право проживания

status
stringoptional

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

  • •
    Промежуточные статусы: NEW - принят для последующей обработки; IN_PROGRESS - в обработке; BIND_REQUESTED - в процессе передачи прав. Самозанятый должен подтвердить передачу прав Альфа-Банку в приложении ФНС «Мой Налог». Опрос статуса результата передачи прав выполняется 5 раз в день: в 10:00, 14:00, 16:00, 18:00, 20:00 МСК; REGISTRATION_REQUESTED - запрос на регистрацию отправлен в ФНС; AGREEMENT_SIGNED - соглашение подписано; PASSPORT_CHECKED - паспорт проверен; CLIENT_DATA_CHECKED - персональные данные проверены; TAXPAYER_STATUS_REQUESTED - запрос на проверку статуса самозанятого отправлен в ФНС; TAXPAYER_REGISTERED - самозанятый поставлен на учёт в ФНС; SIGNATURE_CHECKED - подпись проверена; TAXPAYER_ALREADY_BOUND - самозанятым предоставлены права Альфа-Банку в ФНС; TAXPAYER_ALREADY_REGISTERED - самозанятый уже был поставлен на учёт в ФНС; REGISTRATION_IN_PROGRESS - в процессе регистрации.
  • •
    Финальные статусы: READY - самозанятый успешно добавлен в систему; FAILED - ошибка при добавлении в систему; FAILED_SIGNATURE - подпись невалидна; FAILED_BIND - самозанятым отклонён запрос на передачу прав Альфа-Банку; FAILED_REGISTRATION - постановка на учёт отклонена ФНС; FAILED_CHECK_TAXPAYER_STATUS - получен непредвиденный ответ при проверке статуса в ФНС; FAILED_VERIFY - ошибка в процессе проверки данных самозанятого; FAILED_AGREEMENT - соглашение с Альфа-Банком не подписано самозанятым; TECHNICAL_ERROR - техническая ошибка; TAXPAYER_UNREGISTERED - самозанятый снят с учёта в ФНС; TAXPAYER_UNBOUND - самозанятым не предоставлены права Альфа-Банку в ФНС; REGISTRATION_RATE_EXCEEDED - превышен лимит регистраций
updatedDate
stringoptional

Дата и время обновления статуса самозанятого в системе

array of objectoptional

Ошибки обработки записей списка

field
stringoptional

Наименование поля, в котором возникла ошибка

message
stringoptional

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

objectoptional

Ошибки обработки загруженного списка

code
stringoptional

Код ошибки

message
stringoptional

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

Пример ответа 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  "listStatus": "NEW",
10  "createdDate": "2023-03-28T10:22:08.076Z",
11  "selfemployedAccount": [
12    {
13      "selfemployed": {
14        "personalInformation": {
15          "vatin": "112233445566",
16          "surname": "Иванов",
17          "name": "Иван",
18          "patronymic": "Иванoвич"
19        },
20        "phone": "79130000011",
21        "birthDate": "2000-03-02",
22        "birthPlace": "Г. Иркутск",
23        "citizenship": "RU",
24        "passport": {
25          "series": "6953",
26          "number": "987435",
27          "dateOfIssue": "2022-03-02",
28          "codeOfIssue": "123-321",
29          "authority": "ОВД Иркутской области по Г. Иркутску по Октябрьскому району"
30        },
31        "address": "Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110",
32        "email": "IvanovIvan@mail.ru",
33        "idCard": {
34          "type": "migrationCard",
35          "number": "1234567",
36          "dateOfEffective": "2022-03-02",
37          "dateOfExpiry": "2024-03-02"
38        }
39      },
40      "status": "READY",
41      "updatedDate": "2023-03-28T10:22:08.076Z",
42      "errorRecord": [
43        {
44          "field": "Наименование поля в котором возникла ошибка",
45          "message": "Описание ошибки"
46        }
47      ]
48    }
49  ],
50  "error": {
51    "code": "Код ошибки",
52    "message": "Описание ошибки"
53  }
54}
Нет тела ответа
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}
Нет тела ответа

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

Добавление самозанятых в системуПовторное прикрепление самозанятого к партнёру