---
swagger: "2.0"
info:
  x-ibm-name: gbdul-online-reg-no-commercial
  title: GbdulOnlineRegNoCommercial API
  version: 1.0.0
  description: Регистрация некоммерческих организаций (за исключением регистрации
    политических партий, религиозных объединений)
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/gbdul-online-reg-no-commercial
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:
  /xml-for-sign/encoded:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/RequestEncodedDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: Not Found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: Different errors
          schema:
            $ref: '#/definitions/FailureResponse'
      operationId: encodeApplicationData
      summary: Данные для подписи
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/RequestDto'
      - $ref: '#/parameters/xib-trace-id'
  /send:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/DataResponseShortInfoDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: Not Found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: Different errors
          schema:
            $ref: '#/definitions/FailureResponse'
      operationId: sendMessage
      parameters:
      - name: requestBody
        required: true
        in: body
        schema:
          $ref: '#/definitions/SignedRequestDto'
    parameters:
    - $ref: '#/parameters/xib-trace-id'
  /check-status/{iin}/{correlationId}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/StatusResponse'
      parameters:
      - name: correlationId
        type: string
        required: true
        in: path
        description: Идентификатор цепочки сообщения в системе получателя запроса
      - name: iin
        type: string
        required: true
        in: path
        description: ИИН
      operationId: checkStatus
    parameters:
    - $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
  StatusResponse:
    properties:
      correlationId:
        type: string
        description: Идентификатор корреляции
      messageType:
        type: string
        description: 'Тип сообщения: (NOTIFICATION | RESPONSE)'
      rawData:
        type: string
        description: XML ответ от ГО
      data:
        type: string
        description: JSON ответ в зависимости от сервиса
      status:
        type: string
        description: Статус ответа (SUCCESS | FAILURE)
      statusMessage:
        type: string
        description: описание статуса ответа
    additionalProperties: false
  BenefiziarTypeDto:
    title: Бенефициары юридического лица
    required:
    - personType
    type: object
    properties:
      personType:
        type: array
        items:
          $ref: '#/definitions/PersonTypeDto'
  CapitalShareListTypeDto:
    title: Сведения об уставном капитале юрлица
    type: object
    properties:
      capitalValue:
        title: Сумма уставного капитала, тенге
        type: number
        format: double
      state:
        $ref: '#/definitions/CapitalShareListTypeStateDto'
      private:
        $ref: '#/definitions/CapitalShareListTypePrivateDto'
  CapitalShareListTypePrivateDto:
    title: Доля частного капитала
    type: object
    properties:
      tenge:
        title: вклад в тенге
        type: number
        format: double
      percent:
        title: доля в %
        type: number
        format: double
  CapitalShareListTypeStateDto:
    title: Доля государственного капитала
    type: object
    properties:
      tenge:
        title: вклад в тенге
        type: number
        format: double
      percent:
        title: доля в %
        type: number
        format: double
  CompanyTypeDto:
    title: Учредитель ЮЛ
    required:
    - fullName
    - incCountry
    type: object
    properties:
      bin:
        title: БИН. Для резидентов РК обязателен
        type: string
      incCountry:
        title: Страна инкорпорации
        type: string
      regNumber:
        title: Регистрационный номер в стране инкорпорации. Для нерезинтов РК, не
          имеющих БИН обязателен
        type: string
      taxNumber:
        title: Налоговый номер в стране инкорпорации. Для нерезинтов РК, не имеющих
          БИН обязателен.
        type: string
      fullName:
        title: Полное наименование на русском языке
        type: string
      regDate:
        title: Дата регистрации (перерегистрации) Для нерезинтов РК, не имеющих БИН
          обязателен.
        type: string
        format: date-time
      activity:
        title: Вид деятельности. Для нерезидента РК обязателен
        type: string
  CouncilMembersDto:
    title: Члены совета
    required:
    - iin
    type: object
    properties:
      iin:
        title: ИИН
        type: string
  DocumentTypeDto:
    title: Сведения о документе заявления
    required:
    - documentId
    - fileName
    type: object
    properties:
      documentType:
        title: Тип документа
        type: integer
        format: int32
      fileName:
        title: Название файла с расширением
        type: string
      documentId:
        title: Идентификатор документа в ИС ХЭД для скачивания
        type: string
  DocumentsTypeDto:
    title: Вложенные документы
    required:
    - document
    type: object
    properties:
      document:
        type: array
        items:
          $ref: '#/definitions/DocumentTypeDto'
  EconomicActivitiesTypeDto:
    title: Виды экономической деятельности юрид.лица (филиала, представительства)
    required:
    - economicActivity
    type: object
    properties:
      economicActivity:
        type: array
        items:
          $ref: '#/definitions/EconomicActivityTypeDto'
  EconomicActivityTypeDto:
    required:
    - code
    type: object
    properties:
      code:
        title: Код по ОКЭД
        type: string
      value:
        title: Удельный вес в %
        type: number
        format: double
      main:
        title: Основной вид деятельности? 1- да, 0 - нет
        type: boolean
  FounderTypeDto:
    title: Сведения об участнике
    type: object
    properties:
      percent:
        title: Доля вклада в процентах
        type: number
        format: double
      value:
        title: Сумма вклада в тенге
        type: number
        format: double
      founderUL:
        $ref: '#/definitions/CompanyTypeDto'
      founderFL:
        $ref: '#/definitions/PersonTypeDto'
  FoundersTypeDto:
    title: Участники юридического лица (не заполняется для филиалов и предстваительств)
    type: object
    properties:
      founder:
        type: array
        items:
          $ref: '#/definitions/FounderTypeDto'
  GbdrnInfoTypeDto:
    title: Сведения ГБД РН о правах на недвижимость
    required:
    - digiSign
    - messageDate
    - messageId
    - rightNotice
    type: object
    properties:
      messageId:
        title: Идентификатор сообщения ГБДРН
        type: string
      messageDate:
        title: Дата-время сообщения ГБДРН
        type: string
        format: date-time
      rightNotice:
        title: Сообщение о наличии зарегистрированного права (аренды) на объект недвижимости
        type: string
      digiSign:
        title: ЭЦП сообщения ГБДРН
        type: string
  GeneralTypeDto:
    title: Тип, описывающий общие данные
    required:
    - requestNumber
    type: object
    properties:
      requestNumber:
        title: номер заявки ПЭП
        type: string
      paymentInfo:
        $ref: '#/definitions/PaymentInfoTypeDto'
  IdentityDocumentTypeDto:
    title: Сведения о документе, удостоверяющем личность
    required:
    - documentNumber
    - documentTypeCode
    - issueDate
    - issuerCode
    type: object
    properties:
      documentTypeCode:
        title: Код типа документа
        type: string
      documentNumber:
        title: Номер документа
        type: string
      issueDate:
        title: Дата выдачи
        type: string
        format: date-time
      issuerCode:
        title: Код органа, выдавшего документ
        type: string
  IntelligenceHeadCompanyTypeDto:
    title: Сведения о головной организации
    required:
    - adress
    - adressRegOrgan
    - countryCode
    - dateReg
    - formActivites
    - international
    - middlename
    - nameKz
    - nameLeader
    - nameRu
    - regNumber
    - registrationAuthority
    - registrationMode
    - startActivites
    - surNameLeader
    - taxNumber
    - typeCapital
    type: object
    properties:
      countryCode:
        title: Страна регистрации
        type: string
      regNumber:
        title: Регистрационный номе
        type: string
      taxNumber:
        title: Налоговый номер
        type: string
      dateReg:
        title: Дата (пере)регистрации
        type: string
        format: date-time
      nameRu:
        title: Наименование на рус языке
        type: string
      nameKz:
        title: Наименование на каз языке
        type: string
      startActivites:
        title: Дата начала деятельности в РК
        type: string
        format: date-time
      formActivites:
        title: Вид деятельности
        type: string
      adress:
        title: Адрес нерезидента в стране инкорпорации
        type: string
      nameLeader:
        title: Имя руководителя
        type: string
      surNameLeader:
        title: Фамилия руководителя
        type: string
      middlename:
        title: Отчество руководителя
        type: string
      contactInformation:
        title: контактная информация
        type: string
      registrationAuthority:
        title: Регистрирующий орган
        type: string
      adressRegOrgan:
        title: Юридический адрес регистрирующего органа
        type: string
      capitalValue:
        title: Размер уставного капитала
        type: number
        format: float
      typeCapital:
        title: Вид установного капитала
        type: string
      international:
        title: '1 - Да, 2 - Нет '
        type: string
      registrationMode:
        title: 1- Режим СЭЗ 2 - Офшор 3 - Иной режим
        type: string
  OrganizationAddressTypeDto:
    title: Сведения об адресе
    required:
    - ateId
    - buildingTypeCode
    - rka
    - zipCode
    type: object
    properties:
      rka:
        title: Код адресного ресурса
        type: string
      zipCode:
        title: Почтовый индекс
        type: string
      ateId:
        title: Уникальный идентификатор АТЕ в ИС АР
        type: string
      geonimCode:
        title: Код геонима
        type: string
      buildingTypeCode:
        title: тип строения
        type: string
      buildingNumber:
        title: Номер строения. Если номер строения не указан, то корпус должен быть
          обязательно
        type: string
      corpusNumber:
        title: Номер корпуса
        type: string
      blockNumber:
        title: Номер блока
        type: string
      appartmentTypeCode:
        title: Код типа помещения
        type: string
      appartmentNumber:
        title: Номер помещения
        type: string
      cabinetNumber:
        title: Номер кабинета. Дополнительно к адресу АР
        type: string
      phone:
        title: контактный телефон, факс
        type: string
  OrganizationRequestorTypeDto:
    title: Тип описывающий заявителя - юрлицо
    required:
    - bin
    - nameRu
    type: object
    properties:
      bin:
        title: БИН
        type: string
      nameRu:
        title: Наименование на русском языке
        type: string
      nameKz:
        title: Наименование на государственном языке
        type: string
  PartiesTypeDto:
    title: Сведение об участнике реорганизации
    required:
    - bin
    - rnn
    - scanDocuments
    type: object
    properties:
      bin:
        title: БИН
        type: string
      rnn:
        title: РНН
        type: string
      scanDocuments:
        $ref: '#/definitions/DocumentsTypeDto'
  PaymentInfoTypeDto:
    title: Тип описывающий данные об уплате регсбора
    required:
    - date
    - iik
    - number
    - payerIdn
    - payerName
    - paymentType
    - recipientBin
    type: object
    properties:
      paymentType:
        title: 'Способ оплаты: 1-посредством ПШЭП, 2 - БВУ'
        type: string
      payerIdn:
        title: 'ИИН плательщика:   руководителя головной организации или БИН головной
          организации'
        type: string
      payerName:
        title: Наименование плательщика
        type: string
      iik:
        title: ИИК - расчетный счет получателя
        type: string
      recipientBin:
        title: БИН получателя платежа
        type: string
      uniquePaymentCode:
        title: уникалный код платежа в ПШЭП  requestNumber в соощении от ПШЭП
        type: string
      number:
        title: Номер чека orderNumber в сообщении от ПШЭП
        type: string
      date:
        title: Дата чека
        type: string
        format: date-time
      payedSum:
        title: Оплаченная сумма регсбора
        type: number
        format: double
      taxOrgCode:
        title: Код организации
        type: string
      kbk:
        title: KBK
        type: string
  PersonRequestorTypeDto:
    title: Тип описывающий заявителя - физлицо
    type: object
    properties:
      iin:
        title: ИИН
        type: string
      surName:
        title: Фамилия
        type: string
      name:
        title: Имя
        type: string
      middleName:
        title: Отчество
        type: string
  PersonTypeDto:
    title: Сведения о физлице
    required:
    - countryCode
    - nationalityRelationCode
    type: object
    properties:
      iin:
        title: ИИН
        type: string
      taxNumber:
        title: Налоговый номер в стране инкорпарации
        type: string
      surname:
        title: Фамилия
        type: string
      name:
        title: Имя
        type: string
      middlename:
        title: Отчество
        type: string
      birthday:
        title: Дата рождения
        type: string
        format: date-time
      statusCode:
        title: Статус лица в ГБДФЛ
        type: string
      identityDocument:
        $ref: '#/definitions/IdentityDocumentTypeDto'
      nationalityRelationCode:
        title: Код отношения к гражданству
        type: string
      residenceCountryCode:
        title: Страна гражданства
        type: string
      countryCode:
        title: Страна местожительства
        type: string
  ReorganizationTypeDto:
    title: Тип, описывающий данные о реорганизации
    required:
    - parties
    - reorganizationTypeCode
    type: object
    properties:
      reorganizationTypeCode:
        title: Код вида реорганизации
        type: string
      reorgUlCount:
        title: Количество юридических лиц, участвующих в реорганизации
        type: integer
        format: int32
      parties:
        title: Тип, описывающий данные о реорганизации
        type: array
        items:
          $ref: '#/definitions/PartiesTypeDto'
  RequestDto:
    title: Запрос на получение XML для подписания
    required:
    - businessData
    type: object
    properties:
      businessData:
        $ref: '#/definitions/RequestTypeDto'
  RequestTypeDto:
    title: Бизнес данные запроса
    required:
    - generalData
    - specificData
    type: object
    properties:
      generalData:
        $ref: '#/definitions/GeneralTypeDto'
      specificData:
        $ref: '#/definitions/SpecificTypeDto'
  RequestorTypeDto:
    title: Тип описывающий заявителя ФЛ/ЮЛ
    required:
    - person
    type: object
    properties:
      person:
        $ref: '#/definitions/PersonRequestorTypeDto'
      organization:
        $ref: '#/definitions/OrganizationRequestorTypeDto'
      legal:
        title: Флаг, определяющий, это ЮЛ или ФЛ
        type: boolean
  ServicedObjectDto:
    title: Обслуживаемые объекты
    required:
    - rka
    type: object
    properties:
      rka:
        type: string
        xml:
          name: RKA
  SpecificAddressDto:
    title: Адрес
    required:
    - addressInfo
    type: object
    properties:
      realtyType:
        title: 'Вид права (обременения) на объект недвижимости: 1 – право собственности;
          2 - аренда более 1 года; 3 - аренда до года'
        type: integer
        format: int32
      realtyIdn:
        title: 'Для юрлица: ИИН/БИН собственника или арендополучателя недвижимого
          имущества  с арендой более 1 года'
        type: string
      gbdrnInfo:
        $ref: '#/definitions/GbdrnInfoTypeDto'
      addressInfo:
        $ref: '#/definitions/OrganizationAddressTypeDto'
  SpecificLeaderDto:
    title: Руководитель
    required:
    - docDate
    - docNumber
    - person
    - positionCode
    type: object
    properties:
      positionCode:
        title: 'Код должности руководителя: 1 – рукводитель; 2 – И.о. руководителя'
        type: string
      docNumber:
        title: Номер документа я решением о назначении
        type: string
      docDate:
        title: Дата документа
        type: string
        format: date-time
      person:
        $ref: '#/definitions/PersonTypeDto'
  SpecificTypeDto:
    title: Тип, описывающий специфические данные, необходимые для регистрации (специфические
      сведения
    required:
    - address
    - decidedOrg
    - decisionDate
    - decisionNumber
    - economicActivities
    - email
    - fullNameKz
    - fullNameRu
    - leader
    - members
    - numberPhone
    - numberPhoneCity
    - orgFormCode
    - requestor
    - staff
    type: object
    properties:
      registeringDepartmentUid:
        title: Уникальный идентификатор регистрирующего органа юстиции
        type: string
      orgFormCode:
        title: 'Код формы организации: 1 – юрлицо; 2 – филиал; 3- представительство'
        type: string
      formOfLawCode:
        title: Код организационно-правовой формы
        type: string
      creationMethod:
        title: Способ создания юридического лица
        type: string
      typeGPCode:
        title: Тип государственного предпрития
        type: string
      fullNameRu:
        title: Полное наименование на русском языке
        type: string
      fullNameKz:
        title: Полное наименование на государственном языке
        type: string
      fullNameEn:
        title: Полное наименование на английском языке
        type: string
      shortNameRu:
        title: окращенное наименование заявителя на русском языке
        type: string
      shortNameKz:
        title: Сокращенное наименование заявителя на государственном языке
        type: string
      shortNameEn:
        title: Сокращенное наименование заявителя на английском языке
        type: string
      economicActivities:
        $ref: '#/definitions/EconomicActivitiesTypeDto'
      staff:
        title: Ожидаемая численность занятых человек
        type: integer
      enterpriseSubjectCode:
        title: Код типа частного предпринимательства
        type: string
      payersVAT:
        title: Регистрируется в качестве плательщика НДС? 1 - Да  2- Нет  0 - филиал
        type: integer
        format: int32
      capitalShareList:
        $ref: '#/definitions/CapitalShareListTypeDto'
      headOrgBin:
        title: БИН головной организации – резидента РК
        type: string
      address:
        $ref: '#/definitions/SpecificAddressDto'
      leader:
        $ref: '#/definitions/SpecificLeaderDto'
      ulFoundersCount:
        title: Всего количество участников юридических лиц (не заполняется для филиалов
          и представительств)
        type: integer
        format: int32
      flFoundersCount:
        title: Всего количество участников физических лиц (не заполняется для филиалов
          и предствительств)
        type: integer
        format: int32
      registryHolderBin:
        title: БИН реестродержателя
        type: string
      founders:
        $ref: '#/definitions/FoundersTypeDto'
      benefiziar:
        $ref: '#/definitions/BenefiziarTypeDto'
      reorganization:
        $ref: '#/definitions/ReorganizationTypeDto'
      scanDocuments:
        $ref: '#/definitions/DocumentsTypeDto'
      agreement:
        title: Согласие услугополучателя на использование сведений в ИС ГО
        type: boolean
      requestor:
        $ref: '#/definitions/RequestorTypeDto'
      servicedObject:
        title: Обслуживаемые объекты
        type: array
        items:
          $ref: '#/definitions/ServicedObjectDto'
      ooCode:
        title: ' 1 - детские, 2 - молодежные, 3 - инвалиды, 4 - национально культурные,
          5 - не относятся к вышеперечисленным'
        type: string
      politicalParty:
        title: Полит Партия?
        type: boolean
      isGo:
        title: isGo
        type: boolean
      typeFond:
        title: Тип ФОНДА
        type: string
      statusOOCode:
        title: 'Заполняется для Общественного объединения ОО или религиозного объединения:
          1 - местный статус; 2 - региональный; 3-республиканский'
        type: string
      headCompatyNerez:
        $ref: '#/definitions/IntelligenceHeadCompanyTypeDto'
      members:
        title: Члены совета
        type: array
        items:
          $ref: '#/definitions/CouncilMembersDto'
      decidedOrg:
        title: Орган, принявший решение о регистрации
        type: string
      decisionNumber:
        title: Номер решения
        type: string
      decisionDate:
        title: Дата решения
        type: string
        format: date-time
      iinChairman:
        title: ИИН председателя
        type: string
      iinSecretary:
        title: ИИН секретаря
        type: string
      email:
        title: email
        type: string
      numberPhone:
        title: Номер телефона
        type: string
      numberPhoneCity:
        title: Городской номер телефона
        type: string
      foreignInvest:
        type: boolean
      oneCitizenShip:
        type: boolean
      defaultUstav:
        type: boolean
      quorum:
        type: boolean
  RequestEncodedDto:
    title: Данные запроса XML (base64)
    required:
    - requestEncoded
    type: object
    properties:
      requestEncoded:
        title: XML в виде base64
        type: string
  SignedRequestDto:
    title: Запрос для отправки в ШЭП, подписанный ЭЦП заявителя
    type: object
    properties:
      signedRequest:
        title: Подписанный XML запрос (base64)
        type: string
      iin:
        type: string
  DataResponseShortInfoDto:
    type: object
    properties:
      messageId:
        type: string
        description: Идентификатор сообщения в системе получателя (заполняет система
          получателя запроса (система отрабатывающая сообщение)
        example: "415810776"
      correlationId:
        type: string
        description: Идентификатор цепочки сообщения в системе получателя запроса
        example: "4344354"
      statusCode:
        type: string
        description: 'Код статуса (проставляется системой получателя запроса). Примеры:
          ''SCSS001'' для успешной обработки, ''SCE001'' - ''SCE007'' для различных
          ошибок. Обратите внимание, что коды ошибок начиная с ''SCE001'' предназначены
          для синхронного канала'
        example: SCSS001
      statusMessage:
        type: string
        description: 'Сообщение о статусе. Примеры: ''Сервис отработал штатно'' -
          для успешной обработки, ''Сообщение не соответствует формату'', ''Неправильный
          логин или пароль'', ''Пользователь не имеет прав на сервис'', ''Сервис не
          существует'', ''Транспортная подпись не актуальная'', ''Не верная транспортная
          подпись'', ''Сообщение не подписано'' - для ошибок синхронного канала'
        example: Сервис отработал штатно
      sessionId:
        type: string
        description: Идентификатор сессии на ВШЭП. Устанавливается на ВШЭП. При отправки
          ответа системой получателя запроса заполнять не нужно.
        example: '{7a53f7b3-6d2b-4be3-9682-8d19e5a1c0e6}'
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
...