296 lines
20 KiB
HTML
296 lines
20 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="ru" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Фокус.Комплаенс — документация Kontur Focus Library 0.1.0</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||
|
||
|
||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="_static/documentation_options.js?v=6ff560e8"></script>
|
||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/translations.js?v=cd1d70c9"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
|
||
<link rel="search" title="Поиск" href="search.html" />
|
||
<link rel="next" title="Open API specification" href="open-api.html" />
|
||
<link rel="prev" title="Фокус" href="focus.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
Kontur Focus Library
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Поиск в документации" aria-label="Поиск в документации" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Меню навигации">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="setup.html">Установка</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="focus.html">Фокус</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Фокус.Комплаенс</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id2">Подготовка</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id3">Инициализация</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id4">Основные методы</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id5">Юридические лица</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.company_is_foreign_agent"><code class="docutils literal notranslate"><span class="pre">company_is_foreign_agent()</span></code></a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.search_global_company_profiles_id"><code class="docutils literal notranslate"><span class="pre">search_global_company_profiles_id()</span></code></a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.full_legal_entity_sanctions_profile"><code class="docutils literal notranslate"><span class="pre">full_legal_entity_sanctions_profile()</span></code></a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.legal_entity_profile_report"><code class="docutils literal notranslate"><span class="pre">legal_entity_profile_report()</span></code></a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.full_company_report"><code class="docutils literal notranslate"><span class="pre">full_company_report()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#id6">Физические лица</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.person_is_foreign_agent"><code class="docutils literal notranslate"><span class="pre">person_is_foreign_agent()</span></code></a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#kontur_focus.FocusCompliance.full_individual_report"><code class="docutils literal notranslate"><span class="pre">full_individual_report()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="open-api.html">Open API specification</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Меню навигации для мобильных устройств" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">Kontur Focus Library</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Навигация по страницам">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Фокус.Комплаенс</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/focus-compliance.rst.txt" rel="nofollow"> Просмотреть исходный код страницы</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="id1">
|
||
<h1>Фокус.Комплаенс<a class="headerlink" href="#id1" title="Ссылка на этот заголовок"></a></h1>
|
||
<section id="id2">
|
||
<h2>Подготовка<a class="headerlink" href="#id2" title="Ссылка на этот заголовок"></a></h2>
|
||
<p>Создайте файл <cite>.env</cite> или добавьте в существующий параметры:</p>
|
||
<ul class="simple">
|
||
<li><p><cite>FOCUS_COMPLIANCE_BASE_URL=<kontur_url></cite></p></li>
|
||
<li><p><cite>FOCUS_COMPLIANCE_ACCESS_KEY=<your_access_key></cite></p></li>
|
||
</ul>
|
||
<p>Где <cite>kontur_url</cite> - адрес REST API Контур.Фокус. Например, <cite>https://kyc.kontur.ru/api</cite>.</p>
|
||
<p>А <cite>FOCUS_ACCESS_KEY</cite> - секретный ключ доступа к REST API Контур.Фокус.</p>
|
||
</section>
|
||
<section id="id3">
|
||
<h2>Инициализация<a class="headerlink" href="#id3" title="Ссылка на этот заголовок"></a></h2>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">kontur_focus</span><span class="w"> </span><span class="kn">import</span> <span class="n">FocusCompliance</span>
|
||
|
||
<span class="n">fc</span> <span class="o">=</span> <span class="n">FocusCompliance</span><span class="p">(</span><span class="n">inn</span><span class="o">=</span><span class="s1">'<inn_string>'</span><span class="p">,</span> <span class="n">ogrn</span><span class="o">=</span><span class="s1">'<ogrn_string>'</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Обязательный параметр - <strong>ИНН</strong>.</p>
|
||
</section>
|
||
<section id="id4">
|
||
<h2>Основные методы<a class="headerlink" href="#id4" title="Ссылка на этот заголовок"></a></h2>
|
||
</section>
|
||
<section id="id5">
|
||
<h2>Юридические лица<a class="headerlink" href="#id5" title="Ссылка на этот заголовок"></a></h2>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.company_is_foreign_agent">
|
||
<span class="sig-name descname"><span class="pre">company_is_foreign_agent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.company_is_foreign_agent" title="Ссылка на это определение"></a></dt>
|
||
<dd><p>Вхождение организации и ее руководителей в список иностранных агентов</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Результат<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>Дата формирования реестра, а также признаки присутствия или отсутствия в списках иностранных агентов</p>
|
||
</dd>
|
||
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>dict</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.search_global_company_profiles_id">
|
||
<span class="sig-name descname"><span class="pre">search_global_company_profiles_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">company_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">search_accuracy</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.search_global_company_profiles_id" title="Ссылка на это определение"></a></dt>
|
||
<dd><p>Поиск сводной информации по санкционным профилям ЮЛ</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>company_name</strong> (<em>str</em>) – Наименование компании</p></li>
|
||
<li><p><strong>search_accuracy</strong> (<em>str</em>) – Точность поиска</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Результат<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Список идентификаторов профилей</p>
|
||
</dd>
|
||
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>list</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.full_legal_entity_sanctions_profile">
|
||
<span class="sig-name descname"><span class="pre">full_legal_entity_sanctions_profile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_id_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.full_legal_entity_sanctions_profile" title="Ссылка на это определение"></a></dt>
|
||
<dd><p>Просмотр полной информации определенного санкционного профиля ЮЛ</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>profile_id_list</strong> (<em>list</em>) – Идентификатор санкционного профиля ЮЛ. Идентификатор возвращается в методе
|
||
«Поиск сводной информации по санкционным профилям ЮЛ» -
|
||
GET /banks/{bankId}/companies/profiles/search</p>
|
||
</dd>
|
||
<dt class="field-even">Результат<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Полная информация по профилю ЮЛ</p>
|
||
</dd>
|
||
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dict</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.legal_entity_profile_report">
|
||
<span class="sig-name descname"><span class="pre">legal_entity_profile_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">profile_id_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.legal_entity_profile_report" title="Ссылка на это определение"></a></dt>
|
||
<dd><p>Получение печатного отчета по профилю ЮЛ</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>profile_id_list</strong> (<em>list</em>) – Список идентификаторов санкционных профилей компании</p></li>
|
||
<li><p><strong>path</strong> (<em>str</em><em>, </em><em>optional</em>) – Путь сохранения файла, по-умолчанию файл сохраняется в текущий каталог</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Результат<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Отчет о результате сохранения файла</p>
|
||
</dd>
|
||
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dict</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.full_company_report">
|
||
<span class="sig-name descname"><span class="pre">full_company_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">model</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.full_company_report" title="Ссылка на это определение"></a></dt>
|
||
<dd><p>Запрос на полную проверку и построение печатного отчёта по организации</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>model</strong> (<em>str</em><em>, </em><em>optional</em>) – Идентификатор модели, по которой пройдет проверка.
|
||
Идентификатор возвращается в методе «Получение списка рисковых моделей организации»
|
||
GET /banks/{bankId}/models, defaults to „115-fz“</p></li>
|
||
<li><p><strong>path</strong> (<em>str</em><em>, </em><em>optional</em>) – Путь сохранения файла, по-умолчанию файл сохраняется в текущий каталог, defaults to None</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Результат<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Отчет о результате сохранения файла</p>
|
||
</dd>
|
||
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dict</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<p>Пример вывода результат по отчету:</p>
|
||
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">[{</span><span class="s1">'success'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'filename'</span><span class="p">:</span> <span class="s1">'<имя_файла>'</span><span class="p">,</span> <span class="s1">'path'</span><span class="p">:</span> <span class="s1">'<полный_путь_файла>'</span><span class="p">}]</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="id6">
|
||
<h2>Физические лица<a class="headerlink" href="#id6" title="Ссылка на этот заголовок"></a></h2>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.person_is_foreign_agent">
|
||
<span class="sig-name descname"><span class="pre">person_is_foreign_agent</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.person_is_foreign_agent" title="Ссылка на это определение"></a></dt>
|
||
<dd><p>Вхождение физлица в список иностранных агентов</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Результат<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True или False</p>
|
||
</dd>
|
||
<dt class="field-even">Тип результата<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kontur_focus.FocusCompliance.full_individual_report">
|
||
<span class="sig-name descname"><span class="pre">full_individual_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">passport</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fio</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#kontur_focus.FocusCompliance.full_individual_report" title="Ссылка на это определение"></a></dt>
|
||
<dd><dl class="simple">
|
||
<dt>Запрос на построение печатного отчёта по физ лицу</dt><dd><p>Необходимо обязательно указать либо ИНН, либо ФИО и номер паспорта</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Параметры<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>path</strong> (<em>str</em><em>, </em><em>optional</em>) – Путь сохранения файла, по-умолчанию файл сохраняется в текущий каталог, defaults to None</p></li>
|
||
<li><p><strong>passport</strong> (<em>str</em><em>, </em><em>optional</em>) – Номер паспорты, defaults to None</p></li>
|
||
<li><p><strong>fio</strong> (<em>str</em><em>, </em><em>optional</em>) – ФИО (хотя бы фамилия и имя), defaults to None</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Результат<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Отчет о результате сохранения файла</p>
|
||
</dd>
|
||
<dt class="field-odd">Тип результата<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>dict</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Нижняя область">
|
||
<a href="focus.html" class="btn btn-neutral float-left" title="Фокус" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Предыдущая</a>
|
||
<a href="open-api.html" class="btn btn-neutral float-right" title="Open API specification" accesskey="n" rel="next">Следующая <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Авторские права 2025, Ilya Sapunov. </p>
|
||
</div>
|
||
|
||
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
|
||
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |