{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://check.finap.com.ua/apiinfo/schema/v1/RequestSchema.json",
    "type": "object",
    "title": "CheckLists Request",
    "description": "Схема запиту до сервісу CheckLists",
    "properties": {
        "IDinternal": {
            "$id": "#/properties/IDinternal",
            "type": [
                "integer",
                "string"
            ],            
	    "title": "Внутрішній унікальний ID запиту",
            "description": "Внутрішній унікальний ID запиту,що генерується засобами внутрішнього програмного забезпечення суб'єкта ФМ"
        },
        "IDsubjectFM": {
            "$id": "#/properties/IDsubjectFM",
            "type": "string",
            "title": "Ідентифікаотр cуб'єкта фінансового моніторингу",
            "description": "ID cуб'єкта ФМ (просвоюється при реєстрації суб'єкта ФМ в ПК 'FinAP CheckLists')"
        },
        "tokken": {
            "$id": "#/properties/tokken",
            "type": "string",
            "title": "Токкен доступу",
            "description": "Токкен доступу"
        },
        "listdata": {
            "$id": "#/properties/listdata",
            "type": "number",
            "title": "Індикатор запиту до реєстру",
            "description": "Число, яке при приведенні у двійковий формат відображає у яких списках даних був здійснений пошук збігів, див. https://check.finap.com.ua/apiinfo/#paramListdata"
        },
        "IDuserPC": {
            "$id": "#/properties/IDuserPC",
            "type": [
                "number",
                "string"
            ],            
            "title": "Ідентифікатор робочого місця cуб'єкта фінансового моніторингу",
            "description": "ID робочого місця cуб'єкта ФМ (просвоюється на стороні суб'єкта ФМ)"
        },
        "DateRequest": {
            "$id": "#/properties/DateRequest",
            "type": "string",
            "title": "Дата і час формування запиту",
            "description": "Дата та час формування запиту (генерується засобами внутрішнього ПЗ суб'єкта ФМ) у форматі 'YYYY-MM-DD hh:mm:ss'"
        },
        "name": {
            "$id": "#/properties/name",
            "type": "string",
            "title": "Прізвище, ім'я, по-батькові або назва клієнта/контрагента",
            "description": "Прізвище, ім'я, по-батькові або назва клієнта/контрагента. Основний параметр пошуку у всіх реєстрах CheckLists інформації по фізичних особах і ФОП"
        },
        "namelat": {
            "$id": "#/properties/namelat",
            "type": "string",
            "title": "Прізвище, ім'я, по-батькові або назва клієнта/контрагента у латиниці",
            "description": "Прізвище, ім'я, по-батькові або назва клієнта/контрагента у латиниці (може бути сформовано за результатами роботи алгоритму транслітерації)"
        },
        "date": {
            "$id": "#/properties/date",
            "type": "string",
            "title": "Дата народження",
            "description": "Дата народження клієнта/контрагента — фізичної особи (дата реєстрації юридичної особи) у форматі 'YYYY-MM-DD'. Додатковий параметр для пошуку у реєстрах ('Публічні особи','Санкційні списки') CheckLists інформації по фізичних особах. Впливає на значення параметра level у відповідних реєстрах."
        },
        "ipn": {
            "$id": "#/properties/ipn",
            "type": "string",
            "title": "ІПН фізичної особи або ЄДРПОУ юридичної особи",
            "description": "Індивідуальний податковий номер фізичної особи (більшість реєстрів не містять даних про ІПН), або ЄДРПОУ юридичної особи. Основний параметр пошуку в реєстрах CheckLists інформації по юридичних особах"
        },
        "city": {
            "$id": "#/properties/city",
            "type": "string",
            "title": "Населений пункт",
            "description": "Назва населеного пункту. Використовується для пошуку підприємців в ЄДР ЮО і ФОП за місцем приписки, а також в реєстрі податкових боржників за приналежністю податкової."
        },
        "doc": {
            "$id": "#/properties/doc",
            "type": "string",
            "title": "Реквізити документа клієнта/контрагента",
            "description": "Реквізити документа клієнта/контрагента (національний паспорт, закордонний паспорт, ID картка). Використовується для пошуку в реєстрі 'Втрачені документи' "
        },
        "doctype": {
            "$id": "#/properties/doctype",
            "type": "integer",
	    "minimum": 1,
	    "exclusiveMinimum": false,
	    "maximum": 2,
            "exclusiveMaximum": false,
            "title": "Тип документу",
            "description": "Тип документу. Може приймати значення 1 (ПАСПОРТ ГРОМАДЯНИНА УКРАЇНИ в тому числі і ID карти) та 2 (ПАСПОРТ ГРОМАДЯНИНА УКРАЇНИ ДЛЯ ВИЇЗДУ ЗА КОРДОН). Використовується для пошуку в реєстрі 'Втрачені документи' "
        },
        "lowranklimit": {
            "$id": "#/properties/lowranklimit",
            "type": "integer",
	    "minimum": 0,
	    "exclusiveMinimum": false,
	    "maximum": 100,
            "exclusiveMaximum": false,
            "title": "Нижня межа співпадінь",
            "description": "Число, що визначає нижню межу співпадінь назви чи ПІБ у відсотках (стосується лише пошукових даних Санкційні списки). За замовчуванням - 0."
        },
        "edrchangesfrom": {
            "$id": "#/properties/edrchangesfrom",
            "type": "string",
            "title": "Дата початку періоду змін в ЄДР",
            "description": "Дата початку періоду змін в ЄДР (для Аналізу) у форматі 'YYYY-MM-DD'.Використовується для пошуку в реєстрі 'ЄДР ЮО і ФОП' в блоці історія змін по ЮО. За замовчуванням (якщо не вказувати) – текучий мінус 1 день."
        },
        "edrchangesto": {
            "$id": "#/properties/edrchangesto",
            "type": "string",
            "title": "Дата закінчення періоду змін в ЄДР",
            "description": "Дата закінчення періоду змін в ЄДР (для Аналізу) у форматі 'YYYY-MM-DD'.Використовується для пошуку в реєстрі 'ЄДР ЮО і ФОП' в блоці історія змін по ЮО. За замовчуванням (якщо не вказувати) – текучий день."
        },
        "arrayedrpou": {
            "$id": "#/properties/arrayedrpou",
            "type": "string",
            "title": "Перелік кодів ЄДРПОУ",
            "description": "Перелік кодів ЄДРПОУ(розділених комою), щодо яких аналізуються зміни в ЄДР протягом заданого періоду.Використовується для пошуку в реєстрі 'ЄДР ЮО і ФОП' в блоці історія змін по ЮО."
        },
        "onlyactual": {
            "$id": "#/properties/onlyactual",
            "type": "boolean",
            "title": "Актуальний запис в розширеному ЄДР ЮО і ФОП",
            "description": "Даний параметр вказує чи повертати актуальний запис чи всі нявні в реєстрі записи (true – актуальний, false - всі). За замовчуванням – актуальний. Використовується для пошуку в реєстрі 'розширений ЄДР ЮО і ФОП' "
        },
        "finmon": {
            "$id": "#/properties/finmon",
            "type": "boolean",
            "title": "Ознака підтвердження результатів запиту",
            "description": "Ознака підтвердження результатів запиту підрозділом фінансового моніторингу суб'єкта ФМ (true – потребує підтвердження, false – по замовчуванню, без підтвердження). На даний момент поле не використовується"
        },
        "search": {
            "$id": "#/properties/search",
            "type": "string",
            "title": "Метод пошуку",
            "description": "Метод пошуку (1 — повнотекстний, 2 — контекстний...). На даний момент поле не використовується"
        },
        "responsetype": {
            "$id": "#/properties/responsetype",
            "type": "string",
            "title": "Тип відповіді",
            "description": "Тип відповіді (результату запиту): 1 — відповідь-дозвіл (true|false); 2 – узагальнений; 3 — скорочений; 5 — повний. На даний момент поле не використовується"
        },
        "textformat": {
            "$id": "#/properties/textformat",
            "type": "string",
            "title": "Формат текстового поля для повного типу відповіді",
            "description": "Формат текстового поля для повного типу відповіді (responsetype=5), може набувати значення 'JSON' (або ' ', за замовчуванням), 'xml', 'html' і 'text'. На даний момент поле не використовується"
        }
    },
    "required": [ "IDsubjectFM", "tokken" ]


}