Вы находитесь на странице: 1из 47

Авторизация

Получение токена авторизации (Basic Auth)

Тип метода: POST


Домен: https://api.<domain>
Метод: /token
Пример вызова:
curl -L -X POST 'http://api. myknk.ru/token' \
-H 'Authorization: Basic YWRtaW46dHN0cGFzc3dvcmQ='

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешная авторизация
401 Unauthorized Ошибка авторизации

Описание входных данных:

Параметр Формат Описание


Отсутствуют

Описание выходных данных:

Параметр Формат Описание


access_token RS256 Токен авторизации в формате JWT
exp timestamp Действие токена (сейчас 1 час)
nbf timestamp Начало действия токена (с
момента создания)
iat timestamp Срок завершения действия токена
(сейчас через 1 час с момента
создания)
jti String Уникальный ID токена
aukey String Ключ авторизации пользователя
uid Int UID пользователя
scope String Права
time Timestamp Время запроса
Кредитная линия
Отправка согласия (создание пустой заявки кредитной линии)

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/agreement

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


201 OK Успешно создано
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
405 Method not allowed Неверный тип метода
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String Уникальный ID 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
applicationId String Уникальный ID созданной
кредитной линии
time Timestamp Время запроса
Запрос на отправку СМС для подписания согласия

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/bki-sms

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
См. ID возможных ошибок
400

401 Unauthorized Ошибка авторизации


403 Application is blocked Кредитная линия временно
заблокирована
405 Method not allowed Неверный тип метода
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


phone /(^\\ Телефонный номер 
+\\d\\-\\d{3}\\-\\d{3}\\-\\
d{2}\\-\\d{2})|(^\\
+?\\d{10,11})$/

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
errorDescription Object
errorDescription .sentAt DateTime Время отправки сообщения
errorDescription .availableAt DateTime Время повторной отправки
сообщения
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_signed
sms_is_sent
sms_check_request_error
phone_is_required
phone_is_invalid
application_rejected
not_found
application_is_blocked

Проверка кода СМС для подписания согласия

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/bki-sms-check

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
405 Method not allowed Неверный тип метода
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


code /^\d{4}$/ Код из СМС 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_signed
sms_code_not_set
sms_code_is_wrong
sms_is_required
sms_check_error
not_found
application_is_blocked
application_rejected

Заполнение дополнительных данных после подписания

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/additional

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
См. ID возможных ошибок
400
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
405 Method not allowed Неверный тип метода
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


email email Электронный почтовый 
адрес
limit Decimal(10,3) Лимит 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
email_is_required
limit_is_required
limit_must_be_num
email_is_not_valid
not_found
application_is_blocked
application_rejected

Отправка сканов паспорта (Селфи)

При загрузке сканов, загружаемому скану присваивается первоначальный статус – QUEUED.


Повторная загрузка возможна пока статус не сменился на IN_PROGRESS, смена статуса на
IN_PROGRESS происходит при загрузке последнего оставшегося скана.

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/photo/<selfie|first|second>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
См. ID возможных ошибок
400

401 Unauthorized Ошибка авторизации


403 Application is blocked Кредитная линия временно
заблокирована
405 Method not allowed Неверный тип метода
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


document Base64 Документ 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:
ID
bki_not_signed
not_found
application_is_blocked
selfie_empty_file
email_is_required
limit_is_required
wrong_mime_type
selfie_has_wrong_status
application_rejected

Отправка сканов паспорта (Разворот)

При загрузке сканов, загружаемому скану присваивается первоначальный статус – QUEUED.


Повторная загрузка возможна пока статус не сменился на IN_PROGRESS, смена статуса на
IN_PROGRESS происходит при загрузке последнего оставшегося скана.

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/photo/<selfie|first|second>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
См. ID возможных ошибок
400

401 Unauthorized Ошибка авторизации


403 Application is blocked Кредитная линия временно
заблокирована
405 Method not allowed Неверный тип метода
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


document Base64 Документ 

Описание выходных данных:


Параметр Формат Описание
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса
ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
first_empty_file
email_is_required
limit_is_required
wrong_mime_type
first_has_wrong_status
application_rejected

Отправка сканов паспорта (Регистрация)

При загрузке сканов, загружаемому скану присваивается первоначальный статус – QUEUED.


Повторная загрузка возможна пока статус не сменился на IN_PROGRESS, смена статуса на
IN_PROGRESS происходит при загрузке последнего оставшегося скана.

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/photo/<selfie|first|second>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
См. ID возможных ошибок
400

401 Unauthorized Ошибка авторизации


403 Application is blocked Кредитная линия временно
заблокирована
405 Method not allowed Неверный тип метода
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


document Base64 Документ 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
second_empty_file
email_is_required
limit_is_required
wrong_mime_type
second_has_wrong_status
application_rejected

Получение статуса по всем сканам

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/photo/status

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
status PhotoStatusesObject Объект статусов
time DateTime Время запроса
Возможные статусы изображений
Код Описание Терминальный
QUEUED Первоначальный статус при успешной загрузке
IN_PROGRESS Скан в процессе проверки (присваивается
после загрузки последнего скана)
ACCEPTED Успешная проверка
FORGERY Была предпринята попытка подделки 
DOCUMENT_TEMPLATE Поставляемые документы представляют собой 
шаблоны, загруженные из Интернета.
SPAM Спам 
SELFIE_MISMATCH Фотография пользователя (изображение 
профиля) не соответствует фото в
предоставленных документах
FOREIGNER Когда клиент не принимает кандидатов из 
другой страны или, например, без вида на
жительство
DUPLICATE Этот кандидат уже был создан для этого 
клиента, и дублирование не допускается
правилами.
WRONG_USER_REGION Когда заявителям из определенных регионов / 
стран не разрешается регистрироваться
BLACKLIST Пользователь занесен в черный список 
REGULATIONS_VIOLATIONS Нарушение правил 
INCONSISTENT_PROFILE Как женское имя с мужскими документами 
AGE_REQUIREMENT_MISMATCH Не соблюдены требования по возрасту 
(например, нельзя арендовать автомобиль
лицам младше 25 лет)
EXPERIENCE_REQUIREMENT_MIS Недостаточно опыта (например, стажа 
MATCH вождения недостаточно)
CRIMINAL Пользователь причастен к противоправным 
действиям
COMPROMISED_PERSONS Пользователь не соответствует Политике 
взломанного лица
PEP Пользователь принадлежит к категории PEP 
ADVERSE_MEDIA Пользователь был найден в неблагоприятных 
СМИ
FRAUDULENT_PATTERNS Пользователь был найден в криминальных 
сводках
SANCTIONS Пользователь попал в санкционные списки 

При терминальном статусе повторная загрузка сканов невозможна, как и продолжение создания
кредитной линии

ID возможных ошибок:

ID
not_found
application_is_blocked
application_rejected

Получение статуса по типу документа

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/photo/status/<selfie|first|second>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
photo ENUM (selfie|first|second) Тип проверяемого 
документа

Описание возможных выходных данных:


Параметр Формат Описание
result boolean Результат выполнения запроса
status PhotoStatusObject Объект статусов
time DateTime Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
not_found
application_is_blocked
information_photo_not_found
application_rejected

Получение статуса кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/status

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
status String Статус кредитной линии
statusId Integer ID статуса кредитной линии
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
not_found
application_is_blocked
information_photo_not_found
application_rejected

Создание лида кредитной линии

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/create-lead

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена
400 См. ID возможных ошибок

Описание входных данных:


Параметр Формат Описание Обязательное
uid String ID в системе ретейлера 
address String Адрес проживания 
registration_address String Адрес регистрации 
business_address String Адрес места работы 
employment_type Enum(CommercialEmploye Тип занятости 
e
|Businessman
|Unemployed
|MaternityLeave
|Laborer
|GovernmentEmployee
|Retired
|Student)
income Decimal(10,3) Доход 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
client ClientObject Объект клиента
lead_id String ID созданного лида
time DateTime Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
not_found
application_is_blocked
information_photo_not_found
wrong_application_status
income_is_required
address_is_required
employment type_is_not_in_range
income_must_be_num
income_too_small
credit_line_lead_exists
service_is_unavailable
сreating_lead_error
application_rejected
Получение информации по кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
client ClientObject Объект клиента
time DateTime Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
not_found
application_is_blocked
application_rejected
Получение договора кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/contract

Если договор был подписан, в ответе, в поле «contract», будет pdf в base64, если
нет, то будет html в base64

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
signed boolean Признак подписания договора
contract Base64 Договор в base64
time DateTime Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса
ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
contract_receive_error
contract_download_error
application_rejected

Подписание договора (отправка СМС кода) кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/contract/sign

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:


Параметр Формат Описание
result boolean Результат выполнения запроса
time DateTime Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
application_rejected

Подписание договора (проверка СМС кода) кредитной линии

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/contract/sign

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:


Параметр Формат Описание Обязательное
uid String ID в системе ретейлера 
sms /^\d{4}$/ СМС код 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time DateTime Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
credit_line_information_error
sms_code_has_been_sent
confirmation_code_send_error
sms_check_request_error
sms_check_error
wrong_sms_code
application_rejected

Получение графика по кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/schedule

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
schedule JsonObject График по траншу
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
getting_credit_line_schedule_error
application_rejected

Получение всех контрактов траншей по кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/contracts

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
schedule Массив контрактов по траншу
contractNumber – номер контракта
creationDate – дата создания
amount – сумма
JsonObject
firstPaymentDate – первая дата
погашения
endPaymentDate – крайняя дата
погашения
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
getting_credit_line_contracts_error
application_rejected
Получение всех активных контрактов траншей по кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/contracts/active

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
schedule Массив контрактов по траншу
contractNumber – номер контракта
creationDate – дата создания
amount – сумма
JsonObject
firstPaymentDate – первая дата
погашения
endPaymentDate – крайняя дата
погашения
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:
ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
getting_credit_line_contracts_error
application_rejected

Получение баланса кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/balance

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
balance Decomal(10,3) Текущий баланс
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса
ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
getting_credit_line_balance_error
application_rejected

Получение двух ближайших предстоящих платежей по кредитной линии


(платеж для досрочного погашения и ближайший платеж по графику + сумма
просрочки на текущую дату)

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/payments

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
payments JsonObject  Массив из 3-х платежей:
earlyPayment – Платеж для
досрочного погашения
 nearestPayment –
Ближайший платеж по
графику + просрочка на
текущую дату
 overduePayment – Сумма
просрочки на текущую
дату
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
getting_payments_info_error
application_rejected

Проверка возможности отказа от кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/refuse/check

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
refuse Возможность отказа от кредитной
boolean
линии
message String Описание
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
getting_credit_line_contracts_error
credit_line_has_active_contracts
credit_line_has_already_refused
application_rejected

Отказ от кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/refuse

Возможные коды ответа сервера:


Код ответа Значение Расшифровка
200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_application_status
getting_credit_line_contracts_error
credit_line_has_active_contracts
already_refused
getting_credit_line_info_error
updating_credit_line_info_error
application_rejected

Получение списка запросов увеличения лимита кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/limit

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
limit Decomal(10,3) Лимит кредитной линии
requests JsonObject Массив запросов увеличения
лимита
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
application_rejected
Проверка возможности увеличения лимита кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/limit/increase/check

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
increase boolean Возможность увеличения лимита
message String Сообщение
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
application_rejected
Увеличение лимита кредитной линии

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/limit/increase

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
limit Decimal(10,3) Лимит (значение не 
должно быть меньше
текущего лимита
кредитной линии)

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
first_transh_period_error
error_obtaining_credit_line_limit
limit_must_be_num
limit_too_small
limit_is_required
application_rejected

Получение результата увеличения лимита кредитной линии

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/increase/status

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
data JsonObject Массив с информацией
последнего результата
увеличения лимита
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса
ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
application_rejected
Транши
Создание заказа/транша

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/create

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера
period /^\d{2}$/ Период в месяцах 
amount Decimal(10,3) Сумма транша 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
period_is_required
period_must_be_int
period_is_not_in_range
application_rejected

Запрос на отправку кода подтверждения для создания заказа/транша

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/order-sms

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса
ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
sms_is_sent
order_already_signed
request_sms_error
sms_send_error
wrong_order_status
wrong_application_status
wrong_application_order_status
application_rejected

Проверка кода подтверждения для создания заказа/транша

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/order-sms

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера
code /^\d{4}$/ Код подтверждения 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
sms_was_not_sent
order_already_signed
order_already_exists
sms_send_error
sms_code_not_set
sms_code_is_wrong
creating_order_error
wrong_order_status
wrong_application_status
wrong_application_order_status
application_rejected

Одобрение транша

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/approve

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_order_status
wrong_application_status
wrong_application_order_status
application_rejected

Отклонение транша

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/deny
Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_order_status
wrong_application_status
wrong_application_order_status
order_already_canceled
Получение информации о транше

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
status String Статус транша
time Timestamp Время запроса
order OrderObject Объект заказа
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_order_status
wrong_application_status
wrong_application_order_status

Получение подписанного согласия транша

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/consent

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
consent Base64 Подписанное согласие в pdf
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_order_status
wrong_application_status
wrong_application_order_status

Получение графика по траншу

Тип метода: GET


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/schedule

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
schedule JsonObject График по траншу
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_order_status
wrong_application_status
wrong_application_order_status
error_getting_transh_schedule

Возврат по траншу

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/order/<oid>/refund/<opid>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
Кредитная линия не найдена
404 Not found
Заказа/транш не найден

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера
opid String ID операции в системе 
ретейлера
amount Decimal(10,3) Сумма возврата 

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_order_status
wrong_application_status
wrong_application_order_status
refunding_transh_error
transh_already_refunded
amount_is_required
amount_must_be_num
operation_id_has_already_been_performed
operation_id_is_required

ДДС по кредитной линии


Погашение

Тип метода: POST


Домен: https://api.<domain>
Метод: /application/<uid>/flow/repayment/<opid>

Возможные коды ответа сервера:

Код ответа Значение Расшифровка


200 OK Успешный вызов
400 См. ID возможных ошибок
405 Method not allowed Неверный тип запроса
401 Unauthorized Ошибка авторизации
403 Application is blocked Кредитная линия временно
заблокирована
404 Not found Кредитная линия не найдена

Описание входных данных:

Параметр Формат Описание Обязательное


uid String ID в системе ретейлера 
oid Integer(10) ID заказа в системе 
ретейлера
opid String ID операции в системе 
ретейлера
amount Decimal(10,3) Сумма зачисления 
pay_system /[a-zа-я\s\d]+/ui Платежная система

Описание выходных данных:

Параметр Формат Описание


result boolean Результат выполнения запроса
time Timestamp Время запроса
Или
result boolean Результат выполнения запроса
error Object
error. message String Описание ошибки
error. id String ID ошибки
time Timestamp Время запроса

ID возможных ошибок:

ID
bki_not_signed
not_found
application_is_blocked
wrong_order_status
wrong_application_status
wrong_application_order_status
getting_credit_line_contracts_error
credit_line_is_not_active
getting_credit_line_contracts_error
credit_line_has_no_active_contracts
operation_id_has_already_been_performed
operation_id_is_required
getting_credit_line_balance_error
fixed_credit_line_amounts_not_correspond
getting_credit_line_payments_error
getting_credit_line_info_error
updating_credit_line_info_error
Описание ошибок
Ошибки

credit_line_exists Кредитная линия существует


bki_signed БКИ уже подписывалось
sms_is_sent СМС недавно отправлялось
sms_send_error Ошибка отправки СМС
sms_code_not_set СМС код не указан
sms_code_is_wrong Неверный СМС код
information_photo_not_found Информация не найдена
credit_line_lead_exists Лид по кредитной линии уже создавался
service_is_unavailable Сервис временно недоступен
inn_not_found ИНН не найден
inn_not_match ИНН не соответствует
unknown_error Неизвестная ошибка
сreating_lead_error Ошибка создания лида кредитной линии
contract_receive_error Ошибка получения контракта
contract_download_error Ошибка скачивания контракта
sms_is_required СМС обязательно
wrong_sms_format Неверный формат СМС
code_was_not_sent Код для подтверждения не отправлялся
sms_check_request_error Ошибка запроса проверки СМС кода
sms_check_error Ошибка проверки СМС кода
employment type_is_required Тип занятости обязателен
employment type_is_not_in_range Неверный тип типа занятости
wrong_sms_code Неверный СМС код
credit_line_information_error Ошибка получения информации о кредитной линии
sms_code_has_been_sent СМС недавно отправлялось
confirmation_code_send_error Ошибка отправки кода подтверждения
getting_credit_line_schedule_error Ошибка получения графика платежей по кредитной
линии
getting_credit_line_contracts_error Ошибка получения контрактов кредитной линии
getting_credit_line_balance_error Ошибка получения баланса кредитной линии
getting_payments_info_error Ошибка получения информации о платежах
getting_credit_line_info_error Ошибка получения информации по кредитной
линии
updating_credit_line_info_error Ошибка обновления информации по кредитной
линии
first_transh_period_error Дата первого транша меньше 30-ти дней
application_rejected Отклонение создания кредитной линии
order_already_exists Заказ с таким номеров уже создан
error_obtaining_credit_line_limit Ошибка получения информации о балансе
кредитной линии
contract_already_signed Контракт уже был подписан
wrong_application_order_status Неверный статус кредитной линии и транша/заказа
request_sms_error Ошибка запроса отправки СМС кода
wrong_application_status Неверный статус кредитной линии
sms_was_not_sent СМС код не отправлялся
creating_order_error Ошибка создания транша/заказа
wrong_order_status Неверный статус заказа/транша
order_already_signed Транш уже подписывался
order_already_canceled Транш/заказ уже был закрыт
error_denying_transh Ошибка отказа от заказа/транша
error_getting_transh_schedule Ошибка получения графика платежей по
заказу/траншу
wrong_mime_type Неверный mime тип
refunding_transh_error Ошибка возврата заказа/транша
transh_already_refunded Заказ/транш уже был возвращен
error_getting_contract_info Ошибка получения информации о контракте
fixed_amounts_not_correspond ОС по контракту не соответствуют сумме возврата
credit_line_is_not_active Кредитная линия не активна
credit_line_has_no_active_contracts Нет активных контрактов по траншам кредитной
линии
creating_flow_error Ошибка проведения ДДС
phone_is_required Телефон обязателен
phone_is_invalid Неверный формат телефона
code_is_invalid Неверный формат кода
code_is_required Код обязателен
email_is_invalid Неверный формат почты
application_is_blocked Временно заблокировано в связи с неверным
вводом данных
email_is_required Почта обязательна
limit_must_be_num Лимит должен быть числом
limit_too_small Лимит очень мал
limit_is_required Лимит обязателен
income_must_be_num Доход должен быть числом
income_too_small Доход очень мал
income_is_required Доход обязателен
income_is_invalid Неверный формат дохода
address_is_required Адрес обязателен
registration_address_is_required Адрес регистрации обязателен
business_address_is_required Рабочий адрес обязателен
inn_is_required ИНН обязателен
Inn_format_error Неверный формат ИНН
Inn_is_invalid Неверный ИНН
selfie_empty_file Файл с селфи не может быть пустой
first_empty_file Файл с разворотом не может быть пустой
second_empty_file Файл с регистрацией не может быть пустой
birth_date_is_invalid Неверный формат даты рождения
bki_not_signed БКИ не подписывалось
issue_date_is_invalid Неверный формат даты выдачи
operation_id_has_already_been_performed Операция по этому ID уже проводилась
amount_is_required Сумма обязательна
operation_id_is_required ID операции обязателен
amount_must_be_num Сумма должена быть числом
order_id_is_required Номер заказа/транша обязателен
period_is_required Период обязателен
selfie_has_wrong_status Неверный статус скана (Изображение со статусом
IN_PROGRESS заменять нельзя)
first_has_wrong_status Неверный статус скана (Изображение со статусом
IN_PROGRESS заменять нельзя)
first_has_wrong_status Неверный статус скана (Изображение со статусом
IN_PROGRESS заменять нельзя)
period_must_be_int Период должен быть целым
period_is_not_in_range Период неверный
credit_line_has_active_contracts По кредитной линии есть активные контракты
already_refused По кредитной линии уже был отказ
cant_change_limit Изменение лимита невозможно (ошибка выдается
при попытке изменить лимит методом «/application/
{{appId}}/additional» при статусах заявки когда этого
сделать невозможно, например когда идет процесс
создания лида или корректировка лимита)