Docs
Status
Supportk-id.comCompliance Studio
EndpointsWidgets

Get widget statuses (bulk)

Returns the status of multiple end-to-end or age gate widgets in a single request. Accepts up to 100 widget IDs and returns an object keyed by widget ID. Each value is either a widget status or a `ClientErrorResponse` when the widget could not be found.

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 status GET

Returns the outcome of an end-to-end or age gate widget flow, keyed by the `widgetId` that `/widget/generate-e2e-url` or `/widget/generate-age-gate-url` returned. Use it when the player finishes the flow on another device, such as a phone that scanned the widget's QR code, and your service needs the result. Once a widget reports `PASS` it keeps reporting `PASS`. Follow with `/session/get` for the session's current state and permissions. To learn of an outcome promptly, subscribe to the webhooks rather than polling often.