B2B

Получение оценки благонадёжности контрагента

Песочница
GET https://sandbox.alfabank.ru/api/mathmod-scorings/jp/v1/compliance
Пром
GET https://baas.alfabank.ru/api/mathmod-scorings/jp/v1/compliance
Scope

mathmod-scorings

Описание

Метод позволяет получить оценку благонадёжности юридического лица или ИП по комплаенс-риску. Результат содержит числовое значение вероятности применения комплаенс-мер, уровень риска (low, medium, high) и пороговые границы между зонами риска. Расчёт проводится на основе открытых источников и помогает клиентам понять, насколько безопасно взаимодействие с контрагентом перед началом сотрудничества или открытием ему счёта.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

QUERY
Атрибут
Описание
inn
stringrequired

ИНН организации или индивидуального предпринимателя.

  • •
    Для ЮЛ - 10 цифр;
  • •
    Для ИП - 12 цифр
Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/mathmod-scorings/jp/v1/compliance?inn={inn}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "inn": "7735123456",
3  "rawScore": 0.2094234,
4  "riskLevel": "low",
5  "boundaries": {
6    "low": 0.32,
7    "high": 0.65
8  }
9}
BODY
атрибут
описание
inn
stringrequired

ИНН организации или индивидуального предпринимателя

rawScore
numberrequired

Вероятность применения комплаенс-мер (от 0 до 1)

riskLevel
stringrequired

Уровень риска. Возможные значения:

  • •
    low - клиент демонстрирует устойчивые признаки благонадёжности;
  • •
    medium - показатели благонадёжности в пределах допустимых значений, требуется дополнительная проверка;
  • •
    high - высокий риск применения комплаенс-мер
objectrequired

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

low
numberoptional

Граница перехода уровня риска с low на medium

high
numberoptional

Граница перехода уровня риска с medium на high

Пример ответа 200 (OK)
1{
2  "inn": "7735123456",
3  "rawScore": 0.2094234,
4  "riskLevel": "low",
5  "boundaries": {
6    "low": 0.32,
7    "high": 0.65
8  }
9}
BODY
атрибут
описание
error
stringrequired

Код ошибки. Принимает возможные значения:

  • •
    invalid_request - неверные входные параметры запроса (например, невалидный ИНН)
error_description
stringoptional

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

Пример ошибки 400 (Bad Request)
1{
2  "error": "invalid_request",
3  "error_description": "Parameter inn is not valid"
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."
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

Код ошибки. Принимает возможные значения:

  • •
    not_found - организация не найдена
error_description
stringoptional

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

Пример ошибки 404 (Not Found)
1{
2  "error": "not_found",
3  "error_description": "Company not found"
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}
Нет тела ответа