Описание структуры запроса и ответа
Обновлено 20 декабря 2023
Описание элементов структуры запроса
В таблице описаны правила и пояснения к заполнению элементов тела запроса. Данные правила дополняют правила валидации, определенные на уровне схемы.
В описании используются следующие термины и допущения:
Участник сделки (УС) - Юридическое лицо (ЮЛ) или Индивидуальный предприниматель (ИП), деловая репутация которых подлежит оценке.
Сделка- уровень группировки УС для получения комплексной оценки деловой репутации в целом по всей группе УС как сторон договора.
| Элемент | Кратность | Комментарий к заполнению |
|---|---|---|
| srvGetCreditHistoryAndFraudScoreRq | ||
| header | [1] | Заголовочная часть |
| rqUid | [1] | Уникальный идентификатор сообщения |
| rqTm | [1] | Дата и время передачи сообщения |
| SPName | [1] | Идентификатор системы-источника запроса |
| storageTime | [0..1] | Время жизни запроса (сек) |
| request | [1] | Данные запроса |
| dealInfo | [1] | Информация по сделке |
| ids | [0..1] | Идентификаторы сделки |
| externalId | [0..1] | Внешний ID Правило формирования ID назначается для каждого потребителя индивидуально, его значение зависит от общей методологии оценки. Для согласования методологии отправьте запрос по почте на адрес SKIF@sberbank.ru |
| creationDateTime | [0..1] | Дата создания сделки |
| scoreRules | [0..1] | Наименование набора правил Набор правил назначается для каждого потребителя индивидуально, его значение зависит от общей методологии оценки. Для согласования методологии отправьте запрос по почте на адрес SKIF@sberbank.ru |
| participants | [1] | Участники сделки |
| participant | [1..40] | Участник сделки |
| index | [0..1] | Индекс участника, уникальный для каждого участника в рамках одного запроса. |
| ids | [0..1] | Идентификаторы участника |
| externalId | [0..1] | Внешний ID Правило формирования ID назначается для каждого потребителя индивидуально, его значение зависит от общей методологии оценки. Для согласования методологии отправьте запрос по почте на адрес SKIF@sberbank.ru |
| rolesList | [0..1] | Список ролей участника в сделке |
| role | [1] | Роль участника в сделке "Варианты: "1" - Заемщик "2" - Созаемщик "4" - Поручитель "5" - Залогодатель "8" - Дополнительный поручитель "9" - Руководитель "12" - Лизингополучатель "13" - Учредитель ФЛ "14" - Подписант "15" - Приемщик ПЛ "16" - Поставщик "17" - Учредитель ЮЛ "18" - Генеральный директор "21" - Участник ГСЛ "24" - Потенциальный поручитель "25" - Участник юридического лица "26" - Участник и руководитель "27" - Дублер ИП "28" - Участник-бенефициар " |
| status | [0..1] | Статус в сделке Варианты: "0" - Не определен "1" - Собственник "2" - Не собственник "3" - Учредитель "4" - Руководитель "5" - Сотрудник |
| scoreRules | [0..1] | Наименование набора правил Набор правил назначается для каждого потребителя индивидуально, его значение зависит от общей методологии оценки. Для согласования методологии отправьте запрос по почте на адрес SKIF@sberbank.ru |
| choice: должен присутствовать один из перечисленных ниже элементов | ||
| naturalPerson | [1] | Физ.лицо |
| inn | [0..1] | ИНН |
| maritalStatus | [0..1] | Семейное положение ФЛ Варианты: "0" - Нет данных "1" - Холост/не замужем "2" - Женат/замужем "3" - Гражданский брак "4" - Проживает отдельно "5" - Разведен (-а) "6" - Вдовец (-а) "7" - Помолвлен (-а) "8" - Другое |
| pensionNumber | [0..1] | СНИЛС |
| gender | [0..1] | Пол ФЛ Варианты: "MALE" "FEMALE" |
| birthCountry | [0..1] | Страна рождения |
| birthPlace | [0..1] | Место рождения |
| choice: должен присутствовать один из перечисленных ниже элементов | ||
| citizenship | [0..1] | Гражданство |
| currentPersonData | [1] | Текущие персональные данные |
| lastName | [1] | Фамилия |
| firstName | [1] | Имя |
| middleName | [0..1] | Отчество |
| birthDate | [1] | Дата рождения |
| previousPersonData | [0..1] | Предыдущие персональные данные |
| lastName | [1] | Фамилия |
| firstName | [1] | Имя |
| middleName | [0..1] | Отчество |
| birthDate | [1] | Дата рождения |
| primaryId | [1] | Данные текущего документа, удостоверяющего личность (ДУЛ) |
| idType | [1] | Код вида ДУЛ Варианты: "01" - Паспорт РФ "02" - Международный паспорт "03" - Военный билет "04" - Удостоверение офицера "05" - Паспорт моряка "07" - Временное удостоверение по форме № 2-П "11" - Заграничный паспорт "13" - Дипломатический паспорт гражданина РФ "14" - Паспорт гражданина СССР "17" - Вид на жительство |
| serie | [0..1] | Серия |
| number | [1] | Номер |
| issueLocation | [0..1] | Место выдачи |
| issueDate | [0..1] | Дата выдачи |
| issueAuthority | [0..1] | Наименование органа, выдавшего ДУЛ |
| authorityCode | [0..1] | Код подразделения |
| previousId | [0..1] | Данные предыдущего ДУЛ |
| idType | [1] | Код вида ДУЛ Варианты: "01" - Паспорт РФ "02" - Международный паспорт "03" - Военный билет "04" - Удостоверение офицера "05" - Паспорт моряка "07" - Временное удостоверение по форме № 2-П "11" - Заграничный паспорт "13" - Дипломатический паспорт гражданина РФ "14" - Паспорт гражданина СССР "17" - Вид на жительство |
| serie | [0..1] | Серия |
| number | [1] | Номер |
| issueLocation | [0..1] | Место выдачи |
| issueDate | [0..1] | Дата выдачи |
| issueAuthority | [0..1] | Наименование органа, выдавшего ДУЛ |
| authorityCode | [0..1] | Код подразделения |
| legalPerson | [1] | ИП |
| inn | [1] | ИНН |
| ogrnip | [0..1] | ОГРНИП |
| maritalStatus | [0..1] | Семейное положение ФЛ Варианты: "0" - Нет данных "1" - Холост/не замужем "2" - Женат/замужем "3" - Гражданский брак "4" - Проживает отдельно "5" - Разведен (-а) "6" - Вдовец (-а) "7" - Помолвлен (-а) "8" - Другое |
| pensionNumber | [0..1] | СНИЛС |
| gender | [0..1] | Пол ФЛ Варианты: "MALE" "FEMALE" |
| birthCountry | [0..1] | Страна рождения |
| birthPlace | [0..1] | Место рождения |
| choice: должен присутствовать один из перечисленных ниже элементов | ||
| registrationCountry | [0..1] | Страна резидентства |
| currentPersonData | [0..1] | Текущие персональные данные |
| lastName | [1] | Фамилия |
| firstName | [1] | Имя |
| middleName | [0..1] | Отчество |
| birthDate | [1] | Дата рождения |
| previousPersonData | [0..1] | Предыдущие персональные данные |
| lastName | [1] | Фамилия |
| firstName | [1] | Имя |
| middleName | [0..1] | Отчество |
| birthDate | [1] | Дата рождения |
| primaryId | [0..1] | Данные текущего документа, удостоверяющего личность (ДУЛ) |
| idType | [1] | Код вида ДУЛ Варианты: "01" - Паспорт РФ "02" - Международный паспорт "03" - Военный билет "04" - Удостоверение офицера "05" - Паспорт моряка "07" - Временное удостоверение по форме № 2-П "11" - Заграничный паспорт "13" - Дипломатический паспорт гражданина РФ "14" - Паспорт гражданина СССР "17" - Вид на жительство |
| serie | [0..1] | Серия |
| number | [1] | Номер |
| issueLocation | [0..1] | Место выдачи |
| issueDate | [0..1] | Дата выдачи |
| issueAuthority | [0..1] | Наименование органа, выдавшего ДУЛ |
| authorityCode | [0..1] | Код подразделения |
| previousId | [0..1] | Данные предыдущего ДУЛ |
| idType | [1] | Код вида ДУЛ Варианты: "01" - Паспорт РФ "02" - Международный паспорт "03" - Военный билет "04" - Удостоверение офицера "05" - Паспорт моряка "07" - Временное удостоверение по форме № 2-П "11" - Заграничный паспорт "13" - Дипломатический паспорт гражданина РФ "14" - Паспорт гражданина СССР "17" - Вид на жительство |
| serie | [0..1] | Серия |
| number | [1] | Номер |
| issueLocation | [0..1] | Место выдачи |
| issueDate | [0..1] | Дата выдачи |
| issueAuthority | [0..1] | Наименование органа, выдавшего ДУЛ |
| authorityCode | [0..1] | Код подразделения |
| registrationDate | [0..1] | Дата регистрации |
| organization | [1] | ЮЛ |
| fullName | [0..1] | Полное наименование |
| shortName | [0..1] | Краткое наименование |
| firmName | [0..1] | Фирменное наименование |
| nationalName | [0..1] | Наименование на национальном языке |
| englishName | [0..1] | Наименование на иностранном языке |
| inn | [1] | ИНН |
| ogrn | [0..1] | ОГРН |
| okpo | [0..1] | ОКПО |
| kpp | [0..1] | КПП |
| registrationDate | [0..1] | Дата регистрации |
| registrationCountry | [0..1] | Страна резидентства |
| nonResidentRegNumber | [0..1] | Идентификатор иностранной компании |
| phone | [0..1] | Телефон |
| number | [1] | Номер телефона |
| addresses | [0..1] | Адреса участника сделки |
| address | [1..2] | |
| type | [1] | Тип адреса Варианты: "FACT" - Фактический "REG" - Адрес регистрации |
| index | [0..1] | Индекс |
| region | [1] | Регион |
| regionId | [1] | Идентификатор региона |
| regionName | [0..1] | Наименование региона |
| district | [0..1] | Район |
| districtName | [1] | Наименование района |
| shortDistrictName | [1] | Сокращенное обозначение |
| choice: должен присутствовать один из перечисленных ниже элементов | ||
| city | [1] | Город |
| cityName | [1] | Наименование города |
| shortCityName | [0..1] | Сокращенное обозначение' |
| village | [1] | Населенный пункт |
| villageName | [1] | Наименование населенного пункта |
| shortVillageName | [0..1] | Сокращенное обозначение |
| streetAddress | [1] | Улица и номер дома |
| street | [1] | Улица |
| streetName | [1] | Наименование улицы |
| shortStreetName | [0..1] | Сокращенное обозначение |
| houseNumber | [0..1] | Номер дома |
| buildingNumber | [0..1] | Номер корпуса |
| blockNumber | [0..1] | Номер строения |
| flatNumber | [0..1] | Номер квартиры |
Описание элементов структуры ответа
В описании используются следующие термины и допущения:
- Зона фрод-риска - оценка деловой репутации в виде градации по зонам:
1- Зеленая зона («Высокая благонадежность»)
2- Желтая зона («Средняя благонадежность»)
3- Красная зона («Низкая благонадежность»)
4- Черная зона («Плохая благонадежность»)
| Элемент | Кратность | Комментарий |
|---|---|---|
| srvGetCreditHistoryAndFraudScoreRs | ||
| header | [1] | Заголовочная часть |
| rqUid | [1] | Уникальный идентификатор запроса |
| rqTm | [1] | Дата и время передачи сообщения |
| SPName | [1] | Идентификатор системы-отправителя |
| SCName | [1] | Идентификатор системы-получателя |
| response | [1] | Данные ответа |
| result | [1] | Общий результат обработки запроса (0 - OK, 1 - ошибки) |
| participantsResults | [0..1] | Результаты оценки по участникам |
| participantResults | [1..n] | Результаты по участнику |
| index | [1] | Индекс участника |
| fraudScoreParticipantResult | [0..1] | Результаты оценки деловой репутации и фрод-риска по УС |
| zone | [1] | Зона фрод-риска |
| commentShort | [0..1] | Краткий комментарий |
| commentFull | [0..1] | Полный комментарий |
| triggeredRulesList | [0..1] | Список сработавших правил |
| triggeredRulesCode | [1] | Код сработавшего правила |
| triggeredRule | [1] | Сработавшее правило |
| triggeredRuleCode | [1] | Код сработавшего правила |
| triggeredRuleName | [1] | Наименование сработавшего правила |
| role | [0..1] | Роль участника в сделке |
| dealResults | [0..1] | Результаты оценки по сделке |
| fraudScoreDealResults | [0..1] | Результаты оценки деловой репутации и фрод-риска по сделке |
| zone | [1] | Зона фрод-риска |
| commentShort | [0..1] | Краткий комментарий |
| commentFull | [0..1] | Полный комментарий |
| triggeredRulesList | [0..1] | Список сработавших правил |
| triggeredRulesCode | [1] | Код сработавшего правила |
| triggeredRule | [1] | Сработавшее правило |
| triggeredRuleCode | [1] | Код сработавшего правила |
| triggeredRuleName | [1] | Наименование сработавшего правила |
| errors | [0..1] | Ошибки обработки |
| error | [1..n] | |
| participantIndex | [0..1] | Индекс участника сделки для которого произошла ошибка, если не заполнено то ошибка произошла на уровне сделки. |
| message | [0..1] | Описание ошибки |