メインコンテンツへスキップ
プロセスの取得GET

作成時に Human Plugin が返した id を使って、プロセスを読み取ります。

Markdown

GET /v1/processes/{id}

id は作成レスポンスに含まれる UUID です。認証ヘッダーはなく、クライアントによるスコープもありません。Human Plugin に到達できる呼び出し元であれば、どのプロセスでも読み取れます。

curl http://human-plugin.internal:8080/v1/processes/b063041c-7529-4e70-a2b4-c71c00f19801

結果が届くタイミング​

  • 保留中のプロセス (PROCESS_STATE_CREATED) は、読み取りのたびに確認され、結果が得られ次第、その結果が返されます。
  • 完了または失敗したプロセスは最終状態であり、そのまま返されます。
  • 中断された作成は、開始から約 70 秒後に失敗として返されます。

保留中のプロセスが進むのは読み取り時だけです。バックグラウンドジョブはなく、callbackUri への戻りでも Human Plugin は更新されません。

レスポンス​

作成時と同じ形式 (id、state、data) で 200 OK を返します。

保留中の Journey:

{ "id": "b063041c-7529-4e70-a2b4-c71c00f19801", "state": "PROCESS_STATE_CREATED", "data": {} }

完了したプロセスと失敗したプロセス​

完了したプロセスは、結果を data に含めて返します。本人が誰であるかは humanToken、本人のインテリジェンスは ndocs に入り、フローがチェックする場合は liveness も含まれます。再検証では humanToken の代わりに humanTokenMatch が返されます。各フィールドはdata の結果で説明しています。失敗したプロセスは PROCESS_STATE_FAILED と空の data を返します。

完了したプロセス:

{
  "id": "b063041c-7529-4e70-a2b4-c71c00f19801",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanToken": { "value": "6d3d71…", "status": "validated" },
    "liveness": { "value": "live", "status": "validated" },
    "ndocs": {
      "distinctClientsCount": 2,
      "transactionsCount": 3,
      "firstSeen": "2026-09-08",
      "lastSeen": "2026-11-03",
      "credentials": [
        { "type": "DUI_TYPE_NG_BVN", "countryCode": "NGA", "distinctCredentialCount": 1 }
      ]
    }
  }
}

完了した再検証。ndocs は、確認した本人について記述します。

{
  "id": "7f2c9a10-3d4e-4b5f-8a61-0c9e2d7b4a35",
  "state": "PROCESS_STATE_FINISHED",
  "data": {
    "humanTokenMatch": "true",
    "liveness": { "value": "live", "status": "validated" },
    "ndocs": {
      "distinctClientsCount": 2,
      "transactionsCount": 4,
      "firstSeen": "2026-09-08",
      "lastSeen": "2026-11-04",
      "credentials": [
        { "type": "DUI_TYPE_NG_BVN", "countryCode": "NGA", "distinctCredentialCount": 1 }
      ]
    }
  }
}

失敗したプロセス:

{ "id": "c41e8b27-95d0-4a8f-b3e6-2f7a1d9c0e58", "state": "PROCESS_STATE_FAILED", "data": {} }

Journey の token と link は、作成時にのみ返されます。そのレスポンスから保管してください。

エラー​

ステータスmessage意味
404PROCESS_NOT_FOUNDid が UUID ではないか、不明です
502UPSTREAM_UNAVAILABLEプロセスは保留中で、結果を確認できませんでした。後で再試行してください
503DATABASE_UNAVAILABLEデータベースが失敗しました。後で再試行してください

読み取りは安全に再試行できます。

次へ​

セルフィーの取得

最終更新 に