## SDK для API «Зачестныйбизнес»


### Примеры использования

```lua
local paid = require('zcb.paid')
```

---

### Методы

#### Карточка сущфакта
**Пример вызова:**
`paid.sfact-card(id)`

**Параметры:**
- `id` — идентификатор сущфакта (обязательный).

#### Список лизинговых договоров
**Пример вызова:**
`paid.lease-contracts-list(id, page)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).
- `page` — номер страницы (обязательный).

#### Лизинговый договор
**Пример вызова:**
`paid.lease-contract-card(id, contract_id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).
- `contract_id` — идентификатор договора (обязательный).

#### Связанные организации
**Пример вызова:**
`paid.affilation-company(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Лицензии
**Пример вызова:**
`paid.licenses(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Важные факты/Риски
**Пример вызова:**
`paid.important-facts(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Отчёты АО по банкроту
**Пример вызова:**
`paid.bankrupt-reports(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Проверка на наличие в реестре террористов (по ФИО)
**Пример вызова:**
`paid.check-terror-fio(fio)`

**Параметры:**
- `fio` — ФИО для проверки (обязательный).

#### Выписка из ЕГРЮЛ на требуемую дату (JSON)
**Пример вызова:**
`paid.fns-card-report(id, date)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).
- `date` — дата (ГГГГ-ММ-ДД) (обязательный).

#### Выписка из ЕГРЮЛ на требуемую дату (PDF)
**Пример вызова:**
`paid.fns-card-report-pdf(id, date)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).
- `date` — дата (ГГГГ-ММ-ДД) (обязательный).

#### История изменений юр.адреса/руководителей/учредителей в организации
**Пример вызова:**
`paid.fns-card-attribute-history(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Сообщение по банкротству (по ID сообщения)
**Пример вызова:**
`paid.bankrupt-message(id, message_id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).
- `message_id` — идентификатор сообщения (обязательный).

#### Лизинговый договор (альтернативный метод)
**Пример вызова:**
`paid.lease-contract(id, contract_id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).
- `contract_id` — идентификатор договора (обязательный).

#### Отчёт по форме ФНС на требуемую дату
**Пример вызова:**
`paid.company-fns-requirements-info(id, date)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).
- `date` — дата (ГГГГ-ММ-ДД) (обязательный).

#### Отчёт «Должная осмотрительность» (PDF)
**Пример вызова:**
`paid.pdo-pdf(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Проверка на наличие в реестре иноагентов (по ФИО)
**Пример вызова:**
`paid.check-foreign-agent-fio(fio)`

**Параметры:**
- `fio` — ФИО для проверки (обязательный).

#### Фин. отчётность (Росстат)
**Пример вызова:**
`paid.fs-rosstat(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Уровень Риска ЦБ РФ
**Пример вызова:**
`paid.cbr-rating(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Вероятность налоговой проверки
**Пример вызова:**
`paid.tax-burn(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Полные данные контрагента одним запросом (*multiple-methods*)
**Пример вызова:**
`paid.multiple-methods(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Сводный отчёт PDF (*common-total-pdf*)
**Пример вызова:**
`paid.common-total-pdf(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Проверка на наличие в реестре иноагентов (по ИНН)
**Пример вызова:**
`paid.check-foreign-agent-inn(inn)`

**Параметры:**
- `inn` — ИНН для проверки (обязательный).

#### Стоп‑лист ЦБ РФ (*cbr-stop-list*)
**Пример вызова:**
`paid.cbr-stop-list(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Дела судов общей юрисдикции (список)
**Пример вызова:**
`paid.court-general-jurisdiction(id, page)`

**Параметры:**
  - `id`, *inn*, *ogrn*, *fio*, *passport_series+passport_number* — один из этих параметров обязателен.
  - `page` — номер страницы (обязательный).


#### Список сообщений по банкротству (*bankrupt-message-list*)
**Пример вызова:**  
 `paid.bankrupt-message-list(id, page)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.
 - *page* — номер страницы (обязательный).  


#### Бенефициары 
**Пример вызова:**  
 `paid.beneficiaries(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### Санкции 
**Пример вызова:**  
 `paid.sanctions(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### Поиск 
**Пример вызова:**  
 `paid.search(query, page)`  
 **Параметры:**  
 - *query* — строка поиска (обязательный).  
 - *page* — номер страницы (обязательный).  


#### Основные сведения (*card*) 
**Пример вызова:**  
 `paid.card(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### Сведения о физ. лице (*fl-card*) 
**Пример вызова:**  
 `paid.fl-card(inn)`  
 **Параметры:**  
 - *inn* — ИНН физического лица (обязательный).  


#### Сведения ФНС (*fns-card*) 
**Пример вызова:**  
 `paid.fns-card(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### Изменения (*diffs*) 
**Пример вызова:**  
 `paid.diffs(id, date_from, date_to)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  
 - *date_from* — дата начала периода (обязательный).  
 - *date_to* — дата окончания периода (обязательный).  


#### Фин. отчётность ФНС (*fs-fns*) 
**Пример вызова:**  
 `paid.fs-fns(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### ФССП (*fssp-list*) 
**Пример вызова:**  
 `paid.fssp-list(id, page)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  
 - *page* — номер страницы (обязательный).  


#### Индекс ЗАЧЕСТНЫЙБИЗНЕС (*rating*) 
**Пример вызова:**  
 `paid.rating(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### Реквизиты (*requisites*) 
**Пример вызова:**  
 `paid.requisites(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### Судебные дела арбитражных судов (*court‑arbitration*) 
**Пример вызова:**  
 `paid.court‑arbitration(id, page)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  
 - *page* — номер страницы (обязательный).  


#### Судебное дело арбитражных судов (*court‑arbitration‑card*) 
**Пример вызова:**  
 `paid.court‑arbitration‑card(id, case_id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  
 - *case_id* — номер дела (обязательный).  


#### Контакты (*contacts*) 
**Пример вызова:**  
 `paid.contacts(id)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  


#### Проверки (*proverki*) 
**Пример вызова:**  
 `paid.proverki(id, page)`  
 **Параметры:**  
 - *id*, *inn*, *ogrn* — один из этих параметров обязателен.  
 - *page* — номер страницы (обязательный).  


#### Проверка паспортов (*passports*) СМЭВ   
 **Пример вызова:**   
  `paid.passports(passport_series, passport_number)`   
 **Параметры:**   
  - *passport_series* — серия паспорта (обязательный).   
  - *passport_number* — номер паспорта (обязательный).   


 #### РАФП (*rafp*)   
 **Пример вызова:**   
  `paid.rafp(id)`   
 **Параметры:**   
  - *id*, *inn*, *ogrn* — один из этих параметров обязателен.   


 #### ТОП закупок (*zakupki-top*)   
 **Пример вызова:**   
  `paid.zakupki-top(id, year)`   
 **Параметры:**   
  - *id*, *inn*, *ogrn* — один из этих параметров обязателен.   
  - year — год закупок (обязательный).   


 #### Статистика запросов (*stats*)   
 **Пример вызова:**   
  `paid.stats()`   
    
 **Параметров нет.**

#### Проверка существования физического лица по ИНН
**Пример вызова:**
`paid.check-fl(inn)`

**Параметры:**
- `inn` — ИНН физического лица (обязательный).

#### Проверка существования юридического лица по ИНН
**Пример вызова:**
`paid.check-ul(inn)`

**Параметры:**
- `inn` — ИНН юридического лица (обязательный).

#### Проверка существования ИП по ИНН
**Пример вызова:**
`paid.check-ip(inn)`

**Параметры:**
- `inn` — ИНН индивидуального предпринимателя (обязательный).

#### Проверка юридического адреса
**Пример вызова:**
`paid.check-legal-address(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Проверка фактического адреса
**Пример вызова:**
`paid.check-factual-address(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Проверка сведений о руководителе
**Пример вызова:**
`paid.check-head(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Проверка сведений об учредителях
**Пример вызова:**
`paid.check-founders(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Проверка статуса организации
**Пример вызова:**
`paid.check-status(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).


## Документация для monitoring SDK для API «Зачестныйбизнес»

### Примеры использования

```lua
local monitoring = require('zcb.monitoring')
```

---

### Методы

#### Подписка на изменения
**Пример вызова:**
`monitoring.subscribe(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Отмена подписки
**Пример вызова:**
`monitoring.unsubscribe(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Список подписок
**Пример вызова:**
`monitoring.subscriptions()`

**Параметры:**
- Параметров нет.

#### История изменений по подписке
**Пример вызова:**
`monitoring.history(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

#### Уведомления о событиях
**Пример вызова:**
`monitoring.notifications(id)`

**Параметры:**
- `id` — идентификатор организации (может быть ИНН, ОГРН или внутренний идентификатор) (обязательный).

## Проверка физических лиц 

---

### Примеры использования

```lua
local flcheck = require('zcb.flcheck')
```

---

### Методы

#### Создание запроса на проверку
**Пример вызова:**
`flcheck.create({lastname = 'Иванов', firstname = 'Иван', secondname = 'Иванович', inn = '123456789012'})`

**Параметры:**
- `lastname` — Фамилия (только русские буквы) (обязательный).
- `firstname` — Имя (только русские буквы) (обязательный).
- `secondname` — Отчество (только русские буквы) (обязательный).
- `inn` — ИНН (12 цифр) (обязателен, если не указан birthdate).
- `birthdate` — Дата рождения (ДД.ММ.ГГГГ) (обязателен, если не указан inn).
- `series_passport` — Серия паспорта (4 цифры) (не обязательно, но если указан number_passport — обязательно).
- `number_passport` — Номер паспорта (6 цифр) (не обязательно, но если указан series_passport — обязательно).
- `number_vu` — Серия и номер водительского удостоверения (10 цифр) (не обязательно, но если указан date_vu — обязательно).
- `date_vu` — Дата выдачи водительского удостоверения (ДД.ММ.ГГГГ) (не обязательно, но если указан number_vu — обязательно).

#### Проверка статуса отчёта
**Пример вызова:**
`flcheck.status(request_id)`

**Параметры:**
- `request_id` — идентификатор отчёта (обязательный).

#### Получение результата отчёта
**Пример вызова:**
`flcheck.result(request_id)`

**Параметры:**
- `request_id` — идентификатор отчёта (обязательный).

#### Отмена отчёта
**Пример вызова:**
`flcheck.cancel(request_id)`

**Параметры:**
- `request_id` — идентификатор отчёта (обязательный).

## Проверка паспорта

### Примеры использования

```lua
local passports = require('zcb.passports')
```

### Методы

#### Проверка действительности паспорта
**Пример вызова:**
`passports.request(lastname, series, firstname, number)`

**Параметры:**
- `lastname` — Фамилия (обязательный).
- `series` — Серия паспорта (обязательный).
- `firstname` — Имя (обязательный).
- `number` — Номер паспорта (обязательный).

**Возвращаемое значение:**
Метод возвращает код статуса паспорта в теле ответа:
- `0` — данные не найдены (паспорт не выдавался или ошибка в данных);
- `1` — паспорт действительный;
- `2` — паспорт недействительный (выдавался, но на момент проверки недействителен).