NAV Navbar

Введение

Настоящий документ содержит информацию, актуальную на момент его составления. ООО «ИФР» не гарантирует отсутствия ошибок в данном документе, и оставляет за собой право вносить изменения в документ без предварительного уведомления.

Никакая часть данного документа не может быть воспроизведена или передана в какой бы то ни было форме и какими бы то ни было средствами без письменного разрешения ООО «ИФР».

ООО «ИФР» не гарантирует, что программное обеспечение, для описания которого составлен настоящий документ, не содержит дефектов, будет работать в произвольно выбранных условиях и при этом удовлетворять всем требованиям, которые могут быть к нему предъявлены.

ООО «ИФР» не гарантирует работоспособность нелегально полученного программного обеспечения.

Нелегальное использование программного обеспечения и документации на него преследуется законом.

Все упомянутые в настоящем документе торговые марки, названия продуктов и фирм могут являться интеллектуальной собственностью соответствующих владельцев.

Описание

Настоящий документ является частью документации по системе «РАДАР» и содержит пример использования API подсистемы «Личный кабинет банка».

Термины и сокращения


Личный кабинет Банка

Назначение

ЛКБ предназначен для автоматизации процесса сбора, рассмотрения и согласования заявок новых клиентов – юридических лиц и индивидуальных предпринимателей на открытие расчетного счета и заключение договора на расчетно-кассовое обслуживание.

В процессе рассмотрения заявок осуществляются автоматические проверки нового клиента на основе информации из открытых источников на соответствие критериям, установленным банком, и на отсутствие «стоп факторов», препятствующих открытию счета. Предусмотрена возможность фиксации исполнителями результатов проверок, выполняемых вручную, отражения в системе решения («согласовано» / «отказ в согласовании») исполнителей, участвующих в рассмотрении заявки, фиксация фактов резервирования счета и открытия счета.

Описание API

Подсистемой ЛКБ предоставляется API позволяющее отдавать и получать информацию по клиентам и заявкам.

Протокол общения: http

ЛКБ может работать в двух режимах: boot и api

Доступ к API

Есть два способа получить доступ к API ЛКБ:

Первый - с помощью авторизации и последующей передачи cookies:

При первом запросе к серверу в ответ передается cookie JSESSION, который необходимо передавать при каждом запросе к серверу

Для получения доступа к API необходимо авторизоваться с помощью метода login

Второй - с помощью API Key:

Для получения доступа к API необходимо при выполнение каждого запроса в header-е передавать заголовок вида:

X-Authorization: ${api-key}

Где api-key - секретный ключ который можно задать через ЛКУ:

Администрирование > Системные параметры > Ключ для доступа к API

Помимо заголовка X-Authorization для выполнения методов связанных с бизнес операциями, например Закрытие заявки, Резервирование счёта, необходимо передавать заголовок который содержит ID пользователя ЛКБ:

User-LKB: ${id}

Где id - идентификатор пользователя

Список доступных пользователей в системе можно получить вызвав метод API: users > поле userId

Методы API

Базовый путь для API: /API/

Пример URL для вызова API: http://api/{api-method}

url-service - Адрес сервиса > Для примера 172.16.1.24:8080/api/

api-method - Метод API > Для примера /applications/

Полный пример: http://172.16.1.24:8080/api/applications/


Заявки

setActiveRole

Description: Установить активную роль для текущего пользователя

Метод позволяет изменить одну из доступных ролей у авторизованного пользователя

HTTP Request

***POST*** /user/role/{roleid}

Parameters

Name Located in Description Required Type
roleid path ID Роли Yes integer

Responses

Code Description
200 Роль успешно изменена
404 Пользователь не имеет роли

users

Description: Возвращает список доступных пользователей и информацию о них

Метод позволяет получить информацию о доступных пользователях и информацию о них

HTTP Request

***GET*** /user/list

Responses

Code Description
200 Информация пользователях

Response:

[
  {
    "userId": {
      "description": "ID user",
      "type": "string"
    },
    "userFio": {
      "description": "ФИО",
      "type": "string"
    },
    "employeeId": {
      "description": "ID employee",
      "type": "string"
    },
    "roleString": {
      "description": "Название активной роли",
      "type": "string"
    },
    "firstPassword": {
      "description": "Временный пароль или нет",
      "type": "boolean"
    },
    "roles": {
      "type": "array",
      "description": "Список ролей",
      "items": {
        "$ref": "#/definitions/LkbRole"
      }
    },
    "filterSettings": {
      "description": "Настройки фильрации",
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
]

userInfo

Description: Возвращает информацию о текущем пользователе

Метод позволяет получить информацию о пользователе и списка доступных для него ролей

HTTP Request

***GET*** /user/info/

Responses

Code Description
200 Информация о текущем пользователе

Response:

{
    "userId": {
        "description": "ID user",
        "type": "string"
    },
    "userFio": {
        "description": "ФИО",
        "type": "string"
    },
    "employeeId": {
        "description": "ID employee",
        "type": "string"
    },
    "roleString": {
        "description": "Название активной роли",
        "type": "string"
    },
    "firstPassword": {
        "description": "Временный пароль или нет",
        "type": "boolean"
    },
    "roles": {
        "type": "array",
        "description": "Список ролей",
        "items": {
            "$ref": "#/definitions/LkbRole"
        }
    },
    "filterSettings": {
        "description": "Настройки фильрации",
        "type": "object",
        "additionalProperties": {
            "type": "object"
        }
    }
}

signers

Description: Возвращает всех подписантов

Метод позволяет выбрать всех пользоателей ЛКБ с ролью, которая имеет отметку "Является подписантом"

HTTP Request

***GET*** /user/signer

Responses

Code Description
200 Список подписантов и информация о них

Response:

{
    "description": "Информация о пользователе",
    "type": "array",
    "items": [
        {
            "userId": {
                "description": "ID user",
                "type": "string"
            },
            "userFio": {
                "description": "ФИО",
                "type": "string"
            },
            "employeeId": {
                "description": "ID employee",
                "type": "string"
            },
            "roleString": {
                "description": "Название активной роли",
                "type": "string"
            },
            "firstPassword": {
                "description": "Временный пароль или нет",
                "type": "boolean"
            },
            "roles": {
                "type": "array",
                "description": "Список ролей",
                "items": {
                    "$ref": "#/definitions/LkbRole"
                }
            },
            "filterSettings": {
                "description": "Настройки фильтрации",
                "type": "object",
                "additionalProperties": {
                    "type": "object"
                }
            }
        }
    ]
}

takers

Description: Возвращает всех пользователей, которые могут взять заявки в работу

Метод позволяет выбрать всех пользоателей ЛКБ с ролью, которая имеет отметку "Может брать в работу"

HTTP Request

***GET*** /user/takers

Responses

Code Description
200 Список пользователей и информация о них

Response:

{
    "description": "Список информации о пользователе",
    "type": "array",
    "items": [
        {
            "userId": {
                "description": "ID user",
                "type": "string"
            },
            "userFio": {
                "description": "ФИО",
                "type": "string"
            },
            "employeeId": {
                "description": "ID employee",
                "type": "string"
            },
            "roleString": {
                "description": "Название активной роли",
                "type": "string"
            },
            "firstPassword": {
                "description": "Временный пароль или нет",
                "type": "boolean"
            },
            "roles": {
                "type": "array",
                "description": "Список ролей",
                "items": {
                    "$ref": "#/definitions/LkbRole"
                }
            },
            "filterSettings": {
                "description": "Настройки фильтрации",
                "type": "object",
                "additionalProperties": {
                    "type": "object"
                }
            }
        }
    ]
}

getApplication

Description: Получить полную информацию о заявке

Метод позволяет получить информацию по всем пунктам и разделам конкретной заявки

HTTP Request

***GET*** /application/{applicationid}/

Parameters

Name Located in Description Required Type
applicationid path ID Заявки Yes string

Responses

Code Description
200 Информация о заявке

saveFilter

Description: Сохранить информацию о фильтрах

Метод позволяет сохранить применные значения параметра фильтра, заданные конкретным пользователем ЛКБ

HTTP Request

***POST*** /application/filter

Parameters

Name Located in Description Required Type
request body Информация о фильтрах Yes object

Request:

{
    "limit": {
        "type": "integer",
        "description": "Количество записей, которые будут возвращены"
    },
    "offset": {
        "type": "integer",
        "description": "Offset"
    },
    "substring": {
        "type": "string",
        "description": "Фильтр по строке - ИНН\\Номер заявки\\Клиент"
    },
    "datefrom": {
        "type": "string",
        "description": "Фильтр по дате - from"
    },
    "dateto": {
        "type": "string",
        "description": "Фильтр по дате - to"
    },
    "closedatefrom": {
        "type": "string",
        "description": "Фильтр по дате закрытия - from"
    },
    "closedateto": {
        "type": "string",
        "description": "Фильтр по дате закрытия - to"
    },
    "annulPeriod": {
        "type": "integer",
        "description": "Фильтр по аннулированности"
    },
    "signers": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по подписантам"
    },
    "takers": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по заявкам, взятым в работу"
    },
    "offices": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по офисам"
    },
    "statusid": {
        "type": "array",
        "items": {
            "type": "integer"
        },
        "description": "Фильтр по статусам"
    },
    "work": {
        "type": "integer",
        "description": "0 - нет фильтра , 1 - взят в работу , 2 - не взят в работу"
    }
}

Responses

Code Description
200 Фильтры успешно сохранены

applicationList

Description: Получить список всех заявок для текущего пользователя

Метод позволяет получать выбранные заявки в соответствии с установленными значениями параметров фильтра

HTTP Request

***POST*** /application/

Parameters

Name Located in Description Required Type
request body Параметры для фильтрации Yes object

Request:

{
    "limit": {
        "type": "integer",
        "description": "Количество записей, которые будут возвращены"
    },
    "offset": {
        "type": "integer",
        "description": "Offset"
    },
    "substring": {
        "type": "string",
        "description": "Фильтр по строке - ИНН\\Номер заявки\\Клиент"
    },
    "datefrom": {
        "type": "string",
        "description": "Фильтр по дате - from"
    },
    "dateto": {
        "type": "string",
        "description": "Фильтр по дате - to"
    },
    "closedatefrom": {
        "type": "string",
        "description": "Фильтр по дате закрытия - from"
    },
    "closedateto": {
        "type": "string",
        "description": "Фильтр по дате закрытия - to"
    },
    "annulPeriod": {
        "type": "integer",
        "description": "Фильтр по аннулированности"
    },
    "signers": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по подписантам"
    },
    "takers": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по заявкам, взятым в работу"
    },
    "offices": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по офисам"
    },
    "statusid": {
        "type": "array",
        "items": {
            "type": "integer"
        },
        "description": "Фильтр по статусам"
    },
    "work": {
        "type": "integer",
        "description": "0 - нет фильтра , 1 - взят в работу , 2 - не взят в работу"
    }
}

Responses

Code Description
200 Список заявок

Response:

{
    "type": "array",
    "description": "Список заявок",
    "items": [
        {
            "application": {
                "description": "Заявка",
                "$ref": "#/definitions/Application"
            },
            "actions": {
                "type": "array",
                "description": "Доступные события",
                "items": {
                    "$ref": "#/definitions/ActionInfo"
                }
            },
            "infos": {
                "type": "array",
                "description": "Информация о ролях",
                "items": {
                    "$ref": "#/definitions/AppItemRoleInfo"
                }
            }
        }
    ]
}

applicationCount

Description: Получить количество доступных заявок для текущего пользователя

Метод позволяет получать количество заявок в соответствии с установленными значениями параметров фильтра

HTTP Request

***POST*** /application/count/

Parameters

Name Located in Description Required Type
request body Параметры для фильтрации Yes object

Request:

{
    "limit": {
        "type": "integer",
        "description": "Количество записей, которые будут возвращены"
    },
    "offset": {
        "type": "integer",
        "description": "Offset"
    },
    "substring": {
        "type": "string",
        "description": "Фильтр по строке - ИНН\\Номер заявки\\Клиент"
    },
    "datefrom": {
        "type": "string",
        "description": "Фильтр по дате - from"
    },
    "dateto": {
        "type": "string",
        "description": "Фильтр по дате - to"
    },
    "closedatefrom": {
        "type": "string",
        "description": "Фильтр по дате закрытия - from"
    },
    "closedateto": {
        "type": "string",
        "description": "Фильтр по дате закрытия - to"
    },
    "annulPeriod": {
        "type": "integer",
        "description": "Фильтр по аннулированности"
    },
    "signers": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по подписантам"
    },
    "takers": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по заявкам, взятым в работу"
    },
    "offices": {
        "type": "array",
        "items": {
            "type": "string"
        },
        "description": "Фильтр по офисам"
    },
    "statusid": {
        "type": "array",
        "items": {
            "type": "integer"
        },
        "description": "Фильтр по статусам"
    },
    "work": {
        "type": "integer",
        "description": "0 - нет фильтра , 1 - взят в работу , 2 - не взят в работу"
    }
}

Responses

Code Description
200 Количество заявок

Response:

{
    "count": {
        "description": "Количество",
        "type": "integer"
    }
}

nextStep

Description: Перейти на следующий статус в соответствии со статусной моделью

Метод позволяет осуществить переход заявки на следующий статус в соответствии с настроенной в ЛКУ статусной моделью

HTTP Request

***POST*** /application/{applicationid}/step/{action}

Parameters

Name Located in Description Required Type
applicationid path ID Заявки Yes string
action path ID Ветви перехода Yes string
request body Доп. значения при переходе No object

Responses

Code Description
200 Переход успешно осуществлён

applicationSignatures

Description: Возвращает список подписантов для заявки

Метод позволяет получить перечень пользователей ЛКБ, которые являются подписантами по конкретной заявке

HTTP Request

***GET*** /application/{applicationid}/signature/

Parameters

Name Located in Description Required Type
No object

Responses

Code Description
200 Список подписантов

Response:

{
    "description": "Список подписей",
    "type": "array",
    "items": [
        {
            "applicationid": {
                "description": "ID заявки",
                "type": "string"
            },
            "employeeid": {
                "description": "ID подписанта",
                "type": "string"
            },
            "datetime": {
                "description": "Время подписи",
                "type": "string"
            },
            "signed": {
                "description": "Подписан или нет",
                "type": "boolean"
            }
        }
    ]
}

reserveAccount

Description: Зарезервировать счёт

Метод позволяет зарезервировать номер расчетного счета для конкретной заявки

HTTP Request

***POST*** /application/{applicationid}/reserveaccount/

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string
account body Информация о счёте Yes object

Request:

{
    "type": {
        "description": "Тип",
        "type": "string"
    },
    "accountnumber": {
        "description": "Номер",
        "type": "string"
    },
    "openingdate": {
        "description": "Дата открытия",
        "type": "string"
    },
    "prkoproduct": {
        "description": "ПРКО продукт",
        "type": "integer"
    }
}

Responses

Code Description
200 OK

applicationStatuses

Description: Возвращает список статусов для заявки

Метод позволяет получить список статусов по которым прошла конкретная заявка

HTTP Request

***GET*** /application/{applicationid}/status/

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string

Responses

Code Description
200 Список статусов

Response:

{
    "description": "Список статусов",
    "type": "array",
    "items": [
        {
            "id": {
                "description": "ID",
                "type": "integer"
            },
            "code": {
                "description": "Код",
                "type": "string"
            },
            "name": {
                "description": "Наименование",
                "type": "string"
            },
            "info": {
                "description": "Доп. информация",
                "type": "string"
            }
        }
    ]
}

createDocRequirement

Description: Запросить доп. документ

Метод позволяет осуществить запрос дополнительного документа для конкретной заявки

HTTP Request

***POST*** /application/{applicationid}/docrequirement/

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string
requirement body Информация о запросе Yes object

Request:

{
    "req": {
        "$ref": "#/definitions/AppDocRequirement"
    }
}

Responses

Code Description
200 Запрос доп. документа успешно создан

generateBankForm

Description: Сгенерировать формы банка

Метод позволяет запустить автоматический процесс генерации печатных форм

HTTP Request

***POST*** /application/{applicationid}/generatebankform

Parameters

Name Located in Description Required Type
No object

Responses

Code Description
200 Формы банка успешно сгенерированы

takeToWork

Description: Взять заявку в работу для текущего пользователя

Метод позволяет закрепить заявку за конкретным пользователем ЛКБ

HTTP Request

***GET*** /application/{applicationid}/work

Parameters

Name Located in Description Required Type
No object

Responses

Code Description
200 Заявка успешно взята в работу

removeFromWork

Description: Открепитья заявку от пользователя

Метод позволяет открепить ранее взятую в работу заявку от конкретного пользователя ЛКБ

HTTP Request

***DELETE*** /application/{applicationid}/work

Parameters

Name Located in Description Required Type
No object

Responses

Code Description
200 Заявка успешно откреплена

statusCount

Description: Получить список статусов с их количеством

Метод позволяет получить список статусов с указанием количества заявок в этом статусе

HTTP Request

***GET*** /application/statuscount/

Responses

Code Description
200 Список статусов

changeLifeDate

Description: Изменить время жизни заявки

Метод позволяет изменить дату окончания срока жизни заявки

HTTP Request

***POST*** /application/{applicationid}/lifedate/{date}

Parameters

Name Located in Description Required Type
No object
date path Дата жизни заявки (ISO 8601) Yes string

Responses

Code Description
200 Срок жизни заявки успешно изменен

activeDeclarations

Description: Получить список активных заявок агента

HTTP Request

***GET*** /declaration/active

Parameters

Name Located in Description Required Type
searchStr query Фильтр для поиска по строке No string
product query Фильтр по продукту No integer

Responses

Code Description
200 Список заявок агента

Response:

{
    "description": "Список заявок агентов",
    "type": "array",
    "items": [
        {
            "id": {
                "description": "ID",
                "type": "string"
            },
            "orgnameshort": {
                "description": "Сокращенное название компании",
                "type": "string"
            },
            "fictive": {
                "description": "Фиктивный или нет",
                "type": "boolean"
            },
            "number": {
                "description": "Номер",
                "type": "string"
            },
            "product": {
                "description": "Продукт",
                "type": "object",
                "$ref": "#/definitions/Product"
            },
            "createdate": {
                "description": "Дата создания",
                "type": "string"
            },
            "paymentdate": {
                "description": "Дата оплаты",
                "type": "string"
            },
            "accountOpeningDate": {
                "description": "Дата открытия счёта",
                "type": "string"
            },
            "client": {
                "description": "Клиент",
                "type": "object",
                "$ref": "#/definitions/Client"
            },
            "inn": {
                "description": "ИНН",
                "type": "string"
            },
            "contactPerson": {
                "description": "Контактное лицо",
                "type": "string"
            },
            "contactPhone": {
                "description": "Контактный телефон",
                "type": "string"
            },
            "contactEmail": {
                "description": "Контактный email",
                "type": "string"
            },
            "agent": {
                "description": "Агент",
                "type": "object",
                "$ref": "#/definitions/Agent"
            },
            "paidamount": {
                "description": "Сумма оплаты",
                "type": "string"
            },
            "bank": {
                "description": "Банк",
                "type": "object",
                "$ref": "#/definitions/Bank"
            },
            "actualStatus": {
                "description": "Статус",
                "type": "object",
                "$ref": "#/definitions/Status"
            },
            "appcreatedate": {
                "description": "Дата создания",
                "type": "string"
            },
            "documents": {
                "description": "Список документов",
                "type": "object",
                "additionalProperties": {
                    "type": "object",
                    "properties": {
                        "type": {
                            "description": "Тип",
                            "type": "string"
                        },
                        "documents": {
                            "description": "Документы",
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/Document"
                            }
                        }
                    }
                }
            }
        }
    ]
}

getDeclaration

Description: Получить заявку агента по ID

HTTP Request

***GET*** /declaration/info/{id}

Parameters

Name Located in Description Required Type
id path ID заявки Yes string

Responses

Code Description
200 Заявка агента

Response:

{
    "id": {
        "description": "ID",
        "type": "string"
    },
    "orgnameshort": {
        "description": "Сокращенное название компании",
        "type": "string"
    },
    "fictive": {
        "description": "Фиктивный или нет",
        "type": "boolean"
    },
    "number": {
        "description": "Номер",
        "type": "string"
    },
    "product": {
        "description": "Продукт",
        "type": "object",
        "$ref": "#/definitions/Product"
    },
    "createdate": {
        "description": "Дата создания",
        "type": "string"
    },
    "paymentdate": {
        "description": "Дата оплаты",
        "type": "string"
    },
    "accountOpeningDate": {
        "description": "Дата открытия счёта",
        "type": "string"
    },
    "client": {
        "description": "Клиент",
        "type": "object",
        "$ref": "#/definitions/Client"
    },
    "inn": {
        "description": "ИНН",
        "type": "string"
    },
    "contactPerson": {
        "description": "Контактное лицо",
        "type": "string"
    },
    "contactPhone": {
        "description": "Контактный телефон",
        "type": "string"
    },
    "contactEmail": {
        "description": "Контактный email",
        "type": "string"
    },
    "agent": {
        "description": "Агент",
        "type": "object",
        "$ref": "#/definitions/Agent"
    },
    "paidamount": {
        "description": "Сумма оплаты",
        "type": "string"
    },
    "bank": {
        "description": "Банк",
        "type": "object",
        "$ref": "#/definitions/Bank"
    },
    "actualStatus": {
        "description": "Статус",
        "type": "object",
        "$ref": "#/definitions/Status"
    },
    "appcreatedate": {
        "description": "Дата создания",
        "type": "string"
    },
    "documents": {
        "description": "Список документов",
        "type": "object",
        "additionalProperties": {
            "type": "object",
            "properties": {
                "type": {
                    "description": "Тип",
                    "type": "string"
                },
                "documents": {
                    "description": "Документы",
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Document"
                    }
                }
            }
        }
    }
}

modifyDeclaration

Description: Изменить заявку агента

HTTP Request

***PATCH*** /declaration/modify/{id}

Parameters

Name Located in Description Required Type
id path ID заявки Yes string
request body Информация об изменениях Yes object

Request:

{
    "appcreate": {
        "description": "Дата создания",
        "type": "string"
    },
    "appopendate": {
        "description": "Дата открытия",
        "type": "string"
    },
    "selectedStatus": {
        "description": "Выбранный статус",
        "type": "integer"
    },
    "paymentsum": {
        "description": "Сумма оплаты",
        "type": "string"
    },
    "paymentdate": {
        "description": "Дата оплаты",
        "type": "string"
    },
    "declaration_is_closed": {
        "description": "Закрыта или нет",
        "type": "boolean"
    }
}

Responses

Code Description
200 Изменения успешно внесены

createAgentAct

Description: Создать акт для агента

HTTP Request

***POST*** /act/{agent}/{product}/{paymentSum}/{period}/{paymentdate}

Parameters

Name Located in Description Required Type
agent path ID агента Yes string
product path ID продукта Yes integer
paymentSum path Сумма оплаты Yes string
period path Период Yes string
paymentdate path Дата оплаты Yes string
data formData Доп. файл No file

Responses

Code Description
200 Акт успешно создан

agents

Description: Получить список агентов

HTTP Request

***GET*** /agent

Responses

Code Description
200 Список агентов

Response:

{
    "type": "array",
    "description": "Список агентов",
    "items": [
        {
            "id": {
                "type": "string",
                "description": "ID"
            },
            "fio": {
                "type": "string",
                "description": "ФИО"
            },
            "login": {
                "description": "Login",
                "type": "string"
            }
        }
    ]
}

products

Description: Получить список продуктов

HTTP Request

***GET*** /product

Responses

Code Description
200 Список продуктов

Response:

{
    "description": "Список продуктов",
    "type": "array",
    "items": [
        {
            "id": {
                "description": "ID",
                "type": "integer"
            },
            "name": {
                "description": "Наименование",
                "type": "string"
            }
        }
    ]
}

prkoProducts

Description: Получить список продуктов по РКО

HTTP Request

***GET*** /product/prko

Responses

Code Description
200 Список продуктов

Response:

{
    "description": "Список ПРКО продуктов",
    "type": "array",
    "items": [
        {
            "id": {
                "description": "ID",
                "type": "integer"
            },
            "name": {
                "description": "Наименование",
                "type": "string"
            }
        }
    ]
}

statusList

Description: Получить доступный список статусов

HTTP Request

***GET*** /status

Responses

Code Description
200 Список статусов

Response:

{
    "description": "Список статусов",
    "type": "array",
    "items": [
        {
            "id": {
                "description": "ID",
                "type": "integer"
            },
            "code": {
                "description": "Код",
                "type": "string"
            },
            "name": {
                "description": "Наименование",
                "type": "string"
            },
            "info": {
                "description": "Доп. информация",
                "type": "string"
            }
        }
    ]
}

actList

Description: Получить список актов

HTTP Request

***GET*** /acts

Parameters

Name Located in Description Required Type
agentid query Фильтр по ID агента No string
productid query Фильтр по ID продукта No integer

Responses

Code Description
200 Список актов

Response:

{
    "type": "array",
    "description": "Список актов",
    "items": [
        {
            "number": {
                "description": "Номер",
                "type": "string"
            },
            "agent": {
                "description": "Агент",
                "type": "object",
                "$ref": "#/definitions/Agent"
            },
            "period": {
                "description": "Период",
                "type": "string"
            },
            "product": {
                "description": "Продукт",
                "type": "object",
                "$ref": "#/definitions/Product"
            },
            "paymentsum": {
                "description": "Сумма",
                "type": "string"
            },
            "paymentdate": {
                "description": "Дата оплаты",
                "type": "string"
            },
            "binaryuuid": {
                "description": "ID документа",
                "type": "string"
            }
        }
    ]
}

Документы

setVerify

Description: Получить значение результата проверки документа

Метод позволяет получить результат проверки документа, загруженного в заявку пользователем ЛКК

HTTP Request

***POST*** /application/{applicationid}/doc/{docid}/verify

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string
docid path ID документа Yes string
check body Информация о результате проверки Yes object

Request:

{
    "result": {
        "description": "Результат",
        "type": "boolean"
    },
    "comment": {
        "description": "Комментарий",
        "type": "string"
    }
}

Responses

Code Description
200 Результат успешно добавлен

Description: Получить значение результата проверки документа

Метод позволяет получить результат проверки документа, загруженного в заявку пользователем ЛКК

HTTP Request

***POST*** /application/{applicationid}/doc/{docid}/verify

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string
docid path ID документа Yes string
check body Информация о результате проверки Yes object

Request:

{
    "result": {
        "description": "Результат",
        "type": "boolean"
    },
    "comment": {
        "description": "Комментарий",
        "type": "string"
    }
}

Responses

Code Description
200 Результат успешно добавлен

deleteAppDoc

Description: Удалить документ из заявки

HTTP Request

***DELETE*** /application/{applicationid}/doc/{docid}

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string
docid path ID документа Yes string

Responses

Code Description
200 Документ успешно удален

getClientDocuments

Description: Получить документы, загруженные пользователем в ЛКК

Метод позволяет получить документы, загруженные пользователем ЛКК

HTTP Request

***GET*** /application/{applicationid}/clientdocs

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string

Responses

Code Description
200 Список документов клиента

Response:

{
    "type": "array",
    "description": "Список документов с типами",
    "items": [
        {
            "name": {
                "description": "Название",
                "type": "string"
            },
            "id": {
                "description": "ID",
                "type": "integer"
            },
            "extraid": {
                "description": "Дополнительный ID типа документа",
                "type": "string"
            },
            "docs": {
                "description": "Список документов",
                "type": "array",
                "items": {
                    "$ref": "#/definitions/AppDocument"
                }
            }
        }
    ]
}

download

Description: Скачать документ

Метод позволяет скачивать документы, загруженные пользователем ЛКК

HTTP Request

***GET*** /binary/{documentid}

Parameters

Name Located in Description Required Type
documentid path ID документа Yes string

Responses

Code Description
200 Скачивание документа

getFieldDocuments

Description: Получить документы, загруженные пользователями ЛКБ

Метод позволят получить документы, загруженные в заявку пользователем ЛКБ

HTTP Request

***GET*** /application/{applicationid}/fielddocs

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string

Responses

Code Description
200 Список документов

Response:

{
    "type": "array",
    "description": "Список документов с типами",
    "items": [
        {
            "name": {
                "description": "Название",
                "type": "string"
            },
            "id": {
                "description": "ID",
                "type": "integer"
            },
            "docs": {
                "description": "Список документов",
                "type": "array",
                "items": {
                    "$ref": "#/definitions/AppDocument"
                }
            }
        }
    ]
}

recalled

Description: Отозвать запрос доп. документа

Метод позволяет отозвать запрошенный дополнительный документ пользователем ЛКБ

HTTP Request

***POST*** /application/{applicationid}/doc/recalled

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string
req body Запрос на отзыв доп. документа Yes object

Request:

{
    "ids": {
        "description": "Список ID доп. документов",
        "type": "array",
        "items": {
            "type": "string"
        }
    }
}

Responses

Code Description
200 Запросы доп. документы успешно отозваны
409 Один из запросов доп. документов был выполнен, запрос на отзыв не исполнен

fieldDocumentTypes

Description: Получить список типов документов для загрузки в заявку

Метод позволяет получить перечень доступных типов документов для загрузки в заявку пользователем ЛКБ

HTTP Request

***GET*** /info/fielddocumenttypes/{id}

Parameters

Name Located in Description Required Type
id path ID Заявки Yes string

Responses

Code Description
200 Список типов документов

Response:

{
    "type": "array",
    "description": "Список типов документов",
    "items": [
        {
            "id": {
                "description": "ID",
                "type": "integer"
            },
            "legalentitytype": {
                "description": "Тип лица",
                "type": "string"
            },
            "name": {
                "description": "Наименование",
                "type": "string"
            },
            "description": {
                "description": "Описание",
                "type": "string"
            }
        }
    ]
}

uploadSysFile

Description: Загрузить документ

Метод позволяет загрузить документ в заявку пользователем ЛКБ

HTTP Request

***POST*** /binary/{applicationid}/{doctype}/{docle}

applicationid - id заявки

doctype - типа документа, можно получить из fieldDocumentTypes, поле [id]

docle - тип юридического лица, можно получить из fieldDocumentTypes, поле [legalentitytype]

Parameters

Form Data
upFile: (file)

Responses

Code Description
200 Загрузка документов

Response:

{
  "id": "37d94667-c3c9-4aca-9a12-fc2383024b0e",//id документа
  "name": "qwerty.jpg",//наименование документа
  "mimetype": "image/jpeg",//MIME-тип файла
  "documentType": {
    "id": {
      "id": 79,//id типа документа
      "type": "LEGAL_ENTITY"// Тип юридического лица
    },
    "name": "Учредительные документы 111",//Название типа документа
    "description": "Последняя действующая редакция Устава с отметкой налоговой о регистрации (копия, заверенная регистрирующим органом(оригинал) или нотариально заверенная копия) 222",//Описание
    "showable": true,//Документ видимый в системе
    "required": true,
    "lka": true,
    "lkv": true,
    "deleted": false,//Документ удален
    "extraid": "124",
    "fileCount": 2,//Количество файлов, 0 или NULL - без лимита
    "fileCountLkb": 0,//Максимальное количество загружаемых файлов в ЛКБ за одну загрузку
    "allowFileTypeLkk": "pdf,jpeg,jpg,bmp,png,gif,doc,docx,xls,xlsx,tiff,tif",//Допустимые типы файлов для загрузки в ЛКК
    "allowFileTypeLkb": "pdf,jpeg,jpg,bmp,png,gif,doc,docx,xls,xlsx,tiff,tif",//Допустимые типы файлов для загрузки в ЛКБ
    "maxFileSize": 10,//Максимальный размер загружаемого файла значение в МБ
    "orderNum": 0,//Порядковый номер для сортировки в ЛКУ
    "subType": "LKK_APP_CLIENT",//Подтип (e.g. Форма банка, Клиентские документы )
    "hibernateLazyInitializer": {}
  },
  "createDate": "2020-05-06T11:28:33.227",//Дата создания
  "size": 63452 //Размер документа в Кб
}

Анкета

getQuestionnaire

Description: Получить анкету клиента

Метод позволяет получить значения полей из анкеты опросного листа

HTTP Request

***GET*** /application/{id}/questionnaire/

Parameters

Name Located in Description Required Type
No object

Responses

Code Description
200 JSON анкеты

updateQuestionnaire

Description: Обновить анкету клиента

Метод позволяет внести изменения в значения полей анкеты опросного листа

HTTP Request

***POST*** /application/{id}/questionnaire/

Parameters

Name Located in Description Required Type
No object
form body JSON анкеты Yes object

Responses

Code Description
200 Анкета успешно обновлена

Проверки

setResult

Description: Установить результат проверки

Метод позволяет установить результат ручной проверки для конкретной проверки

HTTP Request

***POST*** /check/{applicationid}/{executetime}/{checktype}/result

Parameters

Name Located in Description Required Type
No object
No object
No object
result body Информация о проверке Yes object

Request:

{
    "result": {
        "description": "Значение результата",
        "type": "string"
    },
    "id": {
        "description": "ID проверки",
        "type": "string"
    }
}

Responses

Code Description
200 Проверка успешно обновлена

addComment

Description: Добавить комментарий к проверке

Метод позволяет добавить комментарий по конкретной проверке в выбранной заявке

HTTP Request

***POST*** /check/{abstractid}/{executetime}/{checktype}/comment

Parameters

Name Located in Description Required Type
No object
No object
No object
comment body Комментарий Yes object

Request:

{
    "content": {
        "description": "Значение комментария",
        "type": "string"
    }
}

Responses

Code Description
200 Комментарий успешно добавлен

generateReport

Description: Сгенерировать отчёт по проверкам

Метод позволяет запустить автоматическое формирование журнала проверок для выбранной заявки

HTTP Request

***GET*** /check/{abstractid}/{executetime}/{checkobjecttype}/report

Parameters

Name Located in Description Required Type
No object
No object
No object

Responses

Code Description
200 XLSX файл

recheckApplication

Description: Перезапустить проверки для заявки

Метод позволяет запустить процесс обновление результата автоматических проверок

HTTP Request

***POST*** /application/{applicationid}/recheck/

Parameters

Name Located in Description Required Type
applicationid path ID заявки Yes string
recheckPost body Доп. информация для перепроверки Yes object

Request:

{
    "id": {
        "description": "ID",
        "type": "string"
    },
    "type": {
        "description": "Тип",
        "type": "string"
    }
}

Responses

Code Description
200 Проверки успешно обновлены

Клиент

clientReports

Description: Получить список всех клиентов

Метод позволяет получить перечень клиентов, которые в процессе регистрации указали номер телефона

HTTP Request

***POST*** /client/report

Parameters

Name Located in Description Required Type
filter body Фильтр с параметрами No object

Request:

{
    "inn": {
        "description": "ИНН",
        "type": "string"
    },
    "inputPhone": {
        "description": "Дата ввода телефона",
        "type": "string"
    },
    "size": {
        "description": "Размер (limit)",
        "type": "integer"
    },
    "page": {
        "description": "Страница (offset)",
        "type": "integer"
    },
    "clientWithoutApp": {
        "description": "Есть ли у клиента заявки",
        "type": "boolean"
    }
}

Responses

Code Description
200 Список клиентов
500 Internal error

Response:

{
    "type": "array",
    "description": "Список клиентов",
    "items": [
        {
            "id": {
                "description": "ID",
                "type": "string"
            },
            "fio": {
                "description": "ФИО",
                "type": "string"
            },
            "phone": {
                "description": "Телефон",
                "type": "string"
            },
            "email": {
                "description": "email",
                "type": "string"
            },
            "inns": {
                "description": "Список заявок с ИНН",
                "type": "array",
                "items": {
                    "type": "string"
                }
            },
            "inputPhone": {
                "description": "Дата ввода телефона",
                "type": "string"
            },
            "sentSms": {
                "description": "Дата отправки смс",
                "type": "string"
            },
            "confirmedPhone": {
                "description": "Дата подтверждения телефона",
                "type": "string"
            },
            "registered": {
                "description": "Дата регистрации",
                "type": "string"
            },
            "lastLogin": {
                "description": "Дата последнего логина",
                "type": "string"
            }
        }
    ]
}

clientReportCount

Description: Получить количество клиентов

Метод позволяет получить количество клиентов, которые в процессе регистрации указали номер телефона

HTTP Request

***POST*** /client/report/count

Parameters

Name Located in Description Required Type
filter body Фильтр с параметрами No object

Request:

{
    "inn": {
        "description": "ИНН",
        "type": "string"
    },
    "inputPhone": {
        "description": "Дата ввода телефона",
        "type": "string"
    },
    "size": {
        "description": "Размер (limit)",
        "type": "integer"
    },
    "page": {
        "description": "Страница (offset)",
        "type": "integer"
    },
    "clientWithoutApp": {
        "description": "Есть ли у клиента заявки",
        "type": "boolean"
    }
}

Responses

Code Description
200 Количество клиентов

Response:

{
    "count": {
        "description": "Значение",
        "type": "integer"
    }
}

getClients

Description: Возвращает список всех клиентов

Метод позволяет получить перечень клиентов, которые в процессе регистрации указали номер телефона

HTTP Request

***GET*** /clients

Responses

Code Description
200 OK

Response:

{
    "type": "array",
    "items": [
        {
            "id": {
                "type": "string"
            },
            "contactfio": {
                "type": "string"
            },
            "phone": {
                "type": "string"
            },
            "email": {
                "type": "string"
            },
            "number": {
                "type": "string"
            },
            "type": {
                "type": "string"
            },
            "inn": {
                "type": "string"
            },
            "kpp": {
                "type": "string"
            },
            "individual": {
                "type": "object"
            },
            "legalentity": {
                "type": "object"
            }
        }
    ]
}

getClient

Description: Возвращает информацию о клиенте по ID

HTTP Request

***GET*** /client/{clientId}

Parameters

Name Located in Description Required Type
No object

Responses

Code Description
200 OK

Response:

{
    "id": {
        "type": "string"
    },
    "contactfio": {
        "type": "string"
    },
    "phone": {
        "type": "string"
    },
    "email": {
        "type": "string"
    },
    "number": {
        "type": "string"
    },
    "type": {
        "type": "string"
    },
    "inn": {
        "type": "string"
    },
    "kpp": {
        "type": "string"
    },
    "individual": {
        "type": "object"
    },
    "legalentity": {
        "type": "object"
    }
}

UI

Description: Получить логотип

Метод позволяет получить логотип, отображаемый при входе в ЛКБ

HTTP Request

***GET*** /logo/login

Responses

Code Description
200 Файл логотипа

Description: Получить логотип верхнего меню

Метод позволяет получить логотип, отображаемый в верхнем меню ЛКБ

HTTP Request

***GET*** /logo/system

Responses

Code Description
200 Файл логотипа

getFavicon

Description: Получить фавикон

Метод позволяет получить фавикон, отображаемый в названии окна браузера ЛКБ

HTTP Request

***GET*** /logo/favicon

Responses

Code Description
200 Файл фавикона

getSystemColors

Description: Получить настройки цветов

Метод позволяет получить список настроенных цветов

HTTP Request

***GET*** /system/color

Responses

Code Description
200 Список цветов

Авторизация

login

Description: Авторизация в системе

Метод позволяет пользователю получить доступ к системе

HTTP Request

***POST*** /login

Parameters

Name Located in Description Required Type
username formData Имя пользователя Yes string
password formData Пароль пользователя Yes string

Responses

Code Description
200 Пользователь успешно авторизован

logout

Description: Выйти из системы

Метод позволяет пользователю осуществить выход из системы

HTTP Request

***GET*** /logout

Responses

Code Description
200 Пользователь успешно вышел из системы

Файлы

deleteObject

Description: Удалить файл по ID

HTTP Request

***DELETE*** /binary/{id}

Parameters

Name Located in Description Required Type
id path ID файла Yes string

Responses

Code Description
200 Файл успешно удален
404 Файл не найден

updateObject

Description: Обновить файл по ID

HTTP Request

***PATCH*** /binary/{id}

Parameters

Name Located in Description Required Type
id path ID файла Yes string
upFile formData Файл Yes file

Responses

Code Description
200 Информация о новом файле
404 Файл не найден

Response:

{
    "id": {
        "description": "ID",
        "type": "string"
    },
    "name": {
        "description": "Наименование",
        "type": "string"
    },
    "mimetype": {
        "description": "Тип",
        "type": "string"
    }
}

createObject

Description: Добавить файл в систему

HTTP Request

***POST*** /binary/

Parameters

Name Located in Description Required Type
upFile formData Файл Yes file

Responses

Code Description
200 Информация о файле

Response:

{
    "id": {
        "description": "ID",
        "type": "string"
    },
    "name": {
        "description": "Наименование",
        "type": "string"
    },
    "mimetype": {
        "description": "Тип",
        "type": "string"
    }
}

Системное

updateLkbUserPassword

Description: Обновить пароль пользователя

Метод позволяет установить новый пароль для пользователя ЛКБ

HTTP Request

***POST*** /lkbuser/firstlogin

Parameters

Name Located in Description Required Type
request body Новый пароль пользователя No object

Request:

{
    "userid": {
        "description": "ID",
        "type": "string"
    },
    "value": {
        "description": "Значение",
        "type": "string"
    }
}

Responses

Code Description
200 Пароль успешно обновлен

getSystemEnvironmentInfoForLoginPage

Description: Получить переменные окружения

Метод позволяет получить текущее значение полей ЛКУ в разделе "Интернационализация"

HTTP Request

***GET*** /info/systeminfologin

Responses

Code Description
200 Список переменных

Response:

{
    "i18n": {
        "description": "Интернационализация",
        "$ref": "#/definitions/I18NStrings"
    },
    "version": {
        "description": "Версия",
        "$ref": "#/definitions/SysVersion"
    }
}

version

Description: Получить текущую версию системы

Метод позволяет получить значение текущей версии системы

HTTP Request

***GET*** /info/version

Responses

Code Description
200 Версия системы

Response:

{
    "version": {
        "description": "Значение",
        "type": "string"
    }
}

recognizePassport

Description: Распознать паспорт

Данный метод не используется

HTTP Request

***POST*** /passport/recognize

Parameters

Name Located in Description Required Type
file formData Файл с изображением паспорта No file

Responses

Code Description
200 Результат распознавания

Response:

{
    "ourResult": {
        "description": "Результат проверки",
        "$ref": "#/definitions/Passport"
    },
    "sdkResult": {
        "description": "Результат проверки",
        "$ref": "#/definitions/Passport"
    },
    "message": {
        "description": "Сообщение",
        "type": "string"
    }
}

environment

Description: Получить переменные окружения

Метод позволяет получить перечень информации для основной страницы ЛКБ

HTTP Request

***GET*** /info/systeminfo

Responses

Code Description
200 Информация о переменных

Response:

{
    "signingRoles": {
        "description": "Список ролей",
        "type": "array",
        "items": {
            "$ref": "#/definitions/LkbRole"
        }
    },
    "flags": {
        "description": "Флаги",
        "$ref": "#/definitions/SysFlags"
    },
    "parameters": {
        "description": "Параметры",
        "$ref": "#/definitions/SysParameters"
    },
    "i18n": {
        "description": "Интернационализация",
        "$ref": "#/definitions/I18NStrings"
    }
}

getSwaggerFile

Description: Получить swagger файл по названию

HTTP Request

***GET*** /swagger/{swaggerFile}

Parameters

Name Located in Description Required Type
No object

Responses

Code Description
200 Файл

Коды ошибок

Код Значение
400 Bad Request -- Невалидный запрос
401 Unauthorized -- Необходимо авторизоваться
403 Forbidden -- Недостаточно прав
404 Not Found -- Ресурс не найден (страница, обьект)
405 Method Not Allowed -- Метод не поддерживается
406 Not Acceptable -- Неправильный формат запроса
429 Too Many Requests -- Слишком много запросов
500 Internal Server Error -- Внутренняя ошибка
503 Service Unavailable -- Сервер недоступен

Интеграция РАДАР и АБС банка

Общий алгоритм работы РАДАР с АБС банка по API выглядит следующим образом:

1. Первый шаг клиента ('InitialCheck'). Клиент ввел свой ИНН, РАДАР запускает автоматическую проверку. Система вызывает API банка для проверки клиента по ИНН. В случае успешной проверки клиент переходит на второй шаг. Если возникла ошибка, то: a. Если в настройках РАДАР включен автоотказ: то анкета автоматически аннулируется. b. если в настройках РАДАР не включен автоотказ, то ошибка игнорируется, и клиент переходит на второй шаг.

2. Второй шаг клиента ('NewClient'). Клиент вводит детальную информацию, загружает необходимые документы. В интерфейсе системы РАДАР сотрудники банка выполняют необходимые согласования. Все готово для резервирования счета. Система РАДАР вызывает API банка по резервированию счета. Если вызов успешен, то РАДАР отдает клиенту информацию о зарезервированном счете, и клиент переходит на третий шаг. Если возникает ошибка, то счет не резервируется, и в историю заявки в ЛКБ, вносится соответствующая запись (ошибка АБС), счет можно будет зарезервировать только в ручном режиме в интерфейсе РАДАР.

3. Третий шаг клиента ('OpenAccount'). Клиент работает с сотрудниками банка, в РАДАР выполняются необходимые действия по согласованию документов. Счет зарезервирован и все готово для открытия счета. Сотрудник банка, в ЛКБ нажимает кнопку «Открыть счет», Радар вызывает API банка для открытия счета. В случае успеха АБС по API РАДАР загружает все необходимые документы в системы Банка. Если вызов вернул ошибку, то заявка остаётся на том же статусе, и в историю заявки вносится соответствующая запись «ошибка АБС». В этом случае открыть счет можно только вне системы РАДАР.

4. Удаление заявки ('DeleteClient'). Если клиент или сотрудник банка удаляет заявку, РАДАР вызывает соответствующее API банка. После этого клиент может зарегистрировать заявку повторно.

Проверки по внутренним спискам банка

Description: Интеграция системы РАДАР с внутренними списками Банка для проверки организации

Динамические поля, настраиваются в личном кабинете администратора

Значение Описание
https://service/send-request URL для отправки на внешний сервис
answerPermit Ключ успешного результата
PERMIT Значение для ключа успешного результата
answerError Ключ результата с ошибкой
ERROR Значение для ключа результата с ошибкой
comment Ключ комментария

HTTPS Request

***POST*** https://service/send-request

Key Description Type
_input_type InitialCheck - тип запроса. Есть 4 типа запросов: Проверка - 'InitialCheck', Резервирование счета - 'NewClient', Открытие счета - 'OpenAccount', Удаление - 'DeleteClient'. String
inn ИНН организации String
orgnameFull Полное название организации String

Request:

{
  "_input_type": "InitialCheck",
  "inn": "9715316168",
  "orgnameFull": "Общество с Ограниченной Ответственностью \"Инновационные Финансовые Решения\""
}

Description: Структура, заполненная текущими значениями, ожидает результат следущего вида:

Responses

Code Description
200 Результат проверки клиента по внутренним спискам

Fields

Key Description Type
'_rc' Статус выполнения проверки заявки клиента из АБС String
'_client_id' Уникальный идентификатор заявки клиента АБС банка Integer
'_comment' Сообщение о результате выполнения сервиса String
'_notes4staff' Описание ошибок Object

Response:

{
  "_rc": "1  - success; -1  - error", 
  "_comment": "Проверка завершилась с ошибкой",
  "_client_id": 843687,
  "_notes4staff": [
    {
      "Тип Проверки": "Проверка на терроризм/экстремизм",
      "Прошла": 1,
      "Сообщение": "ОК"
    },
    {
      "Тип Проверки": "Наличие информации о судебных разбирательствах о взыскании задолженности на сумму более 10 млн руб. (арбитражи)",
      "Прошла": 1,
      "Сообщение": "ОК"
    },
    {
      "Тип Проверки": "Присутствие организации по своему местонахождению (отличие фактического адреса от юридического адреса)",
      "Прошла": 1,
      "Сообщение": "ОК"
    },
    {
      "Тип Проверки": "Возраст единственного учредителя / участника / руководителя в критической зоне ",
      "Прошла": 0,
      "Сообщение": "Внимание! клиент в критической зоне "
    },
    {
      "Тип Проверки": "Организация в негативных списках",
      "Прошла": 1,
      "Сообщение": "ОК"
    },
    {
      "Тип Проверки": "Наличие задолженности по уплате налогов",
      "Прошла": 0,
      "Сообщение": "Внимание! у клиента имеется задолженность"
    },
    {
      "... etc"
    }

  ]
}

Резервирование номера расчётного счета

Description: Интеграция системы РАДАР со внешними сервисами, в том числе АБС, для получения номера зарезервированого счета

HTTPS Request

***POST*** /api/reservationInvoice

Parameters

Key Description Type
applicationId ID заявки в системе Радар String
_input_type тип запроса. Есть 4 типа запросов: (Проверки - 'InitialCheck', Резервирование счета - 'NewClient', Открытие счета - 'OpenAccount', Удаление - 'DeleteClient'. String
regAddress Адрес организации (в разных форматах) Object
regActualAddress Фактический адрес организации (в разных форматах) Object
regDate Дата создание заявки String
orgnameShort Сокращенное название организации String
orgnameFull Полное название организации String
inn ИНН организации String
branch офис, выбранный клиентом в системе Радар String
kpp КПП организации String
ogrn ОГРН организации String
okpo ОКПО организации String
okved Список ОКВЕДов организации Object
bankForm анкета клиента, заполенная в системе Радар Object

Request:

{
  "applicationId": "590ebbb9-a34b-47ed-8e57-c3c1b0c97eed",
  "_input_type": "NewClient",
  "number": null,
  "regAddress": {
    "value": "ООО \"ИФР\"",
    "unrestricted_value": "ООО \"ИФР\"",
    "data": {
      "inn": "9715316168",
      "name": {
        "full_with_opf": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"ИННОВАЦИОННЫЕ ФИНАНСОВЫЕ РЕШЕНИЯ\"",
        "short_with_opf": "ООО \"ИФР\""
      },
      "address": {
        "value": "123298, ГОРОД МОСКВА, УЛИЦА НАРОДНОГО ОПОЛЧЕНИЯ, ДОМ 38, КОРПУС 3, ЭТ 5 ПОМ 22",
        "unrestricted_value": "123298, ГОРОД МОСКВА, УЛИЦА НАРОДНОГО ОПОЛЧЕНИЯ, ДОМ 38, КОРПУС 3, ЭТ 5 ПОМ 22",
        "data": {
          "value": null,
          "postal_code": "123298",
          "country": "Россия",
          "region_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
          "region_kladr_id": "7700000000000",
          "region_with_type": "г Москва",
          "region_type": "г",
          "region_type_full": "город",
          "region": "Москва",
          "area_fias_id": null,
          "area_kladr_id": null,
          "area_with_type": null,
          "area_type": null,
          "area_type_full": null,
          "area": null,
          "city_fias_id": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
          "city_kladr_id": "7700000000000",
          "city_with_type": "г Москва",
          "city_type": "г",
          "city_type_full": "город",
          "city": "Москва",
          "city_area": "Северо-западный",
          "city_district_fias_id": null,
          "city_district_kladr_id": null,
          "city_district_with_type": "р-н Щукино",
          "city_district_type": "р-н",
          "city_district_type_full": "район",
          "city_district": "Щукино",
          "settlement_fias_id": null,
          "settlement_kladr_id": null,
          "settlement_with_type": null,
          "settlement_type": null,
          "settlement_type_full": null,
          "settlement": null,
          "street_fias_id": "7722f381-d4f1-4e6c-b5da-5046bb736643",
          "street_kladr_id": "77000000000195700",
          "street_with_type": "ул Народного Ополчения",
          "street_type": "ул",
          "street_type_full": "улица",
          "street": "Народного Ополчения",
          "house_fias_id": "a8496dd3-fa6a-412d-98b3-0637cecff857",
          "house_kladr_id": "7700000000019570061",
          "house_type": "д",
          "house_type_full": "дом",
          "house": "38",
          "block_type": "к",
          "block_type_full": "корпус",
          "block": "3",
          "flat_type": null,
          "flat_type_full": null,
          "flat": null,
          "flat_area": null,
          "square_meter_price": null,
          "flat_price": null,
          "postal_box": null,
          "fias_id": "a8496dd3-fa6a-412d-98b3-0637cecff857",
          "fias_level": "8",
          "kladr_id": "7700000000019570061",
          "capital_marker": "0",
          "okato": "45283587000",
          "oktmo": "45372000",
          "tax_office": "7734",
          "tax_office_legal": "7734",
          "timezone": "UTC+3",
          "geo_lat": "55.7886312",
          "geo_lon": "37.4890302",
          "beltway_hit": "IN_MKAD",
          "beltway_distance": null,
          "metro": [
            {
              "distance": 0.6,
              "line": "Таганско-Краснопресненская",
              "name": "Октябрьское поле"
            },
            {
              "distance": 1.0,
              "line": "МЦК",
              "name": "Зорге"
            },
            {
              "distance": 1.3,
              "line": "МЦК",
              "name": "Панфиловская"
            }
          ],
          "qc_geo": "0",
          "qc_complete": null,
          "qc_house": null,
          "history_values": null,
          "unparsed_parts": null,
          "source": "123298, ГОРОД МОСКВА, УЛИЦА НАРОДНОГО ОПОЛЧЕНИЯ, ДОМ 38, КОРПУС 3, ЭТ 5 ПОМ 22",
          "qc": "1"
        }
      },
      "kpp": "773401001",
      "okpo": null,
      "ogrn": "1187746470834",
      "okved": "62.01",
      "state": {
        "status": "ACTIVE",
        "statusDesc": "Действующая",
        "actuality_date": "2020-03-16T00:00:00.000+0000",
        "registration_date": "2018-05-11T00:00:00.000+0000"
      },
      "opf": {
        "short": "ООО",
        "full": "Общество с ограниченной ответственностью",
        "code": "12300",
        "type": "2014"
      }
    }
  },
  "regActualAddress": {
    "value": "город Москва, улица Народного Ополчения, дом 38",
    "unrestricted_value": "123298, город Москва, улица Народного Ополчения, дом 38, корпус 3, эт 5 пом 22",
    "data": {Object},
  },  
  "regDate": "2018-05-11T00:00:00",
  "orgnameShort": "ООО \"ИФР\"",
  "orgnameFull": "Общество с Ограниченной Ответственностью \"Инновационные Финансовые Решения\"",
  "inn": "9715316168",
  "branch": " Дополнительный офис «Сколково»",
  "kpp": "773401001",
  "ogrn": "1187746470834",
  "okpo": "28517963",
  "okved": [
    {
      "name": "Разработка компьютерного программного обеспечения",
      "code": "62.01"
    },
    {
      "name": "Деятельность консультативная в области компьютерных технологий прочая",
      "code": "62.02.9"
    },
    {
      "name": "Деятельность по управлению компьютерным оборудованием",
      "code": "62.03"
    },
    {
      "name": "Деятельность, связанная с использованием вычислительной техники и информационных технологий, прочая",
      "code": "62.09"
    },
    {
      "name": "Деятельность по обработке данных, предоставление услуг по размещению информации и связанная с этим деятельность",
      "code": "63.11"
    }

  ],
  "bankForm": [
    {
      "key": "STAKE_PERCENT_SHARE_1",
      "description": null,
      "value": "19.95"
    },
    {
      "key": "STAKE_PERCENT_SHARE_2",
      "description": null,
      "value": "55.10"
    },
    {
      "key": "OWNERSHIPFORM",
      "description": "Форма собственности",
      "value": "16"
    },
    {
      "key": "OFFICE_BIK",
      "description": "Офис: БИК",
      "value": "044525984"
    },
    {
      "key": "PAS_ISSUEDATE_1",
      "description": null,
      "value": "09.05.2018"
    },
    {
      "key": "KPP",
      "description": "КПП",
      "value": "773401001"
    },
    {
      "key": "PAS_ISSUEDATE_2",
      "description": null,
      "value": "09.05.2018"
    },
    {
      "key": "OKFS",
      "description": "ОКФС",
      "value": "Частная собственность"
    },
    {
      "key": "STAKE_INITIALS_PNS_CEO",
      "description": null,
      "value": "Парамзин А. А. "
    },
    {
      "key": "EMAIL_TO",
      "description": "Почту кому отправлять сообщение",
      "value": "egor.zinovjev@mail.ru"
    },
    {
      "key": "STAKE_BIRTHDATE_CEO",
      "description": null,
      "value": "10.05.2017"
    },
    {
      "key": "STAKE_NAME_CEO",
      "description": null,
      "value": "Парамзин Антон Андреевич"
    },
    {
      "key": "LEGAL_FORM",
      "description": "Форма",
      "value": "12300"
    },
    {
      "key": "OKVED_CODE",
      "description": "ОКВЭД код",
      "value": "62.01"
    },
    {
      "key": "ACTUAL_ADDRESS",
      "description": "Адрес фактический",
      "value": "123298, город Москва, улица Народного Ополчения, дом 38, корпус 3, эт 5 пом 22"
    },
    {
      "key": "AUTHORIZED_CAPITAL",
      "description": "Зарегистрированный уставный капитал",
      "value": "100000"
    },
    {
      "key": "STAKE_INITIALS_SHORT_1",
      "description": null,
      "value": "П. А. А."
    },
    {
      "key": "NUMBER",
      "description": "Номер заявки",
      "value": "LK-0000316-2020"
    },
    {
      "key": "OKVED_NAME",
      "description": "ОКВЭД имя",
      "value": "Разработка компьютерного программного обеспечения"
    },
    {
      "key": "REG_DATE_BEFORE_2002",
      "description": "Дата регистрации до 2002",
      "value": ""
    },
    {
      "key": "PAS_REG_ADDRESS_CEO",
      "description": null,
      "value": "г Москва, ул Ягодная, д 4"
    },
    {
      "key": "STAKE_INITIALS_SHORT_2",
      "description": null,
      "value": "С. А. В."
    },
    {
      "key": "PAS_NUMBER_2",
      "description": null,
      "value": "222222"
    },
    {
      "key": "STAKE_POSITION_CEO",
      "description": null,
      "value": "Генеральный Директор"
    },
    {
      "key": "PAS_NUMBER_1",
      "description": null,
      "value": "222222"
    },
    {
      "key": "ORG_NAME_ALIEN",
      "description": "Наименование на иностранном языке",
      "value": "Limited Liability Company \"Innovatsionnye Finansovye Resheniya\""
    },
    {
      "key": "REG_DATE",
      "description": "Дата регистрации",
      "value": "11.05.2018"
    },
    {
      "key": "PAS_SERIAL_1",
      "description": null,
      "value": "2222"
    },
    {
      "key": "DATE_YEAR",
      "description": "Год",
      "value": "2020"
    },
    {
      "key": "BANK_OKPO",
      "description": "Банк: ОКПО",
      "value": "2930407"
    },
    {
      "key": "OFFICE_FULL_ADDRESS",
      "description": "Офис: полный адрес",
      "value": "г. Москва, Сколковское ш., д.31, стр.2"
    },
    {
      "key": "PAS_SERIAL_2",
      "description": null,
      "value": "2222"
    },
    {
      "key": "PAS_REG_ADDRESS_1",
      "description": null,
      "value": "г Москва, ул Ягодная, д 4"
    },
    {
      "key": "PAS_CODE_1",
      "description": null,
      "value": "222-222"
    },
    {
      "key": "BANK_INN",
      "description": "Банк: ИНН",
      "value": "7709345294"
    },
    {
      "key": "PAS_REG_ADDRESS_2",
      "description": null,
      "value": "г Москва"
    },
    {
      "key": "PAS_CODE_2",
      "description": null,
      "value": "222-222"
    },
    {
      "key": "OKOPF_CODE",
      "description": "ОКОПФ код",
      "value": "12300"
    },
    {
      "key": "OGRN",
      "description": "ОГРН",
      "value": "1187746470834"
    },
    {
      "key": "PAS_NUMBER_CEO",
      "description": null,
      "value": "222222"
    },
    {
      "key": "OFFICE_KORR",
      "description": "Офис: КОР",
      "value": "30101810000000000984"
    },
    {
      "key": "OKATO_CODE",
      "description": "ОКАТО код",
      "value": "45283587000"
    },
    {
      "key": "STAKE_INITIALS_PNS_2",
      "description": null,
      "value": "Соколов А. В. "
    },
    {
      "key": "STAKE_INITIALS_PNS_1",
      "description": null,
      "value": "Парамзин А. А. "
    },
    {
      "key": "PAS_CODE_CEO",
      "description": null,
      "value": "222-222"
    },
    {
      "key": "OFFICE_SHORT_ADDRESS",
      "description": "Офис: короткий адрес",
      "value": "Сколковское ш., д.31, стр.2"
    },
    {
      "key": "OKFS_CODE",
      "description": "ОКФС код",
      "value": "16"
    },
    {
      "key": "STAKE_INN_CEO",
      "description": null,
      "value": "550405159605"
    },
    {
      "key": "CLIENT_NAME",
      "description": "Имя клиента",
      "value": "Егор Зиновьев Олегович"
    },
    {
      "key": "SMS_TO",
      "description": "Телефон кому отправлять сообщение",
      "value": "79852874030"
    },
    {
      "key": "INN",
      "description": "Инн",
      "value": "9715316168"
    },
    {
      "key": "CLIENT_PHONE",
      "description": "Телефон Клиента из ЛКК",
      "value": "79852874030"
    },
    {
      "key": "STAKE_NAME_1",
      "description": null,
      "value": "Парамзин Антон Андреевич"
    },
    {
      "key": "STAKE_NAME_2",
      "description": null,
      "value": "Соколов Аркадий Васильевич"
    },
    {
      "key": "CLIENT_FIO",
      "description": "ФИО Клиента из ЛКК",
      "value": "Егор Зиновьев Олегович"
    },
    {
      "key": "PAS_ISSUEDATE_CEO",
      "description": null,
      "value": "09.05.2018"
    },
    {
      "key": "STAKE_BIRTHDATE_2",
      "description": null,
      "value": "10.05.2017"
    },
    {
      "key": "REG_DATE_AFTER_2002",
      "description": "Дата регистрации после 2002",
      "value": "11.05.2018"
    },
    {
      "key": "STAKE_BIRTHDATE_1",
      "description": null,
      "value": "10.05.2017"
    },
    {
      "key": "OKOPF",
      "description": "ОКОПФ",
      "value": "Общества с ограниченной ответственностью"
    },
    {
      "key": "DATE_MONTH_NAME",
      "description": "Месяц прописью",
      "value": "апреля"
    },
    {
      "key": "STAKE_POSITION_2",
      "description": null,
      "value": "Учредитель"
    },
    {
      "key": "STAKE_POSITION_1",
      "description": null,
      "value": "Генеральный Директор"
    },
    {
      "key": "OFFICE_NAME",
      "description": "Офис: Имя",
      "value": " Дополнительный офис «Сколково»"
    },
    {
      "key": "OKOGU",
      "description": "ОКОГУ",
      "value": "Организации, учрежденные юридическими лицами или гражданами, или юридическими лицами и гражданами совместно"
    },
    {
      "key": "DATE_MONTH",
      "description": "Месяц числом",
      "value": "4"
    },
    {
      "key": "OFFICE_CITY",
      "description": "Офис: город",
      "value": "г. Москва"
    },
    {
      "key": "BANK_KPP",
      "description": "Банк: КПП",
      "value": "770901001"
    },
    {
      "key": "BANK_OGRN",
      "description": "Банк: ОГРН",
      "value": "1027739067861"
    },
    {
      "key": "PAS_SERIAL_CEO",
      "description": null,
      "value": "2222"
    },
    {
      "key": "ORG_NAME_SHORT",
      "description": "Краткое наименование организации",
      "value": "ООО \"ИФР\""
    },
    {
      "key": "ORG_NAME_FULL",
      "description": "Полное наименование организации",
      "value": "Общество с Ограниченной Ответственностью \"Инновационные Финансовые Решения\""
    },
    {
      "key": "OKTMO_CODE",
      "description": "ОКТМО код",
      "value": "45372000000"
    },
    {
      "key": "REG_ADDRESS",
      "description": "Адрес регистрации",
      "value": "123298, город Москва, улица Народного Ополчения, дом 38, корпус 3, эт 5 пом 22"
    },
    {
      "key": "STAKE_PERCENT_SHARE_CEO",
      "description": null,
      "value": "19.95"
    },
    {
      "key": "STAKE_INITIALS_SHORT_CEO",
      "description": null,
      "value": "П. А. А."
    },
    {
      "key": "OFFICE_KORR_LOCATION",
      "description": "Офис: КОР адрес",
      "value": "в ГУ Банка России по ЦФО\tг.Москва"
    },
    {
      "key": "STAKE_INN_2",
      "description": null,
      "value": "773471677804"
    },
    {
      "key": "STAKE_INN_1",
      "description": null,
      "value": "550405159605"
    },
    {
      "key": "OKPO",
      "description": "ОКПО",
      "value": "28517963"
    },
    {
      "key": "BANK_NAME",
      "description": "Банк: Имя",
      "value": "АО \"Банк\""
    },
    {
      "key": "REG_AGENCY",
      "description": "Наименование регистрирующего органа",
      "value": "Межрайонная инспекция Федеральной налоговой службы № 46 по г. Москве "
    },
    {
      "key": "DATE_DAY",
      "description": "День",
      "value": "28"
    },
    {
      "key": "innupolnlica2",
      "description": "ИНН",
      "value": ""
    },
    {
      "key": "dataimestorogd1",
      "description": "Место рождения",
      "value": "2"
    },
    {
      "key": "gragdanstvo1",
      "description": "Гражданство",
      "value": "2"
    },
    {
      "key": "passgen",
      "description": "Кем выдан паспорт",
      "value": "2"
    },
    {
      "key": "factadresgendir",
      "description": "Фактический адрес совпадает с адресом регистрации?",
      "value": "Нет"
    },
    {
      "key": "adresgendir",
      "description": "",
      "value": "2"
    },
    {
      "key": "telefongendir",
      "description": "Контактная информация",
      "value": "2"
    },
    {
      "key": "elpochtagendir",
      "description": "",
      "value": "2"
    },
    {
      "key": "migracgendir",
      "description": "Данные миграционной карты",
      "value": ""
    },
    {
      "key": "dokpolnomochgendir",
      "description": "Документ, подтверждающий право иностранного гражданина на пребывание в РФ",
      "value": ""
    },
    {
      "key": "gendirbenvlad",
      "description": "Является ли генеральный директор бенефициарным владельцем",
      "value": "Нет"
    },
    {
      "... etc"
    }
  ]
}



Система радар обращается по https протоколу на внешний сервис. Возвращаемый результат после выполнения запроса:

Responses

Code Description
200 Результат резервирования счёта

Fields

Key Description Type
_input_type NewClient - тип запроса. Есть 4 типа запросов: Проверки - 'InitialCheck', Резервирование счета - 'NewClient', Открытие счета - 'OpenAccount', Удаление - 'DeleteClient'. String
'_rc' статус выполнения удаления заявки клиента из АБС String
'_comment' Сообщение о результате выполнения сервиса String
'_notes4staff' Описание ошибок Object
_client_id ID клиента(это уникальный индетификатор, который система Радар, получает из ответа на сервисы: Проверки по спискам банка и резервирование счета) Integer
_account_number Номер зарезервированного счёта String

Response:

{
  "_input_type": "NewClient",
  "_rc": "1",
  "_comment": "null",
  "_notes4staff": "null",
  "_client_id": 115893,
  "_account_number": "40702810010200293486"
}

Открытие счета в АБС

Description: Интеграция системы РАДАР с АБС Банка для открытие счета

Примечание Для автоматического режима, нужно включить и настроить днамические поля, в личном кабинете администратора, раздел Интеграция с АБС

Значение Описание
https://service/send-request URL внешнего сервиса
answerPermit Названия ключа для успешного результата
PERMIT Значение для ключа успешного результата
answerError Названия ключа для отрицательного результата
ERROR Значение для ключа результата с ошибкой
answerDateFrom Названия ключа для Datefrom
DATEFROM Значение ключа для Datefrom
answerDateto Названия ключа для Dateto
DATETO Значение для ключа Dateto
comment Ключ комментария

HTTPS Request

***POST*** https://service/send-request

Key Description Type
applicationId ID заявки в системе Радар String
_input_type тип запроса. Есть 4 типа запросов: (Проверки - 'InitialCheck', Резервирование счета - 'NewClient', Открытие счета - 'OpenAccount', Удаление - 'DeleteClient'. String
_account_number Номер зарезервированного счета String
_client_id ID клиента(это уникальный индетификатор, который система Радар, получает из ответа на сервисы: Проверки по спискам банка и резервирование счета) String
regAddress Адрес организации(в разных форматах) Object
regActualAddress Фактический адрес организации(в разных форматах) Object
regDate Дата создание заявки String
orgnameShort Сокращенное название организации String
orgnameFull Полное название организации String
inn ИНН организации String
branch офис выбранный клиентом в системе Радар String
kpp КПП организации String
ogrn ОГРН организации String
okpo ОКПО организации String
okved Список ОКВЕДов организации Object
bankForm анкета клиента, заполенная в системе Радар Object

Request:

{
  "applicationId": "b609e653-d718-4e7c-af74-4d6bb0aabd59",
  "_input_type": "OpenAccount",
  "_account_number": "4070 2810 1234 5678 9012",
  "_client_id": 115853,
  "regAddress": "Значения аналогичны как в резервировании счёта",
  "regActualAddress": "Значения аналогичны как в резервировании счёта",
  "regDate": "2018-05-11T00:00:00",
  "orgnameShort": "ООО \"ИФР\"",
  "orgnameFull": "Общество с Ограниченной Ответственностью \"Инновационные Финансовые Решения\"",
  "inn": "9715316168",
  "branch": " Дополнительный офис «Сколково»",
  "kpp": "773401001",
  "ogrn": "1187746470834",
  "okpo": "28517963",
  "okved": "Значения аналогичны как в резервировании счёта",
  "bankForm": "Значения аналогичны как в резервировании счёта"
}

Description: Структура, заполненная текущими значениями, будет ожидать результат следующего вида:

Примечение: Если сервис "Открытие счета" будет включен, и ответ будет с ошибкой, система не откроет счет, пока не будет получен положительный ответ

Responses

Code Description
200 Результат ответа по открытию счета

Fields

Key Description Type
_input_type OpenAccount - тип запроса. Есть 4 типа запросов: (Проверки - 'InitialCheck', Резервирование счета - 'NewClient', Открытие счета - 'OpenAccount', Удаление - 'DeleteClient'. String
'_rc' статус об открытии счёта из АБС String
'_comment' Сообщение о результате выполнения сервиса String
'_notes4staff' Описание ошибок Object

Response:

{
  "_input_type": "OpenAccount",
  "_rc": "1",
  "_comment": "null",
  "_notes4staff": "null"
}

Удаление заявки клиента в АБС

Description: Интеграция системы РАДАР с АБС Банка для удаления заявки клиента

Примечание Для автоматического режима, нужно включить и настроить днамические поля, в личном кабинете администратора, раздел "Интеграция с АБС"

Значение Описание
https://service/send-request URL внешнего сервиса
_rc Названия ключа для успешного результата
PERMIT Значение для ключа успешного результата
_rc Названия ключа для отрицательного результата
ERROR Значение для ключа результата с ошибкой
comment Ключ комментария

HTTPS Request

***POST*** https://service/send-request

Key Description Type
_input_type 'DeleteClient' - тип запроса. Есть 4 типа запросов: (Проверки - 'InitialCheck', Резервирование счета - 'NewClient', Открытие счета - 'OpenAccount', Удаление - 'DeleteClient'. String
_client_id ID клиента(это уникальный индетификатор, который система Радар, получает из ответа на сервисы: Проверки по спискам банка и резервирование счета) Integer

Request json { "_input_type": "DeleteClient", "_client_id": 115902 }

Description: Структура, заполненная текущими значениями, будет ожидать результат следующего вида: Примечение: Если сервис "Удаление аккаунта" включен, то он вызывается при нажатии кнопки анулирование заявки в ЛКК и в ЛКБ при нажатии на "Отозвать" и "Закрыть" заявку

Responses

Code Description
200 Результат ответа по удалению счета

Fields

Key Description Type
_input_type 'DeleteClient' - тип запроса. Есть 4 типа запросов: (Проверки - 'InitialCheck', Резервирование счета - 'NewClient', Открытие счета - 'OpenAccount', Удаление - 'DeleteClient'. String
'_rc' статус выполнения удаления заявки клиента из АБС String
_comment Сообщение о результате выполнения сервиса String

Response:

{
    "_input_type": "-1",  
    "_rc": "1  - success; -1  - error",  
    "comment": "внутренняя проблема с АБС. Не удалось удалить клиента"
}