Получение статуса справки о подтверждающих документах

Обновлено 27 мая 2025

GET

/v1/confirmatory-documents-inquiries/{externalId}/state

Для получения статуса СПД необходимо отправить GET-запрос /fintech/api/v1/confirmatory-documents-inquiries/{externalId}/state с токеном доступа (access_token) пользователя в параметре Authorization заголовка и идентификатором документа (externalId) в path-параметре.

В параметре scope ссылки авторизации пользователя должен быть указан сервис CONFIRMATORY_DOCUMENTS_INQUIRY для получения доступа к этому запросу.

Запрос

Ответы

• 200
• 400
• 401
• 403
• 429
• 500
• 503

OK

bankStatus (string)	Значение
Промежуточный / Продолжать опрашивать
CREATED	Создан
SIGNED	Подписан
DELIVERED	Доставлен
**POSTPONED	В работе ВК
ACCEPTED	Принят
**EXPORTED	Выгружен
TRIED_BY_CFE	Проверяется ВК
ACCEPTED_BY_ABS	Принят АБС
Окончательные статусы/Прекратить опрос
CHECKERROR	Ошибка контроля
REFUSEDBYABS	Отказан АБС
REFUSED_BY_CFE	Отказан ВК
Окончательные(Успешные) статусы/Прекратить опрос
ACCEPTED_BY_CFE	Принят ВК

"Ошибка в запросе или его жизненном цикле"

Cause	Message	Description
DESERIALIZATION_FAULT	Неверный формат запроса	Данные в request указаны в неправильном формате. Атрибуты request, в которых найдены ошибки, указаны в responce в массиве fields с описанием проблемы. Описание типа, формата и regexp атрибутов находится в request ресурса. Скорректируйте заполнение атрибутов и повторите запрос.
WORKFLOW_FAULT	Документ с такими реквизитами уже существует	В АС Банка также присутствует проверка на дублирование документов по полям. Если поля совпадают с уже существующим в банке документом, то такой документ получает статус "bankStatus": "CHECKERROR", а комментарий "bankComment": "Документ с такими реквизитами уже существует."
VALIDATION_FAULT	Ошибка валидации	Данные не соответствуют требованиям валидации. Сведения о некорректных атрибутах request содержатся в массивах fieldNames и checks. Подробные требования к атрибутам описаны в request ресурса, включая типы, форматы и регулярные выражения. Необходимо скорректировать заполнение атрибутов и повторить запрос.

"Не авторизован"

Cause	Message	Description
UNAUTHORIZED	accessToken not found by value =хххххххх-хххх-хххх-хххх-хххххххххххх-х	Указан просроченный access_token. Используйте refresh_token для обновления access_token и повторите запрос.
	Некорректное значение Access Token	Указан некорректный access_token. Используйте refresh_token для обновления access_token и повторите запрос.

"Запрещено"

Cause	Message	Description
ACTION_ACCESS_EXCEPTION	Операция не может быть выполнена: доступ к ресурсу запрещен	Используемый в запросе access_token не имеет разрешения на доступ к нужному сервису Sber API. В ссылке авторизации СберБизнес ID, в параметре scope, не указана операция CONFIRMATORY_DOCUMENTS_INQUIRY. Пользователю потребуется пройти авторизацию заново. Вы получите новые токены access_token и refresh_token. Сделайте повторный запрос с новым access_token.

"Превышен лимит запросов"

Cause	Message	Description
TOO_MANY_REQUESTS	Превышен лимит запросов. Повторите операцию позже.	Количество запросов к данному методу за ограниченное время превысило допустимое значение. Пользователю необходимо повторить запрос позднее

"Внутренняя ошибка сервера"

Cause	Message	Description
UNKNOWN_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

"Сервис временно недоступен"

Cause	Message	Description
UNAVAILABLE_RESOURCE_EXCEPTION	Внутренняя ошибка сервера	Сделайте повторный запрос. Если ошибка повторится, подготовьте логи запроса и направьте в службу Технической поддержки Банка.

Loading...

Loading...