Finger KYC Public API

KYC / KYB Public API

Profile の作成と、profileId に紐づく検証証拠全体の取得を行うサーバー間 API です。ユーザーの画面フローは Finger KYC が提供し、加盟店側で審査とデータ同期を行えます。

ベース URLhttps://api.fingerkyc.com/public/v1

認証Bearer merchant API token

メソッドGET + POST のみ

レスポンスApiResponse { success, code, data }

Public contract

加盟店の審査システム向け統一 Read Model

KYC または KYB Profile を作成し、ユーザーを Finger KYC のホスト画面へ案内します。その後、同じ公開名前空間から Profile、証拠、人物、審査状態を取得できます。匿名 API ではなく、内部 Web ルートとも分離されています。

契約の参照元: public_readme.md + /public/v1 Controller

`/api/web/kycService` や `/api/v1/kyb` は内部ルートであり、加盟店契約には含まれません。Gateway で `/public/v1/**` を転送してください。

KYC または KYB Profile を作成し、返された profileId を自社システムに保存します。

ユーザーをリダイレクトする直前に、サーバー側で加盟店 API Key を使って Hosted JWT（KYB は60分、KYC は30分有効）を作成します。API Key をブラウザへ渡してはいけません。

profileId と Hosted JWT を付けて Finger KYC / Finger KYB の画面へ案内します。Hosted KYB の利用者に FingerGrid SSO アカウントは不要です。

まず軽量 Profile API をポーリングし、状態が変わったら完全な Snapshot を取得します。

Hosted KYB JWT は60分、Hosted KYC JWT は30分で期限切れになります。期限切れダイアログを表示し、自社アプリへ戻してサーバーで新しい Token を発行してください。

証憑、証拠、人物、タスク、validation、review を組み合わせて確認します。AI は補助であり、手動審査の代替ではありません。

このエンドポイントを試す

Merchant API Token を入力し、選択中のエンドポイントへサンプル値で 1 回リクエストします。Token はこのタブだけで使用し保存しません。

Merchant API Token

Gateway 側で対象 Profile と Scope へのアクセスを許可する必要があります。

リクエストを送信すると HTTP レスポンスが表示されます。

OpenAPI

Envelope

すべての Public API は Finger KYC のレスポンス形式を返します。判定には success、code、data.errorCode を使用し、message の文言解析は行わないでください。

successboolean

true または false

codenumber

20000 成功、40001 不正、40404 未検出

messagestring

調査用のメッセージ

dataobject

Profile、Snapshot、資料、人物、タスク