Generate session upgrade URL
Returns a URL for the hosted session upgrade widget, to display in an iframe. Present it to the guardian of a session-upgrade challenge minted by `/session/upgrade`, so they can approve the newly requested permissions.
Authorization
api-key In: header
Request Body
application/json
Generate session upgrade URL request
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"}Generate parental consent URL POST
Returns a URL for the hosted parental consent widget, to display in an iframe. Present it to the guardian of an existing challenge to collect their consent. This is the same experience `/challenge/send-email` links to, for cases where you deliver the link yourself.
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.