---
swagger: "2.0"
info:
  x-ibm-name: gbdul-check-osi
  title: GbdulCheckOsi API
  version: 1.0.0
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
  description: Сервис проверки сведений о наличии/отсутствии зарегистрированного ОСИ
    по указанному в запросе РКА
schemes:
- https
basePath: /v1/gov/gbdul
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  Authorization:
    type: oauth2
    description: Токен аутентификации, полученный при вызове сервиса авторизации
    flow: application
    scopes:
      bcc.application.govtech.api: Allow access to Goventment Services API
    tokenUrl: https://api.bcc.kz/bcc/production/v2/oauth/token
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /check-osi:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ResponseDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: Not Found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: Different errors
          schema:
            $ref: '#/definitions/FailureResponse'
      description: ""
      summary: Предоставлению информации об уплаченных суммах на лицевом счете налогоплательщика
      operationId: sendRequest
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/RequestDto'
      - $ref: '#/parameters/xib-trace-id'
definitions:
  RequestDto:
    title: Параметры запроса
    required:
    - businessData
    - idn
    type: object
    properties:
      businessData:
        $ref: '#/definitions/BusinessDataTypeDto'
      idn:
        type: string
        description: ИИН/БИН
  BusinessDataTypeDto:
    title: Тип, описывающий бизнесс данные
    required:
    - rka
    type: object
    properties:
      rka:
        type: string
        description: РКА объекта
    description: Тип, описывающий бизнесс данные
  FailureResponse:
    type: object
    properties:
      timestamp:
        type: string
        format: date-time
      error:
        type: string
      violations:
        type: array
        items:
          $ref: '#/definitions/Violation'
  Violation:
    type: object
    properties:
      name:
        type: string
      message:
        type: string
  RKATypeDto:
    title: Обслуживаемые объекты
    type: object
    properties:
      rka:
        type: string
        description: РКА объектов
    description: Обслуживаемые объекты
  ResponseDto:
    title: Результат запроса
    type: object
    properties:
      result:
        $ref: '#/definitions/ResultTypeDto'
  ResultTypeDto:
    type: object
    properties:
      status:
        $ref: '#/definitions/StatusTypeDto'
      bin:
        type: string
        description: БИН ОСИ
      nameOsiRu:
        type: string
        description: Наименование ОСИ на русском языке
      nameOsiKz:
        type: string
        description: Наименование ОСИ на казахском языке
      servicedObject:
        type: array
        description: Обслуживаемые объекты
        items:
          $ref: '#/definitions/RKATypeDto'
    description: Результат услуги
  StatusTypeDto:
    title: Статус ответа
    type: object
    properties:
      code:
        type: string
        description: Код статуса ответа
      infoRu:
        type: string
        description: Пояснение ответа на русском языке
      infoKz:
        type: string
        description: Пояснение ответа на казахском языке
    description: Статус ответа
tags: []
security:
- Authorization:
  - bcc.application.govtech.api
parameters:
  xib-trace-id:
    name: xib-trace-id
    type: string
    required: true
    in: header
    description: Уникальный идентификатор запроса
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
...