CreditRating: структура API-ответа

Описание документа: Подробное описание полей и справочников для ответа продукта финансовой благонадёжности.

Файл: ./doc_credit_rating.html. Основная документация API: ./doc.html.

Документация по API ответу

Данный документ описывает структуру и поля ответа вашего API, предоставляя подробные пояснения для каждого поля, включая справочники и возможные значения.

Содержание

1. Верхний уровень ответа

Поле Тип Описание
data Массив Содержит массив объектов с данными по каждому заказу.
request_id Целое число Идентификатор запроса.

2. Массив data

Каждый элемент массива data представляет собой объект с информацией о конкретном заказе.

Объект order_item

Поле Тип Описание
order_item_id Строка (UUID) Уникальный идентификатор элемента заказа.
product_name Строка Название продукта, связанного с заказом.
status Строка Статус обработки заказа (например, "done").
data Объект Содержит детальную информацию по заказу.

4. Объект task

Объект task содержит общую информацию о задаче и включает в себя следующие поля:

Поле Тип Описание
id Строка (UUID) Уникальный идентификатор задачи.
input_data Объект Входные данные, предоставленные для обработки.
jobs Массив Список выполненных работ в рамках задачи.

5. Объект input_data

Объект input_data содержит информацию о пользователе и другие входные параметры.

Поле Тип Обязательное Описание
first Строка Да Имя пользователя.
surname Строка Да Фамилия пользователя.
patronymic Строка Нет Отчество пользователя (если имеется).
birthday Дата Да Дата рождения пользователя в формате ISO 8601.
passport Строка Да Номер паспорта пользователя.
passport_issue_at Дата Нет Дата выдачи паспорта.
Примечание: Поля с персональными данными должны обрабатываться в соответствии с законодательством о защите персональных данных.

6. Массив jobs

Каждый элемент массива jobs представляет собой объект работы, выполненной в рамках задачи.

Актуальный контракт по jobs для API

Для продукта CreditRating при чтении результата через API сначала проверяйте поле status у job, и только потом разбирайте result.

{
  "job_name": "owner_check_individual_credit_rating",
  "status": "in_progress",
  "result": null
}
{
  "job_name": "owner_check_individual_credit_rating",
  "status": "done",
  "result": {
    "report": {
      "score": 751
    }
  }
}

Объект job

Поле Тип Описание
job_name Строка Название работы (например, "owner_check_individual_credit_rating").
status Строка Статус job. Разбирать result безопасно только при status == "done".
result object | array | null Результаты выполнения работы. В незавершённых или проблемных кейсах может приходить null.

7. Объект result

Объект result содержит информацию о результате выполнения работы.

Поле Тип Обязательное Описание
id Строка (UUID) Да Идентификатор запроса.
state Int Да Состояние запроса (см. ниже раздел "Возможные значения поля state").
reportResultType Int Да Статус результата (см. ниже раздел "Возможные значения поля reportResultType").
report Объект Нет Содержит данные отчета (если доступны).

Возможные значения поля state:

Значение Описание
0 Запрос на отчет создан.
1 Запрос на отчет обрабатывается.
2 Запрос на отчет обработан успешно.
3 Запрос на отчет завершился ошибкой.

Возможные значения поля reportResultType:

Значение Описание
1 Успешно.
2 Субъект не найден.

8. Объект report

Объект report содержит детальную информацию по результатам работы.

Поля объекта report:

Поле Тип Обязательное Описание
updateDate Дата Нет Дата обновления отчета.
score Строка Нет Значение рейтинга субъекта. Чем больше рейтинг, тем надежнее субъект. Возможно специальное значение "-1750", указывающее на отсутствие кредитной истории.
factors Массив объектов Factor Нет Факторы влияния на величину рейтинга с указанием процента влияния.
inquiries Объект Inquiry Нет Информация о запросах кредитной истории субъекта.
applications Объект Applications Нет Информация об обращениях субъекта в кредитные организации с детализацией по одобрениям и отказам.
lawsuits Int Нет Информация о наличии судебных споров или требований по обязательствам к субъекту.
completedLawsuits Int Нет Информация о судебных спорах, где вынесено судебное решение.
bankruptcy Int Нет Информация о стадии банкротства субъекта (см. справочник "Стадии банкротства").
capabilities Массив Int Нет Информация о дееспособности субъекта (см. справочник "Виды дееспособности").
credits Объект Credits Нет Информация о кредитах субъекта.

Объект Factor

Поле Тип Описание
type Int Тип фактора (см. справочник "Факторы").
weight Int Вес фактора (в процентах).

Объект Applications

Поле Тип Описание
lastTwoWeeksApprovalCount Int Количество одобренных обращений за последние 14 дней.
lastTwoWeeksRejectCount Int Количество отказов по обращениям за последние 14 дней.
lastMonthApprovalCount Int Количество одобренных обращений за последние 30 дней.
lastMonthRejectCount Int Количество отказов по обращениям за последние 30 дней.
lastTwoMonthsApprovalCount Int Количество одобренных обращений за последние 60 дней.
lastTwoMonthsRejectCount Int Количество отказов по обращениям за последние 60 дней.

Объект Inquiry

Поле Тип Описание
lastWeekCount Int Количество запросов за последние 7 дней.
lastTwoWeeksCount Int Количество запросов за последние 14 дней.
lastMonthCount Int Количество запросов за последние 30 дней.
allTimeCount Int Общее количество запросов.

Объект Credits

Объект Credits содержит информацию о кредитах субъекта.

Поле Тип Описание
worstOverdueForAllCredits Int Максимальный срок просрочки по всем кредитам (см. справочник "Overdue").
worstOverdueForActiveCredits Int Максимальный срок просрочки по активным кредитам (см. справочник "Overdue").
lastCreditCloseDate Дата Год и месяц закрытия последнего кредита.
hasBadDebtOrPassedToCollection Bool Наличие безнадежного долга или передачи на взыскание.
averagePayment Объект Range (Decimal) Размер среднего платежа по активным кредитам.
creditTypeInfos Массив объектов CreditTypeInfo Информация по типам кредитов.
activeCreditsOverdueAmountRange Объект Range (Decimal) Сумма просрочки по активным кредитам.
activeCreditsLimitAmountRange Объект Range (Decimal) Диапазон сумм активных кредитов.
activeCreditsCountRange Объект Range (Int) Диапазон количества активных кредитов.
activeCreditsAsGuaranteeCountRange Объект Range (Int) Диапазон количества счетов, где субъект выступает поручителем.

Объект Range

Объект Range используется для представления диапазона значений.

Поле Тип Описание
from T Нижняя граница диапазона.
till T Верхняя граница диапазона. Значение null трактуется как бесконечность.

Примечание: Если диапазон касается количественной информации (например, количество счетов), используется целое число. Если диапазон касается денежных сумм, используется дробное число.

Объект CreditTypeInfo

Поле Тип Описание
open Int Информация об открытых кредитах данного типа:
  • 1 - имеет открытые кредиты данного типа без просрочек
  • 2 - имеет открытые кредиты данного типа с просрочкой
  • 0 - не имеет открытых кредитов данного типа
  • null - данные отсутствуют
closed Int Информация о закрытых кредитах данного типа:
  • 1 - имеет закрытые кредиты данного типа без просрочек
  • 2 - имеет закрытые кредиты данного типа с просрочкой
  • 0 - не имеет закрытых кредитов данного типа
  • null - данные отсутствуют
type Int Тип кредита (см. справочник "Типы кредитов").

9. Справочники

Справочник Overdue

Значение Описание
0 Все неизвестные результаты.
1 Оплата без просрочек.
2 Просрочка от 1 до 7 дней.
3 Просрочка от 8 до 29 дней.
4 Просрочка от 1 до 29 дней.
5 Просрочка от 30 до 59 дней.
6 Просрочка от 60 до 89 дней.
7 Просрочка от 90 до 119 дней.
8 Просрочка от 120 до 179 дней.
9 Просрочка более 180 дней.

Справочник Факторы

Значение Описание
1 Есть просрочки.
2 Размеры просрочек.
99 Иной фактор.

Справочник Виды дееспособности

Значение Описание
1 Гражданин полностью дееспособен.

Справочник Стадии банкротства

Значение Описание
1 Заявление о признании банкротом принято судом к производству.

Справочник Типы кредитов

Значение Описание
1 Ипотека.
2 Потребительский кредит.
3 Микрофинансовая организация (МФО).

10. Примечания