Песочница
GET https://sandbox.alfabank.ru/api/loans/jp/v1/applications/{applicationId}/files/upload-links
Пром
GET https://baas.alfabank.ru/api/loans/jp/v1/applications/{applicationId}/files/upload-links
Scope
loan-applications
Описание
Метод позволяет получить ссылки для загрузки документов по кредитной заявке в Банк.
Для загрузки файла необходимо выполнить HTTP-запрос методом, указанным в параметре method , по полученной в параметре url ссылке. Время жизни ссылки составляет 1 час.
Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Bearer {access_token}, полученный по Client Credentials Flow
Accept
stringrequired
application/json
PATH
Атрибут
Описание
applicationId
stringrequired
Идентификатор кредитной заявки, полученный в ответе метода «Создание заявки на кредит»
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/loans/jp/v1/applications/{applicationId}/files/upload-links' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
Пример ответа 200 (OK)
1{
2 "uploadFileLinks": [
3 {
4 "url": "https://baas.alfabank.ru/filebox/secure-file-transfer.incoming-files.to-processing/12345678-90ab-cdef-1234-1234567890ab?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8",
5 "method": "PUT",
6 "type": "BORROWER_CONSENT_FORM"
7 }
8 ]
9}
BODY
атрибут
описание
array of objectsoptional
Ссылки для загрузки файлов в Банк
url
stringrequired
Ссылка для загрузки файла
method
stringrequired
Метод, используемый для загрузки файла
type
stringrequired
Тип документа для загрузки. Принимает возможные значения:
-
•
BORROWER_PASSPORT- паспорт заёмщика -
•
BORROWER_CONSENT_FORM- анкета-согласие заёмщика -
•
GUARANTOR_CONSENT_FORM- анкета-согласие поручителя -
•
BORROWER_CONSENT_FORM_SIGNATURE- подпись анкеты-согласия заёмщика -
•
GUARANTOR_CONSENT_FORM_SIGNATURE- подпись анкеты-согласия поручителя
Пример ответа 200 (OK)
1{
2 "uploadFileLinks": [
3 {
4 "url": "https://baas.alfabank.ru/filebox/secure-file-transfer.incoming-files.to-processing/12345678-90ab-cdef-1234-1234567890ab?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230608T152952Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=secure-file-transfer%2F20230608%2Fdev%2Fs3%2Faws4_request&X-Amz-Signature=36ef1ccf28bdf6e54710fc3c1dd235c8f383275c2bbb0c9db365da272d3c24a8",
5 "method": "PUT",
6 "type": "BORROWER_CONSENT_FORM"
7 }
8 ]
9}
BODY
атрибут
описание
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}
BODY
атрибут
описание
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}
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
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}
BODY
атрибут
описание
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}
Нет тела ответа
BODY
атрибут
описание
error
stringrequired
Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional
Описание ошибки
Пример ошибки 500 (Internal Server Error)
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}
Нет тела ответа