---
swagger: "2.0"
info:
  x-ibm-name: gbdfl-universal-token-api
  title: GBDFLUniversal_token API
  version: 1.0.0
  description: Сервис получения информации о физическом лице по ИИН
  contact:
    name: АО «Банк ЦентрКредит»
    email: api@bcc.kz
schemes:
- https
basePath: /v1/gbdfl-universal-token
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.endpoint.hostname)/v2/oauth/token
security:
- Authorization:
  - bcc.application.govtech.api
x-ibm-configuration:
  testable: true
  enforced: true
  phase: realized
paths:
  /{iin}:
    get:
      responses:
        200:
          description: 200 OK
          schema:
            $ref: '#/definitions/PersonDto'
        400:
          description: 400 Bad Request
          schema:
            $ref: '#/definitions/FailureResponse'
        404:
          description: 404 Not Found
          schema:
            $ref: '#/definitions/FailureResponse'
        500:
          description: 500 Internal Server Error
          schema:
            $ref: '#/definitions/FailureResponse'
      parameters:
      - name: iin
        type: string
        required: true
        in: path
        description: ИИН
      - $ref: '#/parameters/xib-trace-id'
      security:
      - []
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
  DocumentDto:
    title: Данные о документе
    type: object
    properties:
      docTypeCode:
        title: Тип документа код
        type: string
      docTypeNameRu:
        title: Тип документа наименование РУС
        type: string
      docTypeNameKz:
        title: Тип документа наименование КАЗ
        type: string
      docTypeChangeDate:
        title: Дата последнего изменения справочного значения
        type: string
        format: date-time
      docStatusCode:
        title: Признак действительности документа
        type: string
      docStatusNameRu:
        title: Признак действительности документа наименование РУС
        type: string
      docStatusNameKz:
        title: Признак действительности документа наименование КАЗ
        type: string
      docStatusChangeDate:
        title: Дата последнего изменения справочного значения
        type: string
        format: date-time
      docIssueOrganizationCode:
        title: Организация, выдавшая документ
        type: string
      docIssueOrganizationNameRu:
        title: Организация, выдавшая документ наименованиеРУС
        type: string
      docIssueOrganizationNameKz:
        title: Организация, выдавшая документ наименование КАЗ
        type: string
      docIssueOrganizationChangeDate:
        title: Дата последнего изменения справочного значения
        type: string
        format: date-time
      invalidityDate:
        title: Дата недействительности документа
        type: string
        format: date-time
      docNumber:
        title: Номер документа
        type: string
      beginDate:
        title: Дата выдачи
        type: string
        format: date-time
      endDate:
        title: Срок действия
        type: string
        format: date-time
      series:
        title: Серия документа
        type: string
      surname:
        title: Фамилия физического лица на момент выдачи документа
        type: string
      name:
        title: Имя физического лица на момент выдачи документа
        type: string
      patronymic:
        title: Отчество физического лица на момент выдачи документа
        type: string
      birthDate:
        title: Дата рождения физического лица
        type: string
        format: date-time
  PersonDto:
    title: Данные о ФЛ
    type: object
    properties:
      iin:
        title: ИИН
        type: string
      lastName:
        title: Фамилия
        type: string
      firstName:
        title: Имя
        type: string
      middleName:
        title: Отчество
        type: string
      engFirstName:
        title: Имя на анг
        type: string
      engSurname:
        title: Фамилия на анг
        type: string
      dateOfBirth:
        title: Дата рождения dd.MM.yyyy
        type: string
        format: date-time
      dateOfDeath:
        title: Дата смерти dd.MM.yyyy
        type: string
        format: date-time
      nationality:
        $ref: '#/definitions/DictionaryItemDto'
      citizenship:
        $ref: '#/definitions/DictionaryItemDto'
      lifeStatus:
        $ref: '#/definitions/DictionaryItemDto'
      imprisonedStatus:
        $ref: '#/definitions/PersonImprisoneStatusDto'
      birthCertificate:
        $ref: '#/definitions/CertificateDto'
      deathCertificate:
        $ref: '#/definitions/CertificateDto'
      personCapableStatus:
        $ref: '#/definitions/PersonCapableStatusDto'
      missingStatus:
        $ref: '#/definitions/MissingStatusDto'
      disappearStatus:
        $ref: '#/definitions/DisappearStatusDto'
      excludeStatus:
        $ref: '#/definitions/PersonExcludeStatusDto'
      repatriationStatus:
        $ref: '#/definitions/PersonRepatriationStatusDto'
      gender:
        $ref: '#/definitions/DictionaryItemDto'
      regAddress:
        $ref: '#/definitions/RegAddressDto'
      birthPlace:
        $ref: '#/definitions/BirthPlaceDto'
      documents:
        title: Документы
        type: array
        items:
          $ref: '#/definitions/DocumentDto'
      addresses:
        title: Сведения о других адресах физического лица
        type: array
        items:
          $ref: '#/definitions/AddressDto'
      removed:
        title: Признак удаления записи о физическом лице из Национального реестра
        type: boolean
  AddressDto:
    title: Другие адреса (например, адрес временной регистрации, адрес убытия)
    type: object
    properties:
      type:
        $ref: '#/definitions/DictionaryItemDto'
      country:
        $ref: '#/definitions/DictionaryItemDto'
      district:
        $ref: '#/definitions/DictionaryItemDto'
      region:
        $ref: '#/definitions/DictionaryItemDto'
      foreignData:
        $ref: '#/definitions/ForeignDataDto'
      city:
        title: Населенный пункт
        type: string
      streetLocation:
        title: Место жительства - улица
        type: string
      houseLocation:
        title: Место жительства - дом
        type: string
      building:
        title: Место жительства - дом
        type: string
      apartmentLocation:
        title: Место жительства - квартира
        type: string
      corpus:
        title: Место жительства - корпус
        type: string
      beginDate:
        title: Дата регистрации по адресу
        type: string
        format: date-time
      endDate:
        title: Дата снятия с регистрации по адресу
        type: string
        format: date-time
      arCode:
        title: Код адреса в формате Адресного регистра
        type: string
  ForeignDataDto:
    title: Данные о адресе за пределами Казахстана
    type: object
    properties:
      districtName:
        title: Область (не Казахстан)
        type: string
      regionName:
        title: Район (не Казахстан)
        type: string
  BirthPlaceDto:
    title: Место рождения
    type: object
    properties:
      country:
        $ref: '#/definitions/DictionaryItemDto'
      district:
        $ref: '#/definitions/DictionaryItemDto'
      region:
        $ref: '#/definitions/DictionaryItemDto'
      foreignData:
        $ref: '#/definitions/ForeignDataDto'
      city:
        title: Населенный пункт
        type: string
      birthTeCodeAR:
        title: Код адреса рождения в формате Адресного регистра
        type: string
  RegAddressDto:
    title: Место жительства
    type: object
    properties:
      address:
        title: Адрес
        type: string
      addressKaz:
        title: Адрес каз
        type: string
      country:
        $ref: '#/definitions/DictionaryItemDto'
      district:
        $ref: '#/definitions/DictionaryItemDto'
      region:
        $ref: '#/definitions/DictionaryItemDto'
      foreignData:
        $ref: '#/definitions/ForeignDataDto'
      city:
        title: Населенный пункт
        type: string
      streetLocation:
        title: Место жительства - улица
        type: string
      building:
        title: Место жительства - дом
        type: string
      houseLocation:
        title: Место жительства - дом
        type: string
      apartmentLocation:
        title: Место жительства - квартира
        type: string
      corpus:
        title: Место жительства - корпус
        type: string
      beginDate:
        title: Дата выдачи
        type: string
        format: date-time
      endDate:
        title: Срок действия
        type: string
        format: date-time
      status:
        $ref: '#/definitions/DictionaryItemDto'
      invalidity:
        $ref: '#/definitions/DictionaryItemDto'
      arCode:
        title: Код адреса в формате Адресного регистра
        type: string
  PersonRepatriationStatusDto:
    title: Статус оралмана
    type: object
    properties:
      repatriationStatus:
        $ref: '#/definitions/DictionaryItemDto'
      repatriationDate:
        title: Дата начала действия статуса
        type: string
        format: date-time
      repatriationEndDate:
        title: Дата окончания действия статуса
        type: string
        format: date-time
      repatriationNumber:
        title: Номер дела
        type: string
      repatriationOrg:
        $ref: '#/definitions/DictionaryItemDto'
      repatriationReason:
        $ref: '#/definitions/DictionaryItemDto'
  DisappearStatusDto:
    title: Физическое лицо скрывается от дознания, следствия, суда и отбытия наказания
    type: object
    properties:
      disappear:
        title: Текущий статус - скрывается (Да/Нет)
        type: boolean
      disappearDate:
        title: Дата начала действия статуса
        type: string
        format: date
      disappearEndDate:
        title: Дата окончания действия статуса
        type: string
        format: date
      disappearNumber:
        title: Номер дела
        type: string
      gpTerritorial:
        $ref: '#/definitions/DictionaryItemDto'
  PersonExcludeStatusDto:
    title: Признак исключения/условного исключения ИИН из Национального реестра
    type: object
    properties:
      excludeReason:
        $ref: '#/definitions/DictionaryItemDto'
      excludeReasonDate:
        title: Дата начала действия статуса
        type: string
        format: date
      excludeDate:
        title: Дата окончания действия статуса
        type: string
        format: date
      excludeParticipant:
        $ref: '#/definitions/DictionaryItemDto'
  MissingStatusDto:
    title: Статус физического лица 'Пропавший без вести'
    type: object
    properties:
      missing:
        title: Пропавший без вести (Да/Нет)
        type: boolean
      missingDate:
        title: Дата начала действия статуса
        type: string
        format: date
      missingEndDate:
        title: Дата окончания действия статуса
        type: string
        format: date
      missingNumber:
        title: Номер дела
        type: string
      gpTerritorial:
        $ref: '#/definitions/DictionaryItemDto'
  PersonCapableStatusDto:
    title: Сведения о дееспособности физического лица
    type: object
    properties:
      capableStatus:
        $ref: '#/definitions/DictionaryItemDto'
      capableDate:
        title: Дата начала действия статуса
        type: string
        format: date
      capableEndDate:
        title: Дата окончания действия статуса
        type: string
        format: date
      capableNumber:
        title: Номер дела в суде
        type: string
      court:
        $ref: '#/definitions/DictionaryItemDto'
  CertificateDto:
    title: Данные о свидетельстве
    type: object
    properties:
      number:
        title: Номер свидетельства
        type: string
      beginDate:
        title: Дата выдачи свидетельства
        type: string
        format: date
      issueOrganisation:
        title: Организация, выдавшая свидетельство
        type: string
  PersonImprisoneStatusDto:
    title: Статус судимости
    type: object
    properties:
      imprisonedStatus:
        $ref: '#/definitions/DictionaryItemDto'
      imprisonedBeginDate:
        title: Дата начала судимости
        type: string
        format: date
      imprisonedEndDate:
        title: Дата окончания судимости
        type: string
        format: date
  DictionaryItemDto:
    title: Справочная информация
    type: object
    properties:
      code:
        title: Код
        type: string
      nameRu:
        title: Наименование на рус.
        type: string
      nameKz:
        title: Наименование на каз.
        type: string
      changeDate:
        title: Дата последнего изменения справочного значения
        type: string
        format: date-time
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
...