Docs
Status
Supportk-id.comCompliance Studio
Endpoints小组件

生成会话升级 URL

返回托管式会话升级组件的 URL，用于在 iframe 中展示。 将其展示给由 `/session/upgrade` 创建的会话升级挑战的监护人，以便其批准新申请的权限。

POST
/widget/generate-session-upgrade-url

Authorization

api-key
AuthorizationBearer <token>

In: header

Request Body

application/json

生成会话升级URL请求

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/widget/generate-session-upgrade-url" \  -H "Content-Type: application/json" \  -d '{    "challengeId": "ae6d4729-af32-42ea-8ef2-ff46c7664802",    "email": "parent@example.com"  }'
{  "url": "https://family.k-id.com/widget",  "shortUrl": "https://family.k-id.com/s/12345678-1234-1234-1234-123456789012?pid=42&s=qr"}

生成家长同意 URL POST

返回托管式家长同意组件的 URL，用于在 iframe 中展示。 将其展示给既有挑战的监护人以收集同意。这与 `/challenge/send-email` 所链接的体验相同，适用于你自行投递链接的场景。

获取小部件状态 GET

以 `/widget/generate-e2e-url` 或 `/widget/generate-age-gate-url` 返回的 `widgetId` 为键，返回端到端或年龄验证小部件流程的结果。 当玩家在另一台设备（例如扫描了小部件二维码的手机）上完成流程，而你的服务需要获取结果时使用。小部件一旦返回 `PASS`，之后会一直返回 `PASS`。接着调用 `/session/get` 读取会话的当前状态和权限。如需及时获知结果，请订阅 Webhook，而不是频繁轮询。