B2B

Получение списка самозанятых, загруженных в систему

Пром GET https://baas.alfabank.ru/api/semp/v1/selfemployed/lists

Песочница GET https://sandbox.alfabank.ru/api/semp/v1/selfemployed/lists

Scope

as-operation-with-selfemployed

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

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

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

Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

QUERY
Атрибут
Описание
fromDate
stringoptional

Дата загрузки кандидата в систему, с

toDate
stringoptional

Дата загрузки кандидата в систему, по

limit
integeroptional

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

offset
integeroptional

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

Пример запроса
curl -X GET https://baas.alfabank.ru/api/semp/v1/selfemployed/lists?fromDate=2021-06-30&toDate=2023-08-02&limit=1&offset=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token} \
  -H 'Content-Type: application/json' 

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

Пример ответа 200 (OK)
{
    "pagination": {
        "limit": 1,
        "offset": 0,
        "totalCount": 2
    },
    "selfemployedAccount": [
        {
            "selfemployed": {
                "personalInformation": {
                    "vatin": "089469330539",
                    "patronymic": "Аврелиевич",
                    "name": "Принцип",
                    "surname": "Ценный"
                },
                "phone": "79984109128",
                "birthDate": "1986-11-02",
                "birthPlace": "Г. Иркутск",
                "citizenship": "RU",
                "passport": {
                    "series": "3308",
                    "number": "198466",
                    "dateOfIssue": "2022-06-01",
                    "codeOfIssue": "226-339",
                    "authority": "ОУФМС РОССИИ"
                },
                "address": "Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110",
                "email": "IvanovIvan@mail.ru"
            },
            "status": "FAILED",
            "createdDate": "2023-04-26T12:54:30.046253+03:00",
            "updatedDate": "2023-10-18T12:36:17.100279+03:00"
        }
    ]
}

objectoptional

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

limit
integeroptional

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

offset
integeroptional

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

totalCount
integeroptional

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

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 - Киргизия

array of objectoptional

Паспорт

objectoptional

Паспорт гражданина РФ. Передается если citizenship равен RU

series
stringoptional

Серия паспорта РФ

number
stringoptional

Номер паспорта РФ

dateOfIssue
stringoptional

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

codeOfIssue
stringoptional

Код подразделения, выдавшего паспорт

authority
stringoptional

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

objectoptional

Паспорт иностранного гражданина. Передается если citizenship равен BY, AM, KZ, KG

number
stringoptional

Номер паспорта иностранного гражданина

dateOfIssue
stringoptional

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

dateOfExpiry
stringoptional

Дата окончания действия паспорта

authority
stringoptional

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

address
stringoptional

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

email
stringoptional

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

objectoptional

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

type
stringoptional

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

number
stringoptional

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

dateOfEffective
stringoptional

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

dateOfExpiry
stringoptional

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

status
stringoptional

Статус самозанятого в системе. Принимает возможные значения: NEW - Принят для последующей обработки; IN_PROGRESS - В обработке; READY - Самозанятый успешно добавлен в систему; FAILED - Ошибка при добавлении в систему; FAILED_SIGNATURE - Подпись не валидна; FAILED_BIND - Самозанятым отклонен запрос на передачу прав Альфа-Банку; FAILED_REGISTRATION - Постановка на учет отклонена ФНС; FAILED_CHECK_TAXPAYER_STATUS - Получен непредвиденный ответ при проверке статуса в ФНС; FAILED_VERIFY - Ошибка в процессе проверки данных самозанятого; FAILED_AGREEMENT - Соглашение с Альфа-Банком не подписано самозанятым; TECHNICAL_ERROR - Техническая ошибка; BIND_REQUESTED - В процессе передачи прав - самозанятый должен подтвердить передачу прав Альфа-Банку в приложении ФНС Мой Налог; REGISTRATION_REQUESTED - В ФНС отправлен запрос на регистрацию; AGREEMENT_SIGNED - Соглашение подписано; PASSPORT_CHECKED - Паспорт проверен; CLIENT_DATA_CHECKED - Персональные данные проверены; TAXPAYER_STATUS_REQUESTED - В ФНС отправлен запрос на проверку статуса самозанятого; TAXPAYER_UNREGISTERED - Самозанятый снят с учета в ФНС; TAXPAYER_UNBOUND - Самозанятым не предоставлены права Альфа-Банку в ФНС; TAXPAYER_REGISTERED - Самозанятый поставлен на учет в ФНС; SIGNATURE_CHECKED - Подпись проверена; TAXPAYER_ALREADY_BOUND - Самозанятым предоставлены права Альфа-Банку в ФНС; TAXPAYER_ALREADY_REGISTERED - Самозанятый уже был поставлен на учет в ФНС

updatedDate
stringoptional

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

createdDate
stringoptional

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

objectoptional

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

field
stringoptional

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

message
stringoptional

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

Пример ответа 200 (OK)
{
    "pagination": {
        "limit": 1,
        "offset": 0,
        "totalCount": 2
    },
    "selfemployedAccount": [
        {
            "selfemployed": {
                "personalInformation": {
                    "vatin": "089469330539",
                    "patronymic": "Аврелиевич",
                    "name": "Принцип",
                    "surname": "Ценный"
                },
                "phone": "79984109128",
                "birthDate": "1986-11-02",
                "birthPlace": "Г. Иркутск",
                "citizenship": "RU",
                "passport": {
                    "series": "3308",
                    "number": "198466",
                    "dateOfIssue": "2022-06-01",
                    "codeOfIssue": "226-339",
                    "authority": "ОУФМС РОССИИ"
                },
                "address": "Иркутская область Г. Иркутск ул. Ленина д.25 кв. 110",
                "email": "IvanovIvan@mail.ru"
            },
            "status": "FAILED",
            "createdDate": "2023-04-26T12:54:30.046253+03:00",
            "updatedDate": "2023-10-18T12:36:17.100279+03:00"
        }
    ]
}

error
stringrequired

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

error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
{
  "error": "invalid_request",
  "error_description": "Authorization header is not present in request headers"
}
error
stringrequired

Код ошибки. Принимает возможные значения: invalid_token - Предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам

error_description
stringoptional

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

Пример ошибки 401 (Unauthorized)
{
  "error": "invalid_token",
  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
}
error
stringrequired

Код ошибки. Принимает возможные значения: insufficient_scope - У пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope; access_denied - Доступ к счету запрещен

error_description
stringoptional

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

Пример ошибки 403 (Forbidden)
{
  "error": "insufficient_scope",
  "error_description": "The request requires higher privileges than provided by the access token"
}
Нет тела ответа
error
stringrequired

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

error_description
stringoptional

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

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

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