---
swagger: "2.0"
info:
  x-ibm-name: review-application
  title: Review Application API
  version: 1.0.0
  description: Сервис «Рассмотрение отзыва заявления»
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/review-application
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:
  /send:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ResponseDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: Person not found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: Different errors
          schema:
            $ref: '#/definitions/FailureResponse'
      operationId: sendRequest
      summary: Отправка подписанного ЭЦП Юр лица на отзыв заявления
    parameters:
    - name: RequestBody
      required: true
      in: body
      schema:
        $ref: '#/definitions/SignedRequestDto'
    - $ref: '#/parameters/xib-trace-id'
  /xml-for-sign/encoded:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/RequestEncodedDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: Person not found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: Different errors
          schema:
            $ref: '#/definitions/FailureResponse'
      operationId: encodeApplicationData
      summary: Получение XML для подписи ЭЦП Юр лица
    parameters:
    - name: RequestBody
      required: true
      in: body
      schema:
        $ref: '#/definitions/RequestDto'
    - $ref: '#/parameters/xib-trace-id'
definitions:
  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
  SignedRequestDto:
    title: 'Запрос для отправки в ШЭП, подписанный ЭЦП заявителя '
    required:
    - signedRequest
    - iin
    type: object
    properties:
      signedRequest:
        title: Подписанный XML запрос (base64)
        type: string
      iin:
        type: string
        description: ИИН
    additionalProperties: false
  DirectoryTypeDto:
    title: Тип, описывающий данные справочника
    type: object
    properties:
      code:
        type: string
        description: код
      nameRu:
        type: string
        description: значение на русском языке
      nameKz:
        type: string
        description: значение нагосударственном языке
    description: Тип, описывающий данные справочника
  ResponseDto:
    title: Параметры ответа
    type: object
    properties:
      status:
        $ref: '#/definitions/DirectoryTypeDto'
      rejectionReason:
        type: string
        description: Причина отказа отзыва
  RequestDto:
    title: Параметры запроса
    required:
    - appId
    - reasonReview
    - iin
    type: object
    properties:
      appId:
        type: string
        description: Номер заявления
      reasonReview:
        type: string
        description: Причина отызва
      iin:
        type: string
        description: ИИН
  RequestEncodedDto:
    title: Данные запроса XML (base64)
    required:
    - requestEncoded
    type: object
    properties:
      requestEncoded:
        title: XML в виде base64
        type: string
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
...