Docs
Status
Supportk-id.comCompliance Studio
Endpointsウィジェット

ウィジェットのステータスを一括取得する

1回のリクエストで複数のエンドツーエンドまたは年齢ゲートウィジェットのステータスを返します。 最大100件のウィジェットIDを受け付け、ウィジェットIDをキーとするオブジェクトを返します。各値はウィジェットのステータス、またはウィジェットが見つからなかった場合は `ClientErrorResponse` になります。

POST
/widget/get-status

Authorization

api-key
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/widget/get-status" \  -H "Content-Type: application/json" \  -d '{    "widgetIds": [      "2f6c1d3e-8a4b-4c5d-9e6f-7a8b9c0d1e2f",      "0bb4a2c1-3d5e-4f6a-8b7c-9d0e1f2a3b4c"    ]  }'
{  "2f6c1d3e-8a4b-4c5d-9e6f-7a8b9c0d1e2f": {    "widgetId": "2f6c1d3e-8a4b-4c5d-9e6f-7a8b9c0d1e2f",    "status": "PASS",    "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672"  },  "0bb4a2c1-3d5e-4f6a-8b7c-9d0e1f2a3b4c": {    "error": "NOT_FOUND",    "errorMessage": "Widget not found"  }}

ウィジェットステータスを取得する GET

エンドツーエンドまたは年齢ゲートウィジェットのフローの結果を、`/widget/generate-e2e-url` または `/widget/generate-age-gate-url` が返した `widgetId` をキーとして返します。 QRコードを読み取ったスマートフォンなど、プレイヤーが別のデバイスでフローを完了し、自社のサービスがその結果を必要とする場合に使用します。ウィジェットが一度 `PASS` を返すと、以降も `PASS` を返し続けます。続いて `/session/get` を呼び出し、セッションの現在の状態と権限を取得してください。結果をすぐに知る必要がある場合は、頻繁にポーリングするのではなくWebhookを購読してください。