---
swagger: "2.0"
info:
  x-ibm-name: owner-nedobj-for-online-reg-ul-api
  title: OwnerNedobjForOnlineRegUL API
  version: 1.0.0
  description: Сервис предоставления данных о наличии прав (аренды) на недвижимость
    для онлайн регистрации ЮЛ
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/owner/nedobj-for-online-reg-ul
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
security:
- Authorization:
  - bcc.application.govtech.api
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /xml-for-sign:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            type: string
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
      operationId: XmlForSign
      parameters:
      - name: body
        required: true
        in: body
        schema:
          $ref: '#/definitions/RequestDataDto'
    parameters:
    - $ref: '#/parameters/xib-trace-id'
  /send:
    post:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/ResponseMessageDto'
        400:
          description: Validation errors
          schema:
            $ref: '#/definitions/FailureResponse'
      summary: ""
      operationId: Send
      parameters:
      - name: body
        required: true
        in: body
        schema:
          $ref: '#/definitions/SignedRequest'
    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
  ResponseMessageDto:
    type: object
    properties:
      businessData:
        $ref: '#/definitions/ResponseDataTypeDto'
      error:
        type: string
        description: Спецификация ошибок
  ResponseDataTypeDto:
    type: object
    required:
    - rezult
    properties:
      rezult:
        $ref: '#/definitions/RezultDto'
      realtyIdn:
        type: string
        description: 'Вид права (обременения) на объект недвижимости: 1 – право собственности;
          2 - аренда'
      address:
        type: array
        items:
          $ref: '#/definitions/AddressTypeDto'
        description: Сведения об адресе
      addressNoRKA:
        type: array
        items:
          $ref: '#/definitions/AddressNoRKATypeDto'
        description: Сведения об адресе без РКА
  RezultDto:
    type: object
    required:
    - code
    - nameKz
    - nameRu
    properties:
      code:
        type: string
        description: Код результата
      nameRu:
        type: string
        description: Сообщение на русском языке
      nameKz:
        type: string
        description: Сообщение на государственном языке
  AddressTypeDto:
    type: object
    required:
    - ateId
    - nameKz
    - nameRu
    - rka
    properties:
      nameRu:
        type: string
        description: Адрес на русском языке
      nameKz:
        type: string
        description: Адрес на государственном языке
      rka:
        type: string
        description: Код адресного ресурса
      ateId:
        type: string
        description: Уникальный идентификатор АТЕ в ИС АР
      geonimCode:
        type: string
        description: Код геонима
      buildingTypeCode:
        type: string
        description: Тип строения
      buildingNumber:
        type: string
        description: Номер строения. Если номер строения не указан, то корпус должен
          быть обязательно
      corpusNumber:
        type: string
        description: Номер корпуса
      blockNumber:
        type: string
        description: Номер блока
      appartmentTypeCode:
        type: string
        description: Код типа помещения
      appartmentNumber:
        type: string
        description: Номер помещения
  AddressNoRKATypeDto:
    type: object
    required:
    - nameKz
    - nameRu
    properties:
      nameRu:
        type: string
        description: Адрес на русском языке
      nameKz:
        type: string
        description: Адрес на государственном языке
  RequestDataDto:
    properties:
      requestType:
        type: integer
        description: 'Тип запроса:  1 –право собственности 2 –аренда'
        format: int32
      ateId:
        type: string
        description: 'Уникальный идентификатор АТЕ: Населенный пункт по справочнику
          АТЕ ИС АР'
      idn:
        type: string
        description: ИИН/БИН
    additionalProperties: false
    required:
    - requestType
    - idn
  SignedRequest:
    properties:
      signedRequest:
        type: string
      idn:
        type: string
        description: ИИН/БИН
    additionalProperties: false
    required:
    - signedRequest
    - idn
tags: []
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
...