Альтернативная точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
Пути
/check-ability-to-open-account/v2/checks
Проверка Клиента и получение персональной ссылки
Проверка Клиента на возможность открытия счета через онлайн канал. При успешной проверке - получение персональной ссылки для перехода в BCC Office. В случае наличия стоп-факторов отображается текст ошибки.
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
ИИН/БИН Клиента
Токен из ответа OTP сервиса (указывать вместе с Bearer )
OK
{
"schema": {
"type": "string"
}
}Unauthorized
Forbidden
Not Found
/otp/send
Отправка OTP кода
Отправка OTP на номер телефона Клиента
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
номер телефона в формате +7___
/otp/verify
Валидация OTP кода
Валидация OTP кода и получение токена для авторизации (при вводе токена добавьте в начале "Bearer ")
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Запрос на верификацию
OK
BAD_REQUEST
/partner/client/save
Сохранение данных по согласию Клиента и идентификация Партнера
ID Партнера генерируется на стороне Банка
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Данные от Партнера
Токен из ответа OTP сервиса (указывать вместе с Bearer )
/partner/client/status
Получение статуса открытия счета Клиента
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
/company/get-basic-info
Метод для получения информации по компании (ОКЭД, Наименование)
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
Токен из ответа OTP сервиса (указывать вместе с Bearer )
200 OK
/company/individual/save-additional-info
/application/create
Метод для сохранения основных данных заявки для открытия счета
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
/doc/sign-verify
Метод для отправки подписанного документа
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
Тело запроса
/doc
Получить документ заявки
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
APPLICATION_FORM - анкета-заявление, KLS - заявление на подключение клс, KLS_SIGNED - подписанное заявление КЛС, REQUISITES - реквизиты счета; (default: APPLICATION_FORM)
200 OK
{
"schema": {
"type": "string"
}
}/doc/base64
Получить документ base64 для типов - APPLICATION_FORM, KLS
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
APPLICATION_FORM - анкета-заявление, KLS - заявление на подключение клс, (default: APPLICATION_FORM)
200 OK
{
"schema": {
"type": "string"
}
}/open
Открытие счета
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
Входная информация для открытия счета
/status
Статус счета
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
/aitu/save
Сохранение подписанного файла с помощью Aitu Passport
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
200 OK
/aitu/sign-url
Генерация URL для подписания с помощью Aitu Passport
Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации на сервисе авторизации, в котором передается Client Id и Client Secret приложения в формате Base64, который возвращает access_token с необходимым перечнем доступов. В дальнейшем поле access_token будет использоваться для аутентификации при вызове сервисов в заголовке Authorization.
Токен из ответа OTP сервиса (указывать вместе с Bearer )
200 OK
Определения
{
"type": "object",
"properties": {
"msisdn": {
"type": "string",
"description": "номер телефона в формате +7___",
"example": "+70000000000"
},
"taxcode": {
"type": "string",
"description": "ИИН",
"example": "012345678912"
}
},
"required": [
"msisdn",
"taxcode"
]
}
{
"type": "object",
"properties": {
"refreshToken": {
"type": "string"
},
"token": {
"type": "string"
}
},
"title": "JwtResponse"
}
{
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "OTP_VERIFICATION_FAILED"
},
"result": {
"type": "string",
"example": "otp verification failed"
}
},
"title": "JwtResponse"
}
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"title": "OpenApiDto"
}
{
"type": "object",
"properties": {
"refId": {
"type": "string"
}
},
"title": "OtpResponse"
}
{
"type": "object",
"properties": {
"code": {
"type": "string"
},
"msisdn": {
"type": "string"
},
"refId": {
"type": "string"
}
},
"required": [
"code",
"refId",
"msisdn"
],
"title": "OtpVerifyRequest"
}
{
"type": "object",
"properties": {
"consent": {
"type": "boolean"
},
"partnerId": {
"type": "string"
},
"taxcode": {
"type": "string"
}
},
"required": [
"consent",
"partnerId",
"taxcode"
],
"title": "PartnerDto"
}
Выходная информация ИП
{
"properties": {
"name": {
"type": "string"
},
"oked": {
"type": "string"
}
},
"additionalProperties": false
}
Входная информация для создания заявки на открытие онлайн счета
{
"required": [
"cityDepartmentInfo",
"currencies",
"frontId",
"tariffInfo"
],
"type": "object",
"properties": {
"cityDepartmentInfo": {
"$ref": "#\/definitions\/CityDepartmentInfoDto"
},
"tariffInfo": {
"$ref": "#\/definitions\/TariffInfoPayload"
},
"currencies": {
"type": "array",
"description": "Список валют",
"items": {
"type": "string",
"description": "Список валют"
}
},
"frontId": {
"type": "string",
"description": "Идентификатор клиента"
}
}
}
Информация где передается название города и айди департамента
{
"type": "object",
"properties": {
"cityName": {
"type": "string"
},
"depId": {
"type": "integer",
"format": "int32"
}
}
}
Информация о тарифе
{
"type": "object",
"properties": {
"tariffCode": {
"type": "string"
},
"tarPeriod": {
"type": "integer",
"format": "int32"
}
}
}
В случае если isBusinessAddressDifferent = true, заполняется адрес
{
"required": [
"district",
"kato",
"region",
"street"
],
"type": "object",
"properties": {
"region": {
"type": "string"
},
"district": {
"type": "string"
},
"locality": {
"type": "string"
},
"kato": {
"type": "string"
},
"street": {
"type": "string"
},
"houseNumber": {
"type": "string"
},
"flatNumber": {
"type": "string"
}
}
}
Выходная успешная информация
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"frontId": {
"type": "string"
}
}
}
{
"required": [
"frontId",
"isBusinessAddressDifferent",
"registrationDate"
],
"type": "object",
"properties": {
"isBusinessAddressDifferent": {
"type": "boolean",
"description": "Отличается ли адрес ведения деятельности от юр адреса"
},
"address": {
"$ref": "#\/definitions\/AddressDto",
"description": "Адрес"
},
"frontId": {
"type": "string",
"description": "идентификатор процесса"
},
"registrationDate": {
"type": "string",
"description": "Дата регистрации компании"
}
}
}
Выходная информация
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"SUCCESS",
"ERROR",
"SCHEDULED"
]
},
"frontId": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
Входная информация для открытия счета
{
"required": [
"frontId"
],
"type": "object",
"properties": {
"frontId": {
"type": "string",
"description": "Идентификатор клиента"
}
}
}
Входная информация для сохранения подписанного документа с помощью Aitu Passport
{
"required": [
"code",
"frontId",
"redirectUri"
],
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Временный код для обмена на токен"
},
"frontId": {
"type": "string",
"description": "Идентификатор клиента"
},
"redirectUri": {
"type": "string",
"description": "URI, на который был отправлен код авторизации"
}
}
}
Входная информация для получения URL для подписания
{
"type": "object",
"properties": {
"url": {
"type": "string"
}
}
}
Входная информация для отправки
{
"required": [
"frontId",
"signedData"
],
"type": "object",
"properties": {
"signedData": {
"type": "string",
"description": "Подписанный документ"
},
"frontId": {
"type": "string",
"description": "Идентификатор клиента"
}
}
}