Finger KYC 公共 API

KYC 與 KYB 公共 API

提供穩定的服務端 API,用於建立驗證 Profile,並根據 profileId 讀取完整的驗證證據。使用者流程由 Finger KYC 網頁承載,商戶可以在自己的系統中完成審核與資料同步。

基礎 URLhttps://api.fingerkyc.com/public/v1
身份驗證Bearer 商戶 API Token
方法只使用 GET + POST
返回格式ApiResponse { success, code, data }
公共契約

面向商戶審核系統的統一讀取模型

建立 KYC 或 KYB Profile,將使用者導向 Finger KYC 網頁流程,再透過統一的公共命名空間讀取 Profile、證據、人員與審核狀態。公共 API 不是匿名接口,也不等同於內部網頁路由。

契約來源: public_readme.md + /public/v1 Controller

`/api/web/kycService` 和 `/api/v1/kyb` 等內部路由不屬於商戶契約。請讓 Gateway 轉發 `/public/v1/**`。

01

建立 Profile

建立 KYC 或 KYB Profile,並將返回的 profileId 保存到自己的系統。

02

建立 Hosted JWT

在跳轉使用者之前,由服務端使用商戶 API Key 建立有效期 30 分鐘的 Hosted JWT。API Key 絕不能暴露給瀏覽器。

03

打開網頁流程

將使用者導向 Finger KYC 或 Finger KYB,並傳遞 profileId 與 Hosted JWT。Hosted KYB 不要求使用者擁有 FingerGrid SSO 帳戶。

04

讀取 Snapshot

先輪詢輕量 Profile 接口,狀態變更後再取得完整 Snapshot。

05

處理過期

Hosted JWT 30 分鐘後過期。頁面應顯示過期提示,並返回你的應用,由服務端重新建立 Token。

06

在自己的系統審核

綜合使用文件、證據、人員、任務、validation 與 review。AI 是輔助工具,不取代人工審核。

調試此接口

商戶 API Token

輸入商戶 API Token,使用目前接口的示例資料發送一次請求。Token 只在本頁使用,不會保存。

Gateway 必須允許此 Token 訪問指定 Profile 和 Scope。

發送請求後,HTTP 返回會顯示在這裡。
OpenAPI

公共 API 文檔

查看接口
返回封裝

穩定的返回結構

所有公共接口都使用 Finger KYC 返回封裝。業務邏輯請使用 success、code 和 data.errorCode,不要解析人類可讀的 message。

successboolean

true 或 false

codenumber

20000 成功,40001 請求錯誤,40404 找不到

messagestring

供排查使用的文字訊息

dataobject

Profile、Snapshot、材料、人員或任務資料