Открыть Электронные книги
Категории
Открыть Аудиокниги
Категории
Открыть Журналы
Категории
Открыть Документы
Категории
V. 2.35 от 25.09.2019
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Оглавление
1. Введение ............................................................................................................................................... 4
1.1 Перекрестные ссылки ......................................................................................................................................................... 4
1.2 Цель документа ...................................................................................................................................................................... 4
1.3 Контроль изменений........................................................................................................................................................... 4
2. Поддерживаемые форматы.................................................................................................................. 4
2.1 Типы полей ............................................................................................................................................................................... 4
2.2 Обязательность и кодировка значений полей...................................................................................................... 5
3. Поддерживаемые протоколы транспортного уровня........................................................................... 5
3.1 Протокол HTTPS ..................................................................................................................................................................... 5
4. Формат XML ........................................................................................................................................... 6
4.1 Объект structure ..................................................................................................................................................................... 6
4.2 Объект collection .................................................................................................................................................................... 6
4.3 Объект attribute ...................................................................................................................................................................... 6
4.4 Объект pair ................................................................................................................................................................................ 6
4.5 Объект null ................................................................................................................................................................................ 6
4.6 Пример XML- структуры .................................................................................................................................................... 6
5. Запрос в Бюро (входной XML - поток) ................................................................................................... 7
5.1 Входной XML-поток и протокол передачи HTTPs ............................................................................................... 7
5.2 Заголовок запроса - Header.Session .......................................................................................................................... 11
5.3 Финансовая информация EnquiryRequest ............................................................................................................ 12
5.4 Информация о решении по кредитному заявлению - EnquiryRequest.Decision............................... 16
5.5 Информация о Заемщике EnquiryRequest.Consumer....................................................................................... 18
5.5.1 Поля согласия субъекта ......................................................................................................................................... 25
5.5.2 Допустимые Типы основного удостоверения и типы дополнительного удостоверения
(Primary ID Type and Secondary ID Type)................................................................................................................... 27
5.6 Работодатель EnquiryRequest.Consumer.[].Employer or Enquiry Employer .......................................... 29
5.7 Адрес субъекта EnquiryRequest.Consumer.[].Address.[] or Enquiry Address ........................................ 31
6. Ответ Бюро (выходной XML- поток) .................................................................................................... 32
6.1 Верхний уровень XML ответа....................................................................................................................................... 39
6.2 Ошибки проверки корректности ValidationErrors.[]....................................................................................... 39
6.3 Резюме Consumer.[].Summary ...................................................................................................................................... 39
6.4 Предупреждения Consumer.[].Warnings.[]............................................................................................................. 45
6.5 Записи CAIS (фактически имеющиеся кредиты) Consumer.[].CAIS.[]..................................................... 45
6.6 Финансовая информация счета CAIS (фактически имеющийся кредит) ............................................ 47
6.6.1 Тип обеспечения счета CAIS. ................................................................................................................................ 50
6.6.2 Формат Процентной ставки................................................................................................................................. 50
6.6.3 Запрос кредитной истории юридичесого лица. ........................................................................................ 50
www.bki-okb.ru 1
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 2
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 3
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
1. Введение
Подписчики (Пользователи) Бюро могут получать Кредитные отчеты, содержащие кредитные истории
субъектов, используя WEB-интерфейс или B2B-интерфейс (CPU-интерфейс, XML-интерфейс).
2. Поддерживаемые форматы
B2B-Интерфейс поддерживает формат XML, который используется для передачи данных. Данный
формат позволяет использовать любые символы Unicode, при условии представления их с помощью
последовательности XML escape (&#n; где n – это десятичное Unicode значение данного символа).
Входные и выходные потоки данных в XML имеют определенную структуру и описываются с помощью
ограниченного набора различных объектов и атрибутов. Преимущества XML состоят в том, что данные в
этом формате легко читаются, так как каждый блок данных носит определенное наименование; нет
необходимости в том, чтобы отправлять каждый блок данных отдельно; если блок опционален, то его
просто можно опустить. Текстовые данные при отправке сохраняют исходный размер, нет
необходимости дополнять их до определенной длины. Существует множество стандартных средств для
чтения и работы с XML. К недостаткам XML можно отнести то, что наименование каждого атрибута
также является частью данных, и по этой причине потоки XML-данных могут быть довольно длинными.
2.1 Типы полей
Поля ввода и вывода имеют следующие основные типы: TEXT (текст), NUMERIC (числовой), CODE (код),
DATE (дата) и TIMESTAMP (временная метка).
• Значения поля TEXT могут содержать любой допустимый символ (длина указана в таблице с
описанием полей).
• Значения поля NUMERIC могут содержать цифры (0-9) (длина указана в таблице с описанием
полей).
www.bki-okb.ru 4
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 5
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
4. Формат XML
Формат XML может быть составлен с использованием как коротких, так и длинных имен. В
возвращаемом XML используются только короткие имена объектов и атрибутов. Использование
коротких имен значительно сокращает размер XML-потоков, которые необходимо посылать в
Кредитное Бюро и принимать из него. Формат XML основан на использовании следующих типов и
атрибутов объектов.
4.1 Объект structure
Объект structure (структура) использует имя объекта “struct” или “s”. Этот объект содержит лишь
внутренние объекты. Каждый из внутренних объектов структуры должен обязательно иметь
уникальный атрибут “name” или “n”.
4.2 Объект collection
Объект collection ( коллекция) использует имя объекта “coll” или “c”. Объект- коллекция содержит лишь
вложенные объекты (обычно того же имени объекта). Эти вложенные объекты не имеют атрибута
“name” или “n”.
4.3 Объект attribute
Объект attribute (атрибут) использует имя объекта “attr” или “a”. Объект-атрибут содержит значение и
не содержит вложенных объектов. По умолчанию этим значением является текстовое значение с
нулевым значением атрибута, идентифицирующим нулевое текстовое значение. Тип объекта-атрибута
может быть далее определен с помощью атрибута “type” или “t”, который может принимать значения
“text” или “t”, “number” или “n”, или “date” или “d”. Объекты-атрибуты могут также иметь значение
“unknown” (неизвестное) или “no” (отсутствует). Для обозначения этого используется атрибут “status”
(состояние) или “s”, который может принимать значения “no_value” (значение отсутствует) или “0”, или
“value_unknown” (значение неизвестно) или “?”. Атрибуты состояния и типа (status и type) объекта-
атрибута не возвращаются в выходном XML-потоке.
4.4 Объект pair
Объект pair (пара) использует имя объекта “pair” или “p”. Объект-пара содержит строго два
неименованных вложенных объекта.
4.5 Объект null
Объект null (нуль) использует имя объекта “null” или “n”. Объект-нуль не имеет ни значения, ни
порожденных объектов.
4.6 Пример XML- структуры
<s>
<s n=”EnquiryRequest”> (запрос)
<a n=”reason” (основание) >02</a>
<a n=”financeType” (тип финансирования) >23</a>
<a n=”currency” (валюта) >EUR</a>
<a n=”creditLimit” (кредитный лимит) >2000</a>
<a n=”paymentFrequency” (частота платежей) >03</a>
<a n=”applicationChannel”(канал подачи заявления)>01</a>
<a n=”cbrFinanceType”(Тип финансирования по классификации ЦБ РФ)>03</a>
<c n=”Consumer”> (клиент)
<s>
<a n=”applicantType” (тип заявителя) >01</a>
www.bki-okb.ru 6
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 7
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
В запрос должен обязательно быть включен только один Субъект. Первый адрес должен быть текущим
фактическим адресом. Второй адрес может адресом регистрации. Блок сведения о работодателе не
обязателен для всех типов запросов.
Информация о
Финансовая Заемщик Работодатель Адрес
решении по
Заголовок информация EnquiryRequest. EnquiryRequest. EnquiryRequest.
кредитному
Header.Session EnquiryRequest Consumer Consumer.[]. Consumer.[].
заявлению
Employer Address.[]
Decision
1...n 1...n
обязательно
необязательно
со следующими параметрами:
Кодирование XML-строки
www.bki-okb.ru 8
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
1. Преобразовать в XML-строку, исключив символы Space #20, Tab #19, символы переноса сроки и
возврат каретки #13 и #10.
2. Полученную XML-строку посимвольно закодировать по правилам указанным в таблице,
используя в качестве входного Набора символов Юникод UTF8
Пример XML-строки
Исходный запрос:
Subscriber=12345&Group=xxx&User=xxx&Password=xxxxxxxx&Function=50&Request=%3C%3Fxml%20version
%3D%221%2E0%22%20encoding%3D%22windows%2D1251%22%3F%3E%3Cs%20n%3D%22EnquiryRequest%2
2%3E%0A%20%20%3Ca%20n%3D%22accountClass%22%3E1%3C%2Fa%3E%0A%3Ca%20n%3D%22reason%22%
3E02%3C%2Fa%3E%0A%3Ca%20n%3D%22financeType%22%3E02%3C%2Fa%3E%0A%3Ca%20n%3D%22currenc
y%22%3ERUB%3C%2Fa%3E%0A . . .
Кодируется как:
www.bki-okb.ru 9
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
%3Ca%20n%3D%22line2%22%3E%26%231057%3B%26%231090%3B%26%231088%3B%26%231086%3B%26%2
31080%3B%26%231090%3B%26%231077%3B%26%231083%3B%26%231077%3B%26%231081%3B%3C%2Fa%3
E%0A%
Первая буква
«С» = %26%231057%3B, где
www.bki-okb.ru 10
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
“CPU Credit Enquiry” (Function number = 50) это запрос кредитной истории в старом формате, сохранен временно для поддержки предоставления отчета в
старом формате (подробное описание структуры отчете смотри документ «Спецификация B2B-интерфейса»).
www.bki-okb.ru 11
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
“CPU Consumer Enquiry (old)” (Function Number = 52) – это запрос субъекта кредитной истории в старом формате, сохранен временно для поддержки
предоставления отчета в старом формате. При выполнении запроса с 52 функцией в кредитном отчете не будут возвращаться новые записи (Банковские
Гарантии, Договоры Залога, Договоры Поручительства, SubscriberDetails - данные об Источнике, и т. д.).
“CPU Consumer Enquiry (new)” (Function Number = 72) – это запрос субъекта кредитной истории в новом формате. При выполнении запроса с 72 функцией в
кредитном отчете будут возвращаться новые записи (Банковские Гарантии, Договоры Залога, Договоры Поручительства, SubscriberDetails - данные об Источнике,
и т. д.).
“CPU Business Enquiry (old)” (Function Number = 53) – этот запрос по юрлицу будет использоваться для совместимости со старым форматом Бюро, при его
выполнении не будут возвращены записи нового формата (банковская гарантия, поручительство, залог и т.д.).
“CPU Extended Business Enquiry” (Function Number = 73) – этот запрос по юрлицу в новом формате, при его выполнении будут возвращены записи нового
формата (банковская гарантия, поручительство, залог и т.д.)
Дли
Name Имя поля XML-имя Тип M Описание
на
Account Class Класс счета accountClass Account 1 M
Class
Reason for Enquiry Основание для reason Reason for 2 M При использовании причины «заявление на получение кредита» (01) будет
запроса Enquiry сформирована информация о заявлении в информационной части КИ
субъекта. Причина «проверка клиента» (02) используется, если запрос
выполняется по клиенту для проверки существующего портфеля и
действующего кредита.
При проверке клиента с целью формирования новых предложений
следует выбирать причину «маркетинговое исследование» (05).
Для запроса CPU Application Load (42) следует выбирать причину запроса
«передача заявления без запроса» (08). Для других типов запроса эту
причину использовать нельзя.
Причина запроса «Запрос клиента» (06) используется только для запроса
Субъекта кредитной истории (52), для других типов запросов она не
используется.
При запросе информационной части (67) для отражения конкретной цели
запроса можно использовать все причины запроса (включая «заявление на
получение кредита» (01)) кроме причин: «Запрос клиента» (06) и
www.bki-okb.ru 12
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 13
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
о платежа
(сумма взноса)
Payment Frequency Частота paymentFrequency Payment 2 С Смотрите Finance Fields (Поля, относящиеся к финансам)
платежей Frequency Значение поля Payment Frequency не может быть Variable (переменная
величина) (98) или Unknown (неизвестная величина) (99)
Duration of срок действия duration Number 3 С Смотрите Finance Fields (Поля, относящиеся к финансам)
Agreement соглашения
durationUnits единица durationUnits Duration 2 С Единица измерения срока договора, день, неделя, месяц или год
измерения Type Значением поля Duration Units не может быть Unknown (неизвестная
срока договора величина) (9).
Type of Security вид typeOfSecurity Type of 2 С Если значением поля Finance Type является Secured Loan (01), то
обеспечения Security заполнение поля Type of Security является обязательным. Если значением
кредита поля Finance Type не является Secured Loan, то поле Type of Security не
используется.
Public Comments комментарии comments Text 150
Application Способ подачи applicationChannel Application 2 C Способ подачи заявления. Обязательно для следующих видов запросов
Channel заявления Channel (CPU Extended Enquiry, CPU Application Load, CPU Score Credit Enquiry, CPU
Standard Credit Enquiry) если Reason for Enquiry = (01 или 08)
Для вида запроса в старом формате (CPU Credit Enquiry / 50) с целью
обеспечения обратной совместимости, поле не является обязательным и
может отсутствовать в запросе.
Для всех других Function Number - необязательно.
CBR Finance Type Тип cbrFinanceType CBR 3 C Тип финансирования, в соответствии с классификацией ЦБ РФ.
финансирован Finance Обязательно для следующих видов запросов (CPU Extended Enquiry, CPU
ия Type Application Load, CPU Score Credit Enquiry, CPU Standard Credit Enquiry) если
Reason for Enquiry = (01 или 08)
Для вида запроса в старом формате (CPU Credit Enquiry / 50) с целью
обеспечения обратной совместимости, поле не является обязательным и
может отсутствовать в запросе.
Для всех других Function Number - необязательно.
www.bki-okb.ru 14
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 15
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 16
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Присутствует и является обязательным только в
Previous Stream
Предыдущий Stream ID streamID Numeric 20 С запросе на обновление решения по заявлению - CPU
ID
Decision Update, Function Number = 41
Type of Decision typeOfDecision Decision type 2 Тип решения. Поле должно быть заполнено
значением 01 (Заявление одобрено) если в поле
Тип решения М
«причина принятия решения» выбрано значение
01(Заявление одобрено).
Date of Decision Дата принятия решения dateOfDecision Date 8 М Дата принятия решения. Не должна быть в будущем
Decision End Дата окончания срока decisionEndDate Date 8 Дата окончания срока действия решения. Поле
Date действия решения обязательно для заполнения, если Тип решения «01 -
Approved», в остальных случаях поле условно
М обязательное
Decision End date >= Date of Decision
Может быть в будущем по отношению к Дате
принятия решения не более чем на 12 месяцев.
Decision Reason Причина принятия decisionReason Decision 2 Причина, по которой по кредитному заявлению было
решения Reason принято данное решение. Поле обязательно для
М заполнения. Поле должно быть заполнено значением
01 (Заявление одобрено) если в поле «тип решения»
выбрано значение 01(Заявление одобрено).
Decision Сумма решения decisionAmount Numeric 15 Сумма, указанная в кредитном заявлении, по
М
Amount которому было принято данное решение
Currency Валюта кредита, currency Currency Code 3 Валюта кредита, указанная в кредитном заявлении,
М
по которому было принято данное решение
Comments Комментарии comments Text 256 Комментарии
www.bki-okb.ru 17
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Applicant Type тип заявителя applicantType Applicant Type 2 M Поле обязательно для заполнения для всех причин
запроса кроме (06) – «Запрос клиента», и должно
всегда иметь значение (01) – основной заявитель.
Sex код пола sex Sex Code 1 M Если значением поля Function Number является
(53) Business Enquiry (запрос о юридическом лице),
а значением поля Applicant Type (тип заявителя) –
Owner (01), то значением поля Sex (пол) должна
быть Company (компания) (3)
Если поле Function Number имеет значение (50)
Credit Enquiry (запрос о физическом лице), а поле
Applicant Type (тип заявителя) – значение Owner
(01), то значением поля Sex (пол) не должна
являться Company (компания) (3)
Nationality гражданство nationality Country 2 M
Title обращение title Title 2 С Если значением поля Sex (пол) является Company
(компания) (3), то Title (обращение) не
используется.
First Name Имя name1 Text 100 С Если значением поля Sex не является Company
(компания) (3), то заполнение поля First Name
(имя) обязательно.
Если значением поля Sex (пол) является Company
(компания) (3), то First Name (имя) не используется.
Patronymic Отчество name2 Text 100 С Если значением поля Sex не является Company (3) и
значением поля Nationality является Russian
(русский) (RU), то заполнение поля Patronymic
(отчество) обязательно.
Если значением поля Sex (пол) является Company
(компания) (3), то Patronymic (отчество) не
используется.
www.bki-okb.ru 18
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Surname Фамилия/ Название surname Text 150 M Если значением поля Sex (пол) является Company
компании (компания) (3), то в поле Surname (фамилия)
вводится название компании
Date of Birth дата рождения dateOfBirth Date 8 С Вводимое значение поля Date of Birth (дата
рождения) не должно относиться к будущему
периоду времени. Если значением поля Sex (пол)
не является Company (3), то значение поля Date of
Birth должно соответствовать минимальному
возрасту потенциального Заявителя - 16 лет
Place of Birth место рождения placeOfBirth Text 100 С Обязательно для заполнения, если в поле Account
Class указано значение 1 (физическое лицо)
Maiden Name девичья фамилия aliasName Text 40 С Обязательно для заполнения, если в поле Sex
указано значение 2 (женский). Если значением
поля Sex (пол) является Company (3),то в поле
Maiden Name вводится название материнской
компании
Consent флаг согласия клиента consentFlag Consumer 1 M Флаг, указывающий, подписал ли данный клиент
Consent соглашение, позволяющее кредитной организации
Indicator запрашивать информацию о кредитной истории в
Бюро.
Date Consent дата получения dateConsentGiven Date 8 M Значение поля Date Consent Given не может
Given согласия клиента относиться к будущему периоду времени
Date Consent дата окончания dateConsentExpiry Date 8 С Дата, в которую согласие перестает действовать.
Expires действия согласия Свойства обязательности и применимые проверки
в разрезе типов запросов описаны в п. 5.5.1.
Consent Purpose цель получения consentPurpose Consent 2 С Свойства обязательности и применимые проверки
согласия Purpose в разрезе типов запросов описаны в п. 5.5.1.
Consent Purpose описание цели consentPurposeDetails Text 100 С Свойства обязательности и применимые проверки
Details получения согласия в разрезе типов запросов описаны в п. 5.5.1.
www.bki-okb.ru 19
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Consent индикатор consentResponsibilityFl Consent 1 С Свойства обязательности и применимые
Responsibility осведомленности об ag Responsibility проверки в разрезе типов запросов описаны в п.
Awareness ответственности за Awareness 5.5.1.
Indicator совершение Indicator
правонарушений
Consent User наименование consentUserDetails Text 100 С Свойства обязательности и применимые
Details пользователя, которому проверки в разрезе типов запросов описаны в п.
было дано согласие 5.5.1.
субъекта
Primary ID Type тип основного primaryIDType Identity Type 2 M Смотрите Допустимые Типы основного
удостоверяющего удостоверения и типы дополнительного
документа удостоверения (Primary ID Type and Secondary ID
Type)
Primary ID номер основного primaryID Text 20 M
удостоверяющего
документа
Primary ID Expiry дата истечения срока primaryIDExpiry Date 8 Значение поля Primary ID Expiry Date не может
Date действия относиться к прошлому периоду времени
удостоверяющего
документа
Primary ID Issue дата выдачи основного primaryIDIssueDate Date 8 M Значение поля Primary ID Issue Date не может
Date удостоверяющего относиться к будущему периоду времени
документа
Primary ID Issue место выдачи primaryIDIssuePlace Text 30 M
Place основного
удостоверяющего
документа
Primary ID орган, выдавший primaryIDAuthority Text 100 M
Authority основной
удостоверяющий
документ
www.bki-okb.ru 20
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Secondary ID Type тип второстепенного secondaryIDType Identity Type 2 С Смотрите Допустимые Типы основного
удостоверяющего удостоверения и типы дополнительного
документа удостоверения (Primary ID Type and Secondary ID
Type) Это поле указывает тип второго
удостоверяющего документа, используемого в
дополнение к основному.
Должен содержать допустимое значение кода,
определенное документом "Значения Кодов".
Если в поле Account Class указано – Юридическое
лицо – то заполнение ИНН – обязательно.
Secondary ID номер второстепенного secondaryID Text 20 С Обязательно для заполнения, если заполнено поле
удостоверяющего Secondary ID Type.
документа
Secondary ID дата истечения срока secondaryIDExpiry Date 8 Значение поля Secondary ID Expiry Date не может
Expiry Date действия относиться к прошлому периоду времени
второстепенного
удостоверяющего
документа
Secondary ID дата выдачи secondaryIDIssueDate Date 8 Значение поля Secondary ID Issue Date не может
Issue Date второстепенного относиться к будущему периоду времени
удостоверяющего
документа
Secondary ID место выдачи secondaryIDIssuePlace Text 30
Issue Place второстепенного
удостоверяющего
документа
Secondary ID орган, выдавший secondaryIDAuthority Text 100
Authority второстепенный
удостоверяющий
документ
Driving licence Водительское drivinglicenceNbr Text 10 Проверки, выполняются в соответствии с
удостоверение Приложением С «Описания данных CAIS»
www.bki-okb.ru 21
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Medical Insurance Номер медицинского medicalNbr Text 25
Number страхования
Pension Number Номер свидетельства pensionNbr Text 20 Только для физических лиц граждан РФ.
государственного
пенсионного
страхования.
Private Номер свидетельства о privateEntrepreneurID Text 20 Только для физических лиц граждан РФ.
Entrepreneur ID регистрации в качестве
Индивидуального
предпринимателя.
Issue date Дата выдачи IssuedateEntrepreneur Date 8 Только для физических лиц граждан РФ.
Entrepreneur свидетельства о
регистрации в качестве
Индивидуального
предпринимателя
EGRN ЕГРН индивидуального EGRNEntrepreneur Text 20 С Только для физических лиц граждан РФ.
Entrepreneur предпринимателя
Previous ID Номер предыдущего previousPassportNbr Text 20 С Поле Previous ID не используется, если значением
документа поля Primary ID Type (тип основного
удостоверения) не является Russian Passport
(российский паспорт) (01). Может содержать номер
старого паспорта или ЕГРН реорганизованного
юридического лица.
Income доход primaryIncome Numeric 15 С Поле обязательно для заполнения, если в поле
Account Class указано значение 1 (Физическое
лицо/индивидуальные предприниматель)
Income Frequency Частота получения primaryIncomeFreq Income 1 С Значением поля Income Frequency (частота
дохода Frequency получения дохода) не может быть Other (другая
величина) (8) или Unknown (неизвестная величина)
(9)
www.bki-okb.ru 22
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Net Gross чистый/общий доход primaryIncomeFlag Income Net 1
Gross Indicator
Other Income другие виды дохода otherIncome Numeric 15
Residential Status статус проживания residentialStatus Residential 1
Status
Occupation работа occupation Occupation / 2
Activity Code
Occupation Status состояние занятости occupationStatus Occupation 2
Status
Marital Status семейное положение maritalStatus Marital Status 2
No. of количество иждивенцев numberDependants Number 3
Dependants
Education образование education Education 1
Mobile Telephone номер мобильного mobileTelNbr Text 16
телефона
Mobile Phone Регистрация mobileRegistration Mobile Phone 1
Registration мобильного телефона Registration
Subject code Subject code subjectCode Text 20
Visa Credit Card имеющаяся платежная visaCCHeld Credit Cards 1
карта Visa Held
MasterCard имеющаяся платежная mastercardCCHeld Credit Cards 1
карта Master Held
Diners Credit Card имеющаяся платежная dinersCCHeld Credit Cards 1
карта Diners Held
American Express имеющаяся платежная amExpressCCHeld Credit Cards 1
карта American Express Held
JCB Credit Card имеющаяся кредитная jcbCCHeld Credit Cards 1
карта JCB Held
Debit Card имеющаяся дебетовая debitCCHeld Credit Cards 1
карта Held
Cheque имеющаяся чековая chqGteeCCHeld Credit Cards 1
Guarantee карта Held
www.bki-okb.ru 23
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
Name Имя поля XML-имя Тип M Примечания
на
Retail Credit Card имеющаяся кредитная retailCCHeld Credit Cards 1
карта Retail Held
Other Credit Card другие имеющиеся otherCCHeld Credit Cards 1
кредитные карты Held
Check Other1 Check Other1 checkOther1 Text 1 В данное время внешние проверки в стадии
Check Other2 Check Other2 checkOther2 Text 1 реализации.
Check Other3 Check Other3 checkOther3 Text 1
Check Other4 Check Other4 checkOther4 Text 1
Check Other5 Check Other5 checkOther5 Text 1
Check Other6 Check Other6 checkOther6 Text 1
Check Other7 Check Other7 checkOther7 Text 1
Check Other8 Check Other8 checkOther8 Text 1
Check Other9 Check Other9 checkOther9 Text 1
Check Other10 Check Other10 checkOther10 Text 1
Check Other11 Check Other11 checkOther11 Text 1
Check Other12 Check Other12 checkOther12 Text 1
Check Other13 Check Other13 checkOther13 Text 1
Check Other14 Check Other14 checkOther14 Text 1
Check Other15 Check Other15 checkOther15 Text 1
Check Other16 Check Other16 checkOther16 Text 1
Check Other17 Check Other17 checkOther17 Text 1
Check Other18 Check Other18 checkOther18 Text 1
Check Other19 Check Other19 checkOther19 Text 1
Check Other20 Check Other20 checkOther20 Text 1
www.bki-okb.ru 24
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Informational Part Enquiry (FN 67) Любой тип подписчика 02 – Проверка клиента Да consentFlag = «0»/согласие дано
03 – Взыскание
задолженности
consentResponsibilityFlag = «0» / подписчик
04 – Страхование осведомлен об ответственности за совершение
правонарушений
05 – Маркетинговое
исследование
07 – Запрос Дата запроса >= Дата получения согласия
информационной части
98-Другое
Дата запроса =< Дата окончания действия
согласия
www.bki-okb.ru 25
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
ВАЖНО: «Дата запроса», указанная в столбце Правила в таблице, это календарная дата направления запроса в Бюро (текущая дата).
Поле «Описание цели получения согласия» обязательно к заполнению в случае, если поле «Цель получения согласия» = 99/Другая
Пользователь может получить кредитный отчет только в случае выполнения всех правил полей согласия.
В случае невыполнения правил пользователю вернется ошибка проверки корректности – «Согласие субъекта отсутствует или заполнено некорректным значением,
но оно является обязательным для данного вида запроса». (п. 8.2 Ошибки проверки корректности).
Поле «Дата получения согласия» не может быть в будущем (п. 8.2 Ошибки проверки корректности).
Поля согласия субъекта, присутствовавшие в формате Бюро ранее – consentFlag и dateConsentGiven – будут отражаться в xml-отчете Бюро без каких-либо
изменений. Все добавившиеся поля согласия: dateConsentExpiry, consentPurpose, consentPurposeDetails, consentResponsibilityFlag и consentUserDetails не будут
возвращаться в xml-отчете Бюро.
www.bki-okb.ru 26
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
5.5.2 Допустимые Типы основного удостоверения и типы дополнительного удостоверения (Primary ID Type and Secondary ID Type)
Тип основного удостоверения личности Primary ID Type должен соответствовать следующим правилам:
B). Если в поле Код пола (Sex Code) указано – Организация (Company) то в поле Primary ID Type доложено быть указан:
I. Для резидентов РФ:
• ЕГРН (06)
• ОКПО (10)
www.bki-okb.ru 27
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Тип дополнительного удостоверения Secondary ID Type не должен быть таким же, что и тип основного удостоверения Primary ID Type
Тип дополнительного (второго) удостоверения личности Secondary ID Type должен соответствовать следующим правилам:
www.bki-okb.ru 28
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
B). Если в поле Код пола (Sex Code) указано – Организация (Company)
Если в поле Код пола (Sex Code) указано – Организация (Company) – то заполнение поля обязательно.
I. Для резидентов РФ:
• ИНН (09)
II. Для не резидентов РФ:
• ИНН (09)
• КИО (22)
• Регистрационный номер юридического лица - нерезидента (25)
www.bki-okb.ru 29
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 30
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru 31
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Ответ, возвращаемый интерфейсом, представляет собой XML-строку, подписанную ЭЦП с использованием действующего сертификата «Оператора бюро для ЭЦП»
методом «attached» в кодировке BASE64. (PKCS#7 Signed). Для передачи строковых полей используется Escape-кодировка аналогичная применяемой в запросе
(см. раздел 5.1).
www.bki-okb.ru 32
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
<s>
<c n=”Consumer” (client) >
<s>
<c n=”BankruptcyProcedure” (Bankruptcy details)>
<s>
<!-- Bankruptcy information omitted here -->
<s n=”BankruptcyConsumer”>
<!-- Consumer information omitted here -->
</s>
<c n=”BankruptcyRecord”>
<s>
<!—Bankruptcy Record information omitted here -->
</s>
<s>
<!—Second Bankruptcy Record information omitted here -->
</s>
</c>
<s n=”BankruptcyCommissioner”>
<!—Bankruptcy Commissioner details information omitted here -->
</s>
</s>
<s>
<!-- Second Bankruptcy information omitted here -->
</s>
</c>
<c n=”BureauScore” (bureau score)>
<s>
<!-- Score information omitted here -->
</s>
</c>
www.bki-okb.ru
33
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
34
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
35
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
</s>
<s>
<!-- Second bank guarantee omitted here -->
</s>
</c>
</s>
</c>
<s n=”SubscriberDetails”> (subscriber details details)>
<!-- Subscriber details information omitted here -->
</s>
</s>
</c>
<c n=”NameIDHistory” (name and passport history changes)>
<s>
<!-- Name and passport history changes information omitted here -->
</s>
</c>
<s n=”PVS”>
<!-- Person Verification Service response information omitted here -->
</s>
<s n=”Summary” (summary details)>
<!-- Summary Information omitted here -->
</s>
<c n=”Warnings” (report warnings) >
<!-- Warnings information omitted here -->
</c>
</s>
</c>»»
www.bki-okb.ru
36
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
37
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
38
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
39
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
CAISDistribution3 CAISDistribution3 Numeric 3 Количество подписчиков передавших 3 записи CAIS (фактически имеющихся кредитов)
CAISDistribution4 CAISDistribution4 Numeric 3 Количество подписчиков передавших 4 записи CAIS (фактически имеющихся кредитов)
CAISDistribution5 CAISDistribution5 Numeric 3 Количество подписчиков передавших 5 записей CAIS (фактически имеющихся
кредитов)
CAISDistribution5Plus CAISDistribution5Plus Numeric 3 Количество подписчиков передавших более 5 записей CAIS (фактически имеющихся
кредитов)
CAISRecordsGuarantor CAISRecordsGuarantor Numeric 3 Количество записей CAIS в Бюро (фактически имеющихся кредитов) в которых субъект
является принципалом
CAISRecordsGuarantor CAISRecordsGuarantor Numeric 3 Количество доступных подписчику записей CAIS (фактически имеющихся кредитов) в
Recip Recip которых субъект является принципалом
CAIS Records Co- CAISRecordsJoint Numeric 3 Количество записей CAIS в Бюро (фактически имеющихся кредитов) в которых субъект
Owner является созаемщиком
CAIS Records Co- CAISRecordsJointRecip Numeric 3 Количество доступных подписчику записей CAIS (фактически имеющихся кредитов) в
Owner Before которых субъект является созаемщиком
Reciprocity
Bureau Enquiries CAISRecordsOwner Numeric 3 Количество доступных подписчику записей CAIS (фактически имеющихся кредитов) в
Owner которых субъект является основным заемщиком
CAIS Records Owner CAISRecordsOwnerRec Numeric 3 Количество доступных подписчику записей CAIS (фактически имеющихся кредитов) в
Before Reciprocity ip которых субъект является основным заемщиком
CAIS Records Referee CAISRecordsReferee Numeric 3 Количество записей CAIS в Бюро (фактически имеющихся кредитов) в которых субъект
является конкурсным управляющим
CAIS Records Referee CAISRecordsRefereeRe Numeric 3 Количество доступных подписчику записей CAIS (фактически имеющихся кредитов) в
Before Reciprocity cip которых субъект является конкурсным управляющим
Bureau Enquiry CAPSDistribution1 Numeric 3 Количество подписчиков сделавших 1 запрос в бюро (CAPS)
Distribution 1
www.bki-okb.ru
40
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
41
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
42
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
43
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
44
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
При запросе «Проверка наличия кредитной истории» (CPU Existence Check Enquiry, Function Number = 51) доступен только тег “CAISRecordsOwner”.
Переменная ConsumerEnquiryCountLast12Month – доступна только при запросе Субъекта кредитной истории (CPU Consumer Enquiry, Function Number = 52)
<c n=”Warnings”>
<a>WARNING_CAIS_QUERIED</a>
<a>WARNING_TOO_MANY_CAPS_RECORDS</a>
</c>
Полный перечень предупреждений представлен в разделе «Описание предупреждений».
www.bki-okb.ru
45
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
</c>
<s n=”Assignee”>
—-- Информация о переуступке прав здесь опущена -->
</s>
<s n=”Lien”>
—-- Информация о договорах залога здесь опущена -->
</s>
<s n=”Guarantee”>
—-- Информация о банковских гаранитях здесь опущена -->
</s>
<c n=”Consumer” (клиент) >
<s>
—-- Account holder (владелец счета) - информация здесь опущена -->
<s n=”Employer” (работодатель)>
—-- информация о работодателе здесь опущена -->
</s>
<c n=”Address” (адрес)>
<s>
—-- информация об адресе здесь опущена -->
</s>
<s>
—-- информация о втором адресе здесь опущена -->
</s>
<s n=”Legal”>
—-- Информация о судебных решениях здесь опущена -->
</s>
<s n=”Warranty”>
—-- Информация о поручительстве здесь опущена -->
</s>
<c n=”WarrantyHistory”>
—-- Информация о договорах поручительства здесь опущена -->
</c>
</c>
www.bki-okb.ru
46
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
</s>
</c>
</s>
<s>
—-- информация о второй записи CAIS здесь опущена -->
</s>
</c>
www.bki-okb.ru
47
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Outstanding Balance outstandingBalance Numeric 9 Общая сумма задолженности по счету на дату учета. Включает сумму
просроченной задолженности, где любые дополнительные расходы
(например, пени) внесены в дебет счета, включая проценты, если они
внесены в дебет счета.
Arrears Balance arrearsBalance Numeric 9 Сумма просроченной задолженности – это поле содержит сумму, которая не
оплачена в срок. Она может включать процент и расходы.
Fulfilment Date fulfilmentDueDate Date 8 Договорная дата исполнения обязательств
Last Payment Date lastPaymentDate Date 8 Это дата, когда была зарегистрирована самая недавняя выплата по счету
Account Closed Date accountClosedDate Date 8 Дата Закрытия счета
Default Date defaultDate Date 8 Дата, когда состояние платежа стало «дефолт»
Litigation Date litigationDate Date 8 Дата, когда состояние платежа стало «тяжба»
Write Off Date writeOffDate Date 8 Дата, когда состояние платежа стало «списан»
Reason for Closure reasonForClosure Reason for Closure 2 Причина закрытия счета
Account Special Status accountSpecialStatus Account Special Status 2 Дополнительное поле для счетов, находящихся в особых обстоятельствах.
Last Missed Payment lastMissedPaymentDat Date 8 Дата последнего неуплаченного взноса
Date e
www.bki-okb.ru
48
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
49
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
В запросе кредитной истории юридичесого лица (номером функции – 53) и запросе кредитной истории субъекта (номером функции 72 и кодом пола
компания(03)), следующие поля не возвращаются в кредитном отчете:
В запросе кредитной истории поручителя (Тип владельца счета – 03), следующие теги обязательно должны быть предствалены в ответе независимо от наличия
значения:
www.bki-okb.ru
50
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
51
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
52
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
53
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
54
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
55
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
56
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Warranty Instalment Amount warrantyInstalmentAmount Numeric 15 Размер платежа, внесенный поручителем, в дату платежа
Warranty Instalment Date warrantyInstalmentDate Date 8 Дата внесения платежа
Warranty Instalment Date ≥ Warranty Open date
Warranty Payment Status warrantyPaymentStatus Account Payment 1 Статус просрочки по договору поручительства на дату внесения
Status записи
Warranty Arrears Balance warrantyArrearsBalance Numeric 15 Сумма просроченной задолженности по договору поручительства
на дату платежа
Warranty Arrears Balance ≤ Warranty Outstanding Balance
Warranty Arrears Balance > 0 если Warranty Payment Status > 0
Warranty Close Date warrantyCloseDate Date 8 Фактическая дата окончания срока действия договора
поручительства
Warranty Close Date ≥ Warranty Open date
Warranty Reason For Closure warrantyReasonForClosure Security reason 2 Причина окончания срока действия договора поручительства
for closure Заполняется значением из справочника Security Reason For Closure
Warranty Reason For Closure заполняется если Warranty Close Date
present
Legal Warranty Agreement legalWarrantyAgreementNum Text 80 Юридический номер (реквизиты) договора поручительства.
Number ber
Subscriber Comments subscriberComments Text 250 Это поле содержит комментарии подписчика о договоре
поручительства.
Unique Loan identifier uniqueLoanIdentifier Text 70 Уникальный идентификатор договора
До тех пор пока Дата истребования поручительства (Warranty Claim date) не заполнена, по соглашению кредитного договора выгружаются только следующие
поля из записи «Информация о договоре поручительства»:
www.bki-okb.ru
57
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
58
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Все записи «Истории по договору поручительства» возвращаются в ответе в том виде, в каком они хранятся в БД Бюро, вне зависимости от того, заполнено ли
поле «Дата истребования поручительства» в соответствующей записи «Информация о договоре поручительства» или нет.
6.14 Информация о договорах залога Consumer.[].CAIS.[].Lien.[]
Коллекция Consumer.[].CAIS.[].Lien.[] содержит структуры в которых хранится информация о договорах залога.
www.bki-okb.ru
59
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
60
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Lien Comments lienComments Text 150 В этом поле указываются комментарии и дополнительная информация.
Unique Loan uniqueLoanIdentifier Text
identifier 70 Уникальный идентификатор договора
6.15 Информация о льготном периоде (ипотечные каникулы) Consumer.[].CAIS.[]. MortgageHoliday.[]
В блоке Информация о льготном периоде (ипотечные каникулы) Consumer.[].CAIS.[]. MortgageHoliday.[] содержится информация о о льготном периоде (ипотечные
каникулы), в случае, если заемщик его запросил. Состав возвращаемых атрибутов описан в таблице ниже.
Информация о льготном периоде (ипотечные каникулы) выдается в отчетах только при выполнении следующих запросов:
www.bki-okb.ru
61
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
62
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Информация об отдельно переданных Банковских гарантиях выдается в отчетах только при выполнении следующих запросов:
• CPU Extended Enquiry 40
• CPU Consumer Enquiry (new) 72
• CPU Business Enquiry (new) 73
• CPU Standard Credit Enquiry 70
Name XML-имя Тип Длина Описание
Guarantee Agreement Number guarAgreementNumber Text 40 Идентификатор договора банковской гарантии
Guarantor Name guarantorName Text 150 Наименование банка выдавшего гарантию
Guarantee Covered Amount guarCoveredAmount Numeric 15 Объем обязательства, обеспеченного гарантией
Guarantee Covered Amount guarCoveredAmountCurrency Currency Code 3 Валюта объема обязательства, обеспеченного
Currency гарантией
Guarantee Amount guarAmount Numeric 15 Сумма гарантии
Guarantee Currency guarAmountCurrency Currency Code 3 Валюта гарантии
Guarantee Open date guarOpenDate Date 8 Дата начала срока действия гарантии
Guarantee Due date guarDueDate Date 8 Плановая дата окончания срока действия гарантии
Guarantee Close Date guarCloseDate Date 8 Фактическая дата окончания срока действия гарантии
Guarantee Reason For Closure guarReasonForClosure Security reason for closure 2 Причина окончания срока действия гарантии
Number of Bank Guarantee guarNumOfHolders Numeric 2 Число владельцев Банковской гарантии
Holders
Timestamp of first take-on guarDateAdded Timestamp 14 Временная метка первого добавления
Timestamp of last update lastUpdateTS Timestamp 14 Временная метка последнего обновления
Guarantee date of last update monthOfLastUpdate Date 8 Дата учета последнего файла с обновлением.
Вместе с этим блоком также выдается блок Consumer.[].GUAR.[]. SubscriberDetails в тех случаях, когда информация о подписчике SubscriberDetails может быть
выдана при запросе.
6.19 Информация о субъекте Банковской гарантии в бюро Consumer.[].GUAR.[].Consumer.[0]
Коллекция “Consumer.[].GUAR.[].Consumer.[]” содержит структуры, в которых хранится информация из ответа Кредитного Бюро о владельце Банковской гарантии и
владельце счета.
www.bki-okb.ru
63
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
64
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Previous company previousCompanyName Text 100 Наименование реорганизованного юридического лица до реорганизации
name
Sex sex Sex Code 1 Код, указывающий пол клиента, или то, что клиент – юридическое лицо
Date of Birth dateOfBirth Date 8 Дата рождения
Place of Birth placeOfBirth Text 100 Место рождения
Nationality nationality Country 2 Гражданство
Consent Flag consentFlag Consumer 1 Флаг, указывающий, подписал ли данный клиент соглашение, позволяющее
Consent кредитной организации передавать информацию о кредитной истории в Бюро.
Indicator
Date Consent Given dateConsentGiven Date 8 Дата, когда было дано согласие
Mobile Telephone mobileTelNbr Text 16 Номер мобильного телефона владельца счета.
Number
Primary ID Authority primaryIDAuthorityCode Text 7 Код органа, выдавшего основной удостоверяющий документ
code.
www.bki-okb.ru
65
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
66
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
67
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
68
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
</s>
</c>
www.bki-okb.ru
69
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Если секция Decision была передана для запроса с причиной Reason for Enquiry = “11”, то она не будет возвращена в ответ на указанные выше типы запросов.
www.bki-okb.ru
70
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
71
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
72
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
73
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
74
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
75
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
6.28 Информация о предыдущем результате проверки субъекта запроса в бюро Consumer.[].CAPS.[]. Consumer.[0].Verification
Коллекция “Consumer.[].CAPS.[].Consumer.[0].Verification” содержит информацию о предыдущем результате Проверки личности для владельца банковского счета,
который совпал с критериями запроса. Возвращенные атрибуты описаны в следующей таблице:
Name XML-имя Тип Длина Описание
Person Status status PersonStatus Статус проверки личности, основанный на результате проверки удостоверения личности и адреса
www.bki-okb.ru
76
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
77
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
78
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
79
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
<s>
<a n="confidenceFlag">1</a>
<a n="scoreCardType">12</a>
<a n="scoreInterval">1</a>
<a n="scoreNumber">-222</a>
</s>
<s>
<a n="confidenceFlag">1</a>
<a n="scoreCardType">1</a>
www.bki-okb.ru
80
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
<a n="scoreInterval">4</a>
<a n="scoreNumber">858</a>
</s>
Если по каким-то причинам рассчитать скоринг для одного из типов скоринговой карты будет невозможно, ‘scoreNumber’ примет значение «-9999», ‘scoreCardType’
будет отображаться корректно, а ‘confidenceFlag’ и ‘scoreInterval’ примут нулевое значение.
Пример:
<s>
<a n="confidenceFlag">0</a>
<a n="scoreCardType">1</a>
<a n="scoreInterval">0</a>
<a n="scoreNumber">-9999</a>
</s>
www.bki-okb.ru
81
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Поля, начинающиеся с маски «privateEntr*» будут возвращаться только в кредитном отчете Субъекта кредитной истории в том случае, когда subscriberType is
“Private Entrepreneur”.
Поля subscriberType, subscriberSpecialStatus, subscriberSpecStatusStartDate будут всегда возвращаться как для своих, так и для чужих данных для всех типов
запросов.
Теги subscriberName и subscriberID раскрываются только подписчику, являющемуся владельцем данной записи (CAIS, CAPS, и др.).
www.bki-okb.ru
82
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
83
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
6.34.2 Consumer.[].BankruptcyProcedure[].BankruptcyComissioner
Name XML-имя Тип Длина Описание
Bankruptcy commissioner ID bcmCommissionerID Numeric 10 Идентификатор финансового управляющего
Bankruptcy commissioner ID in the bcmUFRBI Text 40 Идентификатор финансового управляющего в ЕФРСБ
UFRBI
Surname bcmSurname Text 150 Фамилия
First name bcmName Text 100 Имя
Patronymic bcmPatronymic Text 100 Отчество
Date of birth bcmDateOfBirth Date 8 Дата рождения
Name of self-regulatory organization bcmRegulatoryOrgName Text 1000 Название СРО
Address of self-regulatory bcmRegulatoryOrgAddress Text 200 Адрес СРО
organization
OGRN of self-regulatory organization bcmRegulatoryOrgOGRN Text 20 ОГРН СРО
INN of self-regulatory organization bcmRegulatoryOrgINN Text 20 ИНН СРО
Поля данной секции возвращаются только в субъектном кредитном отчете, для Собственных данных и в ответе на запрос Оператора Бюро. Во всех остальных
случаях данный блок возвращается пустым.
www.bki-okb.ru
84
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
6.34.3 Consumer.[].BankruptcyProcedure[].BankruptcyConsumer
Name XML-имя Тип Длина Описание
Bankruptcy Consumer ID bcoConsumerID Numeric 10 Идентификатор банкрота
Surname bcoSurname Text 150 Фамилия
Maiden Name bcoAliasName Text 150 Девичья фамилия
First name bcoName Text 100 Имя
Patronymic bcoPatronymic Text 100 Отчество
Date of birth bcoDateOfBirth Date 8 Дата рождения
Place of birth bcoPlaceOfBirth Text 100 Место рождения
Sex code bcoSexCode Sex code 1 Пол
SNILS (Pension Number) bcoSNILS Text 20 СНИЛС
INN (Individual TAX Number) bcoINN Text 20 ИНН
Primary ID Type bcoPrimaryIDType Identity Type 2 Тип основного удостоверяющего документа
Primary ID Number bcoPrimaryID Text 20 Номер основного удостоверяющего документа
ID Issue Place bcoIDPlaceOfIssue Text 20 Место выдачи основного удостоверяющего документа
ID Issue Date bcoIDIssueDate Date 8 Дата выдачи основного удостоверяющего документа
Region bcoRegionCode Republic / 2 Республика/регион/область
Region
District bcoDistrict Text 100 Округ/район/штат
City bcoCity Text 50 Населенный пункт / Поселок / Город
Street bcoStreet Text 50 Название проспекта / улицы / переулка
House number bcoHouseNumber Text 6 Номер дома
Construction bcoConstruction Text 6 Строение /корпус
Building bcoBuilding Text 20 Номер блока
Flat number bcoFlatNbr Text 6 Номер квартиры
Post Code bcoPostCode Text 6 Индекс
www.bki-okb.ru
85
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
6.34.4 Consumer.[].BankruptcyProcedure[].BankruptcyRecord[]
Name XML-имя Тип Длина Описание
Bankruptcy Record ID breRecordID Numeric 10 Идентификатор записи о банкротстве
Bankruptcy procedure ID breProcedureID Numeric 10 Идентификатор процесса банкротства
Last update date breLastUpdateDate Date 8 Дата последнего обновления
Date of report to Credit Bureau breDateOfReportCB Date 8 Дата передачи данных в кредитное Бюро
Court decision date breCourtDecisionDate Date 8 Дата принятия решения суда
Court decision authority breCourtDecisionAuth Text 100 Наименование судебного органа, вынесешего решение
Court decision resolution breCourtDecisionRes Text 1000 В этом поле в текстовом формате передается содержание
резолютивной части решения суда.
Bankruptcy procedure stage breProcedureStageCode Bankruptcy 2 Стадия процедуры банкротства
procedure
stages
Bankruptcy procedure stage details breProcedureStageDet Text 1000 Детали текущей стадии банкротства
Date of inclusion to UFRBI breDateOfUFRBI Date 8 Дата включения сведений в ЕФРСБ
Reference to UFRBI breUFRBIRef Text 50 Ссылка на ЕФРСБ
7. Типы запросов
7.1 Стандартный запрос (Standard Credit Enquiry)
• Номер функции : 70
• Используется стандартный шаблон запроса (Input Request)
• Входящий запрос (Input Request) проверяется как Credit Enquiry
• Разрешено включать в него блок «Решения по кредитному заявлению» (Decision)
• В отчете вернется информация о Банковских Гарантиях, переданных в Бюро в GDS-файлах
www.bki-okb.ru
86
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Для новых субъектов запроса должна использоваться причина запроса 01 – “Заявка на кредит”. Также поля “Application Number” и “Application date” должны
быть корректно заполнены. При этом информация о заявлении будет сохранена в информационной части КИ субъекта.
Ответ на Запрос (Standart Credit Enquiry) представляет собой структуру “XML Output” без блока «Решения по кредитному заявлению» (CAPS decision section).
В данной структуре не будет отображена информация по полям: уникальный номер договора, текущий остаток по счету и код органа, выдавшего основной
удостоверяющий документ.
Все заявления (записи CAPS), выполненны с причиной (Reason for enquiry) 08 будут исключены из ответа на данный Запрос.
Выходной XML ответ для стандартного запроса кредитного отчета состоит из следующих основных блоков:
<s>
<c n=”Consumer” (client) >
<s>
<c n=”BankruptcyProcedure” (Bankruptcy details)>
<s>
<!-- Bankruptcy information omitted here -->
<s n=”BankruptcyConsumer”>
<!-- Consumer information omitted here -->
</s>
<c n=”BankruptcyRecord”>
<s>
<!—Bankruptcy Record information omitted here -->
</s>
<s>
<!—Second Bankruptcy Record information omitted here -->
</s>
</c>
<s n=”BankruptcyCommissioner”>
<!—Bankruptcy Commissioner details information omitted here -->
</s>
www.bki-okb.ru
87
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
</s>
<s>
<!-- Second Bankruptcy information omitted here -->
</s>
</c>
<c n=”BureauScore” (bureau score)>
<s>
<!-- Score information omitted here -->
</s>
</c>
www.bki-okb.ru
88
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
</c >
<s n=”Employer” {employer details}>
<!-- Employer information omitted here -->
</s>
<c n=”Legal” (court decisions)>
<!-- Legal information omitted here -->
</c>
<s n=”Warranty” (warranty details)>
<!-- Warranty information omitted here -->
</s>
<c n=”WarrantyHistory” (warranty history details)>
<s>
<s>
<!-- Warranty historical information omitted here -->
</s>
</s>
</c>
</s>
</s>
</c>
<c n=”Guarantee” (bank gurantee details)>
<s>
<!-- Guarantee information tied to account is omitted here -->
</s>
</c>
<c n=”Lien” (lien details)>
<s>
<!-- Lien information omitted here -->
</s>
</c>
<c n=”MonthlyHistory” (account history details)>
<!-- CAIS historical information omitted here -->
</c>
www.bki-okb.ru
89
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
90
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
</c>
<s n=”SubscriberDetails”> (subscriber details details)>
<!-- Subscriber details information omitted here -->
</s>
</s>
<s>
<!-- Second Bureau Enquiry information omitted here -->
</s>
</c>
<c n=”ExtDB1” (SPARK DB1)>
<!-- External Database 1 - SPARK information omitted here -->
</c>
<c n=”ExtDB2” (SPARK DB2 Entrepreneurs)>
<!-- External Database 2 - SPARK Entrepreneurs information omitted here -->
</c>
www.bki-okb.ru
91
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
<s>
<!-- Bank guarantee information omitted here -->
</s>
<s>
<!-- Second bank guarantee omitted here -->
</s>
</c>
</s>
</c>
<s n=”SubscriberDetails”> (subscriber details details)>
<!-- Subscriber details information omitted here -->
</s>
</s>
</c>
<c n=”NameIDHistory” (name and passport history changes)>
<s>
<!-- Name and passport history changes information omitted here -->
</s>
</c>
<s n=”PVS”>
<!-- Person Verification Service response information omitted here -->
</s>
<s n=”Summary” (summary details)>
<!-- Summary Information omitted here -->
</s>
<c n=”Warnings” (report warnings) >
<!-- Warnings information omitted here -->
</c>
</s>
</c>
www.bki-okb.ru
92
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Часть полей (см. Раздел 10) маскируется и не выдается в ответе при Стандартном типе запроса кредитного отчета в Бюро.
7.2 Запрос Расширенного кредитного отчета (Extended Credit Enquiry)
7.2.1 XML – запрос
Запрос на получение расширенного кредитного отчета выполняется со следующими параметрами:
• Номер функции 40 (Header.Function = 40)
• Запрос имеет ту же структуру и использует те же данные, что и запрос на стандартный кредитный отчет
• Запрос валидируется по алгоритму валидации Credit Enquiry
• Допускается включение в запрос секции Decision
• В отчете вернется информация о Банковских Гарантиях, переданных в Бюро в GDS-файлах
Дополнительную информацию по формату запроса можно получить в разделах 4, 5 этого документа.
Для новых кредитных заявлений тег «Причина запроса» (Reason for Enquiry) должен быть заполнен 01 (Заявка на новый кредит). Поля “Application Number” и
“Application date” должны быть заполнены корректно. При этом информация о заявлении будет сохранена в информационной части КИ субъекта.
1 Validation Errors
errorCode
2 responseDate
3 streamID
www.bki-okb.ru
93
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
4
5 Consumer
6 Consumer.[].Summary
7 Consumer.[].BankruptcyProcedure[]
8 Consumer.[].BankruptcyProcedure[].BankruptcyCommissioner
9 Consumer.[].BankruptcyProcedure[].BankruptcyConsumer
10 Consumer.[].BankruptcyProcedure[].BankruptcyRecord[]
11 Consumer.[].CAIS.[]
12 Consumer.[].CAIS.[].MortgageHoliday
13 Consumer.[].CAIS.[].Assignee
14 Consumer.[].CAIS.[].Assignee.[0].SubscriberDetails
15 Consumer.[].CAIS.[].Consumer.[0]
16 Consumer.[].CAIS.[].Consumer.[0].Address.[]
17 Consumer.[].CAIS.[].Consumer.[0].Employer.[]
18 Consumer.[].CAIS.[].Consumer.[0].Legal.[]
19 Consumer.[].CAIS.[].Consumer.[0].Warranty.[]
20 Consumer.[].CAIS.[].Consumer.[0].Warranty History.[]
21 Consumer.[].CAIS.[].Guarantee.[]
22 Consumer.[].CAIS.[].Lien.[]
23 Consumer.[].CAIS.[].Monthly History.[]
24 Consumer.[].CAIS.[].SubscriberDetails
25 Consumer.[].GUAR.[] (when guarantor is not tied to account)
26 Consumer.[].GUAR.[].Consumer.[0]
27 Consumer.[].GUAR.[].Consumer.[0].Address.[]
28 Consumer.[].GUAR.[]. SubscriberDetails
29 Consumer.[].NameIDHistory.[]
30 Consumer.[].CAPS.[]
31 Consumer.[].CAPS.[].Decision
32 Consumer.[].CAPS.[].Consumer[0]
33 Consumer.[].CAPS.[].Consumer[0].Employer
34 Consumer.[].CAPS.[].Consumer[0].Address.[]
35 Consumer.[].CAPS.[].Consumer[0].Verification
www.bki-okb.ru
94
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
36 Consumer.[].CAPS.[].SubscriberDetails
37 Consumer.[].PVS
38 Consumer.[].ExtDB1.[]
39 Consumer.[].ExtDB2.[]
40 Consumer.[].Bureau Score.[]
В секции Consumer.[].CAPS.[].Decision ответа Бюро значение суммы решения отражается только для типа решения “03 (Отказ)”.
Часть полей (см. Раздел 10) маскируется и не выдается в ответе при Стандартном типе запроса кредитного отчета в Бюро.
7.3 Запрос на передачу заявления на получение кредита (Application Load Enquiry)
Информационная часть кредитной истории субъекта на стороне Бюро может быть сформирована двумя способами:
1. Запрос кредитного отчета (функции запроса FN=40, 67, 70) с причиной запроса 01 (заявление на получение кредита). Это стандартный процесс передачи
информационных частей в Бюро в он-лайн режиме. При этом информация о заявлении субъекта на стороне Бюро формируется автоматически.
2. Передача заявления без выполнения запроса (Application Load Enquiry). Относится к тем заявлениям субъектов, по которым не направлялись запросы в
Бюро.
Этот запрос может предавать блок Решение по кредитному заявленю для записи CAPS.
Поэтому, следующие дополнительные условия должны быть соблюдены:
• Блок «Решение» является опциональным
• Тег Stream ID запрещен, не передается
• Эту функцию нельзя использовать для обновления информации по решению.
www.bki-okb.ru
95
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Если необходимо обновить ранее переданное заявление (CAPS) или решение по заявлению (CAPS Decision), то необходимо использовать запрос на обновление
решения по заявлению (CAPS Decision Update).
7.3.2 XML – ответ
Ответ содержит структуру, содержащую только поля указанные ниже и коллекцию Validation Errors, содержащую ошибки валидации (если были).
XML Name Type Описание
responseDate Timestamp Дата и время запроса
errorCode Numeric Код ошибки
streamID Numeric Номер ссылки этого запроса
При этом функция CAPS Decision Update может быть использована для повторной передачи (обновления ранее переданной) информации о решении: новая
информация о решение записывается поверх уже существующей информации о решении (одобрении или отказе), старая информация затирается.
www.bki-okb.ru
96
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Функция Обновление решения по заявлению на получение кредита (CAPS Decision Update) применяется для передачи или обновления решения по заявлению при
условии использования в качестве причины запроса значений 01 или 08.
EnquiryRequest
Name Имя поля XML-имя Тип Длина M Примечания
Application Number номер заявки applicationNumb Text 30 С Если значением поля Reason for Enquiry является «Заявление на
er получение кредита» (01) или «Передача заявления без запроса» (08),
то заполнение поля Application Number является обязательным. Если
значением поля Reason for Enquiry не является «Заявление на
получение кредита» (01) или «Передача заявления без запроса» (08),
то поле Application Number не используется.
Application Date дата подачи applicationDate Date 8 С Если значением поля Reason for Enquiry является «Заявление на
заявки получение кредита» (01) или «Передача заявления без запроса» (08),
то заполнение поля Application Date является обязательным. Если
значением поля Reason for Enquiry не является «Заявление на
получение кредита» (01) или «Передача заявления без запроса» (08),
то поле Application Date не используется.
Значение поля Application Date не должно быть в будущем или
раньше 20150301.
Finance Type тип financeType Finance 2 M Код, идентифицирующий тип кредитного счета.
финансирования Type
www.bki-okb.ru
97
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
98
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Дли
DecisionName Имя поля XML-имя Тип M Примечания
на
Присутствует и является обязательным только в запросе на
Предыдущий
Previous Stream ID streamID Numeric 20 С обновление решения по заявлению - CPU Decision Update, Function
Stream ID
Number = 41
Type of Decision typeOfDecision Decision 2 Тип решения. Поле должно быть заполнено значением 01 (Заявление
type одобрено) если в поле «причина принятия решения» выбрано
значение 01(Заявление одобрено).
В Бюро предусмотрены следующие типы решений:
Тип решения М
01 – Заявление одобрено
02 – На рассмотрении
03 – Отказ
99 – Нет информации
Date of Decision Дата принятия dateOfDecision Date 8 Дата принятия решения. Не должна быть в будущем.
М
решения
Decision End Date Дата окончания decisionEndDate Date 8 Дата окончания срока действия решения. Поле обязательно для
срока действия заполнения, если Тип решения «01 - Approved», в остальных случаях
решения поле условно обязательное
М
Decision End date >= Date of Decision
Может быть в будущем по отношению к Дате принятия решения не
более чем на 12 месяцев.
www.bki-okb.ru
99
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Decision Reason Причина по decisionReason Decision 2 Причина, по которой по кредитному заявлению было принято данное
принятому Reason решение. Поле обязательно для заполнения. Поле должно быть
решению, заполнено значением 01 (Заявление одобрено) если в поле «тип
решения» выбрано значение 01(Заявление одобрено).
В Бюро предусмотрены следующие причины принятия решения:
01 – Заявление одобрено
М 02 – Кредитная история заемщика
03 – Избыточная долговая нагрузка на заемщика (поручителя)
04 – Кредитная политика заимодавца (кредитора)
05 – Несоответствие информации о заемщике, указанной заемщиком в
заявлении, сведениям, которыми располагает заимодавец (кредитор)
98 – Прочее
99 – Нет информации
Decision Amount Сумма решения decisionAmount Numeric 15 М Сумма, по которой было принято решение по кредитному заявлению
Currency Валюта кредита, currency Currency 3 Валюта кредита, на получение которого подавалось кредитное
М
Code заявление
Comments Комментарии comments Text 256 Комментарии
www.bki-okb.ru
100
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer
Name Имя поля XML-имя Тип Длина M Примечания
Если значением поля Sex не является Company
(компания) (3), то заполнение поля First Name (имя)
First Name Имя name1 Text 100 С обязательно.
Если значением поля Sex (пол) является Company
(компания) (3), то First Name (имя) не используется.
Если значением поля Sex (пол) является Company
Фамилия/ Название
Surname surname Text 150 M (компания) (3), то в поле Surname (фамилия) вводится
компании
название компании
Вводимое значение поля Date of Birth (дата рождения)
не должно относиться к будущему периоду времени.
Если значением поля Sex (пол) не является Company (3),
Date of Birth дата рождения dateOfBirth Date 8 С
то значение поля Date of Birth должно соответствовать
минимальному возрасту потенциального Заявителя - 16
лет
Nationality гражданство nationality Country 2 M
тип основного Смотрите Допустимые Типы основного удостоверения
Primary ID Type удостоверяющего primaryIDType Identity Type 2 M и типы дополнительного удостоверения (Primary ID
документа Type and Secondary ID Type)
номер основного
Primary ID удостоверяющего primaryID Text 20 M
документа
дата выдачи
основного Значение поля Primary ID Issue Date не может
Primary ID Issue Date primaryIDIssueDate Date 8 M
удостоверяющего относиться к будущему периоду времени
документа
www.bki-okb.ru
101
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
102
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
7.4.2 XML-ответ
Структура xml-ответа на запрос обновления принятого решения содержит только поля из таблицы ниже, а также набор ошибок валидации.
XML Name Type Description
responseDate Timestamp Временная метка запроса
errorCode Numeric Код ошибки запроса
streamID Numeric Сгенерированный номер запроса
<s>
<a n=”responseDate”>20031021101436</a>
<a n=”errorCode”>0</a>
<a n=”streamID”>12345</a>
<c n=”ValidationErrors” />
</s>
7.5 Запрос наличия кредитной истории (Existence Check Enquiry)
7.5.1 XML – запрос
Запрос на проверку наличия кредитной истории выполняется со следующими параметрами:
• Номер функции 51 (Header.Function = 51)
• Запрос имеет ту же структуру и использует те же данные, что и запрос на стандартный кредитный отчет
Дополнительную информацию по формату запроса можно получить в разделах 4, 5 этого документа.
• Струкутра Decision не передается.
При запросе могут возникать Validation Errors, информация о которых также включается в коллекцию. Ниже представлен пример XML с блоком Validation Errors.
Enquiry Response
Validation Errors
www.bki-okb.ru
103
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
errorCode
responseDate
streamID
<s n="EnquiryResponse">
<c n="Consumer">
<s>
<s n="Summary">
<a n="CAISRecordsOwner">3</a>
</s>
</s>
</c>
<c n="ValidationErrors" />
<a n="errorCode">0</a>
<a n="responseDate">20141002181653</a>
<a n="streamID">30807</a>
7.6 Запрос информационной части (Info Part Enquiry)
7.6.1 XML – запрос
Запрос на проверку наличия кредитной истории выполняется со следующими параметрами:
• Номер функции 67 (Header.Function = 67)
• Запрос имеет ту же структуру и использует те же данные, что и запрос на стандартный кредитный отчет
Дополнительную информацию по формату запроса можно получить в разделах 4, 5 этого документа.
• Запрос информационной части может быть выполнен только по физическому лицу.
• Поля Application Number и Application Date должны быть корректно заполнены.
• Структура Decision не заполняется.
В этот отчет включаются только те записи CAIS, по которым флаг “Info Part Contribution flag” выставлен 1.
www.bki-okb.ru
104
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
В этот отчет включаются только те записи CAPS, в которых “Reason for Enquiry” (причина запроса) = 01 (заявление на кредит) или 08 (Загрузка заявления) и “Application
Date” (Дата заявления) >= 20150301.
В этом отчете обязательно выводится информация по следующим полям:
• Application Number (CAPS)
• Application Date (CAPS)
• Legal Account Number (CAIS)
Должно быть пустым для данного типа отчета:
• fulfilmentDueDate (CAIS)
• openDate (CAIS)
• paymentSource (CAIS)
• subscriberSpecialStatus (CAIS)
• subscriberSpecStatusStartDate (CAIS)
Структура отчета:
Validation Errors
errorCode
responseDate
streamID
Consumer
Consumer.[].Summary
Consumer.[].CAIS.[]
Consumer.[].CAIS.[].Consumer.[0]
Consumer.[].CAIS.[].Consumer.[0].Warranty.[]
Consumer.[].CAIS.[].SubscriberDetails
Consumer.[]. NameIDHistory.[]
Consumer.[].CAPS.[]
Consumer.[].CAPS.[].Consumer[0]
Consumer.[].CAPS.[].Decision
Consumer.[].CAPS.[].SubscriberDetails
Ответ представляет собой стандартный ответ Бюро, который содержит только следующие блоки:
Consumer.[].Summary.[]
www.bki-okb.ru
105
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].CAIS.[]
Name XML-имя Тип Длина Описание
Account Open Date openDate Date 8 Дата открытия счета. Должно быть пустым для данного типа отчета
Finance Type financeType Finance Type 2 Код, идентифицирующий тип кредита.
Account Payment accountPaymentStatu Account Payment 1 Поле отражает исполнение платежей по счету. Поле возвращается только в
Status s Status случае когда его значение 120+ дней просроченной задолженности (статусы
4,5,6,8,L,W)
Account Special Status accountSpecialStatus Account Special Status 2 Поле возвращается в ответе только когда его значение равно 08 (Отсутствие
двух и более подряд платежей в течение 120 календарных дней с даты
наступления срока исполнения обязательства)
CBR Finance Type CBRFinanceType CBR Finance Type 3 Тип кредита по классификации ЦБ РФ
Legal Account Number legalAccountNumber Text 80 Номер договора юридический
Reason for Closure reasonForClosure Reason for Closure 2 Причина закрытия счета
Account Closed Date accountClosedDate Date 8 Дата Закрытия счета
Application Number applicationNumber Text Номер заявления. Поле должно быть заполнено реальным значением.
Consumer Account consumerAccountNu Text 40 Номер счета Субъекта. Поле возвращается только для собственных данных.
Number mber
Fulfilment Date fulfilmentDueDate Date 8 Договорная дата исполнения обязательств. Должно быть пустым для данного
типа отчета
Accounting Date of Last monthOfLastUpdate Date 8 Дата учета последнего загруженного файла с обновлением.
Update
Last Update Timestamp lastUpdateTS Timestamp 14 Временная метка последнего обновления
Source of Payment paymentSource Payment Source 2 Источник платежа. Должно быть пустым для данного типа отчета
Subscriber Comments subscriberComments Text 2000 Комментарии
www.bki-okb.ru
106
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].CAIS.[0].SubscriberDetails
Name XML-имя Тип Длина Описание
Private Entrepreneur Licensce privateEntrLicNbr Text Номер свидетельства индивидуального предпринимателя
Number
Private Entrepreneur Licence Issue privateEntrLicIssueDate Date 8 Дата выдачи свидетельства индивидуального предпринимателя
Date
Private Entrepreneur Surname privateEntrSurname Text 150 Фамилия индивидуального предпринимателя
Private Entrepreneur Name privateEntrName Text 100 Имя индивидуального предпринимателя
Private Entrepreneur Patroymic privateEntrPatronymic Text 100 Отчество индивидуального предпринимателя
Private Entrepreneur Date of Birth privateEntrDOB Date 8 Дата рождения индивидуального предпринимателя
Private Entrepreneur ID Number privateEntrIdNbr Text 20 ID индивидуального предпринимателя
Private Entrepreneur ID Issue Date privateEntrIdIssueDate Date 8 Дата выдачи ID индивидуального предпринимателя
Private Entrepreneur Issue Place privateEntrIssuePlaceAuthority Text 100
Authority
Subscriber Description subscriberDescr Text 255 Описание подписчика
Subscriber ID subscriberID Numeric 5 Код подписчика
Subscriber Name subscriberName Text 100 Имя подписчика
Subscriber OGRN subscriberOgrn Text 13 ОГРН подписчика
Subscriber OKPO subscriberOkpo Text 8 ОКПО подписчика
Subscriber Special Status subscriberSpecialStatus Subscriber 2 Специальный статус подписчика. Должно быть пустым для
Special Status данного типа отчета
Subscriber Special Status Start Date subscriberSpecStatusStartDate Date 8 Дата выставления специального статуса подписчика. Должно
быть пустым для данного типа отчета
Subsriber Tax Number subscriberTaxNbr Text 10 ИНН подписчика
Subscriber Type subscriberType Subscriber 2 Тип подписчика
Type
www.bki-okb.ru
107
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].CAIS.[].Consumer.[0]
Name XML-имя Тип Длина Описание
Account Holder Type accountHolderType Account 2 типы отношения к счету со стороны владельца счета/заявителя.
Holder Владелец, совладелец, принципал или поручитель
Type
First Name name1 Text 100 Имя или краткое наименование организации
Patronymic name2 Text 100 Отчество или иностранное наименование организации
Surname surname Text 150 Фамилия или полное наименование организации
Primary ID Type primaryIDType Identity 2 Тип основного удостоверения личности
Type
Primary ID Number primaryID Text 20 Номер основного удостоверения личности
Primary ID Issue Date primaryIDIssueDate Date 8 Дата выдачи основного удостоверения личности
Primary ID Issue Place primaryIDPlaceOfIssue Text 30 Место выдачи основного удостоверения личности.
Primary ID Expiry primaryIDExpiry Date 8 Дата окончания срока действия основного удостоверения личности
Primary ID Authority primaryIDAuthority Text 100 Код и наименование органа, выдавшего основной удостоверяющий
документ.
Date of Birth dateOfBirth Date 8 Дата рождения
Place of Birth placeOfBirth Text 100 Место рождения
Consumer.[].CAIS.[].Consumer.[0].Warranty.[]
Name XML-имя Тип Длина Описание
Warranty Agreement Number warrantyAgreementNumber Text 40 идентификатор договора поручительства
Account Finance Type accFinanceType Finance Type 2 Тип финансирования счета
Account CBR Finance Type accCBRFinanceType CBR Finance Type 3 Тип кредита из договора займа, в соответствие с
классификацией займов Банка России.
Accounting date of last update warrantyMonthOfLastUpdate Date Дата внесения изменения
Timestamp of last update warrantyLastUpdateTS Timestamp 14 Временная метка обновления счета
Warranty Claim date warrantyClaimDate Date 8 Дата, в которую кредитор истребовал погашение основного
долга с поручителя
Warranty Payment Status warrantyPaymentStatus Account Payment Status 1 Статус просрочки по договору поручительства на дату
внесения записи
www.bki-okb.ru
108
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].NameIDHistory.[]
Name XML-имя Тип Длина Описание
ID Change Source idChangeSource Primary ID Type/Secondary ID 2 Тип документа
Change Source
ID Change Date idChangeDate Date 8 Дата изменения документа
ID Type idType Identity Type 2 Тип документа
ID Number idNbr Text 20 Номер документа
ID Issue Date idIssueDate Date 8 Дата выдачи паспорта
ID Place of Issue idPlaceOfIssue Text 30 Место выдачи паспорта
ID Authority idAuthority Text 100 Наименование органа, выдавшего паспорт, код подразделения
ID Expiry Date idExpiryDate Date 8 Дата окончания действия документа
Passport Status idStatus Passport status 2 Статус паспорта
Country Code nationality Country 3 Страна
Pension Number pensionNbr Text 20 СНИЛС
Surname surname Text 150 Фамилия
First Name name1 Text 100 Имя
Second Name name2 Text 100 Отчество
Date of Birth dateOfBirth Date 8 Дата рождения
Place of Birth placeOfBirth Text 100 Место рождения
New ID Number newIdNbr Text 20 Новый номер документа
www.bki-okb.ru
109
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].CAPS.[]
Записи CAPS возвращаются только в случае выбора причины запроса 01 (Завление на получение кредита) или 08 (Загрузка заявления без запроса)
Name XML-имя Тип Длина Описание
Generated streamID Numeric 20 Сформированный номер ссылки. Поле будет заполнено только для
Reference Number собственных данных.
Reason for Enquiry reason Reason for Enquiry 2 Основание для запроса
Date of Enquiry enquiryDate Date 8 Дата запроса
Application Number applicationNumber Text 30 номер заявки
Application Date applicationDate Date 8 дата подачи заявки
Finance Type financeType Finance Type 2 тип финансирования
Credit Limit creditLimit Numeric 9 лимит кредитования
Amount of Finance amountOfFinance Numeric 9 размер кредитования (сумма средств)
Application channel applicationChannel Application channel 2 Способ подачи заявления
CBR Finance Type CBRFinanceType CBR Finance Type 3 Тип финансирования в соответствии с классификацией ЦБ России
www.bki-okb.ru
110
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].CAPS.[0].SubscriberDetails
Name XML-имя Тип Длина Описание
Private Entrepreneur privateEntrLicNbr Text Номер свидетельства индивидуального предпринимателя
Licensce Number
Private Entrepreneur privateEntrLicIssueDate Date 8 Дата выдачи свидетельства индивидуального предпринимателя
Licence Issue Date
Private Entrepreneur privateEntrSurname Text 150 Фамилия индивидуального предпринимателя
Surname
Private Entrepreneur privateEntrName Text 100 Имя индивидуального предпринимателя
Name
Private Entrepreneur privateEntrPatronymic Text 100 Отчество индивидуального предпринимателя
Patroymic
Private Entrepreneur privateEntrDOB Date 8 Дата рождения индивидуального предпринимателя
Date of Birth
Private Entrepreneur ID privateEntrIdNbr Text 20 ID индивидуального предпринимателя
Number
Private Entrepreneur ID privateEntrIdIssueDate Date 8 Дата выдачи ID индивидуального предпринимателя
Issue Date
Private Entrepreneur privateEntrIssuePlaceAuthority Text 100
Issue Place Authority
Subscriber Description subscriberDescr Text 255 Описание подписчика
Subscriber ID subscriberID Numeric 5 Код подписчика
Subscriber Name subscriberName Text 100 Имя подписчика
Subscriber OGRN subscriberOgrn Text 13 ОГРН подписчика
Subscriber OKPO subscriberOkpo Text 8 ОКПО подписчика
Subscriber Special Status subscriberSpecialStatus Subscriber Special Status 2 Специальный статус подписчика
Subscriber Special Status subscriberSpecStatusStartDate Date 8 Дата выставления специального статуса подписчика
Start Date
Subsriber Tax Number subscriberTaxNbr Text 10 ИНН подписчика
Subscriber Type subscriberType Subscriber Type 2 Тип подписчика
www.bki-okb.ru
111
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].CAPS.[].Consumer[0]
Name XML-имя Тип Длина Описание
Applicant Type applicantType Applicant 2 тип заявителя: Владелец, совладелец, принципал или поручитель
Type
First Name name1 Text 100 Имя / Краткое наименование организации
Patronymic name2 Text 100 Отчество / Наименование организации на иностранном языке
Surname surname Text 150 Фамилия / Полное наименование компании
Date of Birth dateOfBirth Date 8 дата рождения
Place of Birth placeOfBirth Text 100 место рождения
Primary ID Type primaryIDType Identity Type 2 тип основного удостоверяющего документа
Primary ID primaryID Text 20 номер основного удостоверяющего документа
Primary ID Issue primaryIDIssueDate Date 8 дата выдачи основного удостоверяющего документа
Date
Primary ID Issue primaryIDIssuePlace Text 30 место выдачи основного удостоверяющего документа
Place
Primary ID Expiry primaryIDExpiry Date 8 дата истечения срока действия удостоверяющего документа
Date
Primary ID Authority primaryIDAuthority Text 100 орган, выдавший основной удостоверяющий документ
Consumer.[].CAPS.[].Decision
Name XML-имя Тип Длина Описание
Previous Stream ID streamID Numeric 20 Сформированный номер ссылки для этого решения. Может отличаться от такого
же поля в блоке CAPS, если решение было передано с помощью функции
Decision Update
Type of Decision decisionType Decision type 2 Тип принятого решения
Date of Decision dateOfDecision Date 8 Дата принятия решения
Decision End Date decisionEndDate Date 8 Дата окончания срока действия решения
Decision Reason decisionReason Decision 2 Причина по решению, которое было принято по кредитному заявлению
Reason
Decision Amount decisionAmount Numeric 15 Сумма, по которой было принято решение по кредитному заявлению.
Возвращается в ответе только в случае одобрения.
www.bki-okb.ru
112
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Если запрос выполняется по новому заемщику, то в качестве причины запроса (Reason for Enquiry) необходимо уазывать «01 – New credit Application». Поля
Application Number и Application Date должны быть также правильно заполнены.
7.7.2 XML-ответ
В ответе Скоринга бюро выдаются только скоринговый балл, номер скоринговой карты, рисковый индекс и индикатор достоверности. Структура XML-ответа
Скоринга бюро сходна со структурой CAIS, CAPS и EXDBs.
Ответ включает в себя только поля блока “Bureau Score” и, в случае наличия ошибок, блок “Validation Errors”.
См. дополнительную информацию по формату ответа Скоринга Бюро в разделе Информация Скоринг Бюро Consumer.[0].BureauScore[].
www.bki-okb.ru
113
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
8. Ошибки
Все ошибки закодированы, ниже приведен полный перечень возможных ошибок.
В блоке <a n=”errorCode” (код ошибки) >0</a>,
возвращается значение: 0-нет ошибок, 1-есть ошибки.
8.1 Ошибки обработки
Ошибки обработки являются следствием сбоя. При использовании протокола HTTPS используется значение состояния ответа.
Описание ошибки Состояние (HTTPS)
Пустое поле User name (имя пользователя) или недействительное значение “403 Forbidden” (запрещено)
поля Function number (номер функции)
Неверный XML “400 Bad Request” (неправильный запрос)
Неверный формат XML “400.1 Bad Request” (неправильный запрос)
Сбой в процессе запроса “503 Service unavailable” (сервис недоступен)
www.bki-okb.ru
114
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
www.bki-okb.ru
115
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
116 Невозможно определить тип ошибки. Обратитесь в Unable to log. Contact CB operator
техническую поддержку.
www.bki-okb.ru
116
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
202 Запись CAPS найдена, но некоторые поля отличаются от CAPS mismatch. CAPS record found, but some field(s) does not match.
указанных в запросе
204 Дополнительная проверка корректности. Некоторые из Extra Validation failed. Some of the Decision field(s) is invalid.
полей запроса некорректны
205 Найдена запись CAPS, но не совпадают поля основного CAPS ID mismatch. CAPS record found, but Primary ID field(s) does not match.
удостоверения личности.
207 Запись CAPS найдена, но причина запроса не Credit CAPS Reason for Enquiry mismatch. CAPS Record found, but Reason For Enquiry
Application (01) или Application Load (08). is not Credit Application (01) or Application Load (08)
208 Запись CAPS найдена, но номер заявки не совпадает. CAPS Application number mismatch. CAPS record found but Application Number
does not match.
209 Запись CAPS найдена, но тип финансирования не CAPS Account Type mismatch. CAPS record found but Account Type does not
совпадает. match.
210 Тип решения и Причина решения имеют разные Type of Decision and Decision reason are different. Type of Decision must be
значения. Тип решения должен иметь значение “01/Approved” when Decision reason = “01/Approved” (and vice versa).
01/Одобрено если Причина решения = 01/Одобрено (и
наоборот)
8.5 Описание предупреждений
В приведенной ниже таблице описаны возможные значения возвращаемых предупреждений. Некоторые из них заканчиваются числом (<n>), показывающим
сколько раз данное предупреждение было обнаружено.
Имя предупреждения Описание Description
WARNING_CAIS_BLOCKED Данный клиент имеет, по крайней мере, один This client has at least one blocked CAIS account. Blocked
блокированный счет CAIS. Блокированные счета не accounts are not returned.
возвращаются.
WARNING_CAIS_QUERIED Данный клиент имеет, по крайней мере, один This client has at least one queried CAIS account. Queried
сомнительный счет CAIS. Сомнительные счета accounts are returned.
возвращаются.
WARNING_TOO_MANY_ Данный клиент имеет слишком много счетов CAIS. This client has too many CAIS accounts. Only the worst accounts
CAIS_RECORDS Возвращаются только счета с наибольшей просрочкой are returned.
выплат.
WARNING_TOO_MANY_ На данного клиента имеется слишком много запросов This client has too many Bureau Enquiries. Only the most recent
CAPS_RECORDS Бюро. Возвращаются только самые последние из них. enquiries are returned.
www.bki-okb.ru
117
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
9. Собственные данные
Счет CAIS или запись CAPS считаются «Собственными Данными», если выполняются условия:
• Пользователь является владельцем данных.
• Пользователь является Оператором Бюро.
• Владелец данных является дочерним подписчиком Пользователя.
• Пользователь и Владелец данных являются дочерними подписчиками одного и того же подписчика.
Если счет субъекта (CAIS) не относится к Собственным Данным, то поле Consumer Account Number (номер счета клиента), Legal Account Number (номер счета
юридический) and the Account Owner Name (имя владельца счета) не будет содержать значения.
Набор следующих полей также не будет содержать значения для не Собственных Данных:
Секция «Guarantee» – поля « Guarantee Agreement Number» и «Guarantor Name».
Секция «Warrantee» – поле «Warranty Agreement Number» и «Legal Warranty Agreement Number».
Секция «Assignee» – все поля заполняются в соответствии с правилами, определенными в разделах SubscriberDetails и «Собственные данные».
Секция «Lien» – поле «Lien Agreement Number».
www.bki-okb.ru
118
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Если запрос в Бюро (CAPS) не относится к Собственным Данным, то поля «Generated Reference Number» (Stream ID)/(сформированный ссылочный номер) и
«Application Number» остаются не заполненными, а поле «Owner Name» (имя владельца) меняется на поле «Business Type» (вид бизнеса).
Поля « subscriberType», «subscriberSpecialStatus», «subscriberSpecStatusStartDate» содержат значения и для Собственных и для не Собственных данных для всех
видов запросов.
Поля «subscriberID» и «subscriberName» доступны только для Пользователя, являющегося Владельцем данных.
Правила отображения собственных данных не применяются для запросов Оператора Бюро.
Consumer.[].CAIS.[].Consumer.[0]
- Mobile Telephone Number (Номер мобильного телефона)
Consumer.[].CAIS.[].Consumer.[0].Address.[]
- Home Telephone Number (Номер домашнего телефона)
Consumer.[].CAIS.[].Consumer.[0].Employer.[]
- Все поля
Consumer.[].CAPS.[].Consumer.[0]
- Driving license (Номер водительского удостоверения), Medical Insurance Number (Номер медицинского страхования)
- Income (Доход), Income Frequency (Частота получения дохода), Net Gross (общий доход), Other Income (Другие доходы)
- Residential Status (стаус проживания), Occupation (работа), Occupation Status (статус занятости), Marital Status (семейное положение), No. of Dependants
(количество иждивенцев), Education (образование)
- Mobile Telephone (мобильный телефон), Mobile Phone Registration (регистрация мобильного телефона)
- Visa Credit Card, MasterCard, Diners Credit Card, American Express, JCB Credit Card, Debit Card, Cheque Guarantee, Retail Credit Card, Other Credit Card
Consumer.[].CAPS.[].Consumer[0].Address.[]
- Telephone (телефон)
Consumer.[].CAPS.[].Consumer[0].Employer
- Все поля
www.bki-okb.ru
119
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Consumer.[].GUAR.[].Consumer.[0].Address.[]
- Home Telephone Number (номер домашнего телефона)
11. Проверки
Проверки, выполняются в соответствии с Приложением С «Описания данных CAIS»
www.bki-okb.ru
120
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Схема запроса на получение кредитного отчета с автоматическим формированием заявления в информационной части кредитной истории субъекта
Rejected
Decision [0..1]
Application App Stream ID CAPS Decision Update
App Stream ID (FN = 41)
Application
number
Approved CAIS
Standard Enquiry
(FN = 70)
Reason = 01
App Stream ID
anytime 1..n
Request Details
Decision [0..1] registration
InfoPart Enquiry
(FN = 67)
Reason = 01
www.bki-okb.ru
121
Спецификация B2B-интерфейса. V. 2.35 от 25.09.2019
Rejected
Decision [0..1]
App Stream ID
anytime 1..n
Extended Enquiry
(FN = 40)
All Reasons (not 01)
InfoPart Enquiry
(FN = 67)
All Reasons (not 01)
www.bki-okb.ru
122