Skip to content

Instantly share code, notes, and snippets.

@grepto

grepto/Iloilo

Last active December 1, 2023 13:11
Show Gist options
  • Save grepto/e52ea9b934a18af9fd4f00a8320e91ff to your computer and use it in GitHub Desktop.
Save grepto/e52ea9b934a18af9fd4f00a8320e91ff to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Iloilo
{
"swagger": "2.0",
"info": {
"title": "АПИ Контур.Доверенность",
"description": "# О сервисе\n\nAPI Контур.Доверенность - API для управления машиночитаемыми доверенностями (далее – МЧД) организации. API позволяет:\n- формировать МЧД установленного формата\n- загружать их в Контур.Доверенность для подписания и/или регистрации в информационных системах\n- отзывать МЧД\n- хранить всю информацию о выпущенных МЧД организации в едином пространстве\n\nМашиночитаемая доверенность (МЧД) — это электронный документ в формате XML, подписанный электронной подписью руководителя организации или нотариуса. Документ содержит данные о доверителе (организация, которая выдала доверенность), доверенном лице (лицо, которое уполномочено совершать действие) и полномочиях. МЧД или сведения о ней необходимо передавать вместе с каждым документом, который был подписан сертификатом физического лица.\n\n# Термины и сокращения\n\n**Контур.Доверенность** – программа для ЭВМ «Контур.Доверенность», предназначенная для работы с машиночитаемыми доверенностями.\n\n**Машиночитаемая доверенность (далее – МЧД)** – электронный документ в формате XML, подписанный электронной подписью Содержит данные о доверителе (лицо которое выдало доверенность) и доверенном лице (лицо, которое уполномочено совершать действие) и полномочиях.\n\n**Закрытый ключ (ЗК)** – с помощью закрытого ключа происходит подписание и расшифрование документов. ЗК является секретным, к нему имеет доступ только владелец сертификата ЭП.\n\n**Открытый ключ (ОК)** – с помощью открытого ключа происходит проверка подписи и шифрование документов. ОК доступен любому и включен в сертификат ЭП.\n\n**Сертификат ЭП** – документ, содержащий в себе информацию о владельце сертификата и его ОК. Сертификат подтверждает, что ОК принадлежит именно этому владельцу.\n\n**Откреплённая подпись** – ЭП, которая создается при подписании отдельным файлом и отделена от подписываемого документа. При использовании такого типа подписи сам документ не меняется.\n\n**Программный интерфейс (API) Application Programming Interface** – интерфейс прикладного программирования, позволяющий провести интеграцию Контур.Доверенности с различными информационными системами.\n\n**Ключ разработчика** – последовательность символов, буквенно-цифровой код, позволяющий получить доступ к функционалу Контур.Доверенности, используя программные методы API.\n\n**СКЗИ** − программа для ЭВМ, средства криптографической защиты информации (средства электронной подписи).\n\n# Сценарии работы\nAPI Контур.Доверенность позволяет организовать работу с МЧД таким образом, что часть процессов выполняется во внешней системе, а часть в системе Ҡонтур.Доверенность. Информационный обмен между системами реализуется с помощью API-методов. Ниже описан пример самой базовой логики, реализующей основной сценарии при интеграции.\n\n## Загрузка готовой, подписанной МЧД (у вас есть два файла: .xml и .sig)\n- Получите доступные организации с помощью [метода списка организаций](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations). Возвращается массив объектов.\n- Найдите необходимую организацию (например, по ИНН).\n- Загрузите в Контур.Доверенность готовую МЧД с подписью с помощью [метода загрузки и регистрации](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Fregistrations). В случае успешного выполнения запроса, в ответе возвращается идентификатор операции регистрации.\n- С определенным интервалом запрашивайте результат выполнения операции с помощью [метода получения операции регистрации](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Fregistrations%2F%7BoperationId%7D) до тех пор, пока статус не перейдет в терминальное состояние (\"success\" или \"error\").\n- Чтобы подтвердить успешную загрузку вы можете получить мета-информацию по МЧД организации. Для этого необходимо вызвать [метод получения мета-информации по МЧД](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Fpoas%2F%7BpoaNumber%7D), передав идентификатор организации и регистрационный номер зарегистрированной на предыдущем шаге МЧД.\n\n## Загрузка подписанного заявления на отмену МЧД (у вас есть два файла: .xml и .sig)\n- Аналогично сценарию загрузки готовой доверенности, вам необходимо сначала загрузить файлы заявления и подписи (с помощью [метода загрузки отзыва](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Frevocations)), а затем дождаться выполнения операции, проверяя результат (с помощью [метода получения операции отзыва](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Frevocations%2F%7BoperationId%7D)).\n\n## Импорт в Контур.Доверенность МЧД, зарегистрированной ранее в ЦПРР ФНС (у вас есть реквизиты вашей доверенности, зарегистрированной в ЦПРР ФНС)\n- Получите доступные организации с помощью [метода списка организаций](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations). Возвращается массив объектов.\n- Найдите необходимую организацию (например, по ИНН).\n- Импортируйте в Контур.Доверенность МЧД из ЦПРР ФНС с помощью [метода импорта доверенности](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Fimports). В случае успешного выполнения запроса, в ответе возвращается идентификатор операции регистрации.\n- С определенным интервалом запрашивайте результат выполнения операции с помощью [метода получения операции импорта](/doc/m4d-api/method?type=type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Fimports%2F%7BoperationId%7D) до тех пор, пока статус не перейдет в терминальное состояние (\"success\" или \"error\").\n- Чтобы подтвердить успешную загрузку вы можете получить мета-информацию по МЧД организации. Для этого необходимо вызвать [метод получения мета-информации по МЧД](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Fpoas%2F%7BpoaNumber%7D), передав идентификатор организации и регистрационный номер импортированной на предыдущем шаге МЧД.\n\n## Формирование МЧД по данным клиента (у вас есть данные для доверенности)\n- Получите доступные организации с помощью [метода списка организаций](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations). Возвращается массив объектов.\n- Найдите необходимую организацию (например, по ИНН).\n- Отправьте запрос на [формирование XML-файла доверенности](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Fpoas%2Fform-xml) передав необходимые для формирования данные. При успешном выполнении запроса, в ответе вы получите сформированный файл МЧД.\n- В зависимости от дальнейших планов, вы можете либо [загрузить этот файл для подписи](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Fdrafts) в пользовательский интерфейс Контур.Доверенность, либо сохранить для подписания на вашей стороне и последующей загрузки готовой МЧД для регистрации (смотри предыдущий сценарий).\n\n## Регистрация МЧД для отправки в ФНС\n- Получите OIDC токен, у которого будет доступ к Ke.Api.Public\n- Получите доступные организации с помощью [метода списка организаций](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations). Возвращается массив объектов.\n- Найдите необходимую организацию (например, по ИНН).\n- Загрузите в Контур.Доверенность готовую МЧД с подписью и дополнительной информацией с помощью [метода загрузки и регистрации в ФНС](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Ffns%2Fregistrations). Добавьте в запрос заголовок \"ExternOidcToken\" с OIDC токеном для Ke.Api.Public. В случае успешного выполнения запроса, в ответе возвращается идентификатор операции регистрации в ФНС.\n- С определенным интервалом запрашивайте результат выполнения операции с помощью [метода получения операции регистрации в ФНС](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Ffns%2Fregistrations%2F%7BoperationId%7D) до тех пор, пока статус не перейдет в терминальное состояние (\"success\" или \"error\"). Добавьте в запрос заголовок \"ExternOidcToken\" с OIDC токеном для Ke.Api.Public. Результат отправки МЧД находится в поле \"result.docflowSuccessState\". Расшифровка статусов находится в статье \"Состояние документооборота\".\n\n## Регистрация МЧД для отправки в ФCС\n- Получите OIDC токен, у которого будет доступ к Ke.Api.Public\n- Получите доступные организации с помощью [метода списка организаций](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations). Возвращается массив объектов.\n- Найдите необходимую организацию (например, по ИНН).\n- Загрузите в Контур.Доверенность готовую МЧД с дополнительной информацией с помощью [метода загрузки и создания SOAP сообщения для регистрации в ФСС](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Ffss%2Fsoap-messages). Добавьте в запрос заголовок \"ExternOidcToken\" с OIDC токеном для Ke.Api.Public. В случае успешного выполнения запроса, в ответе возвращается идентификатор операции создания SOAP сообщения для регистрации в ФСС.\n- С определенным интервалом запрашивайте результат выполнения операции с помощью [метода получения операции создания SOAP сообщения для регистрации в ФСС](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Ffss%2Fsoap-messages%2F%7BoperationId%7D) до тех пор, пока статус не перейдет в терминальное состояние (\"success\" или \"error\"). Добавьте в запрос заголовок \"ExternOidcToken\" с OIDC токеном для Ke.Api.Public.\n- После успешного выполнения операции получите контент SOAP сообщения с помощью [метода получения контента SOAP сообщения для регистрации в ФСС](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Ffss%2Fsoap-messages%2F%7BoperationId%7D%2Fcontent). Добавьте в запрос заголовок \"ExternOidcToken\" с OIDC токеном для Ke.Api.Public.\n- Подпишите SOAP сообщение с помощью необработанной (raw) подписи.\n- Загрузите подпись с дополнительной информацией с помощью [метода загрузки и регистрации в ФСС](/doc/m4d-api/method?type=post&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Ffss%2Fregistrations). Добавьте в запрос заголовок \"ExternOidcToken\" с OIDC токеном для Ke.Api.Public. В случае успешного выполнения запроса, в ответе возвращается идентификатор операции регистрации в ФСС.\n- С определенным интервалом запрашивайте результат выполнения операции с помощью [метода получения операции регистрации в ФСС](/doc/m4d-api/method?type=get&path=%2Fv1%2Forganizations%2F%7BorganizationId%7D%2Foperations%2Ffss%2Fregistrations%2F%7BoperationId%7D) до тех пор, пока статус не перейдет в терминальное состояние (\"success\" или \"error\"). Добавьте в запрос заголовок \"ExternOidcToken\" с OIDC токеном для Ke.Api.Public. Результат отправки МЧД находится в поле \"result.docflowSuccessState\". Расшифровка статусов находится в статье \"Состояние документооборота\".\n\nЛогика может быть упрощена, оптимизирована и реализована в соответствии с внутренней логикой работы решения интегратора. Например, можно учитывать, что идентификатор организации не меняется со временем и нет необходимости запрашивать его при каждом обращении к API. Необходимо учитывать также то, что операции регистрации МЧД во внешних информационных системах (например, ЦПРР ФНС), в среднем, выполняются несколько секунд, поэтому нет необходимости запрашивать результаты выполнения чаще, чем раз в секунду.\n\n# Состояния документооборота\n- urn:docflow-state:neutral — Состояние не определенно. Доверенность ещё находится в обработке. Необходимо отслеживать документооборот, пока он не перейдет в одно из следующих состояний.\n- urn:docflow-state:successful — Успешно обработан. Пришел положительный протокол, необходимо продолжить документооброт согласно Статусам и порядку документооборота.\n- urn:docflow-state:failed — Обработка завершилась ошибкой или отказом. Нужно ознакомиться с ошибками и переотправить отчет.\n- urn:docflow-state:warning — Обработка завершилась успешно, но у контролирующего органа есть претензии. Пришло уведомление об уточнение. нужно изучить протокол и при необходимости направить корректировку\n\n# Точка входа\n\n- Стейджинг площадка API: https://m4d-api-staging.testkontur.ru\n- Продуктовая площадка API: https://m4d-api.kontur.ru\n\n## Получение доступа\nДля тестирования и проверки работоспособности API вам необходима будет учетная запись на тестовой площадке и тестовый ключ разработчика. Создание учетной записи потребует выпуск **тестового** сертификата электронной подписи на вашу организацию. Несмотря на то, что тестирование проводится на тестовом стенде, сертификаты выпускаются на тестовом УЦ, реквизиты в них должны соответствовать ЕГРЮЛ/ЕГРИП для корректной работы всех сценариев на площадке.\nДля получения всех необходимых для работы данных, обратитесь к вашему менеджеру.\n\n# Авторизация\nДля работы с API Контур.Доверенность вы получите ключ интегратора, api-key. Его необходимо будет передавать во всех запросах к API в заголовках (headers). Ключ передается в поле X-Kontur-Apikey.\n\nПо-умолчанию, одному интегратору выдается один ключ разработчика, но количество организаций, к которым есть доступ у ключа, зависит от тарифного плана и его ограничений. Для того, чтобы у приложения интегратора (то есть у его ключа интегратора) появился доступ к организации, его должен выдать сотрудник организации в пользовательском интерфейсе Контур.Доверенность. Сделать это можно по нашей инструкции: https://support.kontur.ru/pages/viewpage.action?pageId=102898898.\n\nЕсли вам необходимо получить больше ключей, вы можете обратиться к вашему менеджеру.\n\n# Асинхронность\n\nРабота с доверенностями связана с внешними информационными системами (например, ЦПРР ФНС). В связи с тем, что некоторые процессы взаимодействия с внешней средой могут занимать какое-то время, в API Контур.Доверенность добавлены механизмы асинхронного выполнения клиентских запросов. \n\nЧасть методов, доступных в API, работают синхронно, т.к. не взаимодействуют с внешними системами. Например, методы получения списков организаций или доверенностей, метод создания черновиков и т.п. Другие методы требуют больше времени для выполнения, т.к. результат зависит от скорости ответа внешних систем. Например, метод регистрации МЧД. \n\nРабота таких методов реализована через операции: клиент регистрирует операцию на выполнение требуемого действия, получает идентификатор этой операции, начинает проверку статуса её выполнения (поллинг) с определенной периодичностью. Операция может завершиться либо успехом (в ответе будет необходимая для дальнейшей работы информация), либо ошибкой (в ответе будет описания случившейся ошибки).\n\nРаботая с данной документацией, обращайте внимание на то, что для части задач есть два варианта решения: синхронный метод и асинхронный, работающий через операции. Это сделано для удобства клиента и более гибкого выбора инструмента, в зависимости от бизнес-процесса.\n",
"contact": {
"email": "[email protected]"
},
"version": "v1"
},
"paths": {
"/v1/organizations/{organizationId}/drafts": {
"post": {
"tags": [
"Drafts"
],
"summary": "Создание черновика доверенности по файлу XML",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Уникальный идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Запрос на создание черновика по файлу доверенности",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"poa"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"sendToSign": {
"type": "boolean",
"description": "Отправить сразу на подписание"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateByXmlResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateByXmlResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateByXmlResponse"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Некорректный запрос |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Организация не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Conflict` | Доверенность с таким номером уже существует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"415": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `UnsupportedMediaType` | Поддерживается только контент типа multipart/form-data |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/registrations": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию регистрации доверенности",
"description": "Создает операцию регистрации доверенности и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать помощью\r\n[метода получения операции регистрации доверенности](/doc/m4d-api/method?type=get&path=/v1/organizations/{organizationId}/operations/registrations/{operationId})",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Запрос на операцию регистрации доверенности",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"poa",
"signature"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"signature": {
"type": "bytes",
"description": "Байты подписи доверенности"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"415": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `UnsupportedMediaType` | Поддерживается только контент типа multipart/form-data |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/fns/registrations": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию регистрации доверенности в ФНС",
"description": "Создает операцию регистрации доверенности в ФНС и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать с помощью метода получения операции регистрации доверенности в ФНС.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ExternOidcToken",
"in": "header",
"description": "OIDC токен для доступа к Экстерну",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Запрос на операцию регистрации доверенности для отправки в ФНС",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"poa",
"signature",
"fnsCode",
"payerInn",
"senderInn",
"externAccountId",
"senderCertificateContent",
"senderIpAddress"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"signature": {
"type": "bytes",
"description": "Байты подписи доверенности"
},
"fnsCode": {
"type": "string",
"description": "Код ФНС"
},
"payerInn": {
"type": "string",
"description": "ИНН организации"
},
"payerKpp": {
"type": "string",
"description": "КПП организации"
},
"payerOgrn": {
"type": "string",
"description": "ОГРН"
},
"payerSnils": {
"type": "string",
"description": "СНИЛС"
},
"senderInn": {
"type": "string",
"description": "ИНН отправителя"
},
"senderKpp": {
"type": "string",
"description": "КПП отправителя"
},
"externAccountId": {
"type": "string",
"description": "Id учетной записи Экстенра",
"format": "uuid"
},
"senderCertificateContent": {
"type": "string",
"description": "Публичная часть сертификата в Base64"
},
"senderIpAddress": {
"type": "string",
"description": "IP адрес отправителя"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"415": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `UnsupportedMediaType` | Поддерживается только контент типа multipart/form-data |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/fns/registrations/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию регистрации доверенности в ФНС",
"description": "Возвращает статус и детали по операции регистрации доверенности, информацию об ошибке, в случае, если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ExternOidcToken",
"in": "header",
"description": "OIDC токен клиента",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaFnsRegistrationOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaFnsRegistrationOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaFnsRegistrationOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/fss/soap-messages": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию создания SOAP сообщения для регистрации в ФСС",
"description": "Создает операцию создания SOAP сообщения для регистрации в ФСС и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать с помощью метода получения операции создания SOAP сообщения для регистрации в ФСС",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ExternOidcToken",
"in": "header",
"description": "OIDC токен клиента",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Запрос на операцию создания SOAP сообщения для отправки в ФСС",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"poa",
"fssCode",
"fssRegistrationNumber",
"payerInn",
"senderInn",
"externAccountId",
"senderCertificateContent",
"senderIpAddress"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"fssCode": {
"type": "string",
"description": "Код ФСС"
},
"fssRegistrationNumber": {
"type": "string",
"description": "Номер регистрации ФСС"
},
"payerInn": {
"type": "string",
"description": "ИНН организации"
},
"payerKpp": {
"type": "string",
"description": "КПП организации"
},
"payerOgrn": {
"type": "string",
"description": "ОГРН"
},
"payerSnils": {
"type": "string",
"description": "СНИЛС"
},
"senderInn": {
"type": "string",
"description": "ИНН отправителя"
},
"senderKpp": {
"type": "string",
"description": "КПП отправителя"
},
"externAccountId": {
"type": "string",
"description": "Id учетной записи Экстерна",
"format": "uuid"
},
"senderCertificateContent": {
"type": "string",
"description": "Публичная часть сертификата в Base64"
},
"senderIpAddress": {
"type": "string",
"description": "IP адрес отправителя"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"415": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `UnsupportedMediaType` | Поддерживается только контент типа multipart/form-data |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/fss/soap-messages/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию создания SOAP сообщения для регистрации в ФСС",
"description": "Возвращает статус и детали по операции регистрации доверенности, информацию об ошибке, в случае, если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaFssCreateSoapMessageOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaFssCreateSoapMessageOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaFssCreateSoapMessageOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/fss/soap-messages/{operationId}/content": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить контент SOAP сообщения для регистрации в ФСС",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ExternOidcToken",
"in": "header",
"description": "OIDC токен клиента",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Контент SOAP сообщения",
"content": {
"application/xml": {
"schema": {
"type": "string",
"description": "Бинарное представление контента.",
"format": "binary"
},
"examples": {
"application/zip": {
"value": "[file content]"
}
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/fss/registrations": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию регистрации доверенности в ФСС",
"description": "Создает операцию регистрации доверенности в ФСС и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать с помощью метода получения операции регистрации доверенности в ФСС.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "ExternOidcToken",
"in": "header",
"description": "OIDC токен клиента",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Запрос на регистрацию доверенности",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFssRegistrationRequest"
}
],
"description": "Запрос на операцию регистрации доверенности в ФСС"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFssRegistrationRequest"
}
],
"description": "Запрос на операцию регистрации доверенности в ФСС"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFssRegistrationRequest"
}
],
"description": "Запрос на операцию регистрации доверенности в ФСС"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/fss/registrations/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию регистрации доверенности в ФСС",
"description": "Возвращает статус и детали по операции регистрации доверенности, информацию об ошибке, в случае, если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "ExternOidcToken",
"in": "header",
"description": "OIDC токен клиента",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaFssRegistrationOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaFssRegistrationOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaFssRegistrationOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/registrations/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию регистрации доверенности",
"description": "Возвращает статус и детали по операции регистрации доверенности, информацию об ошибке, в случае, если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaRegistrationOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaRegistrationOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaRegistrationOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/imports": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию импорта доверенности",
"description": "Создает операцию импорта доверенности и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать с помощью\r\n[метода получения операции импорта доверенности](/doc/m4d-api/method?type=get&path=/v1/organizations/{organizationId}/operations/imports/{operationId})",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaImportRequest"
}
],
"description": "Запрос операции импорта доверенности"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaImportRequest"
}
],
"description": "Запрос операции импорта доверенности"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaImportRequest"
}
],
"description": "Запрос операции импорта доверенности"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/imports/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию импорта доверенности",
"description": "Позволяет проверять статус состояния операции импорта доверенности после ее создания, и получать информацию об ошибке в случае если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaImportOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaImportOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaImportOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/validations": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию валидации доверенности",
"description": "Создает операцию валидации доверенности и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать с помощью\r\n[метода получения операции валидации доверенности](/doc/m4d-api/method?type=get&path=/v1/organizations/{organizationId}/operations/validations/{operationId})",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Запрос на валидацию доверенности",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationRequest"
}
],
"description": "Запрос на операцию валидации доверенности"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationRequest"
}
],
"description": "Запрос на операцию валидации доверенности"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationRequest"
}
],
"description": "Запрос на операцию валидации доверенности"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/validations/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию валидации доверенности",
"description": "Позволяет проверять статус состояния операции валидации доверенности после ее создания, и получать информацию об ошибке в случае если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификотор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaValidationOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaValidationOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaValidationOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/revocations": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию отзыва доверенности",
"description": "Создает операцию отзыва доверенности и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать с помощью\r\n[метода получения операции отзыва доверенности](/doc/m4d-api/method?type=get&path=/v1/organizations/{organizationId}/operations/revocations/{operationId})",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Запрос на операцию отзыва доверенности",
"content": {
"multipart/form-data": {
"schema": {
"required": [
"revocation",
"signature"
],
"type": "multipart/form-data",
"properties": {
"revocation": {
"type": "bytes",
"description": "Байты отзыва доверенности"
},
"signature": {
"type": "bytes",
"description": "Байты подписи отзыва доверенности"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"409": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Conflict` | Конфликт при отзыве доверенности |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"415": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `UnsupportedMediaType` | Поддерживается только контент типа multipart/form-data |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/revocations/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию отзыва доверенности",
"description": "Позволяет проверять статус состояния операции отзыва доверенности после ее создания, и получать информацию об ошибке в случае если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaRevocationOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaRevocationOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaRevocationOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/downloads": {
"post": {
"tags": [
"Operations"
],
"summary": "Зарегистрировать операцию скачивания доверенности",
"description": "Создает операцию скачивания доверенности и ставит ее в очередь на выполнение.\r\nСтатус операции можно отслеживать с помощью\r\n[метода получения операции скачивания доверенности](/doc/m4d-api/method?type=get&path=/v1/organizations/{organizationId}/operations/downloads/{operationId})\r\n \r\nПосле успешного завершения операции файлы можно скачать через\r\n[метод получения файлов скачанной доверенности](/doc/m4d-api/method?type=get&path=/v1/organizations/{organizationId}/operations/downloads/{operationId}/zip-archive)\r\n \r\nПосле успешного завершения операции метаданные доверенности можно скачать через\r\n[метод получения метаданных скачанной доверенности](/doc/m4d-api/method?type=get&path=/v1/organizations/{organizationId}/operations/downloads/{operationId}/meta)",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Параметры операции скачивания доверенности и дополнительные атрибуты",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaDownloadRequest"
}
],
"description": "Запрос на операцию скачивания доверенности"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaDownloadRequest"
}
],
"description": "Запрос на операцию скачивания доверенности"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/PoaDownloadRequest"
}
],
"description": "Запрос на операцию скачивания доверенности"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OperationInfo"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/downloads/{operationId}": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить операцию скачивания доверенности",
"description": "Позволяет проверять статус состояния операции скачивания доверенности после ее создания, и получать информацию об ошибке в случае если операция завершилась в статусе `error`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoaDownloadOperation"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoaDownloadOperation"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoaDownloadOperation"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Операция не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/downloads/{operationId}/zip-archive": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить файлы скачанной доверенности",
"description": "Позволяет получить файлы доверенности для операции скачивания доверенности. Файлы доступны только в случае, если операции завершилась в статусе `done`",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Файлы доверенности, упакованные в zip-архив",
"content": {
"application/zip": {
"schema": {
"type": "string",
"description": "Бинарное представление контента.",
"format": "binary"
},
"examples": {
"application/zip": {
"value": "[file content]"
}
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Файлы не найдены |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/operations/downloads/{operationId}/meta": {
"get": {
"tags": [
"Operations"
],
"summary": "Получить метаданные скачанной доверенности",
"description": "Позволяет получить метаинформацию доверенности для операции скачивания доверенности. Метаинформация доступна только в случае, если операции завершилась в статусе `done`",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "operationId",
"in": "path",
"description": "Идентификатор операции",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "SyncTimeoutMs",
"in": "query",
"description": "время на синхронизацию с ИС в милисекундах",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/DownloadedPoa"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadedPoa"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/DownloadedPoa"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | ApiKey отсутствует |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Доступ запрещён |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Файлы не найдены |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations": {
"get": {
"tags": [
"Organizations"
],
"summary": "Cписок доступных организаций",
"description": "Возвращает список доступных интегратору организаций в контексте используемого API-ключа. Сейчас все организации возвращаются в рамках одного ответа. В будущем будет реализован пейджинг: в ответе будет только часть организаций и токен, который необходмио будет указать в следующем запросе для получения следующей части списка - `nextToken`.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "NextToken",
"in": "query",
"description": "токен для получения следующей страницы",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/OrganizationsListQueryResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationsListQueryResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationsListQueryResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/poas": {
"get": {
"tags": [
"Poas"
],
"summary": "Поиск доверенностей организации",
"description": "Позволяет получить список доверенностей организации. Позволяет сделать фильтрацию доверенностей по реквизитам конкретного уполномоченного представителя.\r\nДоверенности должны быть предварительно импортированы в сервис Контур.Доверенность или зарегистрированы через сервис Контур.Доверенность",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "идентификатор организации",
"required": true,
"schema": {
"type": "string",
"description": "идентификатор организации",
"format": "uuid"
}
},
{
"name": "NextToken",
"in": "query",
"description": "токен для получения следующей страницы",
"schema": {
"type": "string",
"description": "токен для получения следующей страницы",
"nullable": true
}
},
{
"name": "Take",
"in": "query",
"description": "лимит на число доверенностей в странице",
"schema": {
"type": "integer",
"description": "лимит на число доверенностей в странице",
"format": "int32",
"nullable": true
}
},
{
"name": "SyncTimeoutMs",
"in": "query",
"description": "время на синхронизацию с ИС в милисекундах",
"schema": {
"type": "integer",
"description": "время на синхронизацию с ИС в милисекундах",
"format": "int32",
"nullable": true
}
},
{
"name": "Snils",
"in": "query",
"description": "СНИЛС представителя",
"schema": {
"type": "string",
"description": "СНИЛС представителя",
"nullable": true
}
},
{
"name": "InnFl",
"in": "query",
"description": "ИННФЛ представителя",
"schema": {
"type": "string",
"description": "ИННФЛ представителя",
"nullable": true
}
},
{
"name": "InnUl",
"in": "query",
"description": "ИННЮЛ представителя",
"schema": {
"type": "string",
"description": "ИННЮЛ представителя",
"nullable": true
}
},
{
"name": "Ogrn",
"in": "query",
"description": "ОГРН представителя",
"schema": {
"type": "string",
"description": "ОГРН представителя",
"nullable": true
}
},
{
"name": "OgrnIp",
"in": "query",
"description": "ОГРНИП представителя",
"schema": {
"type": "string",
"description": "ОГРНИП представителя",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/PoasListQueryResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PoasListQueryResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/PoasListQueryResponse"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Некорректный запрос |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Организация не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/poas/{poaNumber}": {
"get": {
"tags": [
"Poas"
],
"summary": "Получить метаинформацию доверенности организации",
"description": "Возвращает метаинформацию доверенности. Доверенность должна быть предварительно импортирована в сервис Контур.Доверенность или зарегистрирована через сервис Контур.Доверенность. Можно передать необязательный параметр `SyncTimeoutMs` - время, в течение которого будет производиться синхронизация статуса с ЦПРР ФНС. Если за это время статус не будет получен, в ответе будет содержаться последний известный статус и время, когда он получен.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "poaNumber",
"in": "path",
"description": "Номер искомой доверенности",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "SyncTimeoutMs",
"in": "query",
"description": "время на синхронизацию с ИС в милисекундах",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetPoaResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPoaResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetPoaResponse"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Некорректный запрос |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Доверенность не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/poas/{poaNumber}/revocation/form-xml": {
"post": {
"tags": [
"Poas"
],
"summary": "Получить файла отзыва МЧД",
"description": "Позволяет получить файла отзыва МЧД. Доверенность должна быть предварительно импортирована в сервис Контур.Доверенность или зарегистрирована через сервис Контур.Доверенность",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "poaNumber",
"in": "path",
"description": "Номер отзываемой доверенности",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Параметры отзыва доверенности<inheritdoc cref=\"T:Poa.Api.External.Features.Poas.FormRevokeXml.FormRevokeXmlRequest\" />",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormRevokeXmlRequest"
}
]
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormRevokeXmlRequest"
}
]
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormRevokeXmlRequest"
}
]
}
}
}
},
"responses": {
"200": {
"description": "Файл отзыва доверенности в формате XML",
"content": {
"*/*": {
"schema": {
"type": "string",
"description": "Бинарное представление контента.",
"format": "binary"
},
"examples": {
"application/zip": {
"value": "[file content]"
}
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Некорректный запрос |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Доверенность не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/poas/validate-local": {
"post": {
"tags": [
"Poas"
],
"summary": "Валидация доверенности",
"description": "Производит проверку доверенности по указанным параметрам. \r\nСтатус доверенности в информационной системе проверяется в рамках заданного времени (SyncTimeoutMs),\r\nесли ответ от информационной системы не получен, проверка производится по последнему известному статусу.\r\nИнформация о времени обновления статуса и факт доступности на момент запроса содержится в ответе.\r\n \r\nМетод локальной проверки повторяет логику проверки через асинхронную операцию, разница заключается в том, \r\nчто операция будет выполняться до успешного завершения или ошибки, а, используя локальную проверку, клиент \r\nсам задает таймаут на ожидание результата синхронищации статуса МЧД.\r\n \r\nПроверить доверенность, выданную одной из доступных интегратору организаций, можно, передавав в запросе её \r\nреквизиты - `poaIdentity`, `principal`, `representative`. \r\nЧтобы проверить \"внешнюю\" МЧД, например, МЧД контрагента, необходимо передать контент доверенности\r\nи подписи в `poaFiles`, данные о доверителе (`principal`) и уполномоченном представителе (`representative`).\r\n \r\nВ ходе выполнения валидации, проверяется статус МЧД и её срок действия, соответствие доверителя в МЧД переданным \r\nв `principal` данным, соответствие доверителя в МЧД и в КЭП, которым была подписана МЧД, соответствие подписи\r\nпод МЧД файлу доверенности, отозванность сертификата, которым была подписана доверенность, срок его действия, \r\nсоответствие данных об уполномоченном представителе в МЧД переданным в `representative` реквизитам.",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Запрос на валидацию доверенности",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LocalPoaValidationRequest"
}
],
"description": "Запрос на валидацию доверенности"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LocalPoaValidationRequest"
}
],
"description": "Запрос на валидацию доверенности"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LocalPoaValidationRequest"
}
],
"description": "Запрос на валидацию доверенности"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/LocalPoaValidationResult"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LocalPoaValidationResult"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LocalPoaValidationResult"
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Доверенность не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/poas/form-xml": {
"post": {
"tags": [
"Poas"
],
"summary": "Формирование xml файла доверенности",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"description": "Запрос на формирование доверенности",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormXmlRequest"
}
],
"description": "Запрос на формирование xml"
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormXmlRequest"
}
],
"description": "Запрос на формирование xml"
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/FormXmlRequest"
}
],
"description": "Запрос на формирование xml"
}
}
}
},
"responses": {
"200": {
"description": "Файл доверенности в формате XML",
"content": {
"*/*": {
"schema": {
"type": "string",
"description": "Бинарное представление контента.",
"format": "binary"
},
"examples": {
"application/zip": {
"value": "[file content]"
}
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Данные запроса некорректны |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Организация не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
},
"/v1/organizations/{organizationId}/poas/{poaNumber}/zip-archive": {
"get": {
"tags": [
"Poas"
],
"summary": "Получить файлы доверенности организации",
"description": "Позволяет получить файлы доверенности. Доверенность должна быть предварительно импортирована в сервис Контур.Доверенность или зарегистрирована через сервис Контур.Доверенность",
"parameters": [
{
"name": "X-KONTUR-APIKEY",
"in": "header",
"description": "В заголовке нужно указать ApiKey.",
"required": true
},
{
"name": "organizationId",
"in": "path",
"description": "Идентификатор организации",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "poaNumber",
"in": "path",
"description": "Номер искомой довренности",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "Архив с файлами доверенности",
"content": {
"*/*": {
"schema": {
"type": "string",
"description": "Бинарное представление контента.",
"format": "binary"
},
"examples": {
"application/zip": {
"value": "[file content]"
}
}
}
}
},
"400": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `BadRequest` | Некорректный запрос |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Unauthorized` | Отсутствует апикей |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `Forbidden` | Нет доступа |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `NotFound` | Доверенность не найдена |",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `InternalServerError` | An error has occured |"
},
"503": {
"description": "| Код ошибки | Описание |\n| ---------- | -------- |\n| `ServiceUnavailable` | Service unavailable |"
}
}
}
}
},
"components": {
"schemas": {
"CertificateInfo": {
"type": "object",
"properties": {
"thumbprint": {
"type": "string",
"description": "Отпечаток сертификата",
"nullable": true
},
"body": {
"type": "string",
"description": "Тело сертификата в Base64",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о сертификате (должен быть указан отпечаток сертификата или тело сертификата)"
},
"CreateByXmlRequest": {
"required": [
"poa"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"sendToSign": {
"type": "boolean",
"description": "Отправить сразу на подписание"
}
}
},
"CreateByXmlResponse": {
"required": [
"draftId"
],
"type": "object",
"properties": {
"draftId": {
"type": "string",
"description": "Уникальный идентификатор черновика доверенности (при подписании остается тем же и становится уникальным идентификатором доверенности)",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Результат создания черновика доверенности"
},
"DownloadedPoa": {
"required": [
"formVersion",
"fullRequisites",
"poaType",
"state"
],
"type": "object",
"properties": {
"formVersion": {
"enum": [
"1.01",
"001",
"002"
],
"type": "string",
"description": "Версия формата доверенности"
},
"poaType": {
"enum": [
"b2b",
"b2g",
"universal"
],
"type": "string",
"description": "Тип доверенности"
},
"fullRequisites": {
"oneOf": [
{
"$ref": "#/components/schemas/XML._002.Poa"
},
{
"$ref": "#/components/schemas/XML.EMCHD_01.Poa"
}
],
"description": "XML модель доверенности"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/DownloadedPoaState"
}
],
"description": "Сведения о состоянии доверенности"
}
},
"additionalProperties": false,
"description": "Доверенность внешней ИС"
},
"DownloadedPoaState": {
"required": [
"systems"
],
"type": "object",
"properties": {
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DownloadedStorageSystemInfo"
},
"description": "Сведения о состоянии доверенности в различных внешних информационных системах"
}
},
"additionalProperties": false
},
"DownloadedStorageSystemInfo": {
"type": "object",
"properties": {
"systemName": {
"type": "string",
"description": "Идентификатор информационной системы",
"nullable": true
},
"statusInfo": {
"allOf": [
{
"$ref": "#/components/schemas/DownloadedSystemStatusInfo"
}
],
"description": "Сведения о статусе доверенности в информационной системе",
"nullable": true
}
},
"additionalProperties": false
},
"DownloadedSystemStatusInfo": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Статус в информационной системе",
"nullable": true
}
},
"additionalProperties": false
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"nullable": true
},
"message": {
"type": "string",
"nullable": true
},
"target": {
"type": "string",
"nullable": true
},
"details": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"nullable": true
},
"context": {
"type": "object",
"additionalProperties": {},
"nullable": true
},
"innerError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ErrorResponse": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32"
},
"traceId": {
"type": "string",
"nullable": true
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ForeignLegalEntity": {
"required": [
"inn",
"kpp"
],
"type": "object",
"properties": {
"shortName": {
"maxLength": 1000,
"type": "string",
"description": "Короткое название организации",
"nullable": true
},
"fullName": {
"maxLength": 1000,
"type": "string",
"description": "Полное название организации",
"nullable": true
},
"inn": {
"maxLength": 10,
"minLength": 10,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}$",
"type": "string",
"description": "ИНН"
},
"kpp": {
"maxLength": 9,
"minLength": 9,
"pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})",
"type": "string",
"description": "КПП"
}
},
"additionalProperties": false,
"description": "Реквизиты иностранной организации"
},
"FormRevokeXmlRequest": {
"required": [
"poaType"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"nullable": true
},
"inn": {
"type": "string",
"nullable": true
},
"ogrn": {
"type": "string",
"nullable": true
},
"kpp": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"poaType": {
"minLength": 1,
"enum": [
"b2b",
"b2g",
"universal"
],
"type": "string"
}
},
"additionalProperties": false
},
"FormXmlRequest": {
"type": "object",
"properties": {
"poaType": {
"type": "string",
"description": "Тип доверенности",
"nullable": true
},
"fullRequisites": {
"oneOf": [
{
"$ref": "#/components/schemas/XML._002.Poa"
},
{
"$ref": "#/components/schemas/XML.EMCHD_01.Poa"
}
],
"description": "XML модель доверенности",
"nullable": true
}
},
"additionalProperties": false,
"description": "Запрос на формирование xml"
},
"GetPoaResponse": {
"type": "object",
"properties": {
"poa": {
"allOf": [
{
"$ref": "#/components/schemas/Poa"
}
],
"description": "Модель доверенности",
"nullable": true
}
},
"additionalProperties": false,
"description": "Ответ на запрос метаданных доверенности"
},
"GetPoasListRequest": {
"required": [
"organizationId"
],
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "идентификатор организации",
"format": "uuid"
},
"nextToken": {
"type": "string",
"description": "токен для получения следующей страницы",
"nullable": true
},
"take": {
"type": "integer",
"description": "лимит на число доверенностей в странице",
"format": "int32",
"nullable": true
},
"syncTimeoutMs": {
"type": "integer",
"description": "время на синхронизацию с ИС в милисекундах",
"format": "int32",
"nullable": true
},
"snils": {
"type": "string",
"description": "СНИЛС представителя",
"nullable": true
},
"innFl": {
"type": "string",
"description": "ИННФЛ представителя",
"nullable": true
},
"innUl": {
"type": "string",
"description": "ИННЮЛ представителя",
"nullable": true
},
"ogrn": {
"type": "string",
"description": "ОГРН представителя",
"nullable": true
},
"ogrnIp": {
"type": "string",
"description": "ОГРНИП представителя",
"nullable": true
}
},
"additionalProperties": false,
"description": "Запрос страницы доверенностей организации"
},
"IndividualEntrepreneur": {
"required": [
"fio",
"inn",
"ogrnIp"
],
"type": "object",
"properties": {
"inn": {
"type": "string",
"description": "ИНН"
},
"fio": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "ФИО"
},
"ogrnIp": {
"maxLength": 15,
"minLength": 15,
"pattern": "^([0-9]{15})$",
"type": "string",
"description": "ОГРНИП"
}
},
"additionalProperties": false,
"description": "Реквизиты индивидуального предпринимателя"
},
"LegalEntity": {
"required": [
"inn",
"kpp",
"ogrn"
],
"type": "object",
"properties": {
"shortName": {
"maxLength": 1000,
"type": "string",
"description": "Короткое название организации",
"nullable": true
},
"fullName": {
"maxLength": 1000,
"type": "string",
"description": "Полное название организации",
"nullable": true
},
"ogrn": {
"maxLength": 13,
"minLength": 13,
"pattern": "^([0-9]{13})$",
"type": "string",
"description": "ОГРН"
},
"inn": {
"maxLength": 10,
"minLength": 10,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}$",
"type": "string",
"description": "ИНН"
},
"kpp": {
"maxLength": 9,
"minLength": 9,
"pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})",
"type": "string",
"description": "КПП"
}
},
"additionalProperties": false,
"description": "Реквизиты юридического лица"
},
"LocalPoaValidationRequest": {
"required": [
"parameters"
],
"type": "object",
"properties": {
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationParameters"
}
],
"description": "Параметры операции валидации доверенности"
},
"poaFiles": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFiles"
}
],
"description": "Файлы доверенности",
"nullable": true
},
"syncTimeoutMs": {
"type": "integer",
"description": "Время на синхронизацию статуса доверенности в миллисекундах. По умолчанию 1000",
"format": "int32",
"nullable": true,
"example": 1000
}
},
"additionalProperties": false,
"description": "Запрос на валидацию доверенности"
},
"LocalPoaValidationResult": {
"required": [
"poaValidationResult",
"systemSyncInfo"
],
"type": "object",
"properties": {
"poaValidationResult": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationResult"
}
],
"description": "Объект, описывающий успешный результат выполнения операции валидации"
},
"systemSyncInfo": {
"allOf": [
{
"$ref": "#/components/schemas/SystemSyncInfo"
}
],
"description": "Сведения о синхронизации с информационной системой"
}
},
"additionalProperties": false,
"description": "Объект, описывающий успешный результат выполнения локальной операции валидации"
},
"OperationInfo": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"validation",
"registration",
"import",
"revocation",
"download"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2b"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Модель операции доверенности"
},
"Organization": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"pattern": "^[({]?[a-fA-F0-9]{8}-?([a-fA-F0-9]{4}-?){3}[a-fA-F0-9]{12}[})]?$",
"type": "string",
"description": "Идентификатор организации"
},
"type": {
"enum": [
"legalEntity",
"foreignLegalEntity",
"individualEntrepreneur"
],
"type": "string",
"description": "Тип организации",
"nullable": true
},
"legalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/LegalEntity"
}
],
"description": "Реквизиты юридического лица",
"nullable": true
},
"foreignLegalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/ForeignLegalEntity"
}
],
"description": "Реквизиты иностранной организации",
"nullable": true
},
"individualEntrepreneur": {
"allOf": [
{
"$ref": "#/components/schemas/IndividualEntrepreneur"
}
],
"description": "Реквизиты индивидуального предпринимателя",
"nullable": true
}
},
"additionalProperties": false,
"description": "Организация"
},
"OrganizationsListQueryResponse": {
"required": [
"organizations",
"totalCount"
],
"type": "object",
"properties": {
"organizations": {
"allOf": [
{
"$ref": "#/components/schemas/OrganizationsPage"
}
],
"description": "Страница организаций"
},
"totalCount": {
"type": "integer",
"description": "Общее количество организаций",
"format": "int64"
}
},
"additionalProperties": false,
"description": "Ответ на запрос списка организаций"
},
"OrganizationsPage": {
"required": [
"items"
],
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
},
"nextToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Страница организаций"
},
"Poa": {
"required": [
"formVersion",
"fullRequisites",
"poaType",
"state"
],
"type": "object",
"properties": {
"formVersion": {
"enum": [
"1.01",
"001",
"002, EMCHD_1"
],
"type": "string",
"description": "Версия формата доверенности"
},
"poaType": {
"enum": [
"b2b",
"b2g",
"universal"
],
"type": "string",
"description": "Тип доверенности"
},
"fullRequisites": {
"oneOf": [
{
"$ref": "#/components/schemas/XML._002.Poa"
},
{
"$ref": "#/components/schemas/XML.EMCHD_01.Poa"
}
],
"description": "XML модель доверенности"
},
"state": {
"allOf": [
{
"$ref": "#/components/schemas/PoaState"
}
],
"description": "Сведения о состоянии доверенности"
}
},
"additionalProperties": false,
"description": "Модель доверенности"
},
"PoaDownloadOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"parameters",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"validation",
"registration",
"import",
"revocation",
"download"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2b"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaDownloadParameters"
}
],
"description": "Параметры, с которыми была создана операция"
}
},
"additionalProperties": false,
"description": "Операция скачивания доверенности"
},
"PoaDownloadParameters": {
"required": [
"poaIdentity",
"representativeRequisites"
],
"type": "object",
"properties": {
"poaIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/PoaIdentity"
}
],
"description": "Данные для идентификации доверенности"
},
"representativeRequisites": {
"allOf": [
{
"$ref": "#/components/schemas/PoaDownloadRepresentativeRequisites"
}
],
"description": "Данные об уполномоченном представителе"
}
},
"additionalProperties": false,
"description": "Параметры операции скачивания доверенности"
},
"PoaDownloadRepresentativeRequisites": {
"type": "object",
"properties": {
"snils": {
"type": "string",
"description": "СНИЛС (должен быть указан СНИЛС или ИНН или оба значения)",
"nullable": true,
"deprecated": true
},
"inn": {
"type": "string",
"description": "ИНН (должен быть указан СНИЛС или ИНН или оба значения)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Данные об уполномоченном представителе"
},
"PoaDownloadRequest": {
"required": [
"parameters"
],
"type": "object",
"properties": {
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaDownloadParameters"
}
],
"description": "Параметры операции импорта доверенности"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом.\r\nПредставляют собой словарь ключ-значение, строка-строка.\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию выпуска доверенности с инициатором в ИС клиента.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Запрос на операцию скачивания доверенности"
},
"PoaFiles": {
"required": [
"poaContent",
"signatureContent"
],
"type": "object",
"properties": {
"poaContent": {
"maxLength": 10485760,
"type": "string",
"description": "Контент доверенности в формате base64"
},
"signatureContent": {
"maxLength": 10485760,
"type": "string",
"description": "Контент подписи в формате base64"
}
},
"additionalProperties": false,
"description": "Файлы доверенности"
},
"PoaFnsRegistrationOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"parameters",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"registrationFns"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2g"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFnsRegistrationParameters"
}
],
"description": "Параметры операции регистрации доверенности в ФНС"
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFnsRegistrationResult"
}
],
"description": "Объект, описывающий успешный результат выполнения операции\r\nПрисутствует, если операция перешла в статус `done` и операция подразумевает описание результата",
"nullable": true
}
},
"additionalProperties": false,
"description": "Операция регистрации доверенности в ФНС"
},
"PoaFnsRegistrationParameters": {
"required": [
"externAccountId",
"fnsCode",
"payerInn",
"senderCertificateContent",
"senderInn",
"senderIpAddress"
],
"type": "object",
"properties": {
"externAccountId": {
"type": "string",
"format": "uuid"
},
"senderInn": {
"type": "string"
},
"senderKpp": {
"type": "string",
"nullable": true
},
"senderCertificateContent": {
"type": "string"
},
"senderIpAddress": {
"type": "string"
},
"fnsCode": {
"type": "string"
},
"payerInn": {
"type": "string"
},
"payerKpp": {
"type": "string",
"nullable": true
},
"payerOgrn": {
"type": "string",
"nullable": true
},
"payerSnils": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Параметры операции регистрации доверенности в ФНС"
},
"PoaFnsRegistrationRequest": {
"required": [
"poa",
"signature",
"fnsCode",
"payerInn",
"senderInn",
"externAccountId",
"senderCertificateContent",
"senderIpAddress"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"signature": {
"type": "bytes",
"description": "Байты подписи доверенности"
},
"fnsCode": {
"pattern": "^([0-9]{4})$",
"type": "string",
"description": "Код ФНС"
},
"payerInn": {
"type": "string",
"description": "ИНН организации"
},
"payerKpp": {
"type": "string",
"description": "КПП организации"
},
"payerOgrn": {
"type": "string",
"description": "ОГРН"
},
"payerSnils": {
"type": "string",
"description": "СНИЛС"
},
"senderInn": {
"type": "string",
"description": "ИНН отправителя"
},
"senderKpp": {
"type": "string",
"description": "КПП отправителя"
},
"externAccountId": {
"type": "string",
"description": "Id учетной записи Экстенра",
"format": "uuid"
},
"senderCertificateContent": {
"type": "string",
"description": "Публичная часть сертификата в Base64"
},
"senderIpAddress": {
"type": "string",
"description": "IP адрес отправителя"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
},
"PoaFnsRegistrationResult": {
"required": [
"docflowId",
"docflowStatus",
"docflowSuccessState"
],
"type": "object",
"properties": {
"docflowId": {
"type": "string",
"description": "Id документооборота",
"format": "uuid"
},
"docflowSuccessState": {
"enum": [
"urn:docflow-state:neutral",
"urn:docflow-state:successful",
"urn:docflow-state:failed",
"urn:docflow-state:warning"
],
"type": "string",
"description": "Состояние документоооборота(квитанция о приеме): принят или не принят"
},
"docflowStatus": {
"type": "string",
"description": "Статус документооборота"
}
},
"additionalProperties": false,
"description": "Результат выполнения операции отправки доверенности в ФНС"
},
"PoaFssCreateSoapMessageOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"parameters",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"createSoapMessageFss"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2g"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFssCreateSoapMessageParameters"
}
],
"description": "Параметры операции создания SOAP сообщения для регистрации в ФСС"
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFssCreateSoapMessageResult"
}
],
"description": "Результат создания SOAP сообщения для регистрации в ФСС",
"nullable": true
}
},
"additionalProperties": false,
"description": "Операция создания SOAP сообщения для регистрации в ФСС"
},
"PoaFssCreateSoapMessageParameters": {
"required": [
"externAccountId",
"fssCode",
"fssRegistrationNumber",
"payerInn",
"senderCertificateContent",
"senderInn",
"senderIpAddress"
],
"type": "object",
"properties": {
"externAccountId": {
"type": "string",
"format": "uuid"
},
"senderInn": {
"type": "string"
},
"senderKpp": {
"type": "string",
"nullable": true
},
"senderCertificateContent": {
"type": "string"
},
"senderIpAddress": {
"type": "string"
},
"payerInn": {
"type": "string"
},
"payerKpp": {
"type": "string",
"nullable": true
},
"payerOgrn": {
"type": "string",
"nullable": true
},
"payerSnils": {
"type": "string",
"nullable": true
},
"fssCode": {
"type": "string"
},
"fssRegistrationNumber": {
"type": "string"
}
},
"additionalProperties": false,
"description": "Параметры операции создания SOAP сообщения для регистрации в ФСС"
},
"PoaFssCreateSoapMessageRequest": {
"required": [
"poa",
"fssCode",
"fssRegistrationNumber",
"payerInn",
"senderInn",
"externAccountId",
"senderCertificateContent",
"senderIpAddress"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"fssCode": {
"pattern": "^([0-9]{4}[1-3]{1})$",
"type": "string",
"description": "Код ФСС"
},
"fssRegistrationNumber": {
"pattern": "^([0-9]{10})$",
"type": "string",
"description": "Номер регистрации ФСС"
},
"payerInn": {
"type": "string",
"description": "ИНН организации"
},
"payerKpp": {
"type": "string",
"description": "КПП организации"
},
"payerOgrn": {
"type": "string",
"description": "ОГРН"
},
"payerSnils": {
"type": "string",
"description": "СНИЛС"
},
"senderInn": {
"type": "string",
"description": "ИНН отправителя"
},
"senderKpp": {
"type": "string",
"description": "КПП отправителя"
},
"externAccountId": {
"type": "string",
"description": "Id учетной записи Экстерна",
"format": "uuid"
},
"senderCertificateContent": {
"type": "string",
"description": "Публичная часть сертификата в Base64"
},
"senderIpAddress": {
"type": "string",
"description": "IP адрес отправителя"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
},
"PoaFssCreateSoapMessageResult": {
"required": [
"documentId",
"draftId"
],
"type": "object",
"properties": {
"documentId": {
"type": "string",
"format": "uuid"
},
"draftId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false,
"description": "Результат операции создания SOAP сообщения для регистрации в ФСС"
},
"PoaFssRegistrationOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"registrationFss"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2g"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFssRegistrationParameters"
}
],
"description": "Параметры операции регистрации доверенности в ФСС",
"nullable": true
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFssRegistrationResult"
}
],
"description": "Результат операции регистрации довереннности в ФСС",
"nullable": true
}
},
"additionalProperties": false,
"description": "Операция регистрации доверенности в ФСС"
},
"PoaFssRegistrationParameters": {
"required": [
"base64SoapMessageSignature",
"documentId",
"draftId",
"externAccountId"
],
"type": "object",
"properties": {
"externAccountId": {
"type": "string",
"format": "uuid"
},
"draftId": {
"type": "string",
"format": "uuid"
},
"documentId": {
"type": "string",
"format": "uuid"
},
"base64SoapMessageSignature": {
"type": "string"
}
},
"additionalProperties": false,
"description": "Параметры операции регистрации доверенности в ФСС"
},
"PoaFssRegistrationRequest": {
"required": [
"base64SoapMessageSignature",
"documentId",
"draftId",
"externAccountId"
],
"type": "object",
"properties": {
"externAccountId": {
"minLength": 1,
"type": "string",
"description": "Id УЗ Экстерна",
"format": "uuid"
},
"draftId": {
"minLength": 1,
"type": "string",
"description": "Id черновика",
"format": "uuid"
},
"documentId": {
"minLength": 1,
"type": "string",
"description": "Id документа",
"format": "uuid"
},
"base64SoapMessageSignature": {
"type": "string",
"description": "Подпись SOAP сообщения в Base64"
},
"payerInn": {
"type": "string",
"description": "ИНН",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом.\r\nПредставляют собой словарь ключ-значение, строка-строка.\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию выпуска доверенности с инициатором в ИС клиента.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Запрос на операцию регистрации доверенности в ФСС"
},
"PoaFssRegistrationResult": {
"required": [
"docflowId",
"docflowStatus",
"docflowSuccessState"
],
"type": "object",
"properties": {
"docflowId": {
"type": "string",
"description": "Id документооборота",
"format": "uuid"
},
"docflowSuccessState": {
"enum": [
"urn:docflow-state:neutral",
"urn:docflow-state:successful",
"urn:docflow-state:failed",
"urn:docflow-state:warning"
],
"type": "string",
"description": "Состояние документоооборота (квитанция о приеме): принят или не принят"
},
"docflowStatus": {
"type": "string",
"description": "Статус документооборота"
}
},
"additionalProperties": false,
"description": "Результат операции регистрации доверенности в ФСС"
},
"PoaIdentity": {
"required": [
"number",
"principalInn"
],
"type": "object",
"properties": {
"number": {
"pattern": "^[({]?[a-fA-F0-9]{8}-?([a-fA-F0-9]{4}-?){3}[a-fA-F0-9]{12}[})]?$",
"type": "string",
"description": "Регистрационный номер доверенности в Реестре Доверенностей",
"example": "9C119111-4251-49C6-A018-042D4871D136"
},
"principalInn": {
"minLength": 1,
"type": "string",
"description": "ИНН доверителя",
"example": "1234567890"
}
},
"additionalProperties": false,
"description": "Данные для идентификации доверенности"
},
"PoaImportOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"parameters",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"validation",
"registration",
"import",
"revocation",
"download"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2b"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaImportParameters"
}
],
"description": "Параметры операции"
}
},
"additionalProperties": false,
"description": "Операция импорта доверенности"
},
"PoaImportParameters": {
"required": [
"poaIdentity",
"representativeRequisites"
],
"type": "object",
"properties": {
"poaIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/PoaIdentity"
}
],
"description": "Данные для идентификации доверенности"
},
"representativeRequisites": {
"allOf": [
{
"$ref": "#/components/schemas/PoaImportRepresentativeRequisites"
}
],
"description": "Данные о уполномоченном представителе"
}
},
"additionalProperties": false,
"description": "Параметры операции импорта доверенности"
},
"PoaImportRepresentativeRequisites": {
"type": "object",
"properties": {
"snils": {
"type": "string",
"description": "СНИЛС (должен быть указан СНИЛС или ИНН или оба значения)",
"nullable": true,
"deprecated": true
},
"inn": {
"type": "string",
"description": "ИНН (должен быть указан СНИЛС или ИНН или оба значения)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Данные о уполномоченном представителе"
},
"PoaImportRequest": {
"required": [
"parameters"
],
"type": "object",
"properties": {
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaImportParameters"
}
],
"description": "Параметры операции импорта доверенности"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом.\r\nПредставляют собой словарь ключ-значение, строка-строка.\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию выпуска доверенности с инициатором в ИС клиента.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Запрос операции импорта доверенности"
},
"PoaPrincipalValidationParameters": {
"required": [
"inn"
],
"type": "object",
"properties": {
"inn": {
"minLength": 1,
"type": "string",
"description": "ИНН доверителя",
"example": "1234567890"
},
"kpp": {
"type": "string",
"description": "КПП доверителя.\r\nУказывается, если доверитель является юридическим лицом",
"nullable": true,
"example": "987654321"
}
},
"additionalProperties": false,
"description": "Информация о доверителе"
},
"PoaRegistrationOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"parameters",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"validation",
"registration",
"import",
"revocation",
"download"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2b"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaRegistrationParameters"
}
],
"description": "Параметры операции регистрации доверенности"
}
},
"additionalProperties": false,
"description": "Операция регистрации доверенности"
},
"PoaRegistrationParameters": {
"required": [
"poaIdentity"
],
"type": "object",
"properties": {
"poaIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/PoaIdentity"
}
],
"description": "Данные для идентификации доверенности"
}
},
"additionalProperties": false,
"description": "Параметры операции регистрации доверенности"
},
"PoaRegistrationRequest": {
"required": [
"poa",
"signature"
],
"type": "multipart/form-data",
"properties": {
"poa": {
"type": "bytes",
"description": "Байты доверенности"
},
"signature": {
"type": "bytes",
"description": "Байты подписи доверенности"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
},
"PoaRevocationOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"parameters",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"validation",
"registration",
"import",
"revocation",
"download"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2b"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaRevocationParameters"
}
],
"description": "Параметры операции отзыва доверенности"
}
},
"additionalProperties": false,
"description": "Операция отзыва доверенности"
},
"PoaRevocationParameters": {
"required": [
"poaIdentity"
],
"type": "object",
"properties": {
"poaIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/PoaIdentity"
}
],
"description": "Данные для идентификации доверенности"
}
},
"additionalProperties": false,
"description": "Параметры операции отзыва доверенности"
},
"PoaRevocationRequest": {
"required": [
"revocation",
"signature"
],
"type": "multipart/form-data",
"properties": {
"revocation": {
"type": "bytes",
"description": "Байты отзыва доверенности"
},
"signature": {
"type": "bytes",
"description": "Байты подписи отзыва доверенности"
},
"attribute:attributeName": {
"type": "string",
"description": "Опциональный атрибут с именем attributeName. attributeName нужно заменить на необходимое имя атрибута. Атрибутов может быть несколько. Атрибуты сохраняются в информации об операции. "
}
}
},
"PoaState": {
"required": [
"systems"
],
"type": "object",
"properties": {
"systems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StorageSystemInfo"
},
"description": "Сведения о состоянии доверенности в различных информационных системах"
},
"revocationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/RevocationInfo"
}
],
"description": "Сведения об отзыве доверенности в информационной системе",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о состоянии доверенности"
},
"PoaValidationOperation": {
"required": [
"createdAt",
"id",
"lastUpdatedAt",
"parameters",
"poaType",
"status",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Уникальный идентификатор операции",
"example": "ccccff44-258a-4f5a-87b3-a7964aeb38f1"
},
"createdAt": {
"type": "string",
"description": "Дата и время создания операции",
"format": "date-time",
"example": "2021-08-23T15:43:16.995Z"
},
"lastUpdatedAt": {
"type": "string",
"description": "Дата и время последнего изменения состояния операции",
"format": "date-time",
"example": "2021-08-23T15:43:19Z"
},
"type": {
"enum": [
"validation",
"registration",
"import",
"revocation",
"download"
],
"type": "string",
"description": "Тип асинхронной операции",
"example": "Validation"
},
"status": {
"enum": [
"queued",
"processing",
"done",
"error"
],
"type": "string",
"description": "Статус асинхронной операции",
"example": "Queued"
},
"poaType": {
"enum": [
"b2b"
],
"type": "string",
"description": "Тип доверенности"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Описание ошибки, произошедшей в процессе выполнения операции\r\nПрисутствует, если операция перешла в статус `error`",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом\r\nПредставляют собой словарь ключ-значение, строка-строка\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в\r\nИС клиента.",
"nullable": true
},
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationParameters"
}
],
"description": "Параметры, с которыми была создана операция"
},
"result": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationResult"
}
],
"description": "Объект, описывающий успешный результат выполнения операции\r\nПрисутствует, если операция перешла в статус `done` и операция подразумевает описание результата",
"nullable": true
}
},
"additionalProperties": false,
"description": "Операция валидации доверенности"
},
"PoaValidationParameters": {
"required": [
"principal",
"representative"
],
"type": "object",
"properties": {
"poaIdentity": {
"allOf": [
{
"$ref": "#/components/schemas/PoaIdentity"
}
],
"description": "Данные для идентификации доверенности",
"nullable": true
},
"principal": {
"allOf": [
{
"$ref": "#/components/schemas/PoaPrincipalValidationParameters"
}
],
"description": "Информация о доверителе"
},
"representative": {
"allOf": [
{
"$ref": "#/components/schemas/RepresentativeValidationParameters"
}
],
"description": "Информация об уполномоченном"
}
},
"additionalProperties": false,
"description": "Параметры операции валидации доверенности"
},
"PoaValidationRequest": {
"required": [
"parameters"
],
"type": "object",
"properties": {
"parameters": {
"allOf": [
{
"$ref": "#/components/schemas/PoaValidationParameters"
}
],
"description": "Параметры операции валидации доверенности"
},
"poaFiles": {
"allOf": [
{
"$ref": "#/components/schemas/PoaFiles"
}
],
"description": "Файлы доверенности",
"nullable": true
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Произвольные атрибуты, проставленные клиентом.\r\nПредставляют собой словарь ключ-значение, строка-строка.\r\nМогут служить для идентификации операции, например, чтобы сопоставить операцию проверки доверенности с документом в ИС клиента.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Запрос на операцию валидации доверенности"
},
"PoaValidationResult": {
"type": "object",
"properties": {
"status": {
"enum": [
"valid",
"invalid"
],
"type": "string",
"description": "Статус валидации доверенности",
"nullable": true,
"example": "Valid"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
},
"description": "Ошибки валидации (если статус результата `invalid`)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Результат выполнения операции валидации"
},
"PoasListQueryResponse": {
"type": "object",
"properties": {
"poas": {
"allOf": [
{
"$ref": "#/components/schemas/PoasPage"
}
],
"description": "Страница доверенностей",
"nullable": true
}
},
"additionalProperties": false,
"description": "Ответ на запрос страницы доверенностей"
},
"PoasPage": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Poa"
},
"nullable": true
},
"nextToken": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"description": "Страница доверенностей"
},
"RepresentativeRequisites": {
"required": [
"name",
"surname"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Имя уполномоченного лица",
"example": "Иван"
},
"surname": {
"type": "string",
"description": "Фамилия уполномоченного лица",
"example": "Иванов"
},
"middlename": {
"type": "string",
"description": "Отчество уполномоченного лица",
"nullable": true,
"example": "Иванович"
},
"snils": {
"type": "string",
"description": "СНИЛС физ.лица\r\nУказывается, если доверенность выдана на физическое лицо",
"nullable": true,
"example": "123-456-789 00"
},
"inn": {
"type": "string",
"description": "ИНН уполномоченного физического лица\r\nУказывается, если доверенность выдана на физическое лицо",
"nullable": true,
"example": "1234567890"
},
"innUl": {
"type": "string",
"description": "ИНН уполномоченного юридического лица\r\nУказывается, если доверенность выдана на юридическое лицо",
"nullable": true,
"example": "1234567890"
},
"kpp": {
"type": "string",
"description": "КПП уполномоченного юридического лица\r\nУказывается, если доверенность выдана на юридическое лицо",
"nullable": true,
"example": "123456789"
}
},
"additionalProperties": false,
"description": "Информация об уполномоченном"
},
"RepresentativeValidationParameters": {
"type": "object",
"properties": {
"requisites": {
"allOf": [
{
"$ref": "#/components/schemas/RepresentativeRequisites"
}
],
"description": "Информация об уполномоченном",
"nullable": true
},
"certificate": {
"allOf": [
{
"$ref": "#/components/schemas/CertificateInfo"
}
],
"description": "Сертификат уполномоченного",
"nullable": true
}
},
"additionalProperties": false,
"description": "Параметры валидации уполномоченного лица"
},
"RevocationInfo": {
"required": [
"request"
],
"type": "object",
"properties": {
"reason": {
"type": "string",
"description": "Причина отзыва доверенности",
"nullable": true
},
"request": {
"allOf": [
{
"$ref": "#/components/schemas/RevocationRequest"
}
],
"description": "Сведения запроса на отзыв доверенности"
},
"sign": {
"allOf": [
{
"$ref": "#/components/schemas/RevocationSign"
}
],
"description": "Сведении о подписанте отзыва доверенности",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об отзыве доверенности"
},
"RevocationRequest": {
"required": [
"sentAt",
"sentByUser"
],
"type": "object",
"properties": {
"sentAt": {
"type": "string",
"description": "Время создания запроса на отзыв",
"format": "date-time"
},
"sentByUser": {
"type": "string",
"description": "Идентификатор пользователя создавшего запрос на отзыв"
}
},
"additionalProperties": false,
"description": "Сведения о запросе на отзыв"
},
"RevocationSign": {
"required": [
"signedAt",
"signedByUser"
],
"type": "object",
"properties": {
"signedAt": {
"type": "string",
"description": "Время подписания отзыва",
"format": "date-time"
},
"signedByUser": {
"type": "string",
"description": "Идентификатор пользователя подписавшего доверенность"
}
},
"additionalProperties": false,
"description": "Сведения о подписи отзыва доверенности"
},
"StorageSystemInfo": {
"required": [
"deliveryInfo"
],
"type": "object",
"properties": {
"systemName": {
"enum": [
"fns"
],
"type": "string",
"description": "Идентификатор информационной системы",
"nullable": true
},
"deliveryInfo": {
"allOf": [
{
"$ref": "#/components/schemas/SystemDeliveryInfo"
}
],
"description": "Сведения о регистрации в информационной системе"
},
"revocationDeliveryInfo": {
"allOf": [
{
"$ref": "#/components/schemas/SystemDeliveryInfo"
}
],
"description": "Сведения об отзыве в информационной системе",
"nullable": true
},
"statusInfo": {
"allOf": [
{
"$ref": "#/components/schemas/SystemStatusInfo"
}
],
"description": "Сведения о статусе доверенности в информационной системе",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о состоянии доверенности информационной системе"
},
"SystemDeliveryInfo": {
"required": [
"changedAt",
"status"
],
"type": "object",
"properties": {
"status": {
"enum": [
"queued",
"delivered",
"error",
"doNotDeliver",
"source"
],
"type": "string",
"description": "Статус доставки в информационную систему"
},
"changedAt": {
"type": "string",
"description": "Дата изменений статуса",
"format": "date-time"
},
"error": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
}
],
"description": "Ошибка доставки в информационную систему",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доставке в информационную систему"
},
"SystemStatusInfo": {
"required": [
"changedAt",
"status"
],
"type": "object",
"properties": {
"status": {
"enum": [
"created",
"active",
"expired",
"revoked"
],
"type": "string",
"description": "Статус в информационной системе"
},
"changedAt": {
"type": "string",
"description": "Дата изменения статуса",
"format": "date-time"
},
"synchronizedAt": {
"type": "string",
"description": "Дата последней синхронизации с информационной системой",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о статусе в информационной системе"
},
"SystemSyncInfo": {
"required": [
"isActual",
"syncedAt"
],
"type": "object",
"properties": {
"syncedAt": {
"type": "string",
"description": "Время последнего обновления статуса из ИС в UTC",
"format": "date-time"
},
"isActual": {
"type": "boolean",
"description": "true в случае если успели синхронизироваться с ИС за установленный лимит времени,\r\nиначе false"
}
},
"additionalProperties": false,
"description": "Сведения о синхронизации с информационной системой"
},
"XML.EMCHD_01.Common.Address": {
"required": [
"region"
],
"type": "object",
"properties": {
"region": {
"maxLength": 2,
"minLength": 2,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Регион'"
},
"fiasAddressId": {
"maxLength": 36,
"minLength": 36,
"pattern": "[\\da-fA-F]{8}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{4}-[\\da-fA-F]{12}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИдФИАС'",
"nullable": true
},
"addressRf": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя элемента в XML: 'АдрРФ'",
"nullable": true
},
"fiasAddressRf": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ФИАСАдрРФ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об адресе"
},
"XML.EMCHD_01.Common.Fio": {
"required": [
"name",
"surname"
],
"type": "object",
"properties": {
"surname": {
"maxLength": 2000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Фамилия'"
},
"name": {
"maxLength": 2000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Имя'"
},
"middlename": {
"maxLength": 2000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Отчество'",
"nullable": true
}
},
"additionalProperties": false,
"description": "ФИО доверителя (или представителя)"
},
"XML.EMCHD_01.Common.ForeignLegalEntity": {
"required": [
"heads",
"info"
],
"type": "object",
"properties": {
"info": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.ForeignLegalEntityInfo"
}
],
"description": "Сведения об иностранном юридическом лице (или филиале (аккредитованном представительстве) иностранного юридического\r\nлица)\n\nСоответствующее имя элемента в XML: 'СвИнОрг'"
},
"heads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPersonInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвРукОП'"
}
},
"additionalProperties": false,
"description": "Сведения об иностранном юридическом лице (или филиале (аккредитованном представительстве) иностранного юридического\r\nлица)"
},
"XML.EMCHD_01.Common.ForeignLegalEntityInfo": {
"required": [
"name"
],
"type": "object",
"properties": {
"notaryStatus": {
"$ref": "#/components/schemas/NotaryStatuses"
},
"name": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимИО'"
},
"innUl": {
"maxLength": 10,
"minLength": 10,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННЮЛ'",
"nullable": true
},
"kpp": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КПП'",
"nullable": true
},
"accreditationEntryNumber": {
"maxLength": 11,
"minLength": 11,
"pattern": "[0-9]{11}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НЗА'",
"nullable": true
},
"registrationCountry": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СтрРег'",
"nullable": true
},
"registratorName": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимРегОрг'",
"nullable": true
},
"registrationNumber": {
"maxLength": 80,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомер'",
"nullable": true
},
"taxpayerCode": {
"maxLength": 80,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодНПРег'",
"nullable": true
},
"contactPhone": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КонтактТлф'",
"nullable": true
},
"email": {
"maxLength": 129,
"minLength": 3,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрЭлПочт'",
"nullable": true
},
"registrationAddress": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрСтрРег'",
"nullable": true
},
"actualAddress": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.Address"
}
],
"description": "Сведения об адресе\n\nСоответствующее имя элемента в XML: 'АдрМНФакт'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об иностранном юридическом лице (или филиале (аккредитованном представительстве) иностранного юридического\r\nлица)"
},
"XML.EMCHD_01.Common.IdentityDocument": {
"required": [
"issueDate",
"serial",
"type"
],
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/IdentityDocumentTypes"
},
"serial": {
"maxLength": 25,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СерНомДок'"
},
"issueDate": {
"maxLength": 10,
"minLength": 10,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаДок'"
},
"issuerName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВыдДок'",
"nullable": true
},
"issuerCode": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодВыдДок'",
"nullable": true
},
"expirationDate": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'expDate'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о документе, удостоверяющем личность физического лица"
},
"XML.EMCHD_01.Common.IndividualEntrepreneurInfo": {
"required": [
"innFl",
"ogrnIp",
"personInfo",
"snils"
],
"type": "object",
"properties": {
"notaryStatus": {
"$ref": "#/components/schemas/NotaryStatuses"
},
"name": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимИП'",
"nullable": true
},
"ogrnIp": {
"maxLength": 15,
"minLength": 15,
"pattern": "^([0-9]{15})$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ОГРНИП'"
},
"innFl": {
"maxLength": 12,
"minLength": 12,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'"
},
"snils": {
"maxLength": 14,
"minLength": 14,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'"
},
"permissionsDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.PermissionDocument"
}
],
"description": "Документ, подтверждающий полномочия лица, действующего без доверенности\n\nСоответствующее имя элемента в XML: 'ДокПдтв'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.PersonInfo"
}
],
"description": "Сведения о физическом лице\n\nСоответствующее имя элемента в XML: 'СведФЛ'"
}
},
"additionalProperties": false,
"description": "Сведения об индивидуальном предпринимателе"
},
"XML.EMCHD_01.Common.IndividualPerson": {
"required": [
"info",
"snils"
],
"type": "object",
"properties": {
"notaryStatus": {
"$ref": "#/components/schemas/NotaryStatuses"
},
"legalCapacityFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"proxySignerFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"disabilityDocument": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДокНедеесп'",
"nullable": true
},
"innFl": {
"maxLength": 12,
"minLength": 12,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"snils": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'"
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPersonInfo"
}
],
"description": "Сведения о физическом лице / руководителе юридического лица (иностранного юридического лица (или филиала\r\n(аккредитованного представительства) иностранного юридического лица))\n\nСоответствующее имя элемента в XML: 'СведФЛ'"
},
"legalRepresentative": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalRepresentative"
}
],
"description": "Сведения о лице (лицах), в том числе законном представителе, действующем (действующих) без доверенности\n\nСоответствующее имя элемента в XML: 'СвЗакПредРук'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о физическом лице (доверителе)"
},
"XML.EMCHD_01.Common.IndividualPersonInfo": {
"required": [
"personInfo"
],
"type": "object",
"properties": {
"notaryStatus": {
"$ref": "#/components/schemas/NotaryStatuses"
},
"innFl": {
"maxLength": 12,
"minLength": 12,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"snils": {
"maxLength": 14,
"minLength": 14,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'",
"nullable": true
},
"position": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Должность'",
"nullable": true
},
"permissionsDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.PermissionDocument"
}
],
"description": "Документ, подтверждающий полномочия лица, действующего без доверенности\n\nСоответствующее имя элемента в XML: 'ДокПдтв'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.PersonInfo"
}
],
"description": "Сведения о физическом лице\n\nСоответствующее имя элемента в XML: 'СведФЛ'"
}
},
"additionalProperties": false,
"description": "Сведения о физическом лице / руководителе юридического лица (иностранного юридического лица (или филиала\r\n(аккредитованного представительства) иностранного юридического лица))"
},
"XML.EMCHD_01.Common.LegalEntity": {
"required": [
"eioFl",
"eioIp",
"eioUk",
"heads"
],
"type": "object",
"properties": {
"eioUk": {
"$ref": "#/components/schemas/BinaryFlag"
},
"eioFl": {
"$ref": "#/components/schemas/BinaryFlag"
},
"eioIp": {
"$ref": "#/components/schemas/BinaryFlag"
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntityInfo"
}
],
"description": "Сведения о юридическом лице (или филиале (обособленном подразделении) юридического лица)\n\nСоответствующее имя элемента в XML: 'СвРосОрг'",
"nullable": true
},
"heads": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalRepresentative"
},
"description": "Соответствующее имя элемента в XML: 'ЛицоБезДов'"
}
},
"additionalProperties": false,
"description": "Сведения о юридическом лице"
},
"XML.EMCHD_01.Common.LegalEntityInfo": {
"required": [
"kpp",
"name"
],
"type": "object",
"properties": {
"notaryStatus": {
"$ref": "#/components/schemas/NotaryStatuses"
},
"name": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимОрг'"
},
"innUl": {
"maxLength": 10,
"minLength": 10,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННЮЛ'",
"nullable": true
},
"kpp": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КПП'"
},
"ogrn": {
"maxLength": 13,
"minLength": 13,
"pattern": "^([0-9]{13})$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ОГРН'",
"nullable": true
},
"registrationNumber": {
"maxLength": 80,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомер'",
"nullable": true
},
"founderDocumentName": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимУчрДок'",
"nullable": true
},
"contactPhone": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КонтактТлф'",
"nullable": true
},
"email": {
"maxLength": 129,
"minLength": 3,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрЭлПочт'",
"format": "email",
"nullable": true
},
"permissionDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.PermissionDocument"
}
],
"description": "Документ, подтверждающий полномочия лица, действующего без доверенности\n\nСоответствующее имя элемента в XML: 'ДокПдтв'",
"nullable": true
},
"registrationAddress": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.Address"
}
],
"description": "Сведения об адресе\n\nСоответствующее имя элемента в XML: 'АдрРег'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о юридическом лице (или филиале (обособленном подразделении) юридического лица)"
},
"XML.EMCHD_01.Common.LegalRepresentative": {
"required": [
"jointPermissionFlag"
],
"type": "object",
"properties": {
"jointPermissionFlag": {
"$ref": "#/components/schemas/JointPermissionFlags"
},
"managementCompanyInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.ManagementCompanyInfo"
}
],
"description": "Сведения о единоличном исполнительном органе – управляющей компании\n\nСоответствующее имя элемента в XML: 'СВЮЛ'",
"nullable": true
},
"individualInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPersonInfo"
}
],
"description": "Сведения о физическом лице / руководителе юридического лица (иностранного юридического лица (или филиала\r\n(аккредитованного представительства) иностранного юридического лица))\n\nСоответствующее имя элемента в XML: 'СвФЛ'",
"nullable": true
},
"individualEntrepreneurInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualEntrepreneurInfo"
}
],
"description": "Сведения об индивидуальном предпринимателе\n\nСоответствующее имя элемента в XML: 'СвИП'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о лице (лицах), в том числе законном представителе, действующем (действующих) без доверенности"
},
"XML.EMCHD_01.Common.ManagementCompanyInfo": {
"required": [
"heads",
"legalEntityInfo"
],
"type": "object",
"properties": {
"legalEntityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntityInfo"
}
],
"description": "Сведения о юридическом лице (или филиале (обособленном подразделении) юридического лица)\n\nСоответствующее имя элемента в XML: 'СвЮЛЕИО'"
},
"heads": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPersonInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвФЛ'"
}
},
"additionalProperties": false,
"description": "Сведения о единоличном исполнительном органе – управляющей компании"
},
"XML.EMCHD_01.Common.PermissionDocument": {
"type": "object",
"properties": {
"documentName": {
"maxLength": 120,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимДокПдтв'",
"nullable": true
},
"issueDate": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаВыд'",
"nullable": true
},
"issuedBy": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КемВыд'",
"nullable": true
},
"certificationInfo": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СвУдДок'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Документ, подтверждающий полномочия лица, действующего без доверенности"
},
"XML.EMCHD_01.Common.PersonInfo": {
"required": [
"fio"
],
"type": "object",
"properties": {
"gender": {
"$ref": "#/components/schemas/GenderFlag"
},
"citizenshipFlag": {
"$ref": "#/components/schemas/CitizenshipFlags"
},
"ernNumber": {
"maxLength": 12,
"minLength": 12,
"pattern": "[0-9]{12}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомЕРН'",
"nullable": true
},
"birthDate": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаРожд'",
"nullable": true
},
"birthPlace": {
"maxLength": 250,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'МестоРожд'",
"nullable": true
},
"citizenship": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Гражданство'",
"nullable": true
},
"contactPhone": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КонтактТлф'",
"nullable": true
},
"email": {
"maxLength": 129,
"minLength": 3,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрЭлПочт'",
"format": "email",
"nullable": true
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.Fio"
}
],
"description": "ФИО доверителя (или представителя)\n\nСоответствующее имя элемента в XML: 'ФИО'"
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.Address"
}
],
"description": "Сведения об адресе\n\nСоответствующее имя элемента в XML: 'АдрМЖ'",
"nullable": true
},
"identityDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IdentityDocument"
}
],
"description": "Сведения о документе, удостоверяющем личность физического лица\n\nСоответствующее имя элемента в XML: 'УдЛичнФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о физическом лице"
},
"XML.EMCHD_01.Common.UnrevocableInfo": {
"required": [
"revocationConditionsFlag",
"unrevocablePoaTransferFlag"
],
"type": "object",
"properties": {
"unrevocablePoaTransferFlag": {
"$ref": "#/components/schemas/UnrevocablePoaTransferFlags"
},
"revocationConditionsFlag": {
"$ref": "#/components/schemas/RevocationConditionsFlags"
},
"revocationConditionsDescription": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ОписУслОт'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о безотзывной доверенности"
},
"XML.EMCHD_01.Document": {
"type": "object",
"properties": {
"knd": {
"maxLength": 7,
"minLength": 7,
"type": "string",
"nullable": true
},
"originPoa": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.OriginPoa"
}
],
"description": "Доверенность\n\nСоответствующее имя элемента в XML: 'Довер'",
"nullable": true
},
"transferPoa": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.TransferPoa"
}
],
"description": "Передоверие\n\nСоответствующее имя элемента в XML: 'Передов'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Состав и структура документа"
},
"XML.EMCHD_01.Notary.ActingNotary": {
"required": [
"fio",
"notaryRegistrationNumber",
"title"
],
"type": "object",
"properties": {
"title": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Должность'"
},
"notaryRegistrationNumber": {
"maxLength": 8,
"minLength": 3,
"pattern": "[0-9]{2}\\/[0-9]{1,5}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомНот'"
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.Fio"
}
],
"description": "ФИО доверителя (или представителя)\n\nСоответствующее имя элемента в XML: 'ФИОНотДейств'"
}
},
"additionalProperties": false,
"description": "ВРИО нотариуса"
},
"XML.EMCHD_01.Notary.HandSign": {
"required": [
"pdfHash",
"signatureHash",
"signatureImage",
"signedAt",
"signedBy"
],
"type": "object",
"properties": {
"pdfHash": {
"maxLength": 16000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ХешPDFДок'"
},
"signatureImage": {
"maxLength": 16000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ПодпИзобр'"
},
"signatureHash": {
"maxLength": 16000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ХешПодп'"
},
"signedAt": {
"type": "integer",
"description": "Соответствующее имя элемента в XML: 'ДатаВремПодп'",
"format": "int32"
},
"signedBy": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.Fio"
}
],
"description": "ФИО доверителя (или представителя)\n\nСоответствующее имя элемента в XML: 'ФИООтв'"
}
},
"additionalProperties": false,
"description": "Рукописная подпись"
},
"XML.EMCHD_01.Notary.NotaryCertification": {
"required": [
"handSigns",
"notary",
"paidAmount",
"poaRegistrationPlace"
],
"type": "object",
"properties": {
"poaRegistrationPlace": {
"maxLength": 250,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'МестоДовер'"
},
"sentToPrincipalEpguCabinetFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"sentToAttorneyEpguCabinetFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"sentToApplicantFnpCabinetFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"sentToAttorneyFnpCabinetFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"paidAmount": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'УплНотДейст'"
},
"exemptionsAmount": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ЛьготаСум'",
"nullable": true
},
"otherSystem": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДрИнфСист'",
"nullable": true
},
"otherTransfer": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДрСпосВыд'",
"nullable": true
},
"otherNotaryPoaInfo": {
"maxLength": 2500,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДопСвНотДовер'",
"nullable": true
},
"otherNotarySignInfo": {
"maxLength": 2500,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ИнСвУдНадпис'",
"nullable": true
},
"notary": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Notary.NotaryInfo"
}
],
"description": "Сведения о нотариусе, совершившем нотариальное действие\n\nСоответствующее имя элемента в XML: 'СвНотДейств'"
},
"handSigns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Notary.HandSign"
},
"description": "Соответствующее имя элемента в XML: 'ПодпРукопис'"
},
"actingNotary": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Notary.ActingNotary"
}
],
"description": "ВРИО нотариуса\n\nСоответствующее имя элемента в XML: 'ВриоНот'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о нотариальном удостоверении"
},
"XML.EMCHD_01.Notary.NotaryInfo": {
"required": [
"fio",
"notaryRegistrationNumber",
"title"
],
"type": "object",
"properties": {
"title": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Должность'"
},
"notaryRegistrationNumber": {
"maxLength": 13,
"minLength": 5,
"pattern": "[0-9]{2}\\/[0-9]{1,5}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомНот'"
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.Fio"
}
],
"description": "ФИО доверителя (или представителя)\n\nСоответствующее имя элемента в XML: 'ФИОНотДейств'"
}
},
"additionalProperties": false,
"description": "Сведения о нотариусе, совершившем нотариальное действие"
},
"XML.EMCHD_01.OriginPoa": {
"required": [
"permissionsInfo",
"poaInfo",
"principalInfos",
"representativeInfos"
],
"type": "object",
"properties": {
"poaInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.PoaInfo"
}
],
"description": "Сведения о доверенности\n\nСоответствующее имя элемента в XML: 'СвДов'"
},
"principalInfos": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Principal.PrincipalInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвДоверит'"
},
"representativeInfos": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Representative.RepresentativeInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвУпПред'"
},
"permissionsInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Permissions.PermissionsInfo"
}
],
"description": "Сведения о полномочиях представителя (представителей)\n\nСоответствующее имя элемента в XML: 'СвПолн'"
},
"notaryCertificationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Notary.NotaryCertification"
}
],
"description": "Сведения о нотариальном удостоверении\n\nСоответствующее имя элемента в XML: 'СвНотУд'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Доверенность"
},
"XML.EMCHD_01.Permissions.MachineReadablePermission": {
"required": [
"code",
"name"
],
"type": "object",
"properties": {
"mnemonic": {
"maxLength": 255,
"minLength": 6,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'МнПолн'",
"nullable": true
},
"code": {
"maxLength": 255,
"minLength": 6,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодПолн'"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимПолн'"
},
"permissionRestrictions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Permissions.PermissionRestriction"
},
"description": "Соответствующее имя элемента в XML: 'ОргСвПолн'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о машиночитаемом полномочии (машиночитаемых полномочиях)"
},
"XML.EMCHD_01.Permissions.PermissionRestriction": {
"required": [
"code",
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Соответствующее имя атрибута в XML: 'ИдОгр'",
"format": "int32"
},
"code": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодОгр'"
},
"name": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимОгр'"
},
"valueName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимЗначОгр'",
"nullable": true
},
"valueCode": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'КодЗначОгр'",
"nullable": true
},
"valueText": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ТексЗначОгр'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об ограничении (ограничениях) к полномочию"
},
"XML.EMCHD_01.Permissions.PermissionsInfo": {
"required": [
"jointPermissionFlag",
"machineReadablePermissions",
"type"
],
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/PermissionTypes"
},
"jointPermissionFlag": {
"$ref": "#/components/schemas/JointPermissionFlags"
},
"permissionLossFlag": {
"$ref": "#/components/schemas/PermissionLossFlags"
},
"text": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ТекстПолн'",
"nullable": true
},
"machineReadablePermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Permissions.MachineReadablePermission"
},
"description": "Соответствующее имя элемента в XML: 'МашПолн'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о полномочиях представителя (представителей)"
},
"XML.EMCHD_01.Poa": {
"required": [
"document",
"fileId",
"formVersion"
],
"type": "object",
"properties": {
"formVersion": {
"maxLength": 10,
"minLength": 1,
"enum": [
"EMCHD_1"
],
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВерсФорм'"
},
"requiredFormElements": {
"type": "integer",
"description": "00000000 - Указаны основные элементы B2B доверенности (по умолчанию)\r\n01000000 - Указаны основные элементы B2B доверенности (по умолчанию) + Элементы, необходимые для получения государственных и муниципальных услуг с использованием платформы полномочий Госуслуг (ЕСИА)\r\n00100000 - Указаны основные элементы B2B доверенности (по умолчанию) + Доверенность удостоверена нотариусом\r\n00010000 - Указаны основные элементы B2B доверенности (по умолчанию) + Элементы, необходимые для взаимодействия с налоговыми органами\r\n01100000 - Указаны основные элементы B2B доверенности (по умолчанию) + Элементы, необходимые для получения государственных и муниципальных услуг с использованием платформы полномочий Госуслуг (ЕСИА) + Доверенность удостоверена нотариусом\r\n00110000 - Указаны основные элементы B2B доверенности (по умолчанию) + Элементы, необходимые для взаимодействия с налоговыми органами + Доверенность удостоверена нотариусом\r\n01110000 - Указаны основные элементы B2B доверенности (по умолчанию) + Элементы, необходимые для получения государственных и муниципальных услуг с использованием платформы полномочий Госуслуг (ЕСИА) + Элементы, необходимые для взаимодействия с налоговыми органами + Доверенность удостоверена нотариусом",
"format": "int32"
},
"fileId": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИдФайл'"
},
"fileIdTax": {
"maxLength": 255,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИдФайлНО'",
"nullable": true
},
"esyaOid": {
"maxLength": 255,
"minLength": 1,
"pattern": "^[0-9]126$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'OID'",
"nullable": true
},
"otherInfo": {
"maxLength": 5000,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ИнСвед'",
"nullable": true
},
"document": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Document"
}
],
"description": "Состав и структура документа\n\nСоответствующее имя элемента в XML: 'Документ'"
}
},
"additionalProperties": false,
"description": "Сведения о доверенности"
},
"XML.EMCHD_01.PoaInfo": {
"required": [
"expireAt",
"internalNumber",
"number",
"poaTransferRestrictions",
"revocationFlag",
"startAt",
"system"
],
"type": "object",
"properties": {
"revocationFlag": {
"$ref": "#/components/schemas/RevocationFlags"
},
"poaTransferRestrictions": {
"$ref": "#/components/schemas/PoaTransferRestrictions"
},
"internalNumber": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВнНомДовер'"
},
"number": {
"maxLength": 36,
"minLength": 36,
"pattern": "^[({]?[a-fA-F0-9]{8}-?([a-fA-F0-9]{4}-?){3}[a-fA-F0-9]{12}[})]?$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомДовер'"
},
"notaryNumber": {
"maxLength": 28,
"minLength": 1,
"pattern": "[0-9]{2}\\/[0-9]{1,5}-н\\/[0-9]{2}-[0-9]{4}-[0-9]{1,3}-[0-9]{1,5}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомРНДДовер'",
"nullable": true
},
"additionalId": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДопИдДовер'",
"nullable": true
},
"internalRegisteredAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаВнРегДовер'",
"nullable": true
},
"startAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаВыдДовер'"
},
"expireAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СрокДейст'"
},
"recipientTaxAuthorityCode": {
"maxLength": 4,
"minLength": 4,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодНО'",
"nullable": true
},
"targetTaxAuthorityCode": {
"maxLength": 4,
"minLength": 4,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодНОДейст'",
"nullable": true
},
"system": {
"maxLength": 1000,
"minLength": 1,
"type": "string",
"description": "Требуемый формат: https://m4d.nalog.gov.ru/EMCHD/check-status?guid={НомДовер}\n\nСоответствующее имя элемента в XML: 'СведСист'"
},
"unrevocableInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.UnrevocableInfo"
}
],
"description": "Сведения о безотзывной доверенности\n\nСоответствующее имя элемента в XML: 'Безотзыв'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверенности"
},
"XML.EMCHD_01.Principal.Principal": {
"type": "object",
"properties": {
"legalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntity"
}
],
"description": "Сведения о юридическом лице\n\nСоответствующее имя элемента в XML: 'РосОргДовер'",
"nullable": true
},
"foreignLegalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.ForeignLegalEntity"
}
],
"description": "Сведения об иностранном юридическом лице (или филиале (аккредитованном представительстве) иностранного юридического\r\nлица)\n\nСоответствующее имя элемента в XML: 'ИнОргДовер'",
"nullable": true
},
"individualEntrepreneur": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualEntrepreneurInfo"
}
],
"description": "Сведения об индивидуальном предпринимателе\n\nСоответствующее имя элемента в XML: 'ИПДовер'",
"nullable": true
},
"individual": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPerson"
}
],
"description": "Сведения о физическом лице (доверителе)\n\nСоответствующее имя элемента в XML: 'ФЛДовер'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверителе"
},
"XML.EMCHD_01.Principal.PrincipalInfo": {
"required": [
"principal",
"type"
],
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/PrincipalTypes"
},
"principal": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Principal.Principal"
}
],
"description": "Сведения о доверителе\n\nСоответствующее имя элемента в XML: 'Доверит'"
}
},
"additionalProperties": false,
"description": "Сведения о доверителе (доверителях)"
},
"XML.EMCHD_01.Representative.LegalEntitySubsidiaryInfo": {
"required": [
"head",
"info"
],
"type": "object",
"properties": {
"info": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntityInfo"
}
],
"description": "Сведения о юридическом лице (или филиале (обособленном подразделении) юридического лица)\n\nСоответствующее имя элемента в XML: 'СвФил'"
},
"head": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPersonInfo"
}
],
"description": "Сведения о физическом лице / руководителе юридического лица (иностранного юридического лица (или филиала\r\n(аккредитованного представительства) иностранного юридического лица))\n\nСоответствующее имя элемента в XML: 'СвРукФил'"
}
},
"additionalProperties": false,
"description": "Сведения о филиале (обособленном подразделении) юридического лица"
},
"XML.EMCHD_01.Representative.Representative": {
"type": "object",
"properties": {
"legalEntityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntityInfo"
}
],
"description": "Сведения о юридическом лице (или филиале (обособленном подразделении) юридического лица)\n\nСоответствующее имя элемента в XML: 'СведОрг'",
"nullable": true
},
"individualEntrepreneurInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualEntrepreneurInfo"
}
],
"description": "Сведения об индивидуальном предпринимателе\n\nСоответствующее имя элемента в XML: 'СведИП'",
"nullable": true
},
"individualPersonInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPersonInfo"
}
],
"description": "Сведения о физическом лице / руководителе юридического лица (иностранного юридического лица (или филиала\r\n(аккредитованного представительства) иностранного юридического лица))\n\nСоответствующее имя элемента в XML: 'СведФизЛ'",
"nullable": true
},
"legalEntitySubsidiaryInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntityInfo"
}
],
"description": "Сведения о юридическом лице (или филиале (обособленном подразделении) юридического лица)\n\nСоответствующее имя элемента в XML: 'СведФилиал'",
"nullable": true
},
"foreignLegalEntityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.ForeignLegalEntityInfo"
}
],
"description": "Сведения об иностранном юридическом лице (или филиале (аккредитованном представительстве) иностранного юридического\r\nлица)\n\nСоответствующее имя элемента в XML: 'СведИО'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о представителе"
},
"XML.EMCHD_01.Representative.RepresentativeInfo": {
"required": [
"representative",
"type"
],
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/RepresentativeTypes"
},
"representative": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Representative.Representative"
}
],
"description": "Сведения о представителе\n\nСоответствующее имя элемента в XML: 'Пред'"
}
},
"additionalProperties": false,
"description": "Сведения о представителе (представителях)"
},
"XML.EMCHD_01.Transfer.OriginPoaInfo": {
"required": [
"expireAt",
"poaMediaType",
"poaTransferFlag",
"startAt"
],
"type": "object",
"properties": {
"poaTransferFlag": {
"$ref": "#/components/schemas/PoaTransferFlags"
},
"poaMediaType": {
"$ref": "#/components/schemas/PoaMediaTypes"
},
"startAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаВыдДовер'"
},
"expireAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СрокДейст'"
},
"originPoaInternalNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВнНомДоверПерв'",
"nullable": true
},
"parentPoaInternalNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВнНомДоверN'",
"nullable": true
},
"originPoaNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомДоверПерв'",
"nullable": true
},
"parentPoaNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомДоверN'",
"nullable": true
},
"originPoaNotaryNumber": {
"maxLength": 28,
"minLength": 1,
"pattern": "[0-9]{2}\\/[0-9]{1,5}-н\\/[0-9]{2}-[0-9]{4}-[0-9]{1,3}-[0-9]{1,5}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомРНДПерв'",
"nullable": true
},
"parentPoaNotaryNumber": {
"maxLength": 28,
"minLength": 1,
"pattern": "[0-9]{2}\\/[0-9]{1,5}-н\\/[0-9]{2}-[0-9]{4}-[0-9]{1,3}-[0-9]{1,5}",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомРНДN'",
"nullable": true
},
"originPoaPrincipalInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.OriginPoaPrincipal"
},
"description": "Соответствующее имя элемента в XML: 'СвДоверПерв'",
"nullable": true
},
"notaryInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Notary.NotaryInfo"
}
],
"description": "Сведения о нотариусе, совершившем нотариальное действие\n\nСоответствующее имя элемента в XML: 'СвНотДейств'",
"nullable": true
},
"actingNotary": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Notary.ActingNotary"
}
],
"description": "ВРИО нотариуса\n\nСоответствующее имя элемента в XML: 'ВриоНот'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о первоначальной доверенности (или доверенности, на основании которой осуществляется передоверие)"
},
"XML.EMCHD_01.Transfer.OriginPoaPrincipal": {
"required": [
"info",
"type"
],
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/PrincipalTypes"
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.OriginPoaPrincipalInfo"
}
],
"description": "Сведения о доверителе первоначальной доверенности\n\nСоответствующее имя элемента в XML: 'ДоверитПерв'"
}
},
"additionalProperties": false,
"description": "Сведения о доверителе (доверителях) первоначальной доверенности"
},
"XML.EMCHD_01.Transfer.OriginPoaPrincipalInfo": {
"type": "object",
"properties": {
"legalEntityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntityInfo"
}
],
"description": "Сведения о юридическом лице (или филиале (обособленном подразделении) юридического лица)",
"nullable": true
},
"individualEntrepreneurInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualEntrepreneurInfo"
}
],
"description": "Сведения об индивидуальном предпринимателе",
"nullable": true
},
"foreignLegalEntityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.ForeignLegalEntityInfo"
}
],
"description": "Сведения об иностранном юридическом лице (или филиале (аккредитованном представительстве) иностранного юридического\r\nлица)",
"nullable": true
},
"individual": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPerson"
}
],
"description": "Сведения о физическом лице (доверителе)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверителе первоначальной доверенности"
},
"XML.EMCHD_01.Transfer.PermissionPersonInfo": {
"required": [
"personTransferredPermissions",
"type"
],
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/PermissionPersonTypes"
},
"personTransferredPermissions": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.PersonTransferredPermissions"
}
],
"description": "Сведения о лице, передавшем полномочия\n\nСоответствующее имя элемента в XML: 'ПередПолн'"
}
},
"additionalProperties": false,
"description": "Сведения о лице (лицах), передавшем (передавших) полномочия"
},
"XML.EMCHD_01.Transfer.PersonTransferredPermissions": {
"type": "object",
"properties": {
"legalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.LegalEntity"
}
],
"description": "Сведения о юридическом лице\n\nСоответствующее имя элемента в XML: 'РосОргПерПолн'",
"nullable": true
},
"individualEntrepreneurInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualEntrepreneurInfo"
}
],
"description": "Сведения об индивидуальном предпринимателе\n\nСоответствующее имя элемента в XML: 'ИППерПолн'",
"nullable": true
},
"individual": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.TransferIndividualPerson"
}
],
"description": "Сведения о физическом лице\n\nСоответствующее имя элемента в XML: 'ФЛПерПолн'",
"nullable": true
},
"legalEntitySubsidiaryInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Representative.LegalEntitySubsidiaryInfo"
}
],
"description": "Сведения о филиале (обособленном подразделении) юридического лица\n\nСоответствующее имя элемента в XML: 'ФилПерПолн'",
"nullable": true
},
"foreignLegalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.ForeignLegalEntity"
}
],
"description": "Сведения об иностранном юридическом лице (или филиале (аккредитованном представительстве) иностранного юридического\r\nлица)\n\nСоответствующее имя элемента в XML: 'ИнПерПолн'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о лице, передавшем полномочия"
},
"XML.EMCHD_01.Transfer.TransferIndividualPerson": {
"required": [
"innFl",
"personInfo",
"snils"
],
"type": "object",
"properties": {
"notaryStatus": {
"$ref": "#/components/schemas/NotaryStatuses"
},
"proxySignerFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"innFl": {
"maxLength": 12,
"minLength": 12,
"pattern": "^([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}$",
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'"
},
"snils": {
"maxLength": 14,
"minLength": 14,
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'"
},
"proxySigner": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.IndividualPersonInfo"
}
],
"description": "Сведения о физическом лице / руководителе юридического лица (иностранного юридического лица (или филиала\r\n(аккредитованного представительства) иностранного юридического лица))\n\nСоответствующее имя элемента в XML: 'СведРукоп'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Common.PersonInfo"
}
],
"description": "Сведения о физическом лице\n\nСоответствующее имя элемента в XML: 'СведФЛ'"
}
},
"additionalProperties": false,
"description": "Сведения о физическом лице"
},
"XML.EMCHD_01.Transfer.TransferPoa": {
"required": [
"info",
"originPoa",
"permissionPersons",
"poaTransferFlag",
"representatives"
],
"type": "object",
"properties": {
"poaTransferFlag": {
"$ref": "#/components/schemas/BinaryFlag"
},
"originPoa": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.OriginPoaInfo"
}
],
"description": "Сведения о первоначальной доверенности (или доверенности, на основании которой осуществляется передоверие)\n\nСоответствующее имя элемента в XML: 'СвПервДовер'"
},
"parentPoa": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.OriginPoaInfo"
}
],
"description": "Сведения о первоначальной доверенности (или доверенности, на основании которой осуществляется передоверие)\n\nСоответствующее имя элемента в XML: 'СвПередов'",
"nullable": true
},
"info": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.PoaInfo"
}
],
"description": "Сведения о доверенности\n\nСоответствующее имя элемента в XML: 'СвПереДовер'"
},
"permissionPersons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Transfer.PermissionPersonInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвПередПолн'"
},
"representatives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML.EMCHD_01.Representative.RepresentativeInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвПолучПолн'"
},
"permissionsInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Permissions.PermissionsInfo"
}
],
"description": "Сведения о полномочиях представителя (представителей)\n\nСоответствующее имя элемента в XML: 'СвПолн'",
"nullable": true
},
"notaryCertification": {
"allOf": [
{
"$ref": "#/components/schemas/XML.EMCHD_01.Notary.NotaryCertification"
}
],
"description": "Сведения о нотариальном удостоверении\n\nСоответствующее имя элемента в XML: 'СвНотУд'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Передоверие"
},
"XML._002.ActingNotary": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Должность'",
"nullable": true
},
"notaryRegistrationNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомНот'",
"nullable": true
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'ФИОВриоНот'",
"nullable": true
}
},
"additionalProperties": false,
"description": "ВРИО нотариуса (ВриоНот)"
},
"XML._002.Address": {
"type": "object",
"properties": {
"region": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Регион'",
"nullable": true
},
"addressRf": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрРФ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об адресе (АдрТип)"
},
"XML._002.Document": {
"type": "object",
"properties": {
"okud": {
"type": "string",
"nullable": true
},
"originPoa": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.OriginPoa"
}
],
"description": "Доверенность (Довер)\n\nСоответствующее имя элемента в XML: 'Довер'",
"nullable": true
},
"transferedPoa": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.TransferPoa"
}
],
"description": "Передоверие (Передов)\n\nСоответствующее имя элемента в XML: 'Передов'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Состав и структура документа (Документ)"
},
"XML._002.Fio": {
"type": "object",
"properties": {
"surname": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Фамилия'",
"nullable": true
},
"name": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Имя'",
"nullable": true
},
"middlename": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Отчество'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)"
},
"XML._002.ForeignLegalEntity": {
"type": "object",
"properties": {
"foreignLegalEntityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.ForeignLegalEntityInfo"
}
],
"description": "Соответствующее имя элемента в XML: 'СвИнОрг'",
"nullable": true
},
"foreignLegalEntityHead": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.ForeignLegalEntityHead"
}
],
"description": "Сведения о руководителе обособленного подразделения (СвРукОП)\n\nСоответствующее имя элемента в XML: 'СвРукОП'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверителе - иностранном юридическом лице (ИнОргДовер)"
},
"XML._002.ForeignLegalEntityHead": {
"type": "object",
"properties": {
"innFl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"permissionsDocumentName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимДокПолн'",
"nullable": true
},
"permissionsDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PermissionsDocumentRequisites"
}
],
"description": "Реквизиты документа подтверждающего полномочия (РеквДокПдтвТип)\n\nСоответствующее имя элемента в XML: 'РеквДокПдтв'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)\n\nСоответствующее имя элемента в XML: 'СведФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о руководителе обособленного подразделения (СвРукОП)"
},
"XML._002.ForeignLegalEntityInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимИО'",
"nullable": true
},
"innUl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННЮЛ'",
"nullable": true
},
"kpp": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КПП'",
"nullable": true
},
"accreditationEntryNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НЗА'",
"nullable": true
},
"registrationCountry": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СтрРег'",
"nullable": true
},
"registratorName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимРегОрг'",
"nullable": true
},
"registrationNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомер'",
"nullable": true
},
"address": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрСтрРег'",
"nullable": true
},
"actualAddress": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрМнФакт'",
"nullable": true
},
"contactPhone": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КонтактТлф'",
"nullable": true
}
},
"additionalProperties": false
},
"XML._002.HandSign": {
"type": "object",
"properties": {
"pdfHash": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ХешPDFДок'",
"nullable": true
},
"signatureImage": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ПодпИзобр'",
"nullable": true
},
"signatureHash": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ХешПодп'",
"nullable": true
},
"signedAt": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ДатаВремПодп'",
"nullable": true
},
"signedBy": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'ФИООтв'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Рукописная подпись (ПодпРукопис)"
},
"XML._002.IdentityDocument": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодВидДок'",
"nullable": true
},
"serial": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СерНомДок'",
"nullable": true
},
"issueDate": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаДок'",
"nullable": true
},
"issuerName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВыдДок'",
"nullable": true
},
"issuerCode": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КодВыдДок'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о документе удостоверяющем личность физического лица (УдЛичнФЛТип)"
},
"XML._002.Individual": {
"type": "object",
"properties": {
"legalCapacityFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ПрДеесп'",
"nullable": true
},
"innFl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"snils": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'",
"nullable": true
},
"disabilityDocument": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДокНедеесп'",
"nullable": true
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'ФИО'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)\n\nСоответствующее имя элемента в XML: 'СведФЛ'",
"nullable": true
},
"legalRepresentativeInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalRepresentativeInfo"
}
],
"description": "Сведения о законном представителе физического лица (СвЗакПредТип)\n\nСоответствующее имя элемента в XML: 'СвЗакПред'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверителе - физическом лице (ФЛДоверТип)"
},
"XML._002.IndividualEntrepreneur": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимИП'",
"nullable": true
},
"innFl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"ogrnIp": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ОГРНИП'",
"nullable": true
},
"snils": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)\n\nСоответствующее имя элемента в XML: 'СведФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об индивидуальном предпринемателе (СведИПТип)"
},
"XML._002.IndividualEntrepreneurInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимИП'",
"nullable": true
},
"innFl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"ogrnIp": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ОГРНИП'",
"nullable": true
},
"snils": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'",
"nullable": true
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'ФИО'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)\n\nСоответствующее имя элемента в XML: 'СведФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об индивидуальном предпринимателе (СвИПТип)"
},
"XML._002.IndividualInfo": {
"type": "object",
"properties": {
"innFl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"snils": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'",
"nullable": true
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'ФИО'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)\n\nСоответствующее имя элемента в XML: 'СведФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о физическом лице (СведФизЛТип)"
},
"XML._002.IndividualTransferredPermissions": {
"type": "object",
"properties": {
"innFl": {
"type": "string",
"nullable": true
},
"snils": {
"type": "string",
"nullable": true
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)",
"nullable": true
},
"legalRepresentativeInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalRepresentativeInfo"
}
],
"description": "Сведения о законном представителе физического лица (СвЗакПредТип)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о лице, передавшем полномочия - физическом лице (ФЛПрдПолн)"
},
"XML._002.LegalEntity": {
"type": "object",
"properties": {
"legalEntityInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalEntityInfo"
}
],
"description": "Сведения о российском юридическом лице (СвРосОргТип)\n\nСоответствующее имя элемента в XML: 'СвРосОрг'",
"nullable": true
},
"legalEntityHead": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalEntityHead"
}
],
"description": "Сведения о лице действующем от имени юридического лица без доверенности (ЛицоБезДов)\n\nСоответствующее имя элемента в XML: 'ЛицоБезДов'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверителе - российском юридическом лице (РосОргДовер)"
},
"XML._002.LegalEntityHead": {
"type": "object",
"properties": {
"legalEntityHeadOrganization": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.OrganizationInfo"
}
],
"description": "Сведения об организации (СвОргТип)\n\nСоответствующее имя элемента в XML: 'СвОрг'",
"nullable": true
},
"legalEntityHeadIndividualInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalEntityHeadIndividualInfo"
}
],
"description": "Сведения по физическому лицу (СвФЛ)\n\nСоответствующее имя элемента в XML: 'СвФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о лице действующем от имени юридического лица без доверенности (ЛицоБезДов)"
},
"XML._002.LegalEntityHeadIndividualInfo": {
"type": "object",
"properties": {
"innFl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"snils": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'",
"nullable": true
},
"position": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Должность'",
"nullable": true
},
"permissionsDocumentName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимДокПолн'",
"nullable": true
},
"permissionsDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PermissionsDocumentRequisites"
}
],
"description": "Реквизиты документа подтверждающего полномочия (РеквДокПдтвТип)\n\nСоответствующее имя элемента в XML: 'РеквДокПдтв'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)\n\nСоответствующее имя элемента в XML: 'СведФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения по физическому лицу (СвФЛ)"
},
"XML._002.LegalEntityInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимОрг'",
"nullable": true
},
"innUl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННЮЛ'",
"nullable": true
},
"ogrn": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ОГРН'",
"nullable": true
},
"kpp": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КПП'",
"nullable": true
},
"address": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрРФ'",
"nullable": true
},
"actualAddress": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'АдрМНФакт'",
"nullable": true
},
"founderDocumentName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимУчрДок'",
"nullable": true
},
"contactPhone": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Тлф'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о российском юридическом лице (СвРосОргТип)"
},
"XML._002.LegalRepresentativeInfo": {
"type": "object",
"properties": {
"organizationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.OrganizationInfo"
}
],
"description": "Сведения об организации (СвОргТип)\n\nСоответствующее имя элемента в XML: 'СвОрг'",
"nullable": true
},
"legalRepresentativePersonInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalRepresentativePersonInfo"
}
],
"description": "Сведения по физическому лицу (СвПоФЛ)\n\nСоответствующее имя элемента в XML: 'СвПоФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о законном представителе физического лица (СвЗакПредТип)"
},
"XML._002.LegalRepresentativePersonInfo": {
"type": "object",
"properties": {
"innFl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННФЛ'",
"nullable": true
},
"snils": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СНИЛС'",
"nullable": true
},
"disabilityDocument": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДокНедеесп'",
"nullable": true
},
"personInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PersonInfo"
}
],
"description": "Сведения о физическом лице (СведФЛТип)\n\nСоответствующее имя элемента в XML: 'СведФЛ'",
"nullable": true
},
"permissionDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PermissionsDocumentRequisites"
}
],
"description": "Реквизиты документа подтверждающего полномочия (РеквДокПдтвТип)\n\nСоответствующее имя элемента в XML: 'РеквДокПдтв'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения по физическому лицу (СвПоФЛ)"
},
"XML._002.NotaryCertificationInfo": {
"type": "object",
"properties": {
"registryPoaNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РстрНомДовер'",
"nullable": true
},
"poaRegistrationPlace": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'МестоДовер'",
"nullable": true
},
"notary": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.NotaryInfo"
}
],
"description": "Сведения о нотариусе, совершившем нотариальное действие (СвНотДейств)\n\nСоответствующее имя элемента в XML: 'СвНотДейств'",
"nullable": true
},
"actingNotary": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.ActingNotary"
}
],
"description": "ВРИО нотариуса (ВриоНот)\n\nСоответствующее имя элемента в XML: 'ВриоНот'",
"nullable": true
},
"payment": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.NotaryPayment"
}
],
"description": "Сведения об оплате за совершение нотариального действия (ОплатНотДейст)\n\nСоответствующее имя элемента в XML: 'ОплатНотДейст'",
"nullable": true
},
"signature": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.HandSign"
}
],
"description": "Рукописная подпись (ПодпРукопис)\n\nСоответствующее имя элемента в XML: 'ПодпРукопис'",
"nullable": true
},
"documentTransfers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.NotaryDocumentTransfer"
},
"description": "Соответствующее имя элемента в XML: 'СпПрдЭНотДок'",
"nullable": true
},
"otherInfo": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ИнСвУдНадпис'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о нотариальном удостоверении (СвНотУдТип)"
},
"XML._002.NotaryDocumentTransfer": {
"type": "object",
"properties": {
"sentToPrincipalEpguCabinetFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НапрДокДовЕПГУ'",
"nullable": true
},
"sentToAttorneyEpguCabinetFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НапрДокПовЕПГУ'",
"nullable": true
},
"sentToApplicantFnpCabinetFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НапрДокЗвлФНП'",
"nullable": true
},
"sentToAttorneyFnpCabinetFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НапрДокПовФНП'",
"nullable": true
},
"otherSystem": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДрИнфСист'",
"nullable": true
},
"otherTransfer": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДрСпосВыд'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Способ передачи электронного нотариального документа (СпПрдЭНотДок)"
},
"XML._002.NotaryInfo": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Должность'",
"nullable": true
},
"notaryRegistrationNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомНот'",
"nullable": true
},
"fio": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'ФИОНотДейств'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о нотариусе, совершившем нотариальное действие (СвНотДейств)"
},
"XML._002.NotaryPayment": {
"type": "object",
"properties": {
"paidAmount": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'УплНотДейст'",
"nullable": true
},
"exemptionsAmount": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ЛьготаСум'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об оплате за совершение нотариального действия (ОплатНотДейст)"
},
"XML._002.OrganizationInfo": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимОрг'",
"nullable": true
},
"innUl": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИННЮЛ'",
"nullable": true
},
"kpp": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КПП'",
"nullable": true
},
"ogrn": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ОГРН'",
"nullable": true
},
"founderDocumentName": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НаимУчрДок'",
"nullable": true
},
"contactPhone": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КонтактТлф'",
"nullable": true
},
"registrationNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'РегНомер'",
"nullable": true
},
"registrationAddress": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Address"
}
],
"description": "Сведения об адресе (АдрТип)\n\nСоответствующее имя элемента в XML: 'АдрРег'",
"nullable": true
},
"actualAddress": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Address"
}
],
"description": "Сведения об адресе (АдрТип)\n\nСоответствующее имя элемента в XML: 'АдрМНФакт'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об организации (СвОргТип)"
},
"XML._002.OriginPoa": {
"type": "object",
"properties": {
"poaInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PoaInfo"
}
],
"description": "Сведения доверенности (СвДовТип)\n\nСоответствующее имя элемента в XML: 'СвДов'",
"nullable": true
},
"principalInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.PrincipalInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвДоверит'",
"nullable": true
},
"representativeInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.RepresentativeInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвУпПред'",
"nullable": true
},
"permissionsInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.PermissionsInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвПолн'",
"nullable": true
},
"notaryCertificationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.NotaryCertificationInfo"
}
],
"description": "Сведения о нотариальном удостоверении (СвНотУдТип)\n\nСоответствующее имя элемента в XML: 'СвНотУд'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Доверенность (Довер)"
},
"XML._002.OriginPoaInfo": {
"type": "object",
"properties": {
"originPoaNumber": {
"type": "string",
"nullable": true
},
"originPoaPrincipals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.OriginPoaPrincipal"
},
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об Основной доверенности (СвОснДовер)"
},
"XML._002.OriginPoaPrincipal": {
"type": "object",
"properties": {
"principalType": {
"type": "string",
"nullable": true
},
"legalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalEntityInfo"
}
],
"description": "Сведения о российском юридическом лице (СвРосОргТип)",
"nullable": true
},
"foreignLegalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.ForeignLegalEntityInfo"
}
],
"nullable": true
},
"individualEntrepreneur": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.IndividualEntrepreneurInfo"
}
],
"description": "Сведения об индивидуальном предпринимателе (СвИПТип)",
"nullable": true
},
"individual": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Individual"
}
],
"description": "Сведения о доверителе - физическом лице (ФЛДоверТип)",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверителе Основной доверенности (СвДовер0)"
},
"XML._002.PermissionsDocumentRequisites": {
"type": "object",
"properties": {
"issueDate": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаВыд'",
"nullable": true
},
"issuedBy": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КемВыд'",
"nullable": true
},
"certificationInfo": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'СвУдДок'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Реквизиты документа подтверждающего полномочия (РеквДокПдтвТип)"
},
"XML._002.PermissionsInfo": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'КодПолн'",
"nullable": true
},
"text": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ТекстПолн'",
"nullable": true
},
"shortDescription": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'СодержПолн'",
"nullable": true
},
"extraDescription": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ДопТекстПолн'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о полномочиях представителя (представителей) (СвПолнТип)"
},
"XML._002.PersonInfo": {
"type": "object",
"properties": {
"birthDate": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаРожд'",
"nullable": true
},
"birthPlace": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'МестоРожд'",
"nullable": true
},
"contactPhone": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'КонтактТлф'",
"nullable": true
},
"gender": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Пол'",
"nullable": true
},
"citizenshipFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ПрГражд'",
"nullable": true
},
"citizenship": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'Гражданство'",
"nullable": true
},
"address": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Address"
}
],
"description": "Сведения об адресе (АдрТип)\n\nСоответствующее имя элемента в XML: 'АдрМЖ'",
"nullable": true
},
"identityDocument": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.IdentityDocument"
}
],
"description": "Сведения о документе удостоверяющем личность физического лица (УдЛичнФЛТип)\n\nСоответствующее имя элемента в XML: 'УдЛичнФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о физическом лице (СведФЛТип)"
},
"XML._002.PersonTransferredPermissions": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ТипЛицПрдПолн'",
"nullable": true
},
"organizationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.OrganizationInfo"
}
],
"description": "Сведения об организации (СвОргТип)\n\nСоответствующее имя элемента в XML: 'РосОргПрдПолн'",
"nullable": true
},
"individualEntrepreneur": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.IndividualEntrepreneur"
}
],
"description": "Сведения об индивидуальном предпринемателе (СведИПТип)\n\nСоответствующее имя элемента в XML: 'ИППрдПолн'",
"nullable": true
},
"individual": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.IndividualTransferredPermissions"
}
],
"description": "Сведения о лице, передавшем полномочия - физическом лице (ФЛПрдПолн)\n\nСоответствующее имя элемента в XML: 'ФЛПрдПолн'",
"nullable": true
},
"signer": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'Подписант'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о лице, передающем полномочия (СвЛицПередПолн)"
},
"XML._002.Poa": {
"type": "object",
"properties": {
"fileId": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ИдФайл'",
"nullable": true
},
"formVersion": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВерсФорм'",
"nullable": true
},
"document": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Document"
}
],
"description": "Состав и структура документа (Документ)\n\nСоответствующее имя элемента в XML: 'Документ'",
"nullable": true
},
"otherInfo": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ИнСвед'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверенности"
},
"XML._002.PoaInfo": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'НомДовер'",
"nullable": true
},
"internalNumber": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ВнНомДовер'",
"nullable": true
},
"internalRegisteredAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаВнРегДовер'",
"nullable": true
},
"startAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаВыдДовер'",
"nullable": true
},
"expireAt": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ДатаКонДовер'",
"nullable": true
},
"poaTransferFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ПрПередов'",
"nullable": true
},
"permissionLossFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ПрУтрПолн'",
"nullable": true
},
"jointPermissionsFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ПрСовмПолн'",
"nullable": true
},
"unrevokableInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.UnrevokableInfo"
}
],
"description": "Сведения о безотзывной доверенности (БезотзывТип)\n\nСоответствующее имя элемента в XML: 'Безотзыв'",
"nullable": true
},
"system": {
"type": "string",
"description": "Требуемый формат: https://m4d.nalog.gov.ru/EMCHD/check-status?guid={НомДовер}\n\nСоответствующее имя элемента в XML: 'СведСистОтм'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения доверенности (СвДовТип)"
},
"XML._002.PrincipalInfo": {
"type": "object",
"properties": {
"principalType": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ТипДовер'",
"nullable": true
},
"legalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.LegalEntity"
}
],
"description": "Сведения о доверителе - российском юридическом лице (РосОргДовер)\n\nСоответствующее имя элемента в XML: 'РосОргДовер'",
"nullable": true
},
"foreignLegalEntity": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.ForeignLegalEntity"
}
],
"description": "Сведения о доверителе - иностранном юридическом лице (ИнОргДовер)\n\nСоответствующее имя элемента в XML: 'ИнОргДовер'",
"nullable": true
},
"individualEntrepreneur": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.IndividualEntrepreneur"
}
],
"description": "Сведения об индивидуальном предпринемателе (СведИПТип)\n\nСоответствующее имя элемента в XML: 'ИПДовер'",
"nullable": true
},
"individual": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Individual"
}
],
"description": "Сведения о доверителе - физическом лице (ФЛДоверТип)\n\nСоответствующее имя элемента в XML: 'ФЛДовер'",
"nullable": true
},
"signer": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.Fio"
}
],
"description": "Фамилия, имя, отчество (при наличии) (ФИОТип)\n\nСоответствующее имя элемента в XML: 'Подписант'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о доверителе (СвДоверит)"
},
"XML._002.RepresentativeInfo": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ТипПред'",
"nullable": true
},
"representativeOrganizationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.RepresentativeOrganizationInfo"
}
],
"description": "Сведения об организации (СвОрг)\n\nСоответствующее имя элемента в XML: 'СвОрг'",
"nullable": true
},
"individualEntrepreneurInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.IndividualEntrepreneurInfo"
}
],
"description": "Сведения об индивидуальном предпринимателе (СвИПТип)\n\nСоответствующее имя элемента в XML: 'СведИП'",
"nullable": true
},
"individualInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.IndividualInfo"
}
],
"description": "Сведения о физическом лице (СведФизЛТип)\n\nСоответствующее имя элемента в XML: 'СведФизЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об уполномоченном представителе (уполномоченных представителях) (СвУпПредТип)"
},
"XML._002.RepresentativeOrganizationInfo": {
"type": "object",
"properties": {
"organizationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.OrganizationInfo"
}
],
"description": "Сведения об организации (СвОргТип)\n\nСоответствующее имя элемента в XML: 'СвОрг'",
"nullable": true
},
"individualInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.IndividualInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвФЛ'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения об организации (СвОрг)"
},
"XML._002.TransferPoa": {
"type": "object",
"properties": {
"transferPoaInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.TransferPoaInfo"
}
],
"description": "Сведения доверенности, выданной в порядке передоверия (СвДовПер)\n\nСоответствующее имя элемента в XML: 'СвДовПер'",
"nullable": true
},
"personsTransferredPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.PersonTransferredPermissions"
},
"description": "Соответствующее имя элемента в XML: 'СвЛицПередПолн'",
"nullable": true
},
"representatives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.RepresentativeInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвЛицПолучПолн'",
"nullable": true
},
"permissionsInfo": {
"type": "array",
"items": {
"$ref": "#/components/schemas/XML._002.PermissionsInfo"
},
"description": "Соответствующее имя элемента в XML: 'СвПолн'",
"nullable": true
},
"notaryCertificationInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.NotaryCertificationInfo"
}
],
"description": "Сведения о нотариальном удостоверении (СвНотУдТип)\n\nСоответствующее имя элемента в XML: 'СвНотУд'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Передоверие (Передов)"
},
"XML._002.TransferPoaInfo": {
"type": "object",
"properties": {
"originPoaInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.OriginPoaInfo"
}
],
"description": "Сведения об Основной доверенности (СвОснДовер)\n\nСоответствующее имя элемента в XML: 'СвОснДовер'",
"nullable": true
},
"parentPoaNumber": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'НомДоверN'",
"nullable": true
},
"poaInfo": {
"allOf": [
{
"$ref": "#/components/schemas/XML._002.PoaInfo"
}
],
"description": "Сведения доверенности (СвДовТип)\n\nСоответствующее имя элемента в XML: 'СвПереДовер'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения доверенности, выданной в порядке передоверия (СвДовПер)"
},
"XML._002.UnrevokableInfo": {
"type": "object",
"properties": {
"unrevokableFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ПрБезотзыв'",
"nullable": true
},
"unrevokablePoaTransferFlag": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'ПрПерБезДов'",
"nullable": true
},
"revocationConditions": {
"type": "string",
"description": "Соответствующее имя атрибута в XML: 'УслОтзыва'",
"nullable": true
},
"revocationConditionsDescription": {
"type": "string",
"description": "Соответствующее имя элемента в XML: 'ОписУслОт'",
"nullable": true
}
},
"additionalProperties": false,
"description": "Сведения о безотзывной доверенности (БезотзывТип)"
}
},
"securitySchemes": {
"X-KONTUR-APIKEY": {
"type": "apiKey",
"description": "В заголовке нужно указать ApiKey.",
"name": "X-KONTUR-APIKEY",
"in": "header"
}
}
},
"security": [
{
"X-KONTUR-APIKEY": []
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment