Технічні умови
подання банками до Національного банку України 
інформації про кредитні операції банку
з боржником-фізичною/юридичною особою та ведення Кредитного реєстру Національного банку України (версія 4.4)

Ці технічні умови (далі - ТУ) визначають вимоги щодо подання інформації згідно з Розділом V Правил організації статистичної звітності, що подається до Національного банку України (затверджені постановою Правління Національного банку України від 13 лютого 2018 року № 120 (зі змінами),  та Положенням про Кредитний реєстр Національного банку України (затверджене постановою Правління Національного банку України від 04 травня 2018 року № 50).

1.	Загальні положення

1.1.	Інформаційний обмін між банком (далі – Банк) і системою Національного банку України (далі – НБУ) накопичення  інформації про кредитні операції банків (далі – Реєстр) здійснюється згідно технології RESTful веб-API.
1.2.	Передавання інформації між  Банком та НБУ здійснюється із використанням механізмів захисту інформації – автентифікації, конфіденційності та контролю цілісності.
1.3.	НБУ проводить автентифікацію та авторизацію Банків  використовуючи криптографічний протокол TLS (Transport Layer Security), вимоги до налаштування якого наведено нижче.
1.4.	Усі повідомлення інформаційного обміну мають формуватися з використанням формату JSON та відповідати формалізованому опису, визначеному у JSON – схемі.
1.5.	JSON - схеми повідомлень наведені у додатках. У всіх повідомленнях використовується кодування символів UTF-8.
1.6.	Для підтвердження автентичності та цілісності інформації використовується електронний цифровий підпис (далі – ЕЦП), вимоги до якого наведено нижче.
1.7.	ЕЦП накладається відповідно до вимог описаних в стандарті RFC 7515 - JSON Web Signature (JWS).

2.	Вимоги до забезпечення цілісності інформації

2.1.	Реєстр використовує зовнішню систему захисту інформації НБУ (бібліотеки криптографічного захисту інформації SecLib02 або RSAC), яку використовує, наприклад, і СЕП-2, отриманий за договором укладеним між Банком та НБУ відповідно до постанови Правління НБУ від 26 листопада 2015 року №829 “Про затвердження нормативно-правових актів з питань інформаційної безпеки”. Для генерації ключів для роботи з Реєстром необхідно використовувати той самий генератор ключів, що і для СЕП-2 – ПМГК.
2.2.	Генерація ключів захисту. Для забезпечення роботи у Реєстрі, для кожного робочого місця необхідно згенерувати ПМГК та направити на сертифікацію ключ

                                  RxxRKy, де

Rxx – ідентифікатор, закріплений за цією установою та вбудований в ПМГК (для банків-учасників СЕП це послідовність з 2-го по 4-й символи ідентифікатора учасника СЕП). Загальна довжина елементу – 3 символи;
RK – тип задачі (“Реєстр”); 
y=0..9 – номер робочого місця.
Після завершення процедури генерації файл відкритого ключа потрібно надіслати засобами електронної пошти НБУ на адресу ZAH-KEY@U1H0 на сертифікацію.
Після сертифікації в центрі сертифікації НБУ сертифікат надсилається на адресу INF_Rxx@URxx «АРМ НБУ Інформаційного» та перекладається до вихідного каталогу системи автоматизації банку.
2.3.	Таблиці відкритих ключів. Для функціонування Реєстру на стороні Банка потрібні файли-таблиці відкритих ключів зовнішньої системи захисту інформації НБУ pub_nbu.ind (pub_odb.ind) та pub_nbu.key (pub_odb.key). Перед початком роботи до таблиць потрібно вбудувати власний сертифікат ключа та сертифікат НБУ.
2.4.	Банк для накладання ЕЦП на інформацію (власним ключом RxxRKy) та перевірки ЕЦП у відповідях від НБУ (ключом сервера) використовує бібліотеки криптографічного захисту інформації SecLib02 або RSAC.

3.	Вимоги до використання криптографічного протоколу TLS та відповідних сертифікатів відкритих ключів

3.1.	НБУ та Банк для встановлення захищеного з’єднання повинні використовувати криптографічний протокол TLS не нижче версії 1.2, а також відповідні особисті ключі та сертифікати відкритих ключів.
3.2.	У протоколі TLS допускаються різні криптографічні набори.
3.3.	Криптографічний набір узгоджується між Банком та сервером НБУ (далі – Сервер) під час встановлення з’єднання. Банк передає Серверу список підтримуваних криптографічних наборів, а Сервер вибирає один з них для захисту інформації.
3.4.	Сервери не повинні використовувати криптографічні набори, які не використовують шифрування або використовують для шифрування алгоритм RC4 (в якості EncryptionAlg встановлено NULL або RC4).
3.5.	Для шифрування інформації повинні використовуватись симетричні криптографічні алгоритми з довжиною ключа не менше 128 біт.
3.6.	Довжина відкритого ключа RSA повинна бути не меншою 2048 біт. 
3.7.	Заборонено використовувати криптографічні набори які використовують попередньо узгоджений загальний секретний ключ (PSK).
3.8.	Для узгодження сеансових ключів використовуються протоколи DHE та ECDHE. Довжина відкритого ключа для протоколу DH повинна бути не меншою 2048 біт. Довжина відкритого ключа для протоколу ECDHE повинна бути не меншою 256 біт.
3.9.	Рекомендується використовувати такі криптографічні набори:
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256;
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256;
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384;
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.
3.10.	Для роботи з сервісами подання інформації має використовуватись неперсоніфікований сертифікат технологічного робочого місця з типом здачі CRK. Генерація сертифіката здійснюється за допомогою ПМГК.
3.11.	Для роботи з сервісами прийому запитів на пошук та надання інформації має використовуватись персоніфікований сертифікат «Зовнішній користувач ІС – посадова особа учасника ІС». Генерація сертифіката здійснюється за допомогою ПМГК. Користувач, що здійснює запити до сервісу, повинен мати відповідні повноваження, що надаються  власниками неперсоніфікованих SSL сертифікатів в Банку: адміністраторами облікових записів (власники сертифікатів типу ADU) та  адміністраторами керування повноваженнями (власники сертифікатів типу ADR). Для надання необхідних повноважень створено окремий ВЕБ сервіс «Керування повноваженнями зовнішніх користувачів інформаційних систем Національного банку України». Назва ролі, що має бути надана користувачу – CM_CRK_SKU. Інструкцію для роботи з сервісом надано в Додатку 1.

4.	Типи JSON об’єктів

4.1.	У Реєстрі використовуються 4 типи об’єктів: 
-	Боржник - юридична особа (далі – Боржник);
-	Боржник - фізична особа (далі – Боржник);
-	Забезпечення за кредитною операцією;
-	Кредитна операція.
4.2.	Ієрархія взаємозв’язку об’єктів: 
-  у  Боржника може не бути, або бути як завгодно багато застав;  
- у Боржника може не бути, або бути як завгодно багато кредитних операцій, які можуть бути пов’язані тільки з заставами Боржника або непов’язані з жодною заставою.

5.	Опис роботи Реєстру

5.1.	Реєстр використовує клієнт-серверну технологію. Банки відправляють та отримують інформацію за допомогою HTTP-запитів (GET, POST, PUT) до відповідних веб-сервісів.
5.2.	Для коректної роботи з веб-сервісами у файлі «c:\Windows\System32\drivers\etc\hosts» необхідно забезпечити наявність таких рядків: 
-	«172.22.2.168		app-crk01»
-	«172.22.2.22		app-crk-stend01».
5.3.	Обмін даними між банком та Реєстром відбувається відповідно до вимог описаних в стандарті RFC 7515 - JSON Web Signature (JWS), використовується тип серіалізації Flattened JWS JSON Serialization (крім запиту на пошук інформації про Боржника, р.18).
5.4.	Відповідно до рекомендацій з використання RESTful веб-API прийняті наступні домовленості:
- запит типу GET використовується для отримання інформації;
- POST для додавання  нового запису;
- PUT для редагування запису.
5.5.	Загальна схема взаємодії з Реєстром наведена у Додатку 2.
5.6.	Для тестування і відпрацювання технології інформаційної взаємодії між системами автоматизації банків з Реєстром розгорнуто тестові ВЕБ-сервіси.
5.7.	Взаємодія з веб-сервісами відбувається за адресами: https://app-crk01 для продуктивного середовища і https://app-crk-stend01 – для тестового (далі по тексту замість зазначених конкретних адрес використовується змінна cr_server). Для роботи з сервісами використовується порт 443. 
5.8.	Для роботи з тестовим сервісом банки мають використовувати сертифікати від тестового АЦСК НБУ. Налаштування програмно-апаратного модулю генерації криптографічних ключів на роботу із тестовим АЦСК НБУ здійснювати відповідно до п.3 Інструкції з використання програмно-апаратного модулю генерації криптографічних ключів СЕП та інформаційних задач для отримання «SSL-сертифікатів».

6.	Надання інформації до Реєстру

6.1.	На стороні НБУ для прийому інформації від Банків та надання інформації Банкам налаштовано чотири веб-сервіса: 1) веб-сервіс «Боржник» (фізична особа) – customer_pp, 2) веб-сервіс «Боржник» (юридична особа) – customer_lp, 3) веб-сервіс «Застави» - pledge та 4) веб-сервіс «Кредитні угоди» - credit.
6.2.	Якщо умовами договору про відкриття кредитної лінії з Боржником  визначено суми, валюти та строки погашення для кожного траншу, то разом з інформацією про кредитну операцію передається інформація щодо кожного траншу в окремому елементі (структурі).
При занесенні даних про кредитну операцію і пов’язані з нею транші до Реєстру діють такі правила:
-	якщо дані про транші, пов’язані з цією операцією, в Реєстрі не містяться (тобто раніше не надавалися банком), то дані про «нові» транші, що надіслані банком, додаються до Реєстру і вважаються актуальними до наступного передавання даних;
-	якщо в Реєстрі вже містились дані про транші, пов’язані з цією операцією (тобто раніше надавалися банком), «нові» дані затирають «старі» дані;
-	якщо у надісланих даних про кредитну операцію не міститься даних про пов’язані транші, то дані про транші у Реєстрі  залишаються незмінними (не важливо, були вони чи ні);
-	  якщо у банка є необхідність видалити усі дані про транші, пов’язані з цією операцією,  то окремий елемент (структура), в якому передається інформація про транші, має містити літеру «D».
6.3.	Банк надає інформацію про Боржника, забезпечення за кредитними операціями та про кредитні операції Боржника та у такій спосіб:
1)	спочатку Банк надає інформацію про Боржника в одному повідомлені (веб-сервіс «Боржник»).  
При успішному прийомі Реєстром інформації про Боржника Банк разом з кодом про успішну обробку отримує у відповідь унікальний код Боржника.
2)	Банк надає інформацію про забезпечення за кредитними операціями Боржника (якщо є) в іншому повідомлені (веб-сервіс «Застави»), вказуючи отриманий унікальний код Боржника.
При успішному прийомі Реєстром інформації про забезпечення за кредитними операціями Боржника Банк разом з кодом про успішну обробку отримує унікальний код для кожного забезпечення.
3)	 Банк надає інформацію про кредитні операції (і про транші, якщо такі є) в іншому повідомлені (веб-сервіс «Кредитні угоди»), вказуючи отриманий унікальний код Боржника. Якщо за кредитом надано забезпечення, то Банк в повідомлені про кредитну операцію вказує у відповідному реквізиті унікальний код/коди такого забезпечення.
При успішному прийомі Реєстром інформації про кредитну операцію Банк разом з кодом про успішну обробку отримує унікальний код кредитної операції.
6.4.	Слід враховувати наступне.
Ключовими реквізитами Боржника в Банку є:
для фізичної і для юридичної особи – код країни реєстрації, “Ідентифікатор Боржника” та “Код виду документа”.
Ключовими реквізитами кредитної операції в Банку є:
-	унікальний код Боржника (наданий Реєстром під час першого успішного прийому інформації про Боржника);
-	номер договору;
-	дата укладання договору.
Ключовими реквізитами забезпечення в Банку є:
-	унікальний код Боржника (наданий Реєстром під час першого успішного прийому інформації про Боржника);
-	номер договору застави;
-	дата укладання договору застави;
-	вид забезпечення (код S031);
-	порядковий номер забезпечення. Банк самостійно присвоює  номер забезпеченню і відслідковує унікальність номерів забезпечення Боржника.
6.5.	Для додавання інформації  щодо нових Боржників необхідно використовувати повідомлення (POST) на веб-сервіс «Боржник».
6.6.	Для коригування даних (у тому числі ключові реквізити) про Боржника Банк надсилає відповідне повідомлення (PUT) з унікальним кодом Боржника та актуальними даними про нього на веб-сервіс «Боржник».
6.7.	Для додавання інформації щодо нового забезпечення Боржника, інформація про якого вже надавалася до Реєстру,  необхідно використовувати відповідне повідомлення (POST) на веб-сервіс «Застави».
6.8.	Банк використовує унікальний код забезпечення для його ідентифікації при необхідності коригування інформації (у тому числі ключові реквізити) по цьому  забезпеченню, шляхом надсилання відповідного повідомлення (PUT) на веб-сервіс «Застави».
6.9.	Для додавання інформації щодо нових кредитних операцій Боржника, інформація про якого вже надавалася до Реєстру, необхідно використовувати відповідне повідомлення (POST) на веб-сервіс «Кредитні угоди».
6.10.	Банк використовує унікальний код кредитної операції для її ідентифікації при необхідності коригування інформації (у тому числі ключові реквізити) по цій  кредитній операції, шляхом надсилання відповідного повідомлення (PUT) на веб-сервіс «Кредитні угоди».
6.11.	Банк використовує унікальний код Боржника під час передавання інформації про кредитні операції та забезпечення за ними цього Боржника. 
6.12.	Якщо кредитна операція забезпечена, Банк разом з інформацією про кредитну операцію надає унікальний номер (номери) забезпечення, яке пов’язане з цією кредитною операцією.
6.13.	Якщо дані по забезпеченню кредитної операції не змінились, то під час коригування даних про кредитну операцію надавати повторно інформацію про пов’язане з кредитною операцією забезпечення непотрібно. Якщо було змінено перелік пов’язаного з кредитною операцією забезпечення, то треба надати актуальний його перелік.
6.14.	Під час виконання запитів POST, PUT діють таки загальні правила.
При виконанні запиту типу POST (для додавання  нового Боржника/нового забезпечення/нової кредитної операції) Реєстр здійснює перевірку: чи є у базі даних реєстру запис з даними ключовими реквізитами Боржника/нового забезпечення/нової кредитної операції. Якщо такій запис знайдено, Банк отримує повідомлення про помилку. 
При виконанні запитів типу PUT (для редагування ключових та неключових реквізитів запису) редагується запис, який буде знайдений за унікальним кодом Боржника/унікальним кодом забезпечення/унікальним кодом кредитної операції відповідно.
При виконанні запиту типу PUT (якщо змінюються ключові реквізити  Боржника/забезпечення/кредитної операції) Реєстр здійснює перевірку: чи вже існує у базі даних реєстру запис з даними ключовими реквізитами Боржника/ забезпечення/кредитної операції. Якщо такій запис знайдено, Банк отримує повідомлення про помилку.
Вилучення інформації (запит типу DELETE) не допускається.
6.15.	Запити (тип GET), які використовуються банками для контроля наданої до Реєстру інформації, можуть бути загальні та конкретні. Загальний запит (GET без параметрів): Банк надсилає запит на сервіс Боржник/Забезпечення/Кредитні операції та у відповідь отримає перелік унікальних кодів Боржників/унікальних кодів забезпечень/унікальних кодів кредитних операцій, які містяться в Реєстрі.
Конкретний запит  (GET з параметрами): Банк надсилає запит з параметром – унікальним кодом Боржника/Забезпечення/Кредитної операції на відповідний сервіс та у відповідь отримає ключові реквізити Боржника/Забезпечення/ Кредитної операції, які містяться в Реєстрі.
JSON - схеми повідомлень та приклади наведені у додатках.

7.	Загальна структура повідомлень, що надходять від Банка до НБУ.

Повідомлення (запит) типу GET, запит актуальних унікальних кодів  Боржника/забезпечення/кредитної операції, які було подано Банком (де xxxx – сервіс customer_pp або  customer_lp , або  pledge, або credit)
GET https://app-crk01/cr_reestr/api/v2/xxxx
Content-Type: application/json

Повідомлення (запит) типу GET, nnnn 
Запит ключових реквізитів про Боржника, забезпечення, кредитну операцію (де xxxx – сервіс customer_pp або  customer_lp, або  pledge, або credit; nnnn – унікальний код Боржника/забезпечення/кредитної операції).

GET https://app-crk01/cr_reestr/api/v2/xxxx/nnnn 
Content-Type: application/json

Повідомлення (запит) типу POST.
Подання інформації про нового Боржника, забезпечення, кредитну операцію (де xxxx – сервіс customer_pp або  customer_lp, або  pledge, або credit)

POST https://app-crk01/cr_reestr/api/v2/xxxx 
Content-Type: application/json

{
“payload” : ”EFycmF5T2ZURVNUVEFCIHhtbG5zOmk9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0iaHR0cDovL3NjaGVtYXMuZGF0YWNvbnRyYWN0Lm9yZy8yMDA0LzA3L0NyZWRSZWVzdHJfREJNb2RlbCI-PFRFU1RUQUIgaTp0eXBlPSJURVNUVEFC”,
“protected” : ”NDwvVEFCX0lEPjxUQUJfVEVYVD7QnNCG0JrQntCb0JDQh9CE0pA8L1RBQl9URVhUPjwvVEVTVFRBQj48VEVTVFRBQiBpOnR5cGU9IlRFU1RUQUIiPjxUQUJ”,
“header” : null,
“signature” : “NCG0JrQntCb0JDQh9CE0pA8L1RBQl9URVhUPjwvVEVT”
}	

Повідомлення (запит) типу PUT, nnnn
Корегування даних про Боржника, забезпечення, кредитну операцію (де xxxx – сервіс customer_pp або  customer_lp, або  pledge, або credit; nnnn – унікальний номер Боржника/забезпечення/кредитної операції).

PUT https://app-crk01/cr_reestr/api/v2/xxxx/nnnn
Content-Type: application/json

{
“payload” : ”EFycmF5T2ZURVNUVEFCIHhtbG5zOmk9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0iaHR0cDovL3NjaGVtYXMuZGF0YWNvbnRyYWN0Lm9yZy8yMDA0LzA3L0NyZWRSZWVzdHJfREJNb2RlbCI-PFRFU1RUQUIgaTp0eXBlPSJURVNUVEFC”,
“protected” : ”NDwvVEFCX0lEPjxUQUJfVEVYVD7QnNCG0JrQntCb0JDQh9CE0pA8L1RBQl9URVhUPjwvVEVTVFRBQj48VEVTVFRBQiBpOnR5cGU9IlRFU1RUQUIiPjxUQUJ”,
“header” : null,
“signature” : “NCG0JrQntCb0JDQh9CE0pA8L1RBQl9URVhUPjwvVEVT”
}	

8.	Опис форматів даних, що використовуються у повідомленнях.

	Формат	Позначення	Значення	
1	Символьний	С (максимальна довжина)	Набор символів	
2	Числовий	N(2) або N(7,4)	число у відповідному форматі (роздільник - крапка). N(7,4) – число (загальна кількість цифр у числі не більше 7, кількість цифр у числі після крапки не більше 4).	
3	Логічний	B	true або false	
4	Дата, ISO 8601	D(10)	2015-05-19	
5	Комбіновані дата й час, ISO 8601	D(19)	2015-05-19T15:22:37	

Формат дати D(10), що використовується у повідомленнях:
“YYYY-MM-DD”, де: YYYY – рік (чотири цифри), MM –місяць (дві цифри), DD – день (дві цифри). Наприклад: 2015-05-19 означає 19 травня 2015 року.
Формат дати та часу D(19), що використовується у захищеному заголовку повідомлення:
“YYYY-MM-DDThh:mm:ss” , де: YYYY – рік (чотири цифри), MM –місяць (дві цифри), DD – день (дві цифри), T – спеціальний символ, hh – години (дві цифри), mm – хвилини (дві цифри), ss – секунди (дві цифри). Наприклад: 2015-05-19T15:22:37 означає 19 травня 2015 року 15 година 22 хвилини 37 секунд.
Необов'язкові поля заповнюються наступним чином: -якщо даних немає то поле або не вказується, або встановлюється значення null; -якщо поле вказується і значення не дорівнює null, то значення повинне задовольняти вимогам наведеним в Json схемі.

9.	Загальна структура повідомлення, що отримує Банк у відповідь на свій запит у разі його успішної обробки.

Повідомлення (відповідь) на запити типу GET
HTTP/1.1 200 OK
Content-Type: application/json

{
“payload” : ”lc3REYXRhMTwvVEFCX1RFWFQ-PC9URVNUVEFCPjxURVNUVEFCIGk6dHlwZT0iVEVTVFRBQiI-PFRBQl9EQVQ-MjAxNy0wNi0wOFQxNjozNjoyOS45OTk3MzM0KzAzOjAwPC9”,
“protected” : ”QUJfVEVYVD7QnNCG0JrQntCb0JDQh9CE0pA8L1RBQl9URVhUPjwvVEVTVFRBQj48VEVTVFRBQiBpOnR5cGU9IlRFU1RUQUIiPjxUQU”,
“signature” : “NlIiB4bWxucz0iaHR0cDovL3NjaGVtYXMuZGF0YWNvbnRyYWN0Lm9yZy8yMD”
}	
Повідомлення (відповідь) на запити типу POST
HTTP/1.1 201 Created
Content-Type: application/json

{
“payload” : ”lc3REYXRhMTwvVEFCX1RFWFQ-PC9URVNUVEFCPjxURVNUVEFCIGk6dHlwZT0iVEVTVFRBQiI-PFRBQl9EQVQ-MjAxNy0wNi0wOFQxNjozNjoyOS45OTk3MzM0KzAzOjAwPC9”,
“protected” : ”QUJfVEVYVD7QnNCG0JrQntCb0JDQh9CE0pA8L1RBQl9URVhUPjwvVEVTVFRBQj48VEVTVFRBQiBpOnR5cGU9IlRFU1RUQUIiPjxUQU”,
“signature” : “NlIiB4bWxucz0iaHR0cDovL3NjaGVtYXMuZGF0YWNvbnRyYWN0Lm9yZy8y”
}	
Повідомлення (відповідь) на запити типу PUT
HTTP/1.1 200 OK
Content-Type: application/json

Всі значення параметрів (payload, protected, signature), вкладені JSON – об’єкти, повинні бути закодовані (стандарт RFC 7515) за допомого Base64Url кодування (стандарт RFC 4648).
Повідомлення, JSON – об’єкт повинен містити наступні параметри:
1.	“payload” – об’єкт в якому передаються дані повідомлень (об’єкт  “data”);
2.	“protected” – об’єкт в якому передається захищений заголовок повідомлення;
3.	“signature” – закодоване за допомогою Base64Url кодування (стандарт RFC 4648) значення ЕЦП. Мається на увазі саме кодування строкового (Base64) значення ЕЦП, а не приведення його до Base64Url шляхом заміни деяких символів.

Можливі статуси повідомлення (відповіді):

200: статус Ok. Вказує на успішну обробку повідомлення (запита) GET;
201: статус Created. Вказує на успішне створення об’єкта. Використовується у відповіді на повідомлення (запит) POST;
203: статус Non-Authoritative Information – Вказує на невідповідність вхідного повідомлення формалізованому опису, визначеному у JSON – схемі.
400: статус BadRequest - помилка при обробці повідомлення (запита);
401: статус Unathorized – Банк не авторизовано;
403: статус Forbidden - доступ заборонено;
404: статус NotFound - ресурс не знайдено;
412: статус Precondition Failed – не вірне значення ЕЦП.

Реквізити об’єкта “data”, в якому міститься квитанція сформована за результатами роботи відповідного сервісу (запит типу POST), і який знаходиться в закодованому вигляді в об’єкті “payload”:

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний ідентифікатор сесії, в якій було оброблено інформацію	session_id	С(100)	+		
2	Адреса веб-сервіса, яким було оброблено інформацію	web_service_url	C(100)	+		
3	Http метод запиту	http_method	C(15)	+		
4	IP адреса з якої було здійснено запит	client_ip	C(15)	+		
5	Унікальний ідентифікатор SSL сертифіката користувача який здійснював запит	client_cert_id	C(50)	+		
6	Код помилки	general_err_code	N(20)	+	Загальний код помилки отриманий за результатами обробки запиту. Можливі значення: 0 – оброблено без помилок; 1 – оброблено з помилками (інформація не прийнята); 2 – оброблено з помилками (інформація прийнята частково. Див. п. 10.3 опису структури result_kvi).	
7	Код стану HTTP	general_http_status_code	N(3)	+	Частина першого рядка відповіді сервера при запитах по протоколу HTTP (HttpStatusCode).	
8	Коментар	general_err_comment	C(250)	+	Загальний коментар за результатами обробки запиту.	
9	Дата та час формування квитанції	kvi_date	D	+	Дата та час у форматі 
YYYY-MM-DDThh:mm:ss[.sssss]	
10. Перелік результатів виконання операцій в рамках запиту. Структура (елемент) result_kvi.	
10.1	Порядковий номер  запису у повідомлені	orderNum	N(20)	+	Дорівнює значенню orderNum в повідомленнях про забезпечення/ кредитні операції від банку.	
10.2	Унікальний код Боржника/забезпечення/кредитної операції.	reestr_id	N(20)	+	Унікальний код Боржника/забезпечення/кредитної операції, наданий Реєстром під час першого успішного прийому інформації.	
10.3	Код помилки за операцією	err_code	N(20)	+	Можливі значення: 0 – операцію оброблено без помилок; 1 – операцію оброблено з помилками (інформація за даною операцією не прийнята);	
10.4	Коментар до виконання операції	err_comment	C(250)	+		
10.5	Дата та час здійснення операції (з мілісекундами)	err_date	D	+	YYYY-MM-DDThh:mm:ss.sssss	

Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запити типу POST.

{
  "session_id": "7c405ab9ed0f6bd3a10892b7f6fdc0d6e373d00c68bad4ee5a56c5c675be45d9",
  "web_service_url": "https://app-crk01/cr_reestr/api/v2/xxxx",
  "client_ip": "172.22.1.123",
  "client_cert_id": "XRxxiiinnn",
  "general_err_code": 2,
  "general_http_status_code": 200,
  "general_err_comment": "Коментар зформований за результатами роботи сервісу",
  "kvi_date": "2017-10-02T16:57:42.8452978+03:00",
  "result_kvi": [
    {
      "orderNum": 1,
      "reestr_id": 10,
      "err_code": 0,
      "err_comment": "Коментар до однієї операції 1",
      "err_date": "2017-10-02T16:57:42.851803+03:00"
    },
    {
      "orderNum": 2,
      "reestr_id": 0,
      "err_code": 1,
      "err_comment": "Коментар до однієї операції 2",
      "err_date": "2017-10-02T16:57:42.851803+03:00"
    },
    {
      "orderNum": 3,
      "reestr_id": 12,
      "err_code": 0,
      "err_comment": "Коментар до однієї операції 3",
      "err_date": "2017-10-02T16:57:42.851803+03:00"
    }
  ]
}	

10.	Опис реквізитів об’єкта “protected”, в якому передається захищений заголовок повідомлень, що використовуються в Реєстрі (усі реквізити є обов’язковими).

Найменування реквізиту	Зміст	Значення	
alg	Криптографічний алгоритм який буде використано при створенні JWS об'єкту	none	
typ	Тип серіалізації JWS	JOSE+JSON	
cty	Тип контенту JWS об'єкту	application/json	
kid	Унікальний ідентифікатор ключа системи захисту НБУ, яким було створено ЕЦП	RxxRKy, де
Rxx – ідентифікатор, закріплений за цією установою та вбудований в ПМГК (для банків-учасників СЕП це послідовність з 2-го по 4-й символи ідентифікатора учасника СЕП). Загальна довжина елементу – 3 символи;
RK – тип задачі (“Реєстр”); 
y=0..9 – номер робочого місця.	
dateOper	Дата створення повідомлення	Дата у форматі D(20)	
appId	Унікальний код задачі	CRK	

11.	Правила заповнення реквізитів.

Правила заповнення реквізитів викладені у Описі правил та особливостей формування реквізитів повідомлень об'єктів.
11.1.	«Код Боржника за параметром К020» і для фізичної особи, і для юридичної особи зазначається за параметром К020 за винятком: якщо код/ідентифікаційний номер нерезидента містить більше 10 знаків, то заповнення параметра відбувається в такому форматі: латинська літера «I» та код/ідентифікаційний номер нерезидента без скорочення.
11.2.	Реквізити «Ідентифікатор Боржника», «Ідентифікатор роботодавця», «Ідентифікатор учасника групи», «Ідентифікатор пов’язаного контрагента», «Ідентифікатор власника істотної участі» заповнюється одним з таких наявних значень (викладені за пріоритетами у разі наявності кількох):
для фізичних осіб-резидентів
1) реєстраційний номер облікової картки платника податків (РНОКПП);
2) унікальний номер запису в Єдиному державному демографічному реєстрі (УНЗР);
3) серія і номер паспорта у вигляді книжечки (без пробілів);
4) серія і номер документа, що замінює паспорт (без пробілів);
для фізичних осіб-нерезидентів
1) реєстраційний номер облікової картки платника податків (РНОКПП);
2) ідентифікаційний номер, який фізична особа має у країні постійного місця проживання;
3) серія і номер паспорта (без пробілів);
4) серія і номер документа, що замінює паспорт (без пробілів);
5) присвоєний банком умовний код для цілей складання статистичної звітності.
для юридичних осіб-резидентів 
1) ідентифікаційний код відповідно до Єдиного державного реєстру підприємств та організацій України (ЄДРПОУ);
для юридичних осіб-нерезидентів
1)	ідентифікаційний код відповідно до Єдиного державного реєстру підприємств та організацій України (ЄДРПОУ);
2)	ідентифікаційний код відповідно до вимог законодавства країни – місця реєстрації юридичної особи;
3)	присвоєний банком умовний код для цілей складання статистичної звітності.
11.3.	В реквізиті «Код виду документа» вказується код того документу, який банк використав для заповнення колонки «Ідентифікатор Боржника». Реквізит може приймати одне із значень з переліку, який наведений нижче (перелік містить у тому числі документи, визначені у Законі України «Про Єдиний державний демографічний реєстр та документи, що підтверджують громадянство України, посвідчують особу чи її спеціальний статус»). 
Код виду документа	Вид документа, який використовувався для заповнення колонки «Ідентифікатор Боржника»	
Фізична особа	
11	Облікова картка платника податків в Україні	
12	Єдиний державний демографічний реєстр України	
14	Паспорт громадянина України (у вигляді книжечки)	
15	Паспорт громадянина України для виїзду за кордон	
16	Дипломатичний паспорт України	
17	Службовий паспорт України	
18	Посвідчення особи моряка	
19	Посвідчення члена екіпажу	
20	Посвідчення особи на повернення в Україну	
21	Тимчасове посвідчення громадянина України	
31	Ідентифікаційний номер у країні постійного місця проживання (для нерезидента)	
32	Паспорт громадянина іншої країни (для нерезидента)	
33	Присвоєний банком умовний код	
49	Інший документ	
Юридична особа	
11	Облікова картка платника податків в Україні (для ФОП)	
12	Єдиний державний демографічний реєстр України (для ФОП)	
14	Паспорт громадянина України (у вигляді книжечки) (для ФОП)	
51	Єдиний державний реєстр підприємств та організацій України (ЄДРПОУ)	
61	Ідентифікаційний код, який юридична особа має в іншій країні реєстрації відповідно до вимог законодавства іншої країни (для нерезидента)	
62	Присвоєний банком умовний код 	
99	Інший документ	

11.4.	При наданні інформації про боржника та його кредитні операції Банк має присвоїти реквізиту “Ознака використання даних для Кредитного реєстру Національного банку України” значення 1, якщо на перший робочий день місяця, наступного за звітним сума балансової заборгованості (за основною сумою та відсотками) (без урахування комісійних доходів, що відносяться до кредитної операції) за кредитними операціями Боржника дорівнює або перевищує 100 розмірів мінімальних заробітних плат (або еквівалент цієї суми в іноземній валюті за офіційним курсом Національного банку, установленим на перший робочий день місяця, наступного за звітним). У іншому випадку (тобто, якщо на перший робочий день місяця, наступного за звітним сума балансової заборгованості (за основною сумою та відсотками) (без урахування комісійних доходів, що відносяться до кредитної операції) за кредитними операціями Боржника менше 100 розмірів мінімальних заробітних плат (або еквівалент цієї суми в іноземній валюті за офіційним курсом Національного банку, установленим на перший робочий день місяця, наступного за звітним),  Банк має присвоїти реквізиту “Ознака використання даних для Кредитного реєстру Національного банку України” значення 0.
11.5.	Якщо кредитна операція має транші, то такі реквізити як:
-	Процентна ставка;
-	Періодичність сплати основного боргу;
-	Періодичність сплати процентів;
-	строкова  заборгованість (яка обліковується за балансовими рахунками) за основним боргом;
-	строкова заборгованість (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції);
-	прострочена  заборгованість (яка обліковується за балансовими рахунками) за основним боргом;
-	прострочена  заборгованість  (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції);
-	Кількість днів прострочення основним боргом;
-	Кількість днів прострочення за процентами;
на рівні договору заповнюються пустими значеннями (NULL) або 0 в залежності від типу даних. Всі ці реквізити заповнюються на рівні траншів.

12.	Опис реквізитів повідомлення (запиту) про Боржника (фізична особа)

12.1.	Цей тип повідомлення можна використовувати при первинному надавані інформації про Боржника або її коригуванні.
12.2.	Під час першого успішного прийому інформації про Боржника Реєстр повертає Банку унікальний код Боржника, який в подальшому буде використовуватись для його ідентифікації у Реєстрі для коригування даних.

Приклад повідомлення (JSON-об’єкт), що повинен бути розміщений в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” під час надання запитів типу POST та PUT.

{
    "data": {
		"codMan": 7,
		"isRez": true,
		"inn": "1234567890",
		"codDocum": 11,
		"codK020":  "1234567890",
		"fio": {
					"firstName": "ІВАН",
					"lastName": "ТКАЧУК",
					"middleName": "ТАРАСОВИЧ"
		},
		"birthDay": "1996-02-29",
		"document": [
						{
							"typeD": 1,
							"seriya": "AA",
							"nomerD": "012345",
							"dtD": "2017-01-24"
						},
						{
							"typeD": 2,
							"seriya": "SS",
							"nomerD": "01234567",
							"dtD": "2017-01-24"
						},
						{
							"typeD": 3,
							"seriya": "19910824-00026",
							"nomerD": "012345678",
							"dtD": "2017-01-24"
						}
					],
		"address": {
					 "codRegion" : "11",
					 "area" : "абвгдЯЇЄ",
					 "zip" : "00001",
					 "city" : "село Яблунівка",
					 "streetAddress": "21 Друга вулиця",
			  		 "houseNo": "5А/7",
					 "adrKorp": "секція 1",
					 "flatNo": "кв. 11,12"
					}, 
		"education": [4,5],
		"organization": [
					{
						"typeW": 1,
						"codEdrpou": "WN/5-12.34567890",
						"nameW": "New Production"
					},
					{
						"typeW": 2,
						"codEdrpou": "87654321",
						"nameW": "Підприємець"
					}
				],
		"profit": {
					"real6month" : 17999,
					"noreal6month" : null
		},
		"family": { 
					"status": true,
					"members": 4
		},
		"k060": ["02", "07"],
		"isKr": 0
		}
}	

12.3.	Реквізити об’єкта “data”, в якому міститься інформація про Боржника (фізична особа), і який знаходиться в закодованому вигляді в об’єкті “payload”:
№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний код Боржника	codMan	N(20)	+	Набуває значень:
0 – якщо інформація про Боржника надається вперше;
Унікальний код Боржника, наданий Реєстром під час першого успішного прийому інформації про Боржника;	
2 Прізвище, ім’я, по батькові фізичної особи. Структура (елемент) fio.	
2.1	Прізвище	lastName	C(100)	+		
2.2	Ім’я	firstName	C(100)	+		
2.3	По батькові	middleName	C(100)	+	У разі відсутності зазначається null. (див. приклади)	
3	Ознака резидентності	isRez	B	+ 
	Набуває значень:
true – якщо особа є резидентом;
false – якщо особа не є резидентом; 	
4	Ідентифікатор Боржника	inn	C(50)	+	Реквізит набуває значення відповідно до п. 11.2 цих ТУ.	
5	Код виду документа	codDocum	N(2)	+	Реквізит набуває значення відповідно до п. 11.3 цих ТУ.	
6	Код Боржника за некласифікованим реквізитом К020	codK020	C(50)	+		
7	Дата народження	birthDay	D(10)	+	Див. п. 8 	
8. Документ що посвідчує особу. Структура (елемент) document. Якщо документів кілька, то поля з 8.1. по 8.4. повторюються. Пояснення до заповнення та обробки значень елементу надані в п. 12.4.	
8.1	Тип документа	typeD	N(1)	+	Набуває значень:
1 (загальний паспорт) або 2 (закордонний паспорт), або 3 (ID картка), або 4 (Інше). 	
8.2	Серія документа	seriya	C(20)	+	Якщо тип документа ID картка (typeD = 3), зазначається унікальний номер запису в Єдиному державному демографічному реєстрі. У разі відсутності зазначається null. (див. приклади)	
8.3	Номер документа	nomerD	С(20)	+		
8.4	Дата видачі документа	dtD	D(10)	+		
9. Адреса реєстрації. Структура (елемент) address. Якщо Боржник є нерезидентом, то структура (елемент) address не зазначається.	
9.1	Код регіону	codRegion	C(2)	+		
9.2	Район	area	C(100)			
9.3	Поштовий індекс	zip	С(10)	+		
9.4	Назва населеного пункту 	city	C(254)	+		
9.5	Вулиця	streetAddress	C(254)	+		
9.6	Будинок	houseNo	C(50)	+		
9.7	Корпус (споруда)	adrKorp	C(50)			
9.8	Квартира	flatNo	C(50)			
10	Код країни реєстрації	countryCodNerez	C(3)		Зазначається код країни – місця реєстрації нерезидента.	
11	Освіта	education	N(1)		Якщо освіт кілька, то значення вказуються через знак “,”. Якщо інформація про освіту Боржника невідома, то зазначається значення null (див. приклади). Пояснення до заповнення та обробки значень елементу надані в п. 12.4.	
12. Місце роботи Боржника. Структура (елемент) organization. Якщо місць роботи кілька, то поля з 12.1. по 12.3. повторюються. Якщо у Боржника не має місця роботи, структура (елемент) organization не зазначається. Пояснення до заповнення та обробки значень елементу надані в п. 12.4.	
12.1	Тип роботодавця	typeW	N(1)	+	Набуває значень:
1 – якщо роботодавець – юридична особа;
2 – якщо роботодавець – фізична особа – суб’єкт підприємницької діяльності.	
12.2	Ідентифікатор роботодавця	codEdrpou	C(50)			
12.3	Найменування роботодавця	nameW	C(254)	+		
13. Дані про дохід Боржника (ціле число, в сотих частках валюти). Структура (елемент) profit. Інформація про середньомісячний дохід Боржника надається під час надання кредиту та оновлюється щороку в разі наявності інформації в банку за кредитами, за якими визначення розміру кредитного ризику здійснюється на індивідуальній основі.	
13.1	Підтверджений дохід Боржника 	real6month	N(32)	+	Ціле число у копійках. Якщо у Боржника немає доходу, то зазначається цифра 0, якщо дохід Боржника невідомий, то зазначається значення null (див. приклади). 	
13.2	Непідтверджений дохід Боржника	noreal6month	N(32)	+	Ціле число у копійках. Якщо у Боржника немає доходу, то зазначається цифра 0, якщо дохід Боржника  невідомий, то зазначається значення null (див. приклади).	
14. Сімейний стан Боржника та кількість осіб, що перебувають на його утриманні. Структура (елемент) family.	
14.1	Сімейний стан Боржника	status	B	+	Зазначається сімейний стан Боржника: 
true – одружений /заміжня;
false – неодружений /незаміжня; Якщо інформація невідома, то зазначається значення null (див. приклади). 	
14.2	Кількість осіб, що перебувають на  утриманні Боржника	members	N(2)	+	Якщо інформація невідома, то зазначається значення null (див. приклади).	
15	Тип пов’язаної з банком особи	k060	C(2)	+		
16	Ознака використання даних для Кредитного реєстру Національного банку України	isKr	N(1)	+	Набуває значень:
0 – дані не використовуються у Кредитному реєстрі;
1 – дані використовуються у Кредитному реєстрі.
Див. “Опис правил та особливостей формування реквізитів повідомлень об'єктів“.	

12.4.	Обробка вхідних даних («Документ, що посвідчує особу», «Освіта», «Місце роботи Боржника») здійснюється наступним чином: 1) елемент відсутній у вхідних даних або його значення дорівнює null – інформація,  що була надана раніше до Реєстру, не змінюється; 2) значенням елементу є порожній масив –  інформація, що була надана раніше, видаляється з Реєстру; 3) значенням елементу є непорожній масив – інформація, що була надана раніше видаляється, а нова записується до Реєстру (стає актуальною).
12.5.	Шлях до актуальної JSON-схеми Боржника (фізична особа) https://bank.gov.ua/files/Taxonomy/JS_Ph_Osoba_v2_1.json.

13.	Опис реквізитів повідомлення (запиту) про Боржника  (юридична особа)

13.1.	Цей тип повідомлення запиту можна використовувати при первинному наданні інформації про Боржника або її коригуванні.
13.2.	Під час першого успішного прийому інформації про Позичальника Реєстр повертає Банку унікальний код Позичальника, який в подальшому буде використовуватись для ідентифікації Позичальника у Реєстрі для коригування даних.
13.3.	Реквізити об’єкта “data”, в якому міститься інформація про  Боржника (юридична особа), і який знаходиться в закодованому вигляді в об’єкті “payload”:

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний код Боржника	codMan	N(20)	+	Набуває значень:
0 – якщо інформація про Боржника надається вперше;
Унікальний код Боржника, наданий Реєстром під час першого успішного прийому інформації про Боржника;	
2	Найменування Боржника	nameUr	C(254)	+		
3	Резидентність особи	isRez	B	+ 
	Набуває значень:
true – якщо особа є резидентом;
false – якщо особа не є резидентом;	
4	Ідентифікатор Боржника	codEdrpou	C(50)	+	Реквізит набуває значення відповідно до п. 11.2 цих ТУ.	
5 	Код виду документа	codDocum	N(2)	+	Реквізит набуває значення відповідно до п. 11.3 цих ТУ.	
6	Код Боржника за некласифікованим реквізитом К020	codK020	C(50)	+		
7	Дата державної реєстрації	registryDay	D(10)	+	Зазначається дата державної реєстрації юридичної особи.	
8	Номер державної реєстрації	numberRegistry	C(32)	+	Зазначається номер державної реєстрації юридичної особи.	
9	Вид економічної діяльності	k110	C(5)	+		
10	Період	ec_year	D(10)	+	Зазначається рік, за який визначено вид економічної діяльності (календарний рік).	
11	Код країни реєстрації	countryCodNerez	C(3)		Зазначається код країни – місця реєстрації нерезидента.	
12. Розмір фінансових показників діяльності Боржника. Структура (елемент) finPerformance.
Інформація щодо фінансових показників надається в тис.грн.	
12.1	Показник сукупного обсягу реалізації  (SALES)	sales	N(32)	+		
12.2	Показник фінансового результату від операційної діяльності  (EBIT)	ebit	N(32)		Не зазначається для фізичної особи – суб’єкта підприємницької  діяльності.	
12.3	Показник фінансового результату від звичайної діяльності до оподаткування фінансових витрат і нарахування амортизації (EBITDA)	ebitda	N(32)		Не зазначається для фізичної особи - суб’єкта підприємницької  діяльності.	
12.4	Показник концентрації залучених коштів (TOTAL NET DEBT)	totalDebt	N(32)	+		
13	Приналежність Боржника до групи юридичних осіб, які перебувають під спільним контролем	isMember	B	+	Зазначається приналежність Боржника до групи юридичних осіб, що знаходяться під спільним контролем: 
true-так; false-ні; Якщо Боржник – фізична особа - суб’єкт підприємницької  діяльності зазначається null.	
14	Статус участі Боржника в групі	isController	B	+	Зазначається статус участі Боржника в групі.
Набуває значень:
true – материнська компанія/контролер; false – учасник; 
null - якщо Боржник не входить до групи юридичних осіб (тобто isMember має значення false) або Боржник є фізичною особою - суб’єктом підприємницької  діяльності.	
15. Перелік юридичних осіб, які входять до групи юридичних осіб, які перебувають під спільним контролем. Структура (елемент) groupUr. Якщо Боржник-юридична особа не входить до групи юридичних осіб, структура (елемент) groupUr не зазначається. Якщо учасників кілька, структура 15 повторюється. Пояснення до заповнення та обробки значень елементу надані в п. 13.4.	
15.1	Статус участі юридичної особи в групі	whoIs	N(1)	+ 	Зазначається статус участі юридичної особи в групі.
Набуває значень:
0 – учасник;
1 – материнська компанія/контролер;
2 - учасник групи, якому надано гарантію.	
15.2	Резидентність особи	isRezGr	B	+ 
	Набуває значень:
true – якщо особа є резидентом; false – якщо особа не є резидентом.	
15.3	Ідентифікатор учасника групи	codEdrpouGr	C(50)	+		
15.4	Найменування особи	nameUrGr	C(254)	+		
15.5	Код країни місця реєстрації	countryCodGr	C(3)		Зазначається код країни – місця реєстрації нерезидента.	
16. Розмір фінансових показників діяльності групи юридичних осіб, що знаходяться під спільним контролем. Структура (елемент) finPerformanceGr. Якщо Боржник - юридична особа не входить до групи юридичних осіб, то структура (елемент) finPerformanceGr не зазначається.
Інформація щодо фінансових показників надається в тис.грн.	
16.1	Показник сукупного обсягу реалізації  (SALES)	salesGr	N(32)	+		
16.2	Показник фінансового результату від операційної діяльності  (EBIT)	ebitGr	N(32)	+		
16.3	Показник фінансового результату від звичайної діяльності до оподаткування фінансових витрат і нарахування амортизації (EBITDA)	ebitdaGr	N(32)	+		
16.4	Показник концентрації залучених коштів (TOTAL NET DEBT)	totalDebtGr	N(32)	+		
16.5	Клас групи	classGr	C(1)	+	Зазначається код класу відповідно до значень довідника S080	
17	Факт приналежності Боржника до групи пов’язаних контрагентів	isPartner	B	+ 	Зазначається факт приналежності Боржника до групи пов’язаних контрагентів, що несуть спільний економічний ризик Набуває значень:
true-так; false-ні; Якщо Боржник – фізична особа - суб’єкт підприємницької  діяльності, зазначається null.	
18. Перелік юридичних осіб, які належать до групи пов’язаних контрагентів Структура (елемент) partners. Якщо Боржник - юридична особа не входить до групи пов’язаних контрагентів, то структура (елемент) partners не зазначається. Якщо учасників кілька, структура  повторюється. Пояснення до заповнення та обробки значень елементу надані в п. 13.4.	
18.1	Резидентність особи	isRezPr	B	+ 
	Набуває значень:
true – якщо особа є резидентом; false – якщо особа не є резидентом.	
18.2	Ідентифікатор пов’язаного контрагента	codEdrpouPr	C(50)	+		
18.3	Найменування особи	nameUrPr	C(254)	+		
18.4	Код країни місця реєстрації	countryCodPr	C(3)		Зазначається код країни – місця реєстрації нерезидента.	
19. Розмір фінансових показників діяльності групи пов’язаних контрагентів. Структура (елемент) finPerformancePr. Якщо Боржник-юридична особа не входить до групи пов’язаних контрагентів, то структура (елемент) finPerformancePr не зазначається.
Інформація щодо фінансових показників надається в тис.грн.	
19.1.	Показник сукупного обсягу реалізації  (SALES)	sales	N(32)	+		
19.2	Показник фінансового результату від операційної діяльності  (EBIT)	ebit	N(32)	+	Не зазначається для фізичної особи - суб’єкта підприємницької  діяльності.	
19.3	Показник фінансового результату від звичайної діяльності до оподаткування фінансових витрат і нарахування амортизації (EBITDA)	ebitda	N(32)	+	Не зазначається для фізичної особи - суб’єкта підприємницької  діяльності.	
19.4	Показник концентрації залучених коштів (TOTAL NET DEBT)	totalDebt	N(32)	+	Не зазначається для фізичної особи - суб’єкта підприємницької  діяльності.	
20	Факт проходження аудиту фінансової звітності	isAudit	B	+ 	Набуває значень:
true-так; false-ні; Не зазначається для фізичної особи - суб’єкта підприємницької  діяльності. Якщо Боржник – фізична особа - суб’єкт підприємницької  діяльності зазначається null.	
21	Тип пов’язаної з банком особи	k060	C(2)	+		
22. Власники істотної участі в статутному капіталі боржника  – юридичної особи – фізичні особи. Структура (елемент) ownerPp. Якщо власників кілька, структура ownerPp повторюється. Якщо Боржник - юридична особа є фізичною особою – підприємцем, то структура (елемент) ownerPp не зазначається. Пояснення до заповнення та обробки значень елементу надані в п. 13.4.	
22.1. Прізвище, ім’я, по батькові фізичної особи. Структура (елемент) FIO.	
22.1.1	Прізвище	lastName	C(100)	+		
22.1.2	Ім’я	firstName	C(100)	+		
22.1.3	По батькові	middleName	C(100)	+	У разі відсутності зазначається null. (див. приклади)	
22.2	Резидентність особи	isRez	B	+ 
	Набуває значень:
true – якщо особа є резидентом; false – якщо особа не є резидентом;	
22.3	Ідентифікатор власника істотної участі	inn	C(50)	+		
22.4	Код країни місця реєстрації	countryCod	C(3)		Зазначається код країни – місця реєстрації нерезидента.	
22.5	Частка прямої та опосередкованої участі власника істотної участі в статутному капіталі боржника – юридичної особи	perCent	N(9,6)	+		
22.6. Місце реєстрації власника істотної участі в статутному капіталі боржника  – юридичної особи – фізичної особи. Структура (елемент) address. Якщо відсутня інформація щодо місця реєстрації  фізичної особи нерезидента  - власника  істотної участі  то у пунктах 22.6.3-6 зазначається “0”.	
22.6.1	Код регіону	codRegion	C(2)			
22.6.2	Район	area	C(100)			
22.6.3	Поштовий індекс	zip	С(10)	+		
22.6.4	Назва населеного пункту 	city	C(254)	+		
22.6.5	Вулиця	streetAddress	C(254)	+		
22.6.6	Будинок	houseNo	C(50)	+		
22.6.7	Корпус (споруда)	adrKorp	C(50)			
22.6.8	Квартира	flatNo	C(50)			
23. Власники істотної участі в статутному капіталі боржника  – юридичної особи – юридичні особи. Структура (елемент) ownerJur. Якщо власників кілька, структура ownerJur повторюється. Якщо Боржник - юридична особа є фізичною особою – підприємцем, то структура (елемент) ownerJur не зазначається. Пояснення до заповнення та обробки значень елементу надані в п. 13.4.	
23.1	Найменування особи	nameOj	C(254)	+		
23.2	Резидентність особи	isRezOj	B	+ 	Набуває значень:
true – якщо особа є резидентом; false – якщо особа не є резидентом;	
23.3	Ідентифікатор власника істотної участі	codEdrpouOj	C(50)	+		
23.4	Дата державної реєстрації	registryDayOj	D(10)	+	Якщо дату державної реєстрації нерезидента - юридичної особи визначити неможливо, то в полі зазначається умовна дата 1990-01-01.	
23.5	Номер державної реєстрації	numberRegistryOj	C(32)	+	Якщо номер державної реєстрації нерезидента - юридичної особи визначити неможливо, то в полі зазначається "0".	
23.6	Код країни місця реєстрації	countryCodOj	C(3)		Зазначається код країни – місця реєстрації нерезидента.	
23.7	Частка прямої та опосередкованої участі власника істотної участі в статутному капіталі боржника – юридичної особи (10 і більше відсотків).	perCentOj	N(9,6)	+		
24	Ознака використання даних для Кредитного реєстру Національного банку України	isKr	N(1)	+	Набуває значень:
0 – дані не використовуються у Кредитному реєстрі;
1 – дані використовуються у Кредитному реєстрі.
Див. “Опис правил та особливостей формування реквізитів повідомлень об'єктів“.	

13.4.	Обробка вхідних даних («Перелік юридичних осіб, які входять до групи юридичних осіб, які знаходяться під спільним контролем», «Перелік юридичних осіб, які належать до групи пов’язаних контрагентів», «Власники істотної участі – фізичні особи», «Власники істотної участі – юридичні особи») здійснюється наступним чином: 1) елемент відсутній у вхідних даних або його значення дорівнює null – інформація,  що була надана раніше до Реєстру, не змінюється; 2) значенням елементу є порожній масив –  інформація, що була надана раніше, видаляється з Реєстру; 3) значенням елементу є непорожній масив – інформація, що була надана раніше видаляється, а нова записується до Реєстру (стає актуальною).
13.5.	Шлях до актуальної JSON-схеми Боржника (фізична особа) https://bank.gov.ua/files/Taxonomy/JS_Ur_Osoba_v2_1.json.

14.	Опис реквізитів повідомлення (запиту) про забезпечення за кредитною операцією Боржника (фізична особа, юридична особа)

14.1.	Цей тип повідомлення запиту можна використовувати при надавані або коригуванні інформації про забезпечення за кредитними операціями Боржника (фізична особа, юридична особа).
14.2.	Під час першого успішного прийому інформації про забезпечення за кредитною операцією Боржника (фізична особа, юридична особа) Реєстр повертає Банку унікальний код забезпечення, який в подальшому буде використовуватись для ідентифікації забезпечення під час  коригування даних.
14.3.	Реквізити об’єкта “data”, в якому міститься інформація про забезпечення за кредитною операцією Боржника (фізична особа, юридична особа), і який знаходиться в закодованому вигляді в об’єкті “payload”:

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Порядковий номер  запису у повідомлені	orderNum	N(2)	+	Набуває значень:
ціле число від 1 до 99 включно.	
2	Унікальний код забезпечення за кредитною операцією Боржника	codZastava	N(20)	+	Набуває значень:
0 – якщо інформація про забезпечення за кредитною операцією Боржника надається  вперше;
Унікальний код забезпечення за кредитною операцією Боржника, наданий Реєстром під час першого успішного прийому інформації про  забезпечення;	
3	Унікальний код Боржника	codMan	N(20)	+	Зазначається унікальний код Боржника, наданий Реєстром під час першого успішного прийому інформації про Боржника;	
4	Номер договору застави/іпотеки, гарантії, поруки, грошового покриття	numberPledge	C(50)	+		
5	Дата укладання договору застави/іпотеки, гарантії, поруки, грошового покриття	pledgeDay	D(10)	+		
6	Код виду забезпечення за договором	s031	C(2)	+		
7	Порядковий номер  застави/іпотеки, гарантії, поруки, грошового покриття у Боржника	orderZastava	N(15)	+		
8	Код валюти	r030	C(3)			
9	Сума забезпечення згідно з договором	sumPledge	N(32)	+	Ціле число, в сотих частках валюти.  	
10	Вартість забезпечення згідно з висновком суб’єкта оціночної діяльності	pricePledge	N(32)		Ціле число, в сотих частках валюти.    	
11	Дата останньої оцінки забезпечення	lastPledgeDay	D(10)			
12	Вид нерухомого майна	codRealty	N(1)			
13	Поштовий індекс	zipRealty	С(10)		Якщо об’єкт договору  має кілька поштових індексів, то зазначається один поштовий індекс. 	
14	Загальна площа нерухомого майна	squareRealty	N(16,4)		В метрах квадратних (загальна кількість цифр у числі не більше 16, кількість цифр у числі після крапки не більше 4).    	
15	Сума поруки	sumBail	N(32)		Ціле число, в копійках.
Зазначається сума поруки.	
16	Сума гарантії	sumGuarantee	N(32)		Ціле число, в копійках.
Зазначається сума гарантії.	
17	Середній підтверджений дохід особи, яка надала поруку/ гарантію	real6month	N(32)		Ціле число, в копійках.
Зазначається, якщо Боржник – фізична особа.	
18	Регулярний непідтверджений дохід особи, яка надала поруку/гарантію	noreal6month	N(32)		Ціле число, в копійках.
Зазначається, якщо Боржник – фізична особа.	
19	Факт страхування  забезпечення	flagInsurancePledge	B	+	Набуває значень:
true – застраховане; false – ні.	
20. Депозити, що є предметом забезпечення. Структура (елемент) Deposit. Структура Deposit може бути або масивом значень (поля 20.1 – 20.4) при необхідності надання інформації про один або декілька депозитів або строкою зі значенням “D” - при необхідності видалити всі депозити, пов’язанні із забезпеченням. Якщо депозитів за забезпеченням декілька, то поля структури Deposit повторюються стільки разів, скільки є депозитів. Якщо предметом забезпечення не є депозити або інформація за депозитами, яка була надана раніше, не потребує змін, то структура (елемент) Deposit не зазначається.	
20.1	Номер депозитного договору	numDogDp	С(50)	+ 	Зазначається номер депозитного договору, за яким депозит є предметом застави що є забезпеченням за кредитним договором.	
20.2	Дата укладання депозитного договору	dogDayDp	D(10)	+	Зазначається дата укладання депозитного договору, за яким депозит є предметом застави що є забезпеченням за кредитним договором. 	
20.3	Код валюти за депозитом	r030Dp	C(3)	+	Зазначається цифровий код валюти або банківського металу за депозитним договором.
Значення коду  визначається відповідно до Класифікатора іноземних валют.	
20.4	Сума депозиту	sumDp	N(32)	+	Зазначається сума депозиту, що зазначена в договорі (ціле число, в сотих частках валюти).	

14.4.	Шлях до актуальної JSON-схеми про забезпечення https://bank.gov.ua/files/Taxonomy/JS_Zastava_v2_1.json.

15.	Опис реквізитів повідомлення (запиту) про кредитні операції Боржника (фізична особа, юридична особа)

15.1.	Цей тип повідомлення запиту можна використовувати при надавані або коригуванні інформації про кредитні угоди Боржника (фізична особа, юридична особа).
15.2.	Під час першого успішного прийому інформації про кредитну операцію Боржника Реєстр повертає Банку унікальний код кредитної операції Боржника, який в подальшому буде використовуватись для ідентифікації кредитної операції для коригування даних.
15.3.	Реквізити об’єкта “data”, в якому міститься інформація про кредитні операції Боржника (фізична особа, юридична особа), і який знаходиться в закодованому вигляді в об’єкті “payload”:

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Порядковий номер кредитної операції у повідомлені	orderNum	N(2)	+	Набуває значень:
ціле число від 1 до 99 включно.	
2	Ознака особи	flagOsoba	B	+	Набуває значень:
true – фізична особа; false – юридична особа.	
3	Унікальний код кредитної операції Боржника	codCredit	N(20)	+	Набуває значень:
0 – якщо інформація про кредитну операцію Боржника надається ь вперше;
Унікальний код кредитної операції Боржника, наданий Реєстром під час першого успішного прийому інформації про кредитну операцію;	
4	Унікальний код Боржника	codMan	N(20)	+	Зазначається унікальний код Боржника, наданий Реєстром під час першого успішного прийому інформації;	
5	Вид кредиту/наданого фінансового зобов’язання	typeCredit	N(2)	+	 	
6	Номер договору	numberDog	С(50)	+ 
	 	
7	Дата укладання договору	dogDay	D(10)	+		
8	Кінцева дата погашення кредиту/наданого фінансового зобов’язання	endDay	D(10)			
9	Загальна сума (ліміт кредитної лінії/
овердрафту) наданого фінансового зобов’язання	sumZagal	N(32)	+	Ціле число, в сотих частках валюти.	
10	Код валюти	r030	C(3)	+		
11	Номінальна процентна ставка	procCredit	N(7,4)	+		
12	Сума платежів за кредитною операцією	sumPay	N(32)	+		
13	Періодичність сплати основного боргу	periodBase	N(1)	+	 	
14	Періодичність сплати відсотків	periodProc	N(1)	+		
15	Строкова  заборгованість (яка обліковується за балансовими рахунками) за основним боргом	sumArrearsBase	N(32)	+	Ціле число, в сотих частках валюти.	
16	Строкова заборгованість (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції)	sumArrearsProc	N(32)	+	Ціле число, в сотих частках валюти.	
17	Прострочена  заборгованість (яка обліковується за балансовими рахунками) за основним боргом	arrearBase	N(32)	+	Ціле число, в сотих частках валюти.	
18	Прострочена  заборгованість  (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції)	arrearProc	N(32)	+	Ціле число, в сотих частках валюти.	
19	Кількість днів прострочення за основним боргом	dayBase	N(5)	+		
20	Кількість днів прострочення  за процентами	dayProc	N(5)	+		
21	Дата фактичного погашення кредиту/припинення зобов’язань по кредиту 	factEndDay	D(10)		Зазначається дата фактичного погашення кредиту або припинення зобов’язань по кредиту.
Інформація  надається одноразово  після повного погашення кредиту або припинення зобов’язань по кредиту.	
22	Наявність здійснених заходів із примусового стягнення боргу	flagZ	B	+	Набуває значень:
true – так; false – ні.	
23	Клас боржника визначений на підставі оцінки фінансового стану	klassS080	C(1)	+	Зазначається код класу боржника/контрагента відповідно до значень довідника S080	
24	Код типу оцінки кредитного ризику	s083	N(1)	+	Зазначається код типу оцінки кредитного ризику відповідно до значень довідника S083	
25. Коди факторів, на підставі яких коригується клас боржника. Структура (елемент) Factor. Якщо за активними банківськими операціями, за якими до боржника не застосовуються ознаки щодо коригування класу боржника, то структура (елемент) Factor не зазначається.	
25.1	Код щодо належності до групи юридичних осіб під спільним контролем/групи пов’язаних контрагентів	f074	C(3)		Зазначається код щодо належності контрагента/пов’язаної з банком особи до групи юридичних осіб під спільним контролем або до групи пов’язаних контрагентів відповідно до значень довідника F074	
25.2	Код щодо наявності ознаки, що свідчить про високий кредитний ризик	f075	C(50)		Зазначається код ознаки (довжина 4 символи), яка свідчать про високий кредитний ризик контрагента/пов’язаної з банком особи відповідно до значень довідника F075. Якщо значень декілька, то вони відокремлюються символом «;»	
25.3	Код щодо події дефолту	f076	C(100)		Зазначається код ознаки (довжина 9 символів), яка свідчать про подію дефолту контрагента/пов’язаної з банком особи відповідно до значень довідника F076. Якщо значень декілька, то вони відокремлюються символом «;»	
25.4	Код щодо своєчасності сплати боргу	f077	C(3)		Зазначається код ознаки своєчасності сплати боргу контрагентом/пов’язаною з банком особою відповідно до значень довідника F077	
25.5	Код щодо додаткових характеристик	f078	C(5)		Зазначається код ознаки, яка відповідає додатковим характеристикам щодо контрагента/пов’язаної з банком особи - емітента цінних паперів відповідно до значень довідника F078	
25.6	Код щодо класу боржника за інформацією з кредитного реєстру Національного банку України	f102	C(3)		Зазначається код щодо наявності інформації у Кредитному  реєстрі, на підставі якої клас боржника підлягає коригуванню відповідно до значень довідника F102	
26	Код фактора, на підставі якого скоригований клас Боржника	f079	C(50)		Зазначається код (довжина 2 символи), що відповідає фактору, на підставі якого скоригований клас контрагента/пов’язаної з банком особи відповідно до значень довідника F079. Якщо значень декілька, то вони відокремлюються символом «;»	
27	Код ознаки дефолту Боржника, щодо якого доведено відсутність дефолту	f080	C(100)		Зазначається код ознаки події дефолту контрагента/пов’язаної з банком особи (довжина 9 символів), щодо якої банк на підставі застосованого ним судження довів, що дефолту немає відповідно до значень довідника F080. Якщо значень декілька, то вони відокремлюються символом «;»	
28	Скоригований клас Боржника	klass	C(2)	+	Див. “Опис правил та особливостей формування реквізитів повідомлень об'єктів“.	
29	Величина кредитного ризику	risk	N(32)	+		
30	Факт страхування  кредиту	flagInsurance	B	+	Зазначається факт страхування  кредиту.
Набуває значень:
true – так; false – ні;	
31. Забезпечення за кредитним договором. Структура (елемент) Pledge. Структура Pledge може бути або масивом значень (поля 31.1 – 31.3) при необхідності надання інформації про забезпечення, пов’язанні з кредитним договором, або строкою зі значенням “D” - при необхідності видалити усі забезпечення, пов’язанні з кредитним договором.  Якщо забезпечень за кредитним договором декілька, то поля структури Pledge повторюються стільки разів, скільки є забезпечень. Якщо забезпечення не передбачені кредитним договором або інформація за забезпеченням, яка була надана раніше, не потребує змін, то структура (елемент) Pledge не зазначається.	
31.1	Забезпечення за кредитним договором	codZastava	N(20)	+	Зазначається код забезпечення (наданий Реєстром під час першого успішного прийому інформації про дане забезпечення Боржника). 	
31.2	Сума забезпечення згідно з договором	sumPledge	N(32)	+	Ціле число, в сотих частках валюти.  
Якщо забезпечення надано за двома (або більше) кредитними операціями, то сума забезпечення зазначається в частині, пропорційній розміру заборгованості за кожною кредитною  операцією.	
31.3	Вартість забезпечення згідно з висновком суб’єкта оціночної діяльності	pricePledge	N(32)		Ціле число, в сотих частках валюти.  
Якщо забезпечення надано за двома (або більше) кредитними операціями, то сума забезпечення зазначається в частині, пропорційній розміру заборгованості за кожною кредитною  операцією.	
32. Транші за кредитним договором. Структура (елемент) Tranche. Структура Tranche може бути або масивом значень (поля 32.1 – 32.22) при необхідності надання інформації про транші, пов’язанні з кредитним договором, або строкою зі значенням “D” - при необхідності видалити усі транші, пов’язанні з кредитним договором.  Якщо траншів за кредитним договором декілька, то поля структури Tranche повторюються стільки разів, скільки є траншів. Якщо транші не передбачені кредитним договором або інформація за траншами, яка була надана раніше, не потребує змін, то структура (елемент) Tranche не зазначається.	
32.1	Номер договору траншу	numDogTr	С(50)	+ 	Зазначається номер додаткового договору/іншого первинного документа (траншу), згідно з яким у Боржника виникає заборгованість перед Банком  та/або Банк надає фінансові зобов’язання.	
32.2	Дата укладання договору траншу	dogDayTr	D(10)	+	Зазначається дата укладання додаткового договору (траншу). Якщо операція здійснена без укладання договору, то зазначається дата виникнення заборгованості.	
32.3	Кінцева дата погашення заборгованості траншу	endDayTr	D(10)	+	Зазначається кінцева дата погашення заборгованості або дата припинення наданих банком  фінансових зобов’язань по траншу згідно з умовами договору.	
32.4	Сума наданого фінансового зобов’язання за траншем	sumZagalTr	N(32)	+	Зазначається загальна сума траншу, що зазначена в договорі (ціле число, в сотих частках валюти).	
32.5	Код валюти за траншем	r030Tr	C(3)	+		
32.6	Процентна ставка за траншем	procCreditTr	N(7,4)	+		
32.7	Періодичність сплати основного боргу за траншем	periodBaseTr	N(1)	+	Зазначається періодичність здійснення платежів із погашення основної заборгованості за траншем: 
1-щомісяця;
2-щокварталу;
3-раз у  півроку;
4-раз у рік;
5-у кінці строку дії договору;
6-за індивідуальним графіком. 	
32.8	Періодичність сплати процентів за траншем	periodProcTr	N(1)	+	Зазначається періодичність сплати процентів за траншем відповідно до умов договору: 
1-щомісяця;
2-щокварталу;
3-раз у  півроку;
4-раз у рік;
5-у кінці строку дії договору;
6-за індивідуальним графіком.	
32.9	Строкова  заборгованість (яка обліковується за балансовими рахунками) за основним боргом за траншем	sumArrearsTrBase	N(32)	+	Ціле число, в сотих частках валюти	
32.10	Строкова заборгованість (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції) за траншем	sumArrearsTrProc	N(32)	+	Ціле число, в сотих частках валюти	
32.11	Прострочена  заборгованість (яка обліковується за балансовими рахунками) за основним боргом за траншем	arrearBaseTr	N(32)	+	Зазначається прострочена заборгованість за основним боргом траншу.	
32.12	Прострочена  заборгованість  (яка обліковується за балансовими рахунками) за процентами ​(комісійними доходами, що відносяться до кредитної операції) за траншем.	arrearProcTr	N(32)	+	Зазначається прострочена заборгованість  за процентами траншу.	
32.13	Кількість днів прострочення за траншем 	dayBaseTr	N(5)	+	Зазначається кількість днів прострочення за основним боргом траншу. 	
32.14	Кількість днів прострочення за процентами траншу	dayProcTr	N(5)	+	Зазначається кількість днів прострочення за процентами траншу.	
32.15	Дата фактичного погашення траншу/припинення зобов’язань по траншу	factEndDayTr	D(10)		Зазначається дата фактичного погашення траншу або припинення зобов’язань по траншу.
Інформація  надається одноразово  після повного погашення зобов’язань по траншу або припинення зобов’язань по траншу.	
32.16	Клас боржника за траншем визначений на підставі оцінки фінансового стану	klassS080Tr	C(1)	+	Зазначається код класу боржника/контрагента відповідно до значень довідника S080	
32.17	Код типу оцінки кредитного ризику	s083Tr	N(1)	+	Зазначається код типу оцінки кредитного ризику відповідно до значень довідника S083	
32.18 Коди факторів, на підставі яких коригується клас боржника за траншем. Структура (елемент) FactorTr. Якщо за активними банківськими операціями, за якими згідно з Положенням № 351 до боржника не застосовуються ознаки щодо коригування класу боржника за траншем, то структура (елемент) FactorTr не зазначається.	
32.18.1	Код щодо належності до групи юридичних осіб під спільним контролем/групи пов’язаних контрагентів	f074	C(3)		Зазначається код щодо належності контрагента/пов’язаної з банком особи до групи юридичних осіб під спільним контролем або до групи пов’язаних контрагентів відповідно до значень довідника F074	
32.18.2	Код щодо наявності ознаки, що свідчить про високий кредитний ризик	f075	C(50)		Зазначається код ознаки (довжина 4 символи), яка свідчать про високий кредитний ризик контрагента/пов’язаної з банком особи відповідно до значень довідника F075. Якщо значень декілька, то вони відокремлюються символом «;»	
32.18.3	Код щодо події дефолту	f076	C(100)		Зазначається код ознаки (довжина 9 символів), яка свідчать про подію дефолту контрагента/пов’язаної з банком особи відповідно до значень довідника F076. Якщо значень декілька, то вони відокремлюються символом «;»	
32.18.4	Код щодо своєчасності сплати боргу за траншем	f077	C(3)		Зазначається код ознаки своєчасності сплати боргу контрагентом/пов’язаною з банком особою відповідно до значень довідника F077	
32.18.5	Код щодо додаткових характеристик	f078	C(5)		Зазначається код ознаки, яка відповідає додатковим характеристикам щодо контрагента/пов’язаної з банком особи - емітента цінних паперів відповідно до значень довідника F078	
32.18.6	Код щодо класу боржника за траншем інформацією з кредитного реєстру Національного банку України	f102	C(3)		Зазначається код щодо наявності інформації у Кредитному  реєстрі, на підставі якої клас боржника підлягає коригуванню відповідно до значень довідника F102	
32.19	Код фактора, на підставі якого скоригований клас боржника за траншем	f079Tr	C(50)		Зазначається код (довжина 2 символи), що відповідає фактору, на підставі якого скоригований клас контрагента/пов’язаної з банком особи відповідно до значень довідника F079. Якщо значень декілька, то вони відокремлюються символом «;»	
32.20	Код ознаки дефолту боржника, щодо якого доведено відсутність дефолту	f080Tr	C(100)		Зазначається код ознаки події дефолту контрагента/пов’язаної з банком особи (довжина 9 символів), щодо якої банк на підставі застосованого ним судження довів, що дефолту немає відповідно до значень довідника F080. Якщо значень декілька, то вони відокремлюються символом «;»	
32.21	Скоригований клас боржника за траншем	klassTr	C(2)		Див. “Опис правил та особливостей формування реквізитів повідомлень об'єктів“.	
32.22	Величина кредитного ризику за траншем	riskTr	N(32)	+	Зазначається величина кредитного ризику Боржника, яка розрахована відповідно до Положення № 351.	

15.4.	Шлях до актуальної JSON-схеми про кредитні операції Боржника https://bank.gov.ua/files/Taxonomy/JS_Credits_v2_1.json.

16.	Розділ видалено у зв’язку з втратою актуальності.

17.	Перелік реквізитів, які надходять від Реєстру на запити GET від банків

17.1.	Перелік реквізитів відповіді на загальний запит (GET без параметрів) (див. п. 6.15).

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний код Боржника/Забезпечення/Кредитної операції у Реєстрі	recordId	N(20)	+	При запиті про кредитні операції повертається інформація лише про діючі  операції (кредитні операції, по яким не зазначено реквізит factEndDay).	
2	Дата першого надання інформації	dateIns	D(19)	+		
3	Дата останньої модифікації інформації 	dateEdit	D(19)	+		

При здійсненні Загального запиту (GET без параметрів) є можливість використовувати додаткові параметри адресної строки (OData). Наразі реалізована можливість використання наступних параметрів:
-	$filter, фільтрація даних;
-	$orderby, сортування;
-	$select, отримання окремих реквізитів;
-	$skip, пропуск перших n записів;
-	$top, отримання перших n записів.
Фільтрацію, сортування та вибірку можливо здійснювати тільки за реквізитами, що наведені в переліку реквізитів  відповіді на Загальний запит.
Приклади здійснення запитів із використанням додаткових параметрів адресної строки:
-	Пошук даних, дата останньої модифікації яких більша або дорівнює 01.08.2018 використовується посилання: cr_server/cr_reestr/api/v2/xxxx?$filter=dateEdit ge DATETIME'2018-08-22';
-	Сортувати за значенням унікального коду та отримати перші 100 записів: cr_server /cr_reestr/api/v2/xxxx?$orderby=recordId&$top=100;
-	Сортувати за значенням унікального коду, пропустити перші 100 записів та отримати наступні 100: cr_server/cr_reestr/api/v2/xxxx?$orderby=recordId&$top=100&$skip=100;
-	Сортувати за значенням унікального коду, пропустити перші 100 записів та отримати тільки значення унікальних кодів для наступних 100 записів: cr_server/cr_reestr/api/v2/CREDIT?$orderby=recordId&$top=100&$skip=100&$select=recordId. 
Параметри можливо комбінувати один з одним. Коротко про використання додаткових параметрів можливо прочитати за посиланням https://www.odata.org/getting-started/basic-tutorial.
Якщо кількість записів наданих банком до КР перевищує 10000, наполегливо рекомендуємо не використовувати запит типу GET без додаткових параметрів адресної строки. Не виконання цих рекомендацій може призвести до значного уповільнення роботи сервісу та унеможливлення отримання інформації.
Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запит типу GET.

[
   {
      "recordId":20017,"dateIns":"2017-11-02T14:10:00","dateEdit":"2017-11-02T14:10:00"
   },
   {
      "recordId":20019,"dateIns":"2017-11-02T14:09:05","dateEdit":"2017-11-02T14:09:05"
   },
…
   {
      "recordId":20031,"dateIns":"2017-11-02T14:09:09","dateEdit":"2017-11-02T14:09:09"
   }
]	

17.2.	Перелік реквізитів відповіді на конкретний запит  (GET з параметрами) (див. п. 6.15) на веб-сервіс «Боржник» (фізична особа) – customer_pp.

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний код Боржника у Реєстрі	recordId	N(20)	+		
2	Дата першого надання інформації	dateIns	D(19)	+		
3	Дата останньої модифікації інформації 	dateEdit	D(19)	+		
4	Ідентифікатор Боржника	inn	C(50)	+	Відомості, що ідентифікують Боржника	
5	Код виду документа	codDocum	N(2)	+		
6	Код країни	countryCodNerez	C(3)	+	Зазначається код країни	
7	Ознака використання даних у Кредитному реєстрі	isKr	N(1)	+	Набуває значень:
0 – дані не використовуються у Кредитному реєстрі;
1 – дані використовуються у Кредитному реєстрі.
Див. “Опис правил та особливостей формування реквізитів повідомлень об'єктів“.	

Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запит типу GET.

{
  "recordId": 20019,
  "dateIns": "2017-11-02T14:10:00",
  "dateEdit": "2017-11-02T14:10:00",
  "inn": "3114002039",
  "codDocum": 11,
  "countryCodNerez": “804”,
  "isKr": 1
}	

17.3.	Перелік реквізитів відповіді на конкретний запит  (GET з параметрами) (див. п. 6.15) на веб-сервіс «Боржник» (юридична особа) – customer_lp.

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний код Боржника у Реєстрі	recordId	N(20)	+		
2	Дата першого надання інформації	dateIns	D(19)	+		
3	Дата останньої модифікації інформації 	dateEdit	D(19)	+		
4	Ідентифікатор Боржника	codEdrpou	C(50)	+	Відомості, що ідентифікують Боржника	
5	Код виду документа	codDocum	N(2)	+		
6	Код країни	countryCodNerez	C(3)	+	Зазначається код країни	
7	Ознака використання даних у Кредитному реєстрі	isKr	N(1)	+	Набуває значень:
0 – дані не використовуються у Кредитному реєстрі;
1 – дані використовуються у Кредитному реєстрі.
Див. “Опис правил та особливостей формування реквізитів повідомлень об'єктів“.	

Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запит типу GET.

{
  "recordId": 20784,
  "dateIns": "2017-11-02T14:09:21",
  "dateEdit": "2017-11-08T14:26:35",
  "codEdrpou": "IN-00000597",
  "codDocum": 61,
  "countryCodNerez": "900",
  "isKr": 0
}	

17.4.	Перелік реквізитів відповіді на конкретний запит  (GET з параметрами) (див. п. 6.15) на веб-сервіс «Застави» - pledge.

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний код Забезпечення у Реєстрі	recordId	N(20)	+		
2	Дата першого надання інформації	dateIns	D(19)	+		
3	Дата останньої модифікації інформації 	dateEdit	D(19)	+		
4	Порядковий номер  застави/іпотеки, гарантії, поруки, грошового покриття у Боржника	orderZastava	N(15)	+		
5	Номер договору застави/іпотеки, гарантії, поруки, грошового покриття	numberPledge	C(50)	+		
6	Дата укладання договору застави/іпотеки, гарантії, поруки, грошового покриття	pledgeDay	D(10)	+		
7	Код виду забезпечення за договором	s031	C(2)	+		
8	Унікальний код Боржника	codMan	N(20)	+	Зазначається унікальний код Боржника	
9	Ознака Боржника	isLegalPerson	N(1)	+	Набуває значень:
0 -  Фізична особа;
1 – Юридична особа.

Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запит типу GET.

{
  "recordId": 30059,
  "dateIns": "2017-11-03T12:03:17",
  "dateEdit": "2017-11-03T12:03:17",
  "orderZastava": 1,
  "numberPledge": "08 офф",
  "pledgeDay": "2008-02-08",
  "s031": "25",
  "codMan": 20052,
  "isLegalPerson": 1
}	

17.5.	Перелік реквізитів відповіді на Конкретний запит  (GET з параметрами) (див. п. 6.15) на веб-сервіс «Кредитні угоди» - credit.

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
довжина)	Обов’язковість заповнення	Примітки	
1	Унікальний код Кредитної операції у Реєстрі	recordId	N(20)	+		
2	Дата першого надання інформації	dateIns	D(19)	+		
3	Дата останньої модифікації інформації 	dateEdit	D(19)	+		
4	Номер договору	numberDog	С(50)	+ 
	 	
5	Дата укладання договору	dogDay	D(10)	+		
6	Унікальний код Боржника	codMan	N(20)	+	Зазначається унікальний код Боржника	
7	Дата включення Кредитної операції до Кредитного реєстру	krDate	D(19)	+	Якщо значення null – дані про Кредитну операцію не використовується у Кредитному реєстрі	
8	Ознака Боржника	isLegalPerson	N(1)	+	Набуває значень:
0 -  Фізична особа;
1 – Юридична особа.	
9	Дата фактичного погашення кредиту/припинення зобов’язань по кредиту 	factEndDay	D(10)		Зазначається дата фактичного погашення кредиту або припинення зобов’язань по кредиту. Якщо значення null –Кредитна операція діюча.	
10	Ознака Кредитної операції (діюча/недіюча)	isActive	N(1)	+	Набуває значень:
0 -  Кредитна операція не є діючою;
1 – Кредитної операція є діючою.	

Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запит типу GET.

{
  "recordId": 10051,
  "dateIns": "2017-11-03T12:05:05",
  "dateEdit": "2017-11-08T14:27:16",
  "numberDog": "2-14-08",
  "dogDay": "2008-06-26",
  "codMan": 20031,
  "krDate": null,
  "isLegalPerson": 1,
  "factEndDay": "2020-05-30",
  "isActive": 1
}	

18.	Надання інформації банкам з Реєстру щодо Боржників, які наявні у кредитному реєстрі.

На стороні НБУ для прийому запитів на пошук та надання інформації Банкам налаштовано два веб-сервіса: 1) веб-сервіс «Пошук Боржника» (фізична особа), 2) веб-сервіс «Пошук Боржника» (юридична особа). Відповідні адреси сервісів:
cr_server/cr_seek/api/v1/customer_pp
cr_server/cr_seek/api/v1/customer_lp.
18.1.	Для пошуку інформації про особу Банк надсилає відповідне повідомлення (POST) на веб-сервіс «Пошук Боржника». Повідомлення має містити запит про одну особу. Повідомлення надається в форматі JSON (не потребує використання JSON Web Signature).
Приклад повідомлення (JSON-об’єкт) запиту (тип POST) для пошуку інформації про фізичну особу.

{
    "data": {
		"fio": {
				"firstName": "ІВАН",
				"lastName": "ТКАЧУК"
		},
		"birthDay": "1996-02-29",
		"inn": "1234567890",
		"isClient": true,
		"isPlan": false
		}
}	
Приклад повідомлення (JSON-об’єкт) запиту (тип POST) для пошуку інформації про юридичну особу.

{
    "data": {
		"nameUr": "Підприємство АБС123",
		"codEdrpou": "12345678",
		"isClient": true,
		"isPlan": false
	}
}	

18.2.	Перелік реквізитів повідомлення для пошуку інформації про фізичну особу

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1 Прізвище, ім’я, по батькові фізичної особи. Структура (елемент) fio.	
1.1	Прізвище	lastName	C(100)	Див. пояснення нижче		
1.2	Ім’я	firstName	C(100)			
1.3	По батькові	middleName	C(100)			
2	Дата народження	birthDay	D(10)	Див. пояснення нижче		
3	Ідентифікатор Боржника	inn	C(50)	Див. пояснення нижче		
4	Особа є боржником/пов’язаною особою боржника	isClient	B	+	Набуває значень:
true – так; false – ні;	
5	Наявність документального підтвердження звернення особи щодо наміру  укласти кредитний правочин	isPlan	B	+	Зазначається факт наявності документального підтвердження звернення особи щодо наміру  укласти кредитний правочин.
Набуває значень:
true – так; false – ні;	
Пояснення.
Реквізити isClient та isPlan в пошуковому запиті мають бути заповнені обов’язково. Якщо  isClient та isPlan одночасно мають значення false, пошук не виконується.
В пошуковому запиті, як мінімум, має бути обов’язково заповнена хоча б одна з пар реквізитів: <lastName + inn>  або <inn + birthDay>. 
Пошук в базі даних Реєстру здійснюється за повним збігом заповнених реквізитів пошукового запиту з відповідними полями бази даних.
Примітка: перед пошуком здійснюється переведення усіх символів заповнених реквізитів елементу fio та відповідних полів бази даних до однакового регістру.

18.3.	Перелік реквізитів повідомлення для пошуку інформації про юридичну особу

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Найменування юридичної особи	nameUr	C(254)	Див. пояснення нижче		
2	Код юридичної особи за ЄДРПОУ	codEdrpou	C(50)	Див. пояснення нижче		
3	Особа є боржником/пов’язаною особою боржника	isClient	B	+	Набуває значень:
true – так; false – ні;	
4	Наявність документального підтвердження звернення особи щодо наміру  укласти кредитний правочин	isPlan	B	+	Зазначається факт наявності документального підтвердження звернення особи щодо наміру  укласти кредитний правочин.
Набуває значень:
true – так; false – ні;	
Пояснення.
Реквізити isClient та isPlan в пошуковому запиті мають бути заповнені обов’язково. Якщо  isClient та isPlan одночасно мають значення false, пошук не виконується.
В пошуковому запиті допустимі такі варіанти заповнення реквізитів:
1) заповнені обидва реквізити codEdrpou і nameUr.
2) заповнений тільки реквізит codEdrpou;
3) заповнений тільки реквізит nameUr (при цьому реквізит nameUr має містити не менш семи значущих символів!).
В залежності від варіантів заповнення реквізитів пошук в базі даних Реєстру здійснюється таким чином:
Варіант 1). Пошук здійснюється за повним збігом реквізиту codEdrpou з відповідним полем бази даних та входженням реквізиту nameUr складовою частиною до поля «Найменування юридичної особи». 
Примітка: перед пошуком здійснюється переведення усіх символів реквізиту nameUr і поля бази даних «Найменування юридичної особи» до однакового регістру.
Варіант 2). Відбираються записи за повним збігом реквізиту codEdrpou з відповідним полем бази даних.
Варіант 3). Пошук здійснюється за входженням реквізиту nameUr складовою частиною до поля «Найменування юридичної особи» тільки серед юридичних осіб – нерезидентів.
Примітка: перед пошуком здійснюється переведення усіх символів реквізиту nameUr і поля бази даних «Найменування юридичної особи» до однакового регістру.

18.4.	За результатами пошуку у відповідь банк отримає повідомлення (JSON – об’єкт)

Повідомлення (відповідь) на запити типу POST для пошуку інформації
HTTP/1.1 200 Ok
Content-Type: application/json

{
“payload” : ”lc3REYXRhMTwvVEFCX1RFWFQ-PC9URVNUVEFCPjxURVNUVEFCIGk6dHlwZT0iVEVTVFRBQiI-PFRBQl9EQVQ-MjAxNy0wNi0wOFQxNjozNjoyOS45OTk3MzM0KzAzOjAwPC9”,
“protected” : ”QUJfVEVYVD7QnNCG0JrQntCb0JDQh9CE0pA8L1RBQl9URVhUPjwvVEVTVFRBQj48VEVTVFRBQiBpOnR5cGU9IlRFU1RUQUIiPjxUQU”,
“signature” : “NlIiB4bWxucz0iaHR0cDovL3NjaGVtYXMuZGF0YWNvbnRyYWN0Lm9yZy8y”
}	

В об’єкті “payload” в закодованому вигляді знаходиться JSON – об’єкт “data”, в якому містяться результати роботи сервісу пошуку.

18.5.	Реквізити об’єкта “data” для фізичної особи:

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний ідентифікатор сесії, в якій було оброблено інформацію	session_id	С(100)	+		
2	Адреса веб-сервіса, яким було оброблено інформацію	web_service_url	C(100)	+		
3	Http метод запиту	http_method	C(15)	+		
4	IP адреса з якої було здійснено запит	client_ip	C(15)	+		
5	Унікальний ідентифікатор SSL сертифіката користувача який здійснював запит	client_cert_id	C(50)	+		
6	Код помилки	general_err_code	N(20)	+	Загальний код помилки отриманий за результатами обробки запиту. Можливі значення: 0 – оброблено без помилок; 1 – оброблено з помилками (інформація не прийнята); 2 – оброблено з помилками (інформація прийнята частково. Див. п. 10.3 опису структури result_kvi).	
7	Код стану HTTP	general_http_status_code	N(3)	+	Частина першого рядка відповіді сервера при запитах по протоколу HTTP (HttpStatusCode).	
8	Коментар	general_err_comment	C(250)	+	Загальний коментар за результатами обробки запиту.	
9	Дата та час формування квитанції	kvi_date	D	+	Дата та час у форматі 
YYYY-MM-DDThh:mm:ss[.sssss]	
10. Перелік результатів пошуку інформації. Структура result_kvi - масив значень (поля 10.1 – 10.7). Якщо банків, в яких знайдена інформація про особу декілька, то поля структури result_kvi повторюються стільки разів, скільки є таких банків. Якщо інформація у Реєстрі не знайдена, структура (елемент) result_kvi є пустим масивом.	
10.1	Порядковий (умовний) номер  банку у повідомлені	orderBank	N(3)	+		
10.2	Ознака	markOfOwner	N(1)	+	Набуває значень:
1 – особа є Боржником банку, що здійснив запит; 0 – особа не є Боржником банку, що здійснив запит.	
10.3 Прізвище, ім’я, по батькові фізичної особи. Структура (елемент) fio.	
10.3.1	Прізвище	lastName	C(100)	+		
10.3.2	Ім’я	firstName	C(100)			
10.3.3	По батькові	middleName	C(100)			
10.4	Дата народження	birthDay	D(10)			
10.5	Ідентифікатор Боржника	inn	C(50)	+		
10.6 Інформація про умови кредитної операції та виконання зобов’язань за кредитною операцією. Структура (елемент) credits - масив значень (поля 10.6.1 – 10.6.14). Якщо кредитних операцій декілька, то поля структури credits повторюються стільки разів, скільки є кредитних операцій.	
10.6.1	Вид кредиту/наданого фінансового зобов’язання	typeCredit	N(2)	+	 	
10.6.2	Номер договору	numberDog	С(50)	+ 
	 	
10.6.3	Дата укладання договору	dogDay	D(10)	+		
10.6.4	Кінцева дата погашення кредиту/наданого фінансового зобов’язання	endDay	D(10)			
10.6.5	Загальна сума (ліміт кредитної лінії/
овердрафту) наданого фінансового зобов’язання	sumZagal	N(32)	+	Ціле число, в сотих частках валюти.	
10.6.6	Код валюти	r030	C(3)	+		
10.6.7	Залишок заборгованості за кредитною операцією	sumArrears	N(32)		Ціле число, в сотих частках валюти. 	
10.6.8	Строкова  заборгованість (яка обліковується за балансовими рахунками) за основним боргом	sumArrearsBase	N(32)		Ціле число, в сотих частках валюти.	
10.6.9	Строкова заборгованість (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції)	sumArrearsProc	N(32)		Ціле число, в сотих частках валюти.	
10.6.10	Прострочена  заборгованість (яка обліковується за балансовими рахунками) за основним боргом	arrearBase	N(32)	+	Ціле число, в сотих частках валюти.	
10.6.11	Прострочена  заборгованість  (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції)	arrearProc	N(32)	+	Ціле число, в сотих частках валюти.	
10.6.12	Кількість днів прострочення за основним боргом	dayBase	N(5)	+		
10.6.13	Кількість днів прострочення  за процентами	dayProc	N(5)	+		
10.6.14	Скоригований клас Боржника	klass	C(2)	+		
10.6.15. Транші за кредитним договором. Структура (елемент) Tranche - масив значень (поля 10.5.15.1 – 10.5.15.12). Якщо траншів за кредитним договором декілька, то поля структури Tranche повторюються стільки разів, скільки є траншів. Якщо транші не передбачені кредитним договором структура (елемент) Tranche є пустим масивом.	
10.6.15.1	Номер договору траншу	numDogTr	С(50)	+ 	Зазначається номер додаткового договору/іншого первинного документа (траншу), згідно з яким у Боржника виникає заборгованість перед Банком  та/або Банк надає фінансові зобов’язання.	
10.6.15.2	Дата укладання договору траншу	dogDayTr	D(10)	+	Зазначається дата укладання додаткового договору (траншу). Якщо операція здійснена без укладання договору, то зазначається дата виникнення заборгованості.	
10.6.15.3	Кінцева дата погашення заборгованості траншу	endDayTr	D(10)	+	Зазначається кінцева дата погашення заборгованості або дата припинення наданих банком  фінансових зобов’язань по траншу згідно з умовами договору.	
10.6.15.4	Сума наданого фінансового зобов’язання за траншем	sumZagalTr	N(32)	+	Зазначається загальна сума траншу, що зазначена в договорі (ціле число, в сотих частках валюти).	
10.6.15.5	Код валюти за траншем	r030Tr	C(3)	+		
10.6.15.6	Строкова  заборгованість (яка обліковується за балансовими рахунками) за основним боргом за траншем	sumArrearsTrBase	N(32)		Ціле число, в сотих частках валюти	
10.6.15.7	Строкова заборгованість (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції) за траншем	sumArrearsTrProc	N(32)		Ціле число, в сотих частках валюти	
10.6.15.8	Прострочена  заборгованість (яка обліковується за балансовими рахунками) за основним боргом за траншем	arrearBaseTr	N(32)	+	Зазначається прострочена заборгованість за основним боргом траншу.	
10.6.15.9	Прострочена  заборгованість  (яка обліковується за балансовими рахунками) за процентами ​(комісійними доходами, що відносяться до кредитної операції) за траншем.	arrearProcTr	N(32)	+	Зазначається прострочена заборгованість  за процентами траншу.	
10.6.15.10	Кількість днів прострочення за траншем 	dayBaseTr	N(5)	+	Зазначається кількість днів прострочення за основним боргом траншу. 	
10.6.15.11	Кількість днів прострочення за процентами траншу	dayProcTr	N(5)	+	Зазначається кількість днів прострочення за процентами траншу.	
10.6.15.12	Скоригований клас Боржника за траншем	klassTr	C(2)	+		
10.7	Інформація про належність боржника до пов’язаних із банком осіб	flagK060	B	+	Набуває значень:
true – так; false – ні;	
10.8. Інформація про забезпечення виконання зобов’язань за кредитною операцією, у тому числі порукою. Структура (елемент) Pledge - масив значень (поля 10.7.1 – 10.7.3). Якщо  договорів застави/іпотеки, гарантії, поруки декілька, то поля структури Pledge повторюються стільки разів, скільки є договорів. Якщо договорів застави/іпотеки, гарантії не має, то структура (елемент) Pledge є пустим масивом.	
10.8.1	Дата укладання договору застави/іпотеки, гарантії, поруки, грошового покриття	pledgeDay	D(10)	+		
10.8.2	Код виду забезпечення за договором	s031	C(2)	+		
10.8.3	Порядковий номер  застави/іпотеки, гарантії, поруки, грошового покриття у Боржника	orderZastava	N(15)	+		

Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запити типу POST для фізичної особи.

    "data": {
"session_id": "7c405ab9ed0f6bd3a10892b7f6fdc0d6e373d00c68bad4ee5a56c5c675be45d9",
"web_service_url": "https://app-crk01/cr_seek/api/v1/customer_pp",
"http_method": "POST",
"client_ip": "172.22.1.123",
"client_cert_id": "XRxxiiinnn",
"general_err_code": 2,
"general_http_status_code": 200,
"general_err_comment": "Коментар зформований за результатами роботи сервісу",
"kvi_date": "2017-10-02T16:57:42.8452978+03:00",
"result_kvi": 	[
		{
			"orderBank": 1,
			"markOfOwner": 1,
			"fio": {
				"firstName": "ІВАН",
				"lastName": "ТКАЧУК"
			},
			"birthDay": "1996-02-29",
			"inn": "1234567890",
			"credits": [
				{
					"typeCredit": 12,
					"numberDog": "7773h",
					"dogDay": "2001-07-20",
					"endDay": "2002-05-29",
					"sumZagal": 55000000,
					"r030": "152",
					"sumArrears": null,
					"sumArrearsBase": 500,
					"sumArrearsProc": 30,
					"arrearBase": 0,
					"arrearProc": 0,
					"dayBase": 0,
					"dayProc": 0,
					"klass": “C1”,
					"tranche": [{
						"numDogTr": "23h-tr1",
						"dogDayTr": "2000-02-29",
						"endDayTr": "2001-05-29",
						"sumZagalTr": 2998005600,
						"r030Tr": "040",
						"sumArrearsTrBase": 800,
						"sumArrearsTrProc": 50,
						"arrearBaseTr": 700,
						"arrearProcTr": 100,
						"dayBaseTr": 135,
						"dayProcTr": 73,
						"klassTr": “D1”
					},
					{
						"numDogTr": "23h-tr2",
						"dogDayTr": "2000-12-29",
						"endDayTr": "2001-05-29",
						"sumZagalTr": 1000,
						"r030Tr": "090",
						"sumArrearsTrBase": 300,
						"sumArrearsTrProc": 25,
						"arrearBaseTr": 700,
						"arrearProcTr": 100,
						"dayBaseTr": 135,
						"dayProcTr": 73,
						"klassTr": “D1”
					}
					]
				},
				{
					"typeCredit": 12,
					"numberDog": "55-h",
					"dogDay": "1996-02-29",
					"endDay": "2002-05-29",
					"sumZagal": 1000,
					"r030": "084",
					"sumArrears": null,
					"sumArrearsBase": 900,
					"sumArrearsProc": 70,
					"arrearBase": 700,
					"arrearProc": 100,
					"dayBase": 135,
					"dayProc": 73,
					"klass": “C1”,
					"tranche": []
				},
			{
			],
			"flagK060": true,
			"pledge": [
				{
					"pledgeDay": "2015-02-19",
					"s031": "25",
					"orderZastava": 1
				},
				{
					"pledgeDay": "2014-12-09",
					"s031": "34",
					"orderZastava": 2
				}
			]
		}
		]
	}
}	
JSON - схеми повідомлень та приклади наведені у додатках.

18.6.	Реквізити об’єкта “data” для юридичної особи:

№
з/п	Зміст реквізиту	Найменування реквізиту 	Тип (макс.
дов-жина)	Обов’язковість заповнення	Примітки	
1	Унікальний ідентифікатор сесії, в якій було оброблено інформацію	session_id	С(100)	+		
2	Адреса веб-сервіса, яким було оброблено інформацію	web_service_url	C(100)	+		
3	Http метод запиту	http_method	C(15)	+		
4	IP адреса з якої було здійснено запит	client_ip	C(15)	+		
5	Унікальний ідентифікатор SSL сертифіката користувача який здійснював запит	client_cert_id	C(50)	+		
6	Код помилки	general_err_code	N(20)	+	Загальний код помилки отриманий за результатами обробки запиту. Можливі значення: 0 – оброблено без помилок; 1 – оброблено з помилками (інформація не прийнята); 2 – оброблено з помилками (інформація прийнята частково. Див. п. 10.3 опису структури result_kvi).	
7	Код стану HTTP	general_http_status_code	N(3)	+	Частина першого рядка відповіді сервера при запитах по протоколу HTTP (HttpStatusCode).	
8	Коментар	general_err_comment	C(250)	+	Загальний коментар за результатами обробки запиту.	
9	Дата та час формування квитанції	kvi_date	D	+	Дата та час у форматі 
YYYY-MM-DDThh:mm:ss[.sssss]	
10. Перелік результатів пошуку інформації. Структура result_kvi - масив значень (поля 10.1 – 10.15). Якщо банків, в яких знайдена інформація про особу декілька, то поля структури result_kvi повторюються стільки разів, скільки є таких банків. Якщо інформація у Реєстрі не знайдена, структура (елемент) result_kvi є пустим масивом.	
10.1	Порядковий (умовний) номер  банку у повідомлені	orderBank	N(3)	+		
10.2	Ознака	markOfOwner	N(1)	+	Набуває значень:
1 – особа є Боржником банку, що здійснив запит; 0 – особа не є Боржником банку, що здійснив запит.	
10.3	Найменування Боржника	nameUr	C(254)	+		
10.4	Ідентифікатор Боржника	codEdrpou	C(50)	+		
10.5	Вид економічної діяльності	k110	C(5)	+		
10.6	Період, за який визначено вид економічної діяльності.	ec_year	D(10)	+		
10.7	Приналежність Боржника до групи юридичних осіб	isMember	B		Зазначається приналежність Боржника до групи юридичних осіб, що знаходяться під спільним контролем: 
true-так; false-ні; Якщо Боржник – фізична особа - суб’єкт підприємницької  діяльності зазначається null.	
10.8. Перелік юридичних осіб, що входять до групи юридичних осіб, що знаходяться під спільним контролем. Структура (елемент) groupUr. Якщо Боржник-юридична особа не входить до групи юридичних осіб, структура (елемент) groupUr не вказується. Якщо учасників кілька, структура повторюється.	
10.8.1	Статус участі юридичної особи в групі	whoIs	N(1)	+ 	Зазначається статус участі юридичної особи в групі.
Набуває значень:
0 – учасник;
1 – материнська компанія/контролер;
2 - учасник групи, якому надано гарантію.	
10.8.2	Ідентифікатор учасника групи	codEdrpouGr	C(50)	+		
10.8.3	Найменування особи	nameUrGr	C(254)			
10.8.4	Клас групи	classGr	C(1)	+	Зазначається код класу відповідно до значень довідника S080	
10.8.5	Факт приналежності Боржника до групи пов’язаних контрагентів	isPartner	B	+ 	Зазначається факт приналежності Боржника до групи пов’язаних контрагентів, що несуть спільний економічний ризик Набуває значень:
true-так; false-ні; Якщо Боржник – фізична особа - суб’єкт підприємницької  діяльності, зазначається null.	
10.9. Перелік юридичних осіб, які належать до групи пов’язаних контрагентів Структура (елемент) partners. Якщо Боржник - юридична особа не входить до групи пов’язаних контрагентів, структура (елемент) partners не вказується. Якщо учасників кілька, структура  повторюється.	
10.9.1	Ідентифікатор пов’язаного контрагента	codEdrpouPr	C(50)	+		
10.9.2	Найменування особи	nameUrPr	C(254)			
10.10	Факт проходження аудиту фінансової звітності	isAudit	B	+ 	Набуває значень:
true-так; false-ні; Не зазначається для фізичної особи - суб’єкта підприємницької  діяльності. Якщо Боржник – фізична особа - суб’єкт підприємницької  діяльності зазначається null.	
10.11. Власники істотної участі в статутному капіталі боржника  – юридичної особи – фізичні особи. Структура (елемент) ownerPp. Якщо власників кілька, структура ownerPp повторюється. Якщо Боржник - юридична особа є фізичною особою – підприємцем, структура (елемент) ownerPp не вказується.	
10.10.1. Прізвище, ім’я, по батькові фізичної особи. Структура (елемент) FIO.	
10.11.1.1	Прізвище	lastName	C(100)	+		
10.11.1.2	Ім’я	firstName	C(100)	+		
10.11.1.3	По батькові	middleName	C(100)			
10.11.2	Ідентифікатор власника істотної участі	inn	C(50)	+		
10.11.3	Код країни місця реєстрації	countryCod	C(3)		Зазначається код країни – місця реєстрації нерезидента.	
10.12. Місце реєстрації власника істотної участі в статутному капіталі боржника  – юридичної особи – фізичної особи. Структура (елемент) address.	
10.12.1.	Код регіону	codRegion	C(2)			
10.12.2.	Район	area	C(100)			
10.12.3.	Поштовий індекс	zip	С(10)	+		
10.12.4.	Назва населеного пункту 	city	C(254)	+		
10.12.5.	Вулиця	streetAddress	C(254)			
10.12.6.	Будинок	houseNo	C(50)			
10.12.7.	Корпус (споруда)	adrKorp	C(50)			
10.12.8.	Квартира	flatNo	C(50)			
10.13. Власники істотної участі в статутному капіталі боржника  – юридичної особи – юридичні особи. Структура (елемент) ownerJur. Якщо власників кілька, структура ownerJur повторюється. Якщо Боржник - юридична особа є фізичною особою – підприємцем, структура (елемент) ownerJur не вказується.	
10.13.1	Найменування особи	nameOj	C(254)	+		
10.13.2	Ідентифікатор власника істотної участі	codEdrpouOj	C(50)	+		
10.14 Інформація про умови кредитної операції та виконання зобов’язань за кредитною операцією. Структура (елемент) credits - масив значень (поля 10.14.1 – 10.14.14). Якщо кредитних операцій декілька, то поля структури credits повторюються стільки разів, скільки є кредитних операцій.	
10.14.1	Вид кредиту/наданого фінансового зобов’язання	typeCredit	N(2)	+	 	
10.14.2	Номер договору	numberDog	С(50)	+ 
	 	
10.14.3	Дата укладання договору	dogDay	D(10)	+		
10.14.4	Кінцева дата погашення кредиту/наданого фінансового зобов’язання	endDay	D(10)			
10.14.5	Загальна сума (ліміт кредитної лінії/
овердрафту) наданого фінансового зобов’язання	sumZagal	N(32)	+	Ціле число, в сотих частках валюти.	
10.14.6	Код валюти	r030	C(3)	+		
10.14.7	Залишок заборгованості за кредитною операцією	sumArrears	N(32)		Ціле число, в сотих частках валюти.	
10.14.8	Строкова  заборгованість (яка обліковується за балансовими рахунками) за основним боргом	sumArrearsBase	N(32)		Ціле число, в сотих частках валюти.	
10.14.9	Строкова заборгованість (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції)	sumArrearsProc	N(32)		Ціле число, в сотих частках валюти.	
10.14.10	Прострочена  заборгованість (яка обліковується за балансовими рахунками) за основним боргом	arrearBase	N(32)	+	Ціле число, в сотих частках валюти.	
10.14.11	Прострочена  заборгованість  (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції)	arrearProc	N(32)	+	Ціле число, в сотих частках валюти.	
10.14.12	Кількість днів прострочення за основним боргом	dayBase	N(5)	+		
10.14.13	Кількість днів прострочення  за процентами	dayProc	N(5)	+		
10.14.14	Скоригований клас Боржника	klass	C(2)	+		
10.14.15. Транші за кредитним договором. Структура (елемент) Tranche - масив значень (поля 10.14.15.1 – 10.14.15.12). Якщо траншів за кредитним договором декілька, то поля структури Tranche повторюються стільки разів, скільки є траншів. Якщо транші не передбачені кредитним договором структура (елемент) Tranche є пустим масивом.	
10.14.15.1	Номер договору траншу	numDogTr	С(50)	+ 	Зазначається номер додаткового договору/іншого первинного документа (траншу), згідно з яким у Боржника виникає заборгованість перед Банком  та/або Банк надає фінансові зобов’язання.	
10.14.15.2	Дата укладання договору траншу	dogDayTr	D(10)	+	Зазначається дата укладання додаткового договору (траншу). Якщо операція здійснена без укладання договору, то зазначається дата виникнення заборгованості.	
10.14.15.3	Кінцева дата погашення заборгованості траншу	endDayTr	D(10)	+	Зазначається кінцева дата погашення заборгованості або дата припинення наданих банком  фінансових зобов’язань по траншу згідно з умовами договору.	
10.14.15.4	Сума наданого фінансового зобов’язання за траншем	sumZagalTr	N(32)	+	Зазначається загальна сума траншу, що зазначена в договорі (ціле число, в сотих частках валюти).	
10.14.15.5	Код валюти за траншем	r030Tr	C(3)	+		
10.14.15.6	Строкова  заборгованість (яка обліковується за балансовими рахунками) за основним боргом за траншем	sumArrearsTrBase	N(32)		Ціле число, в сотих частках валюти	
10.14.15.7	Строкова заборгованість (яка обліковується за балансовими рахунками) за процентами (комісійними доходами, що відносяться до кредитної операції) за траншем	sumArrearsTrProc	N(32)		Ціле число, в сотих частках валюти	
10.14.15.8	Прострочена  заборгованість (яка обліковується за балансовими рахунками) за основним боргом за траншем	arrearBaseTr	N(32)	+	Зазначається прострочена заборгованість за основним боргом траншу.	
10.14.15.9	Прострочена  заборгованість  (яка обліковується за балансовими рахунками) за процентами ​(комісійними доходами, що відносяться до кредитної операції) за траншем.	arrearProcTr	N(32)	+	Зазначається прострочена заборгованість  за процентами траншу.	
10.14.15.10	Кількість днів прострочення за траншем 	dayBaseTr	N(5)	+	Зазначається кількість днів прострочення за основним боргом траншу. 	
10.14.15.11	Кількість днів прострочення за процентами траншу	dayProcTr	N(5)	+	Зазначається кількість днів прострочення за процентами траншу.	
10.14.15.12	Скоригований клас Боржника за траншем	klassTr	C(2)	+		
10.15	Інформація про належність боржника до пов’язаних із банком осіб	flagK060	B	+	Набуває значень:
true – так; false – ні;	
10.16. Інформація про забезпечення виконання зобов’язань за кредитною операцією, у тому числі порукою. Структура (елемент) Pledge - масив значень (поля 10.16.1 – 10.16.3). Якщо  договорів застави/іпотеки, гарантії, поруки декілька, то поля структури Pledge повторюються стільки разів, скільки є договорів. Якщо договорів застави/іпотеки, гарантії не має, то структура (елемент) Pledge є пустим масивом.	
10.16.1	Дата укладання договору застави/іпотеки, гарантії, поруки, грошового покриття	pledgeDay	D(10)	+		
10.16.2	Код виду забезпечення за договором	s031	C(2)	+		
10.16.3	Порядковий номер  застави/іпотеки, гарантії, поруки, грошового покриття у Боржника	orderZastava	N(15)	+		

Приклад квитанції (JSON-об’єкт), що буде розміщено в закодованому, за допомогою Base64url кодування, вигляді в значенні параметра “payload” у відповідь на запити типу POST для юридичної особи.

{
    "data": {
"session_id": "7c405ab9ed0f6bd3a10892b7f6fdc0d6e373d00c68bad4ee5a56c5c675be45d9",
"web_service_url": "https://app-crk01/cr_seek/api/v1/customer_lp",
"http_method": "POST",
"client_ip": "172.22.1.123",
"client_cert_id": "XRxxiiinnn",
"general_err_code": 2,
"general_http_status_code": 200,
"general_err_comment": "Коментар зформований за результатами роботи сервісу",
"kvi_date": "2017-10-02T16:57:42.8452978+03:00",
"result_kvi": 	[
		{
			"orderBank": 1,
			"markOfOwner": 1,
			"nameUr": "3 Підприємство своє",
			"codEdrpou": "12345678",
			"k110": "N2562",
			"ec_year": "2016-04-20",
			"isMember": true,
			"groupUr": [
			{
				"whoIs": [1],
				"codEdrpouGr": "22333444",
				"nameUrGr": "Перший 1 учасник резидент"
			},
			{
				"whoIs": [2],
				"codEdrpouGr": "IN/12333444",
				"nameUrGr": "Другий 2 учасник нерезидент"
			}
			],
			"classGr": "D",
			"isPartner": true,
			"partners": [
				{
					"codEdrpouPr": "19283746",
					"nameUrPr": "Перший партнер резидент"
				},
				{
					"codEdrpouPr": "Ner-34567543",
					"nameUrPr": "Другий партнер нерезидент"
				}
				],
			"isAudit": true,
			"ownerPp": [
				{
					"fio": {
						  "firstName": "МИКОЛА",
						  "lastName": "ТКАЧУК",
						  "middleName": "ТАРАСОВИЧ"
						},
					"inn": "1234567890",
					"address": {
						 "codRegion" : "11",
						 "area" : "абвгдЯЇЄ",
						 "zip" : "00001",
						 "city" : "село Яблунівка",
						 "streetAddress": "21 Друга вулиця",
						 "houseNo": "5А/7",
						 "adrKorp": "секція 1",
						 "flatNo": "кв. 11,12"
						}
						},							
						{
					"fio": {
						  "firstName": "ВАСИЛЬ",
						  "lastName": "ШЕВЧУК",
						  "middleName": "ПЕТРОВИЧ"
						},
					"inn": "0987654321",
					"address": {
						 "codRegion" : "11",
						 "area" : "абвгдЯЇЄ",
						 "zip" : "20001",
						 "city" : "село Дубровка",
						 "streetAddress": "Центральна",
						 "houseNo": "55"
						}							
						}
						],
			"ownerJur":	[
					{
					"nameOj": "Власник юрік 1",
					"codEdrpouOj": "12345678"
					},
					{
					"nameOj": "Власник юрік 2",
					"codEdrpouOj": "NW--98761111"
					}
					],
			"credits": [
				{
					"typeCredit": 12,
					"numberDog": "7773h",
					"dogDay": "2001-07-20",
					"endDay": "2002-05-29",
					"sumZagal": 55000000,
					"r030": "152",
					"sumArrears": null,
					"sumArrearsBase": 700,
					"sumArrearsProc": 70,
					"arrearBase": 0,
					"arrearProc": 0,
					"dayBase": 0,
					"dayProc": 0,
					"klass": “D1”,
					"tranche": [{
						"numDogTr": "23h-tr1",
						"dogDayTr": "2000-02-29",
						"endDayTr": "2001-05-29",
						"sumZagalTr": 2998005600,
						"r030Tr": "040",
						"sumArrearsTrBase": 800,
						"sumArrearsTrProc": 80,
						"arrearBaseTr": 700,
						"arrearProcTr": 100,
						"dayBaseTr": 135,
						"dayProcTr": 73,
						"klassTr": “D1”
					},
					{
						"numDogTr": "23h-tr2",
						"dogDayTr": "2000-12-29",
						"endDayTr": "2001-05-29",
						"sumZagalTr": 1000,
						"r030Tr": "090",
						"sumArrearsTrBase": 700,
						"sumArrearsTrProc": 70,
						"arrearBaseTr": 700,
						"arrearProcTr": 100,
						"dayBaseTr": 135,
						"dayProcTr": 73,
						"klassTr": “D1”
					}
					]
				},
				{
					"typeCredit": 12,
					"numberDog": "55-h",
					"dogDay": "1996-02-29",
					"endDay": "2002-05-29",
					"sumZagal": 1000,
					"r030": "084",
					"sumArrears": null,
					"sumArrearsBase": 800,
					"sumArrearsProc": 80,
					"arrearBase": 700,
					"arrearProc": 100,
					"dayBase": 135,
					"dayProc": 73,
					"klass": “D1”,
					"tranche": []
				},
			],
			"flagK060": true,
			"pledge": [
				{
					"pledgeDay": "2015-02-19",
					"s031": "25",
					"orderZastava": 1
				},
				{
					"pledgeDay": "2014-12-09",
					"s031": "34",
					"orderZastava": 2
				}
			]
		}
		]
	}
}	
JSON - схеми повідомлень та приклади наведені у додатках.