GbdrnReport305 API

GbdrnReport305 API 1.0.0

0
No votes yet

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

expand_moreexpand_lessContact information
АО «Банк ЦентрКредит»
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"

Paths

/{iin}

post /{iin}
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

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

iin
Required in path
string

ИИН

requestBody
Required in body
object

Тело запроса

GbdrnReportRequest
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

GbdrnReportResponse
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report-305/{iin}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report-305/{iin}
content-type
accept
xib-trace-id
iin

/{iin}/check-status/{correlationId}

get /{iin}/check-status/{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

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

iin
Required in path
string

ИИН

Accept
Optional in header
string
application/json
200

200 OK

StatusResponse
Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report-305/{iin}/check-status/{correlationId}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/gbdrn-report-305/{iin}/check-status/{correlationId}
accept
xib-trace-id
correlationId
iin

Definitions 

{
    "properties": {
        "messageId": {
            "type": "string",
            "description": "Идентификатор сообщения в системе получателя (заполняет система получателя запроса (система отрабатывающая сообщение))",
            "example": "41577741654"
        },
        "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}"
        }
    },
    "additionalProperties": false
}
              
{
    "properties": {
        "applicationId": {
            "type": "string",
            "description": "Идентификатор заявки"
        },
        "cadastralNumber": {
            "type": "string",
            "description": "Кадастровый номер"
        }
    },
    "additionalProperties": false,
    "required": [
        "applicationId"
    ]
}
              
{
    "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
}