---
swagger: "2.0"
info:
  x-ibm-name: gbdulchecknamesfornecom
  title: GbdulCheckNamesForNeCom API
  version: 1.0.0
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
  description: Cервис проверки уникальности названия некоммерческих ЮЛ по названию
schemes:
- https
basePath: /v1/gov/gbdul/check-names-for-ne-com
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: 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'
    parameters:
    - $ref: '#/parameters/xib-trace-id'
  /xml-for-sign/encoded:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ResponseTypeDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: Not Found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: Different errors
          schema:
            $ref: '#/definitions/FailureResponse'
      summary: Получение XML для подписи ЭЦП Юр лица
      operationId: xmlForSign
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/RequestTypeDto'
    parameters:
    - $ref: '#/parameters/xib-trace-id'
definitions:
  RequestTypeDto:
    properties:
      nameRu:
        type: string
        description: Наименование на русском языке
      nameKz:
        type: string
        description: Наименование на казахском языке
      nameEn:
        type: string
        description: Наименование на английском
      codeOpf:
        type: string
        description: Код организационно правовой формы
      idn:
        type: string
        description: ИИН/БИН
    additionalProperties: false
    description: Запрос на проверку уникальности названия юридического лица для онлайн
      регистрации некоммерческих лиц  GbdulCheckNamesForNecom
    required:
    - nameKz
    - nameRu
    - codeOpf
    - idn
  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
  SimiliarNameTypeDto:
    title: Тип описывающий структуру схожих наименований юл
    type: object
    properties:
      similiars:
        type: array
        description: Схожие наименования
        items:
          $ref: '#/definitions/SimiliarNamesDto'
    description: Похожие названия
  SimiliarNamesDto:
    title: Список схожих наименований юридических лиц
    type: object
    properties:
      nameFace:
        type: string
        description: Наименование юрлица
    description: Схожие наименования
  RequestDto:
    properties:
      signedRequest:
        type: string
        description: Подписанный XML запрос (base64)
      idn:
        type: string
        description: ИИН/БИН
    additionalProperties: false
    required:
    - signedRequest
    - idn
  ResponseDto:
    title: Ответ на запрос
    type: object
    properties:
      codeStatus:
        type: string
        description: Код статуса ответа
      infoRu:
        type: string
        description: Информация на русском языке
      infoKz:
        type: string
        description: Информация на казахском  языке
      similiarNames:
        $ref: '#/definitions/SimiliarNameTypeDto'
  ResponseTypeDto:
    properties:
      requestEncoded:
        type: string
        description: XML в виде base64
    additionalProperties: false
    description: Данные запроса XML (base64)
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
...