Digital Consents API

Digital Consents 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

/{id}/send-otp

post /{id}/send-otp
DigitalConsentIndividualController

Отправка SMS кода для подтверждения действия (согласие, отзыв) по ЦС

Создание черновика ЦС для физ. лица (с формированием документа для дальнейшего подтверждения)

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | DIGITAL_CONSENT_NOT_FOUND

INVALID_STATE | OTP_SEND_FAILURE | DIGITAL_CONSENT_INDIVIDUAL_INVALID_DOCUMENT

DIGITAL_CONSENT_INDIVIDUAL_OTP_ALREADY_CONFIRMED

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
id
Required in path
integer / int64

Идентификатор ЦС

Accept-Language
Required in header
string

Код культуры KK | RU | EN

requestBody
Required in body
object

Тело запроса

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

OK

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/send-otp
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/send-otp
content-type
accept
Accept-Language
id

/{id}/confirm-otp

post /{id}/confirm-otp
DigitalConsentIndividualController

Подтверджение действия (согласие, отзыв) по ЦС полученным SMS кодом

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | DIGITAL_CONSENT_NOT_FOUND

INVALID_STATE | OTP_CONFIRM_INCORRECT_PARAMETERS | OTP_CONFIRM_FAILURE

OTP_CONFIRM_REJECTED | DIGITAL_CONSENT_INDIVIDUAL_OTP_ALREADY_CONFIRMED

DIGITAL_CONSENT_INDIVIDUAL_INVALID_DOCUMENT | OTP_CONFIRM_INVALID_DOCUMENT_CHECKSUM

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
id
Required in path
integer / int64

Идентификатор ЦС

body
Required in body
object
DigitalConsentIndividualConfirmWithOtpRequestDto
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

OK

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/confirm-otp
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/confirm-otp
content-type
accept
id

/{id}/confirm-biometry

post /{id}/confirm-biometry
DigitalConsentIndividualController

Подтвердить прохождение биометрии

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | DIGITAL_CONSENT_NOT_FOUND

INVALID_STATE | DIGITAL_CONSENT_INDIVIDUAL_DOCUMENT_IS_NOT_CONFIRMED

DIGITAL_CONSENT_INDIVIDUAL_INVALID_DOCUMENT | BIOMETRY_VERIFY_FAILURE

BIOMETRY_VERIFY_REJECTED | BIOMETRY_VERIFY_EXPIRED

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
id
Required in path
integer / int64

Идентификатор ЦС

body
Required in body
object
DigitalConsentIndividualConfirmBiometryRequestDto
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

OK

Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/confirm-biometry
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/confirm-biometry
content-type
accept
id

/revoke

post /revoke
DigitalConsentIndividualController

Отзыв ЦС

Создание черновика ЦС для физ. лица (с формированием документа для дальнейшего подтверждения)

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | BMG_VERIFICATION_INCORRECT_PARAMETERS

BMG_VERIFICATION_NOT_REGISTERED | BMG_VERIFICATION_FAILURE

DIGITAL_CONSENT_INDIVIDUAL_ACTIVE_NOT_EXIST | PRODUCT_NOT_AVAILABLE

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
body
Required in body
object
DigitalConsentIndividualRevokeRequestDto
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
*/*
200

OK

DigitalConsentIndividualRevokeResponseDto
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/revoke
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/revoke
content-type
accept

/draft

post /draft
DigitalConsentIndividualController

Создание черновика ЦС

Создание черновика ЦС для физ. лица (с формированием документа для дальнейшего подтверждения)

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | BMG_VERIFICATION_INCORRECT_PARAMETERS

BMG_VERIFICATION_NOT_REGISTERED | BMG_VERIFICATION_FAILURE

DIGITAL_CONSENT_INDIVIDUAL_ACTIVE_EXIST | PRODUCT_NOT_AVAILABLE

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
body
Required in body
object
DigitalConsentIndividualCreateDraftRequestDto
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
*/*
200

OK

DigitalConsentIndividualCreateDraftResponseDto
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/draft
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/draft
content-type
accept

/{id}

get /{id}
DigitalConsentIndividualController

Получить ЦС по идентификатору

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | DIGITAL_CONSENT_NOT_FOUND

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
id
Required in path
integer / int64

Идентификатор ЦС

signerIin
Required in query
string

ИИН клиента

Accept
Optional in header
string
*/*
200

OK

DigitalConsentIndividualResponseDto
Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}
accept
id
signerIin

/{id}/init-biometry

post /{id}/init-biometry
DigitalConsentIndividualController

Инициализация прохождения биометрии

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | DIGITAL_CONSENT_NOT_FOUND

INVALID_STATE | OTP_SEND_FAILURE | DIGITAL_CONSENT_INDIVIDUAL_INVALID_DOCUMENT

DIGITAL_CONSENT_INDIVIDUAL_OTP_ALREADY_CONFIRMED

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
id
Required in path
integer / int64

Идентификатор ЦС

requestBody
Required in body
object

Тело запроса

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

OK

DigitalConsentIndividualInitBiometryResponseDto
Example Request
Example Response
POST https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/init-biometry
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/{id}/init-biometry
content-type
accept
id

/list/by-signer/{signerIin}

get /list/by-signer/{signerIin}
DigitalConsentIndividualController

Получить список цифровых согласий по физ. лицу

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | DIGITAL_CONSENT_NOT_FOUND

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
signerIin
Required in path
string

ИИН клиента

page
Optional in query
integer / int32

Номер страницы

{
    "default": 0
}
size
Optional in query
integer / int32

Количество элементов на странице

{
    "default": 10
}
Accept
Optional in header
string
*/*
200

OK

PageDigitalConsentIndividualResponseDto
Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/list/by-signer/{signerIin}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/list/by-signer/{signerIin}
accept
signerIin
page
size

/check-state/{signerIin}

get /check-state/{signerIin}
DigitalConsentIndividualController

Проверка наличия активного цифрового согласия

Возможные коды ошибок:

VALIDATION_EXCEPTION | INTERNAL_ERROR | PRODUCT_NOT_AVAILABLE

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
signerIin
Required in path
string

ИИН клиента

Accept
Optional in header
string
*/*
200

OK

DigitalConsentIndividualCheckStateResponseDto
Example Request
Example Response
GET https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/check-state/{signerIin}
Try this operation
https://api.bcc.kz:10443/bcc/production/v1/digital-consent/individual/check-state/{signerIin}
accept
signerIin

Definitions

Ответ цифрового согласия (физ. лицо)

{
    "type": "object",
    "properties": {
        "id": {
            "type": "integer",
            "format": "int64"
        },
        "createDate": {
            "type": "string",
            "format": "date-time"
        },
        "updateDate": {
            "type": "string",
            "format": "date-time"
        },
        "partner": {
            "$ref": "#\/definitions\/PartnerShortInfoDto"
        },
        "product": {
            "$ref": "#\/definitions\/ProductShortInfoDto"
        },
        "signerClientId": {
            "type": "string",
            "description": "Идентификатор клиента"
        },
        "signerClientIdn": {
            "type": "string",
            "description": "БИН клиента"
        },
        "signerClientName": {
            "type": "string",
            "description": "Наименование компании"
        },
        "signerIin": {
            "type": "string",
            "description": "ИИН физ. лица"
        },
        "signerData": {
            "$ref": "#\/definitions\/UserIndividualDto"
        },
        "state": {
            "type": "string",
            "description": "Текущий статус цифрового согласия (DRAFT - черновик, ACTIVE - подписан, REVOKED - отозван, DELETED - удален, EXPIRED - истекший)",
            "example": "ACTIVE",
            "enum": [
                "DRAFT",
                "ACTIVE",
                "REVOKED",
                "DELETED",
                "EXPIRED"
            ]
        },
        "startDate": {
            "type": "string",
            "description": "Дата создания заявки",
            "format": "date",
            "example": "2022-09-01"
        },
        "endDate": {
            "type": "string",
            "description": "Дата окончания цифрового согласия (максимальный срок 1 год)",
            "format": "date",
            "example": "2023-09-01"
        }
    }
}

Данные для получения OTP кода через SMS по цифровому согласию

{
    "type": "object",
    "required": [
        "signerIin"
    ],
    "properties": {
        "signerIin": {
            "type": "string",
            "maxLength": 12,
            "minLength": 12,
            "description": "ИИН физ. лица",
            "example": "123456789012"
        }
    }
}

Данные подверждения (согласие, отзыв) по цифровому согласию с OTP (физ. лицо)

{
    "type": "object",
    "required": [
        "documentContentBase64",
        "otpCode",
        "signerIin"
    ],
    "properties": {
        "signerIin": {
            "type": "string",
            "maxLength": 12,
            "minLength": 12,
            "description": "ИИН физ. лица",
            "example": "123456789012"
        },
        "documentContentBase64": {
            "type": "string",
            "description": "Документ согласия (отзыва) в формате base64"
        },
        "otpCode": {
            "type": "string",
            "description": "OTP код"
        }
    }
}

Данные подверждения (согласие, отзыв) биометрией (физ. лицо)

{
    "type": "object",
    "required": [
        "biometryRefId",
        "signerIin"
    ],
    "properties": {
        "signerIin": {
            "type": "string",
            "maxLength": 12,
            "minLength": 12,
            "description": "ИИН физ. лица",
            "example": "123456789012"
        },
        "biometryRefId": {
            "type": "string",
            "description": "Идентификатор пройденной биометрии"
        }
    }
}

Данные для старта процесса отзыва цифрового согласия (физ. лицо)

{
    "type": "object",
    "required": [
        "signerIin",
        "signerPhone"
    ],
    "properties": {
        "signerIin": {
            "type": "string",
            "maxLength": 12,
            "minLength": 12,
            "description": "ИИН физ. лица",
            "example": "123456789012"
        },
        "signerPhone": {
            "type": "string",
            "description": "Номер телефона физ. лица",
            "example": "77771234567"
        }
    }
}

Ответ инициализации отзыва цифрового согласия (физ. лицо)

{
    "type": "object",
    "properties": {
        "id": {
            "type": "integer",
            "format": "int64"
        },
        "createDate": {
            "type": "string",
            "format": "date-time"
        },
        "updateDate": {
            "type": "string",
            "format": "date-time"
        },
        "partner": {
            "$ref": "#\/definitions\/PartnerShortInfoDto"
        },
        "product": {
            "$ref": "#\/definitions\/ProductShortInfoDto"
        },
        "signerClientId": {
            "type": "string",
            "description": "Идентификатор клиента"
        },
        "signerClientIdn": {
            "type": "string",
            "description": "БИН клиента"
        },
        "signerClientName": {
            "type": "string",
            "description": "Наименование компании"
        },
        "signerIin": {
            "type": "string",
            "description": "ИИН физ. лица"
        },
        "signerData": {
            "$ref": "#\/definitions\/UserIndividualDto"
        },
        "state": {
            "type": "string",
            "description": "Текущий статус цифрового согласия(DRAFT - черновик, ACTIVE - подписан, REVOKED - отозван, DELETED - удален, EXPIRED - истекший)",
            "example": "2022-09-01",
            "enum": [
                "DRAFT",
                "ACTIVE",
                "REVOKED",
                "DELETED",
                "EXPIRED"
            ]
        },
        "startDate": {
            "type": "string",
            "description": "Дата создания заявки",
            "format": "date",
            "example": "2022-09-01"
        },
        "endDate": {
            "type": "string",
            "description": "Дата окончания цифрового согласия (максимальный срок 1 год)",
            "format": "date",
            "example": "2023-09-01"
        },
        "digitalConsentDocumentContentBase64": {
            "type": "string",
            "description": "Документ цифрового согласия (base64)"
        }
    }
}

Партнер

{
    "type": "object",
    "required": [
        "partnerBin",
        "partnerNameLongKz",
        "partnerNameLongRu",
        "partnerNameShort",
        "responsiblePersonName"
    ],
    "properties": {
        "id": {
            "type": "integer",
            "format": "int64"
        },
        "partnerNameShort": {
            "type": "string",
            "maxLength": 50,
            "minLength": 0
        },
        "partnerBin": {
            "type": "string",
            "maxLength": 100,
            "minLength": 0
        },
        "responsiblePersonName": {
            "type": "string",
            "maxLength": 100,
            "minLength": 0
        },
        "partnerNameLongKz": {
            "type": "string",
            "maxLength": 100,
            "minLength": 0
        },
        "partnerNameLongRu": {
            "type": "string",
            "maxLength": 100,
            "minLength": 0
        }
    }
}

Услуга

{
    "type": "object",
    "required": [
        "apiName"
    ],
    "properties": {
        "id": {
            "type": "integer",
            "format": "int64"
        },
        "apiName": {
            "type": "string",
            "maxLength": 20,
            "minLength": 0
        }
    }
}

Данные о пользователе (физ. лицо)

{
    "type": "object",
    "properties": {
        "iin": {
            "type": "string",
            "description": "ИИН физ. лица"
        },
        "phone": {
            "type": "string",
            "description": "Номер телефона"
        },
        "lastname": {
            "type": "string",
            "description": "Фамилия пользователя"
        },
        "firstname": {
            "type": "string",
            "description": "Имя пользователя"
        },
        "middlename": {
            "type": "string",
            "description": "Отчество пользователя"
        }
    }
}

Данные создания черновика цифрового согласия (физ. лицо)

{
    "type": "object",
    "required": [
        "signerIin",
        "signerPhone"
    ],
    "properties": {
        "signerIin": {
            "type": "string",
            "maxLength": 12,
            "minLength": 12,
            "description": "ИИН физ. лица",
            "example": "123456789012"
        },
        "signerPhone": {
            "type": "string",
            "description": "Номер телефона физ. лица",
            "example": "77771234567"
        }
    }
}

Ответ после создания черновика цифрового согласия (физ. лицо)

{
    "type": "object",
    "properties": {
        "id": {
            "type": "integer",
            "format": "int64"
        },
        "createDate": {
            "type": "string",
            "format": "date-time"
        },
        "updateDate": {
            "type": "string",
            "format": "date-time"
        },
        "partner": {
            "$ref": "#\/definitions\/PartnerShortInfoDto"
        },
        "product": {
            "$ref": "#\/definitions\/ProductShortInfoDto"
        },
        "signerClientId": {
            "type": "string",
            "description": "Идентификатор клиента"
        },
        "signerClientIdn": {
            "type": "string",
            "description": "БИН клиента"
        },
        "signerClientName": {
            "type": "string",
            "description": "Наименование компании"
        },
        "signerIin": {
            "type": "string",
            "description": "ИИН физ. лица"
        },
        "signerData": {
            "$ref": "#\/definitions\/UserIndividualDto"
        },
        "state": {
            "type": "string",
            "description": "Текущий статус цифрового согласия(DRAFT - черновик, ACTIVE - подписан, REVOKED - отозван, DELETED - удален, EXPIRED - истекший)",
            "example": "2022-09-01",
            "enum": [
                "DRAFT",
                "ACTIVE",
                "REVOKED",
                "DELETED",
                "EXPIRED"
            ]
        },
        "startDate": {
            "type": "string",
            "description": "Дата создания заявки",
            "format": "date",
            "example": "2022-09-01"
        },
        "endDate": {
            "type": "string",
            "description": "Дата окончания цифрового согласия (максимальный срок 1 год)",
            "format": "date",
            "example": "2023-09-01"
        },
        "digitalConsentDocumentContentBase64": {
            "type": "string",
            "description": "Документ цифрового согласия (base64)"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "totalPages": {
            "type": "integer",
            "format": "int32"
        },
        "totalElements": {
            "type": "integer",
            "format": "int64"
        },
        "pageable": {
            "$ref": "#\/definitions\/PageableObject"
        },
        "numberOfElements": {
            "type": "integer",
            "format": "int32"
        },
        "first": {
            "type": "boolean"
        },
        "last": {
            "type": "boolean"
        },
        "sort": {
            "$ref": "#\/definitions\/Sort"
        },
        "size": {
            "type": "integer",
            "format": "int32"
        },
        "content": {
            "type": "array",
            "items": {
                "$ref": "#\/definitions\/DigitalConsentIndividualResponseDto"
            }
        },
        "number": {
            "type": "integer",
            "format": "int32"
        },
        "empty": {
            "type": "boolean"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "paged": {
            "type": "boolean"
        },
        "unpaged": {
            "type": "boolean"
        },
        "pageSize": {
            "type": "integer",
            "format": "int32"
        },
        "pageNumber": {
            "type": "integer",
            "format": "int32"
        },
        "sort": {
            "$ref": "#\/definitions\/Sort"
        },
        "offset": {
            "type": "integer",
            "format": "int64"
        }
    }
}
              
{
    "type": "object",
    "properties": {
        "unsorted": {
            "type": "boolean"
        },
        "sorted": {
            "type": "boolean"
        },
        "empty": {
            "type": "boolean"
        }
    }
}

Ответ проверки статуса цифрового согласия (физ. лицо)

{
    "properties": {
        "active": {
            "type": "boolean",
            "description": "Наличие активного ЦС",
            "example": "true"
        }
    },
    "additionalProperties": false
}

Данные для инициализации биометрии (физ. лицо)

{
    "properties": {
        "signerIin": {
            "type": "string",
            "description": "ИИН физ. лица"
        },
        "callbackUrl": {
            "type": "string",
            "description": "URL для отправки результата прохождения биометрии"
        },
        "ibmClientId": {
            "type": "string",
            "description": "client-id Партнера (IBM) для формирования redirectUri"
        },
        "ibmAccessToken": {
            "type": "string",
            "description": "Временный авторизационный токен (IBM) Партнера для формирования redirectUri"
        },
        "redirectUri": {
            "type": "string",
            "description": "URL страницы для перенаправления после прохождения биометрии"
        }
    },
    "additionalProperties": false,
    "required": [
        "ibmClientId",
        "ibmAccessToken",
        "callbackUrl",
        "signerIin"
    ]
}

Ответ инициализации биометрии (физ. лицо)

{
    "properties": {
        "biometryUri": {
            "type": "string",
            "description": "URL, по которому открывается веб-страница для прохождения биометрии"
        }
    },
    "additionalProperties": false
}