Получить продукт Рейтинг ЮЛ

Обновлено 20 февраля 2025

GET

/rating/partner

Получить продукт Рейтинг ЮЛ

Запрос

Query Parameters

legal_inn

string

required

Значение должно соответствовать регулярному выражению ^(([0-9]{12})|([0-9]{10}))$

ИНН ЮЛ, рейтинг которого запрашивает Партнер

model_id

integer

required

Возможные значения: >= 1 и <= 5

Модель продукта

Header Parameters

x-Introspect-RqUID

string

required

Значение должно соответствовать регулярному выражению ^(([0-9]|[a-f]|[A-F]){32})$

Уникальный идентификатор запроса

RqUID

string

Значение должно соответствовать регулярному выражению ^(([0-9]|[a-f]|[A-F]){32})$

Уникальный идентификатор

Ответы

• 200
• 206
• 400
• 401
• 403
• 404
• 405
• 429
• 500
• 503

ОК

• application/json

• Схема
• Пример из схемы

Schema

• Array [

legal_inn

string

required

Значение должно соответствовать регулярному выражению ^(([0-9]{12})|([0-9]{10}))$

ИНН ЮЛ

legal_info

object

Информация по продукту рейтинг ЮЛ

legal_name

string

required

Возможные значения: <= 600 characters, Value must match regular expression ^[^{}]+$

Наименование ЮЛ, рейтинг которого запрашивают

additional_info

object

Дополнительная информация о ЮЛ

segment

string

Возможные значения: <= 100 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9,+&"': ._()/-]+$

Сегмент

industry

string

Возможные значения: <= 500 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9,+&"': ._()/-]+$

Отрасль

address_registered

string

Возможные значения: <= 700 characters, Value must match regular expression ^[^{}#%]+$

Юридический адрес

forecast_financial_conditions

object

Блок Прогноз финансового состояния

light

string

Возможные значения: [Green, YellowGreen, Yellow, Orange, Red, Grey]

Общая оценка блока Прогноз финансового состояния

value

string

required

Возможные значения: <= 400 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9,+&"':;% \._()/-]+$

Текстовое описание блока Прогноз финансового состояния

rating

object

Рейтинг ЮЛ

light

string

Возможные значения: [Green, YellowGreen, Yellow, Orange, Red, Grey]

Общая оценка значения Рейтинга

value

string

required

Возможные значения: <= 4 characters, Value must match regular expression ^[0-9.,]+$

Значение рейтинга

valuation_date

string

required

Возможные значения: <= 20 characters, Value must match regular expression ^[0-9]{4}-(0[1-9]|1[012])-(0[1-9]|1[0-9]|2[0-9]|3[01])$

Дата расчета рейтинга

recommendation_array

object[]

Possible values: >= 1, <= 3

Array [

category_recommendation

object

Категория рекомендаций

category_recommendation_code

string

Возможные значения: <= 100 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9., _/-:]+$

Код категории рекомендации

category_recommendation_priority

integer

Возможные значения: >= 0 и <= 10

Приоритет категории рекомендации

category_recommendation_text

string

Возможные значения: <= 100 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9., _/-:]+$

Название категории рекомендации

recommendation

object[]

Possible values: >= 1, <= 10

Рекомендация

Array [

recommendation_code

string

Возможные значения: <= 100 characters, Value must match regular expression ^[a-zA-Z0-9., _/-]+$

Код категории рекомендации

recommendation_priority

integer

Возможные значения: >= 0 и <= 50

Приоритет рекомендации

recommendation_text

string

Возможные значения: <= 400 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9., ;%\_/()-:]+$

Текст рекомендации

]

]

badges_array

object[]

Possible values: >= 1, <= 3

Array [

category_badges

object

Категория бейджей

category_badges_code

string

Возможные значения: <= 100 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9., _/-:]+$

Код категории badges

category_badges_priority

integer

Возможные значения: >= 0 и <= 10

Приоритет категории badges

category_badges_text

string

Возможные значения: <= 100 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9., _/-:]+$

Текст категории badges

badges

object[]

Possible values: >= 1, <= 10

Badges

Array [

badges_code

string

Возможные значения: <= 100 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9., _/-:]+$

Код badges

badges_priority

integer

Возможные значения: >= 0 и <= 50

Приоритет badges

badges_name

string

Возможные значения: <= 400 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9., _/-:]+$

Наименование badges

]

]

status

object

Статус сообщения, заполняется в случае ошибки

status_code

string

required

Возможные значения: <= 4 characters, Value must match regular expression ^[0-9]+$

Код статуса ошибки

status_desc

string

required

Возможные значения: <= 400 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9,+&'':\[\] ._()/-]+$

Успешное завершение задачи/Successful

• ]

[
  {
    "legal_inn": "8473637383",
    "legal_info": {
      "legal_name": "ОАО Ромашка",
      "additional_info": {
        "segment": "Офисы",
        "industry": "Строительство",
        "address_registered": "г. Москва, ул. Пушкина, д.5"
      },
      "forecast_financial_conditions": {
        "light": "Green",
        "value": "Благоприятный прогноз финансового состояния на ближайшие 5 лет"
      },
      "rating": {
        "light": "Green",
        "value": "9",
        "valuation_date": "2021-01-03"
      },
      "recommendation_array": [
        {
          "category_recommendation": {
            "category_recommendation_code": "rec_1",
            "category_recommendation_priority": 1,
            "category_recommendation_text": "Рекомендация",
            "recommendation": [
              {
                "recommendation_code": "recm_debt_burden",
                "recommendation_priority": 1,
                "recommendation_text": "Рекомендация"
              }
            ]
          }
        }
      ],
      "badges_array": [
        {
          "category_badges": {
            "category_badges_code": "Код категории",
            "category_badges_priority": 1,
            "category_badges_text": "Категория badges 1",
            "badges": [
              {
                "badges_code": "active_user",
                "badges_priority": 1,
                "badges_name": "Активный пользователь продуктов Сбербанка"
              }
            ]
          }
        }
      ]
    },
    "status": {
      "status_code": "200",
      "status_desc": "Ok"
    }
  }
]

не найдено согласие по данному клиенту

• application/json

• Схема
• Пример из схемы

Schema

GetRatingPartnerRs

object

Формат ошибочного сообщения

x-introspect-rquid

string

required

Значение должно соответствовать регулярному выражению ^(([0-9]|[a-f]|[A-F]){32})$

уникальный идентификатор

status

object

required

Статус сообщения, заполняется в случае ошибки

status_code

string

required

Возможные значения: <= 4 characters, Value must match regular expression ^[0-9]+$

Код статуса ошибки

status_desc

string

required

Возможные значения: <= 400 characters, Value must match regular expression ^[а-яА-ЯеЁa-zA-Z0-9,+&'':\[\] ._()/-]+$

Успешное завершение задачи/Successful

{
  "GetRatingPartnerRs": {
    "x-introspect-rquid": "f97790c799fb31db9c98fd8e2141c147",
    "status": {
      "status_code": "200",
      "status_desc": "Ok"
    }
  }
}

Bad Request

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "400",
  "httpMessage": "Bad Request",
  "moreInformation": "Bad Request"
}

Unauthorized

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "401",
  "httpMessage": "Unauthorized",
  "moreInformation": "Unauthorized"
}

Forbidden

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "403",
  "httpMessage": "Forbidden",
  "moreInformation": "Forbidden"
}

Not Found

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "404",
  "httpMessage": "Not Found",
  "moreInformation": "Not Found"
}

Method Not Allowed

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "405",
  "httpMessage": "Method Not Allowed",
  "moreInformation": "Method Not Allowed"
}

Too Many Requests

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "429",
  "httpMessage": "Too Many Requests",
  "moreInformation": "Too Many Requests"
}

Internal Server Error

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "500",
  "httpMessage": "Internal Server Error",
  "moreInformation": "Internal Server Error"
}

Service Unavailable

• application/json

• Схема
• Пример из схемы

Schema

httpCode

string

required

Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$

Код ошибки

httpMessage

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Описание ошибки

moreInformation

string

required

Возможные значения: <= 50 characters, Value must match regular expression ^(.*)$

Дополнительная информация

{
  "httpCode": "503",
  "httpMessage": "Service Unavailable",
  "moreInformation": "Service Unavailable"
}

Loading...

Loading...