Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Начало работы

Добро пожаловать в документацию платформы НПЦК. Здесь вы найдёте всё необходимое для успешной интеграции — от первого запроса до production.

Оперативные уведомления — плановые работы и обновления API публикуются в Telegram: t.me/npckconnect

Сервисы платформы

Title

🔐 FinID / ЦОИД

Target
Сервис аутентификации личности клиента FinID
Title

✍️ Облачная ЭЦП

Target
Сервис управления облачной ЭЦП Esign
Title

💳 Платежи (МСМП)

Target
Межбанковская система мобильных платежей (МСМП)
Title

🏦 Open API (пилот)

Target
Open Banking
Title

✍️Сервис управления согласиями (СУС)

Target
Сервис управления согласиями (СУС)
Title

👔 Сервис проверки юридического лица (первого руководителя)

Target
Сервис проверки юридического лица (первого руководителя)

Быстрый старт

Сервисы ЦОИД

1

Шаг 1 - Предоставление данных ЮЛ/ФЛ

Вход в личный кабинет Портала НПК осуществляется посредством биометрической верификации с использованием цифрового сканирования лица пользователя - данные сотрудников должны быть предоставлены заранее.

Направьте письмо на соответствующий адрес:

Проект
Email

ЦОИД, Облачная ЭЦП и агрегация счетов (Open API)

coid@npck.kz

В письме укажите для каждого сотрудника:

  1. Фотографию (формат как на удостоверение личности)

  2. ФИО

  3. ИИН

  4. Номер телефона

  5. БИН и наименование организации

  6. Кто будет выступать руководителем на тестовом стенде

  7. Систему, к которой планируете подключиться (ЦОИД, Open Banking/Open API)

В тестовой среде регистрация первого руководителя организации не требуется - руководителем может быть любой уполномоченный сотрудник.

2

Шаг 2 - Регистрация и авторизация в Портале НПК

Портал НПК (тестовая среда): cabinet.stage.npck.kz

Регистрацию выполняет сотрудник, назначенный руководителем на тесте:

  1. Заполните форму авторизации и нажмите Войти

  2. На форме подтверждения ИИН убедитесь, что введён корректный ИИН, и нажмите Продолжить

  3. При положительном ответе от ГБД ФЛ проводится биометрическая верификация физического лица с использованием цифрового сканирования лица

Перед прохождением биометрической верификации убедитесь, что лицо полностью в кадре, взгляд направлен в камеру, глаза открыты, фон однородный, освещение равномерное без теней. При превышении количества неуспешных попыток система временно блокирует пользователя.

  1. Введите одноразовый SMS-код

На тестовом стенде SMS не отправляется - вводите код 0000. Если код не пришёл - нажмите Отправить код повторно.

  1. Введите БИН организации

  2. Нажмите Разрешить

Регистрация завершена! Руководителю открывается Личный кабинет участника.

3

Шаг 3 - Добавление сотрудников

Сотрудники → Добавить сотрудника:

  1. Введите ИИН, ФИО и должность сотрудника

  2. Выберите доступы по роли:

    • Менеджеры / аналитики - все функции

    • Технические специалисты - «Управление услугами» и «Управление заявками»

  3. При необходимости - установите галочку «Право подписания юридических документов»

  4. Нажмите Добавить

Можно загрузить список сотрудников в формате CSV. Шаблон: employees_example.csv

4

Шаг 4 - Подача заявки на подключение к сервису

  1. Перейдите в раздел Подключиться к ЦОИД

  2. Нажмите Подать заявку

  3. Выберите тип сервиса

  4. Прикрепите необходимые документы (перечень - в правилах функционирования ЦОИД на npck.kz)

  5. Нажмите Отправить

Статусы заявки: черновик → в работе → одобрена / отказ

Если заявка отклонена - причина указана в деталях. Подайте новую заявку с исправлениями.

  1. Перейдите в раздел Подключиться к Open Banking

  2. Нажмите Подать заявку

  3. Выберите роль:

    • Поставщик API - для обмена информацией по счетам

    • Пользователь API (чтение и запись) - для агрегации счетов

  4. Прикрепите документы (для тестовой среды достаточно лицензии на проведение банковских операций)

  5. Нажмите Отправить

Статусы заявки: черновик → в работе → одобрена / отказ

5

Шаг 5 - Регистрация приложения

После одобрения заявки: Услуги → Мои приложения → Добавить приложение

  • Название - наименование приложения

  • Redirect URL - адрес для перенаправления после аутентификации (можно несколько)

  • Логотип - PNG, 100×100 px (необязательно)

Нажмите Сохранить. Система сгенерирует client_id и client_secret.

client_secret - строго конфиденциально. Сохраните сразу - повторно просмотреть нельзя. При необходимости можно сгенерировать новый через Сгенерировать новый client secret.

6

Шаг 6 - Настройка и тестирование API

Сервис сопоставления фотоизображений (IDEC/Photomatch) подключается отдельно от остальных сервисов ЦОИД - не через Портал НПК (cabinet.npck.kz), а через собственный контур регистрации Удостоверяющего центра. См. вкладку «📷 Сопоставление фотоизображений».

Реализуйте на своей стороне:

  1. Получение URL для перенаправления клиента - POST /v1/auth/generate-user-url

  2. Перенаправление клиента на полученный URL через SafariWebView (iOS) или WebView (Android)

  3. Перехват редиректа с кодом авторизации code на redirectUri

  4. Обмен code на access_token - POST /oauth2/token

  5. Проверка и анализ токена - POST /oauth2/introspect

iOS: только SafariWebView, WKWebView не поддерживается. Редирект перехватывать через deeplink.

Android WebView: если не отображается изображение с камеры при прохождении биометрической верификации:

webView.settings.allowContentAccess = true
webView.settings.mediaPlaybackRequiresUserGesture = false
webView.settings.domStorageEnabled = true

На тестовом стенде SMS не отправляется - клиент вводит код 0000.

Срок жизни URL - 15 минут, кода авторизации - 300 секунд (одноразовый).

Срок жизни access_token - 12 часов для FinID scopes.

→ Спецификация: auth-openapi.npck.kz

→ Клиентский сценарий: Описание клиентского пути FinID

Реализуйте на своей стороне:

  1. Загрузите документы для подписания через API Esign до начала сессии

  2. Получите URL для перенаправления клиента со scope esign (физлица) или organization_esign (юрлица)

  3. Перенаправьте клиента через SafariWebView / WebView

  4. Перехватите редирект с code и обменяйте на access_token

  5. Получите подписанные документы

Срок жизни access_token для scope esign / organization_esign - 5 минут.

Если у клиента нет облачной ЭЦП - система предложит выпустить её прямо в flow. ЭЦП выпускается на 1 год.

На тестовом стенде SMS - код 0000.

Пароль от ЭЦП не хранится в системах ЦОИД - только его хэш в HSM. Клиент может сбросить пароль через «Не помню пароль» - при этом выпускается новая ЭЦП.

→ Спецификация: esign-openapi.npck.kz

→ Клиентский сценарий: Описание клиентского пути Esign

1. Настройка API (для Поставщика API)

Услуги → Мои API → Настройки API:

  • Введите URL-адрес, по которому будут доступны ваши API

  • Заполните основную информацию о поставщике

  • Нажмите Перейти к публикации API

Токен доступа (JWT) действует 1 год. Хранить только на серверной стороне.

2. Публикация API

В разделе Мои API выберите нужный API из списка и нажмите Активировать услугу.

3. Запуск автотестов

После публикации API нажмите Запустить проверку рядом с нужным API.

Система запустит автоматические тесты и отобразит результат. Если выявлены ошибки - они будут показаны с описанием, исправьте согласно технической документации и запустите проверку повторно.

Кнопка Опубликовать становится доступна только после успешного прохождения всех проверок.

4. Тестирование (для Пользователя API)

Реализуйте на своей стороне полный OAuth2 flow:

  1. POST /v1/auth/generate-user-url со scopes accounts, account_balance, account_transactions

  2. Перенаправление клиента → аутентификация (подтверждение ИИН + биометрическая верификация + SMS-код 0000) → согласие

  3. Получение code → обмен на access_token (срок жизни 30 дней)

  4. Запрос данных счетов: GET /accounts, GET /accounts/{id}/balance, GET /accounts/{id}/transactions

API v2 устарел - используйте API v3.

→ Спецификация: accounts-openapi.npck.kz

→ Рекомендации для Пользователя API

→ Рекомендации для Поставщика API

Переходите в промышленную среду только после успешного тестирования и подписания протокола с АО «НПК».

1

Шаг 1 - Регистрация и авторизация в Портале НПК

Портал НПК (промышленная среда): cabinet.npck.kz

В промышленной среде предоставление данных сотрудников заранее не требуется - верификация через ГБД ФЛ и ГБД ЮЛ автоматическая.

Регистрацию выполняет первый руководитель организации:

  1. Откройте форму авторизации и нажмите Войти

  2. Введите ИИН и нажмите Продолжить

  3. Пройдите биометрическую верификацию

  4. Введите SMS-код (отправляется реально на телефон)

  5. Введите БИН организации

  6. Нажмите Разрешить

Регистрация завершена!

2

Шаг 2 - Добавление сотрудников

Сотрудники → Добавить сотрудника - те же шаги, что и в тестовой среде.

В промышленной среде один сотрудник может быть добавлен в личный кабинет только одного участника.

3

Шаг 3 - Подача заявки на подключение

  1. Подключиться к ЦОИД → Подать заявку

  2. Выберите тип сервиса, прикрепите документы, нажмите Отправить

client_id и client_secret в промышленной среде отличаются от тестовых.

  1. Подключиться к Open Banking → Подать заявку

  2. Выберите роль, прикрепите документы, нажмите Отправить

client_id и client_secret в промышленной среде отличаются от тестовых.

4

Шаг 4 - Регистрация приложения

Услуги → Мои приложения → Добавить приложение

  • Название, Redirect URL (production-домен), Логотип (необязательно)

  • Нажмите Сохранить → получите промышленные client_id и client_secret

client_secret отображается только один раз. Сохраните сразу.

5

Шаг 5 - Настройка подключения и публикация API

Клиентский сценарий идентичен тестовому - SMS отправляется реально.

  1. Выполните smoke-тест с промышленными client_id / client_secret

  2. Проверьте логирование и мониторинг на своей стороне

Альтернативный путь обслуживания

Участнику необходимо обеспечить альтернативный способ идентификации клиента на случай, если биометрическая верификация не может быть пройдена успешно.

В случае неуспешной верификации запрос может быть передан разработчику биометрического решения на дополнительный анализ. До получения результатов анализа рекомендуется обслуживать клиента альтернативным методом в соответствии с внутренними процедурами Участника.

→ Результаты биометрической аутентификации

→ Матрица полномочий (для юрлиц, Esign)

1. Настройка и публикация API

Услуги → Мои API → Настройки API → укажите production endpoint → Перейти к публикации API.

Подайте заявку на публикацию - требуется подписанный протокол тестирования. Срок рассмотрения - 3 рабочих дня.

2. Smoke-тест

Выполните smoke-тест с промышленными ключами, проверьте логирование и мониторинг.

→ Статус API участников

Сервис сопоставления фотоизображений

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

Аутентификацию могут пройти люди, у которых имеется как минимум один из следующих документов:

  • удостоверение личности гражданина РК

  • паспорт гражданина РК

  • вид на жительство иностранца в РК

  • удостоверение лица без гражданства (казахстанского образца)

Для использования сервиса Участник должен:

  1. Пройти процедуру регистрации на Портале АО «НПК» (см. Регистрация и авторизация в Портале НПК)

  2. Подать заявку на подключение к ЦОИД (см. 5.1 Подключение к ЦОИД)

  3. Зарегистрировать приложение Участника (см. Пользователям API (добавление и использование приложения))

1

Шаг 1 - Получение криптографических ключей

Перейдите на портал УЦ: betacms.npck.kz/info, скачайте шаблон заявки и направьте заполненную заявку согласно инструкции на портале.

→ Подробнее: Выпуск ключей ГОСТ 2015

По вопросам получения ключей: supportca@npck.kz или +7 (727) 250-66-75

2

Шаг 2 - Выполните первый запрос

Авторизация по схеме Basic Auth:

Используется для моментальной верификации личности с заранее определённым типом согласия. Согласие собирается Участником перед началом процедуры идентификации и подписывается ЭЦП организации (JWS, алгоритм ГОСТ 34.10-2012/2015).

→ Подробнее о формировании подписи: Формирование ЭЦП JWS

В ответ возвращается результат сопоставления в процентах (%).

Получение электронного документа по результатам:

→ Спецификация: identity-openapi.npck.kz

Используется для запуска процесса верификации, который требует подтверждения от физического лица посредством SMS с номера 1414. Номер телефона берётся из базы мобильных граждан (БМГ).

В тестовой среде SMS не отправляется - согласие имитируется через Telegram-бот @NPCK_TestControl_bot: нажмите /start, введите ИИН.

Если клиент отклонил согласие - сопоставление не производится. Участник получает соответствующий статус в ответе.

→ Спецификация: identity-openapi.npck.kz

Переходите в промышленную среду только после успешного тестирования.

1

Шаг 1 - Заключение договора

Заключите «Договор с Участником (сопоставление фотоизображений)».

Шаблон: npck.kz - Типовые договора - вкладка «Типовые договора» - «Договор с Участником (сопоставление фотоизображений)»

Регистрация участника в ИС ЦОИД произойдёт автоматически после заключения договора.

По вопросам заключения договора: coid@npck.kz или +7 (727) 297-91-44

2

Шаг 2 - Получение криптографических ключей

Заполните Приложение №1 к Заявлению/Соглашению к Договору о предоставлении услуг УЦ и направьте в Удостоверяющий центр.

Портал УЦ: cms.npck.kz/auth

Первичные ключи действуют 14 дней и требуют ежегодного переоформления.

По вопросам: supportca@npck.kz или +7 (727) 250-66-75

3

Шаг 3 - Настройка сетевого доступа. При необходимости.

Доступ к промышленной среде осуществляется через выделенный канал IP VPN или IPSec.

Сканированный вариант заполненного шаблона необходимо направить на info@npck.kz:

4

Шаг 4 - Выполните первый запрос

Используйте те же методы, что и в тестовой среде, с промышленными ключами:

  • Sync V2: https://api.npck.kz/v2/identity/sync/verify

  • Async V1: https://api.npck.kz/v1/identity/async/verify

Интеграция завершена! По вопросам: coid@npck.kz или +7 (727) 297-91-44

Спецификации

Сервис
Ссылка

Auth (FinID, OAuth2, Esign)

auth-openapi.npck.kz

Esign

esign-openapi.npck.kz

Open Banking ID

obid-openapi.npck.kz

Accounts

accounts-openapi.npck.kz

Identity

identity-openapi.npck.kz

NextТехнические требования к клиентским устройствам

Last updated