メインコンテンツへスキップ
API Reference 概要

ゼロから最初のhumanTokenを取得するまでに必要なすべて。

Markdown

Human Tokenには3つのエンドポイントがあります。このページでは、それらがどのように連携するかを示し、すぐに統合を開始できるようにします。

ベースURL​

環境ベースURL
本番環境https://humantoken.unico.app

すべてのリクエストにはx-unico-accesskeyヘッダーが必要です。キーの生成方法については認証をご覧ください。

クイックスタートフロー​

ステップ1 — 認証​

Human DashboardまたはAuthentication APIでx-unico-accesskeyを生成します。以下のすべてのリクエストでこのキーを使用します。

x-unico-accesskey: uip_ak.prod.a1b2c3d4.e5f6g7h8.i9j0k1l2

ステップ2 — プロセスを作成する​

Create Processを呼び出して検証を開始します。2つのモデルから1つを選択してください：

モデルフロー仕組み
API Onlyapi+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidationバックエンドがセルフィーをimageBase64として送信します。humanTokenは同じレスポンスで返されます。
Human Token Journeyhumantoken, humantoken+revalidationユーザーがUnicoプラットフォームでキャプチャを完了します。journeyを提示するためのtokenとlinkを取得し、Get Processで結果を取得します。

API Onlyの例：

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "api+humantoken",
    "imageBase64": "<base64-encoded-selfie>",
    "companyBranchId": "<your-branch-id>"
  }'

Human Token Journeyの例：

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "humantoken",
    "callbackUri": "https://yourapp.com/callback",
    "companyBranchId": "<your-branch-id>"
  }'

すべてのフロー、パラメータ、レスポンスの詳細についてはCreate Processをご覧ください。

ステップ3 — ユーザーにjourneyを提示する（Journeyフローのみ）​

humantokenおよびhumantoken+revalidationフローの場合、Create Processのレスポンスには以下が含まれます：

  • token — Web SDKまたはネイティブ統合を初期化します
  • link — ユーザーをリダイレクトするURL

プラットフォームに合った統合を選択してください：

プラットフォームアプローチ
Web — SDKidpay-b2b-sdkでjourneyをインラインで埋め込む → Web Integration
Web — Redirectユーザーをlinkにリダイレクトする → Web Integration
AndroidCustom Tabs → Android
iOSASWebAuthenticationSession → iOS
IonicCapacitor plugin → Ionic
React NativeNative module → React Native
FlutterPlatform Channels → Flutter

journeyが終了すると、ユーザーはcallbackUriに戻ります。ステップ4に進んでください。

API Onlyフロー

このステップをスキップしてください — 結果はすでにCreate Processのレスポンスに含まれています。

ステップ4 — 結果を取得する（Journeyフローのみ）​

プロセスidを使用してGet Processを呼び出し、結果を取得します：

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

レスポンスにはdata.humanToken.value（標準フロー）またはdata.humanTokenMatch（再検証フロー）が含まれます。完全なレスポンススキーマとステータス値についてはGet Processをご覧ください。

ステップ5 — humanTokenを使用する​

humanTokenは安定した不透明な識別子です（最大100文字）。同じ人物は常に同じ値に解決されます。

const { humanToken } = process.data;

if (!humanToken?.value) {
  // Inconclusive — retry or reject per your business rules
  return;
}

const existing = await db.persons.findByHumanToken(humanToken.value);

if (existing) {
  // Same person seen before — returning user or duplicate
} else {
  // First time — create a new record
  await db.persons.create({ humanToken: humanToken.value });
}
警告

保存または照合する前に、data.humanToken.valueが空でないことを必ず確認してください。

ステップ6 — セルフィーを取得する（オプション）​

Get Selfieを呼び出してキャプチャした画像をダウンロードします。セルフィーはプロセス完了後24時間利用可能です — その後、完全に削除されます。

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID/selfie \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

レスポンスの詳細とエラーコードについてはGet Selfieをご覧ください。

エンドポイント一覧​

メソッドエンドポイント説明
POST/client/v1/processCreate Process — 検証を開始
GET/client/v1/process/{processId}Get Process — 結果を取得
GET/client/v1/process/{processId}/selfieGet Selfie — セルフィーをダウンロード（24時間）

次のステップ​

  • Create Process — 5つのフローすべての完全なパラメータリファレンス
  • Authentication — アクセスキーの生成と管理
  • Build With LLM — AIアシスタントにプロンプトを貼り付けて完全な統合を生成
最終更新 に