Финансовый скоринг БКИ¶

finScoringBki¶

Тип HTTP запроса: POST

URL вызова: https://api.id-x.org/idx/api2/finScoringBki

Поддерживаются следующие форматы передачи параметров:

JSON, Content-Type: application/json
Form submit, Content-Type: application/x-www-form-urlencoded

Параметры:

Параметр	Тип	Обязательный	Описание
accessKey	String	Да	Ключ доступа, выданный при регистрации в Системе IDX
secretKey	String	Да	Секретный ключ, выданный при регистрации в Системе IDX
firstName	String	Да	Имя
lastName	String	Да	Фамилия
midName	String	Нет	Отчество (при наличии)
birthDate	String	Да	Дата рождения в формате dd.MM.yyyy
passportNumber	String	Да	Номер паспорта, серия и номер слитно без разделителей
passportDate	String	Да	Дата выдачи паспорта в формате dd.MM.yyyy
phone	String	Да	Телефонный номер в формате 7XXXAAABBCC
consentFlag	Boolean	Да	Признак наличия согласия на обработку персональных данных физлица (true – есть согласие, false – нет согласия)
consentDate	String	Да	Дата получения согласия на обработку. Формат даты – ДД.ММ.ГГГГ
consentResponsibilityFlag	Boolean	Да	Признак осведомленности об ответственности за нарушение правил сбора согласия на обработку персональных данных (true – осведомлен, false – не осведомлен)

Функция возвращает:

Параметр	Тип	Обязательный	Описание
resultCode	Int	Да	Результат выполнения функции (0 – успешное завершение функции, -100 – данные не найдены, иные значения – ошибка выполнения)
resultMessage	String	Нет	Сообщение об ошибке
operationToken	String	Нет	Уникальный идентификатор операции
errorText	String	Нет	Текст ошибки
status	String	Да	Статус
score	Integer	Да	Скоринг балл. Подробнее см. расшифровка скоринг балла
probability	Double	Да	Вероятность дефолта по кредитам. Под "дефолтом" понимается просрочка 90 и более дней, возникающая в течение 12 месяцев после выдачи займа
exclusionCode	String	Нет	Код исключения. Подробнее см. коды исключений

Пример вызова:

POST /idx/api2/finScoringBki
Host: api.id-x.org
Content-Type: application/json
Accept: application/json

{
    "accessKey": "выданный accessKey",
    "secretKey": "выданный secretKey",
    "lastName": "Иванов",
    "firstName": "Иван",
    "midName": "Иванович",
    "birthDate": "27.03.1990",
    "passportNumber": "1234567890",
    "passportDate": "27.03.2010",
    "phone": "79991112233",
    "consentFlag": true,
    "consentDate": "10.10.2020",
    "consentResponsibilityFlag": true
}

Пример успешного ответа:

{
        "resultCode": 0,
        "resultMessage": " ",
        "operationToken": "b75d654330d0486ba7dac462984ef92b",
        "status": "success",
        "score": 500,
        "probability": 0.032136907
}

Пример неуспешного ответа:

{
        "resultCode": -100,
        "resultMessage": "Информация не найдена",
        "operationToken": "7ba83ae3196441c296a7aded3c34e725",
        "status": "SUBJECT_NOT_FOUND",
        "score": 0,
        "probability": 0.0
}

Расшифровка значений скорингового балла¶

Скоринг	Кредитный Рейтинг
>650	Хороший
600-650	Средний
550-600	Плохой
1-550	Крайне плохой
0	Информация не найдена

Коды исключений¶

Код исключения	Описание
0	Ошибок и исключений нет. Расчет скорингового балла произведен
1	Системная ошибка. При однократном получении такой ошибки, повторите запрос. Если ошибка повторяется, незамедлительно сообщите ее код и текст в службу поддержки
2	Субъект помечен в БД как скончавшийся. Расчет скорингового балла производиться не будет
3	Подозрение на мошенничество. Обнаружена информация, указывающая на возможное мошенничество. Расчет скорингового балла производиться не будет
4, 5	В кредитном отчете недостаточно информации для расчета скорингового балла. Расчет производиться не будет. Рекомендуется оценка платежеспособности субъекта другими средствами
6	Информация устарела. Данные в кредитном отчете обновлялись слишком давно. Расчет скорингового балла производиться не будет. Рекомендуется оценка платежеспособности субъекта другими средствами