---
swagger: "2.0"
info:
  x-ibm-name: business-accounts
  title: Онлайн открытие счетов для ЮЛ/ИП
  version: 1.1.0
  contact:
    email: shymbolat.aitbek@bcc.kz
  description: ""
schemes:
- https
basePath: /business-accounts/v1/api
produces:
- application/json
consumes:
- application/json
security:
- Authorization:
  - bcc.application.business.accounts
securityDefinitions:
  Authorization:
    type: oauth2
    description: Авторизация посредством вызова запроса с механизмом HTTP Basic аутентификации
      на сервисе авторизации, в котором передается Client Id и Client Secret приложения
      в формате Base64, который возвращает access_token с необходимым перечнем доступов.
      В дальнейшем поле access_token будет использоваться для аутентификации при вызове
      сервисов в заголовке Authorization.
    flow: application
    scopes:
      bcc.application.business.accounts: Доступ к информационным сервисам Банка
    tokenUrl: https://api.bcc.kz/bcc/production/v2/oauth/token
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /check-ability-to-open-account/v2/checks:
    get:
      tags:
      - check-ability-to-open-account-controller
      summary: Проверка Клиента и получение персональной ссылки
      description: Проверка Клиента на возможность открытия счета через онлайн канал.
        При успешной проверке - получение персональной ссылки для перехода в BCC Office.
        В случае наличия стоп-факторов отображается текст ошибки.
      operationId: openApiAbilityToOpenAccountUsingGET
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: taxcode
        in: query
        description: ИИН/БИН Клиента
        required: true
        type: string
      - $ref: '#/parameters/X-Customer-Authorization'
      responses:
        200:
          description: OK
          schema:
            type: string
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
      security:
      - Authorization:
        - bcc.application.business.accounts
      deprecated: false
  /otp/send:
    post:
      tags:
      - otp-controller
      summary: Отправка OTP кода
      description: Отправка OTP на номер телефона Клиента
      operationId: sendOtpUsingPOST
      parameters:
      - in: body
        name: body
        description: номер телефона в формате +7___
        required: true
        schema:
          $ref: '#/definitions/OtpSendRequest'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/OtpResponse'
        201:
          description: Created
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
      deprecated: false
      security:
      - Authorization:
        - bcc.application.business.accounts
  /otp/verify:
    post:
      tags:
      - otp-controller
      summary: Валидация OTP кода
      description: Валидация OTP кода и получение токена для авторизации (при вводе
        токена добавьте в начале "Bearer ")
      operationId: verifyOtpUsingPOST
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: otpVerifyRequest
        description: Запрос на верификацию
        required: true
        schema:
          $ref: '#/definitions/OtpVerifyRequest'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/JwtResponse'
        400:
          description: BAD_REQUEST
          schema:
            $ref: '#/definitions/OtpVerifyResponse'
      deprecated: false
      security:
      - Authorization:
        - bcc.application.business.accounts
  /partner/client/save:
    post:
      tags:
      - partner-controller
      summary: Сохранение данных по согласию Клиента и идентификация Партнера
      description: ID Партнера генерируется на стороне Банка
      operationId: saveClientUsingPOST
      consumes:
      - application/json
      produces:
      - application/json;charset=UTF-8
      parameters:
      - in: body
        name: partnerDto
        description: Данные от Партнера
        required: true
        schema:
          $ref: '#/definitions/PartnerDto'
      - $ref: '#/parameters/X-Customer-Authorization'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/OpenApiDto'
        201:
          description: Created
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
      security:
      - Authorization:
        - bcc.application.business.accounts
  /partner/client/status:
    get:
      tags:
      - partner-controller
      summary: Получение статуса открытия счета Клиента
      operationId: getStatusUsingGET
      produces:
      - application/json;charset=UTF-8
      parameters:
      - name: front_id
        in: query
        description: front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
        required: true
        type: string
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/OpenApiDto'
        401:
          description: Unauthorized
        403:
          description: Forbidden
        404:
          description: Not Found
      security:
      - Authorization:
        - bcc.application.business.accounts
      deprecated: false
  /company/get-basic-info:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/IndividualDto'
      description: Метод для получения информации по компании (ОКЭД, Наименование)
      operationId: getBasicInfo
      parameters:
      - name: front_id
        type: string
        description: front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
        required: true
        in: query
      - $ref: '#/parameters/X-Customer-Authorization'
  /company/individual/save-additional-info:
    put:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/CommonResponseDto'
      description: Метод для сохранения данных ИП (дата рег, адрес)
      operationId: saveAdditionalInfo
      parameters:
      - $ref: '#/parameters/X-Customer-Authorization'
      - name: body
        required: true
        in: body
        schema:
          $ref: '#/definitions/CompanyInfoRequestDto'
        description: requestBody
  /application/create:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/BusinessAccountsCommonResponseDto'
      description: Метод для сохранения основных данных заявки для открытия счета
      parameters:
      - $ref: '#/parameters/X-Customer-Authorization'
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/BusinessAccountApplicationPayload'
      operationId: createApplication
  /doc/sign-verify:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/BusinessAccountsCommonResponseDto'
      description: Метод для отправки подписанного документа
      operationId: signVerify
      parameters:
      - $ref: '#/parameters/X-Customer-Authorization'
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/SignedDocPayload'
        description: Тело запроса
  /doc:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            type: string
      description: Получить документ заявки
      operationId: getDoc
      parameters:
      - $ref: '#/parameters/X-Customer-Authorization'
      - name: front_id
        type: string
        description: front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
        required: true
        in: query
      - name: docType
        type: string
        required: false
        in: query
        description: 'APPLICATION_FORM - анкета-заявление, KLS - заявление на подключение
          клс, KLS_SIGNED - подписанное заявление КЛС, REQUISITES - реквизиты счета;
          (default: APPLICATION_FORM)'
  /doc/base64:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            type: string
      description: Получить документ base64 для типов - APPLICATION_FORM, KLS
      parameters:
      - $ref: '#/parameters/X-Customer-Authorization'
      - name: front_id
        type: string
        required: true
        in: query
        description: front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
      - name: docType
        type: string
        required: false
        in: query
        description: 'APPLICATION_FORM - анкета-заявление, KLS - заявление на подключение
          клс, (default: APPLICATION_FORM)'
      operationId: getDocBase64
  /open:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/BusinessAccountsCommonResponseDto'
      description: Открытие счета
      operationId: openCard
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/CardAccountPayload'
        description: Входная информация для открытия счета
    parameters:
    - $ref: '#/parameters/X-Customer-Authorization'
  /status:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/BusinessAccountsCommonResponseDto'
      description: Статус счета
      operationId: getStatus
      summary: ""
      parameters:
      - name: front_id
        type: string
        description: front_id, указанный в response сервиса /api/check-ability-to-open-account/v2/checks
        required: true
        in: query
    parameters:
    - $ref: '#/parameters/X-Customer-Authorization'
  /aitu/save:
    post:
      responses:
        200:
          description: 200 OK
      description: Сохранение подписанного файла с помощью Aitu Passport
      operationId: saveAituDoc
      parameters:
      - $ref: '#/parameters/X-Customer-Authorization'
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/SaveDocPayload'
  /aitu/sign-url:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/SignUrlDto'
      description: Генерация URL для подписания с помощью Aitu Passport
      parameters:
      - $ref: '#/parameters/X-Customer-Authorization'
      - name: front_id
        type: string
        required: true
        in: query
      - name: redirect_uri
        type: string
        required: true
        in: query
      operationId: getAituSignUrl
definitions:
  OtpSendRequest:
    type: object
    properties:
      msisdn:
        type: string
        description: номер телефона в формате +7___
        example: "+70000000000"
      taxcode:
        type: string
        description: ИИН
        example: 012345678912
    required:
    - msisdn
    - taxcode
  JwtResponse:
    type: object
    properties:
      refreshToken:
        type: string
      token:
        type: string
    title: JwtResponse
  OtpVerifyResponse:
    type: object
    properties:
      code:
        type: string
        example: OTP_VERIFICATION_FAILED
      result:
        type: string
        example: otp verification failed
    title: JwtResponse
  OpenApiDto:
    type: object
    properties:
      code:
        type: string
      description:
        type: string
    title: OpenApiDto
  OtpResponse:
    type: object
    properties:
      refId:
        type: string
    title: OtpResponse
  OtpVerifyRequest:
    type: object
    properties:
      code:
        type: string
      msisdn:
        type: string
      refId:
        type: string
    required:
    - code
    - refId
    - msisdn
    title: OtpVerifyRequest
  PartnerDto:
    type: object
    properties:
      consent:
        type: boolean
      partnerId:
        type: string
      taxcode:
        type: string
    required:
    - consent
    - partnerId
    - taxcode
    title: PartnerDto
  IndividualDto:
    properties:
      name:
        type: string
      oked:
        type: string
    additionalProperties: false
    description: Выходная информация ИП
  BusinessAccountApplicationPayload:
    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: Идентификатор клиента
    description: Входная информация для создания заявки на открытие онлайн счета
  CityDepartmentInfoDto:
    type: object
    properties:
      cityName:
        type: string
      depId:
        type: integer
        format: int32
    description: Информация где передается название города и айди департамента
  TariffInfoPayload:
    type: object
    properties:
      tariffCode:
        type: string
      tarPeriod:
        type: integer
        format: int32
    description: Информация о тарифе
  AddressDto:
    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
    description: В случае если isBusinessAddressDifferent = true, заполняется адрес
  CommonResponseDto:
    type: object
    properties:
      success:
        type: boolean
      frontId:
        type: string
    description: Выходная успешная информация
  CompanyInfoRequestDto:
    required:
    - frontId
    - isBusinessAddressDifferent
    - registrationDate
    type: object
    properties:
      isBusinessAddressDifferent:
        type: boolean
        description: Отличается ли адрес ведения деятельности от юр адреса
      address:
        $ref: '#/definitions/AddressDto'
        description: Адрес
      frontId:
        type: string
        description: идентификатор процесса
      registrationDate:
        type: string
        description: Дата регистрации компании
  BusinessAccountsCommonResponseDto:
    type: object
    properties:
      status:
        type: string
        enum:
        - SUCCESS
        - ERROR
        - SCHEDULED
      frontId:
        type: string
      message:
        type: string
    description: Выходная информация
  CardAccountPayload:
    required:
    - frontId
    type: object
    properties:
      frontId:
        type: string
        description: Идентификатор клиента
    description: Входная информация для открытия счета
  SaveDocPayload:
    required:
    - code
    - frontId
    - redirectUri
    type: object
    properties:
      code:
        type: string
        description: Временный код для обмена на токен
      frontId:
        type: string
        description: Идентификатор клиента
      redirectUri:
        type: string
        description: URI, на который был отправлен код авторизации
    description: Входная информация для сохранения подписанного документа с помощью
      Aitu Passport
  SignUrlDto:
    type: object
    properties:
      url:
        type: string
    description: Входная информация для получения URL для подписания
  SignedDocPayload:
    required:
    - frontId
    - signedData
    type: object
    properties:
      signedData:
        type: string
        description: Подписанный документ
      frontId:
        type: string
        description: Идентификатор клиента
    description: Входная информация для отправки
tags: []
parameters:
  X-Customer-Authorization:
    name: X-Customer-Authorization
    type: string
    required: true
    in: header
    description: Токен из ответа OTP сервиса (указывать вместе с Bearer )
x-ibm-endpoints:
- endpointUrl: https://api.bcc.kz:10443/bcc/production
  description: Альтернативная точка подключения для вызова сервиса в продуктивной
    среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в
    режиме "PRODUCTION"
  type:
  - production
  - development
- endpointUrl: https://api.bcc.kz/bcc/production
  description: Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"
  type:
  - production
- endpointUrl: https://api-test.bcc.kz/bcc/production
  description: Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное
    на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"
  type:
  - development
...