GbdrnReport303 API

GbdrnReport303 API 1.0.0

0
Голосов пока нет

Сервис выдачи справки о зарегистрированных правах (обременениях) на недвижимое имущество и его технических характеристиках ЮЛ

expand_moreexpand_lessКонтактная информация
АО «Банк ЦентрКредит»
production
development
https://api.bcc.kz:10443/bcc/production

Альтернативная точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"

production
https://api.bcc.kz/bcc/production

Точка подключения для вызова сервиса в продуктивной среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "PRODUCTION"

development
https://api-test.bcc.kz/bcc/production

Точка подключения для вызова сервисов в тестовой среде. Зарегистрированное на портале developer.bcc.kz приложение должно быть в режиме "DEVELOPMENT"

Пути

/send

post /send

Получить информацию о недвижимости ЮЛ

Authorization
Authorization
(oauth2 application)

Токен аутентификации, полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.govtech.api
Allow access to Goventment Services API
RequestBody
Required in body
object
RequestDto
xib-trace-id
Required in header
string

Уникальный идентификатор запроса

Content-Type
Опционально в header
string
application/json
Accept
Опционально в header
string
application/json
200

200 OK

DataResponseShortInfoDto
400

Validation errors

FailureResponse
404

Not Found

FailureResponse
500

Different errors

FailureResponse
Пример запроса
Пример ответа
POST https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report303/send
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report303/send
content-type
accept
xib-trace-id

/check-status/{bin}/{correlationId}

get /check-status/{bin}/{correlationId}
Authorization
Authorization
(oauth2 application)

Токен аутентификации, полученный при вызове сервиса авторизации

Token URL
https://api.bcc.kz/bcc/production/v2/oauth/token
Scopes
bcc.application.govtech.api
Allow access to Goventment Services API
xib-trace-id
Required in header
string

Уникальный идентификатор запроса

correlationId
Required in path
string

Идентификатор цепочки сообщения в системе получателя запроса

bin
Required in path
string

БИН

Accept
Опционально в header
string
application/json
200

200 OK

StatusResponse
Пример запроса
Пример ответа
GET https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report303/check-status/{bin}/{correlationId}
Попробуйте выполнить эту операцию
https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report303/check-status/{bin}/{correlationId}
accept
xib-trace-id
correlationId
bin

Определения 

{
    "type": "object",
    "properties": {
        "timestamp": {
            "type": "string",
            "format": "date-time"
        },
        "error": {
            "type": "string"
        },
        "violations": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/Violation"
            }
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "message": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "Название ЮЛ на русс"
        },
        "nameKz": {
            "type": "string",
            "description": "Название ЮЛ на каз"
        },
        "rnn": {
            "type": "string",
            "description": "РНН"
        },
        "bin": {
            "type": "string",
            "description": "БИН ЮЛ"
        },
        "registrationNumber": {
            "type": "string"
        },
        "organizationFormId": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "lastName": {
            "type": "string"
        },
        "firstName": {
            "type": "string"
        },
        "middleName": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "arCode": {
            "type": "string"
        },
        "streetCode": {
            "type": "string"
        },
        "conStreetCode": {
            "type": "string"
        },
        "cooperativeCode": {
            "type": "string"
        },
        "building": {
            "type": "string"
        },
        "corpus": {
            "type": "string"
        },
        "flat": {
            "type": "string"
        },
        "addrStr": {
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "owner": {
            "$ref": "#\/definitions\/OrganizationRequisitesTypeDto",
            "description": "Собственник"
        },
        "ownerShort": {
            "$ref": "#\/definitions\/OwnerShortDto",
            "description": "Собственник крат."
        },
        "objectType": {
            "type": "string",
            "description": "Вид объекта недвижимости"
        },
        "objectLocation": {
            "$ref": "#\/definitions\/RealEstateObjectAddressTypeDto",
            "description": "Код РК"
        },
        "cadastralNumber": {
            "type": "string",
            "description": "Кадастровый номер"
        },
        "language": {
            "type": "string",
            "enum": [
                "RU",
                "KZ",
                "ALL"
            ],
            "description": "Язык запроса"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "requestNumber": {
            "type": "string"
        },
        "declarantId": {
            "type": "string"
        },
        "requestDate": {
            "type": "string",
            "format": "date-time"
        },
        "registredRightsOrganizationRequest": {
            "$ref": "#\/definitions\/RegistredRightsOrganizationRequestDto"
        }
    }
}
              
{
    "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}"
        }
    }
}
              
{
    "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
}