Perform age key verification
Starts an AgeKey verification and returns a hosted URL to display in an iframe. A player who already holds an AgeKey reuses it here instead of verifying from scratch, so this is the lowest-friction method for returning players. `subject` is optional and supplies your own identifiers for telemetry and reporting only. `options.facialAgeEstimation.passIfOver` sets the minimum estimated age for an AgeKey backed by facial age estimation, and for the facial age estimation fallback offered to players without an AgeKey. AgeKeys backed by other methods are checked against `criteria`. The player completes it at the returned URL; read the outcome from `/age-verification/get-status` or a webhook.
Authorization
api-key In: header
Request Body
application/json
Perform age key verification
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/age-verification/perform-age-key-verification" \ -H "Content-Type: application/json" \ -d '{ "jurisdiction": "US-CA", "criteria": {} }'{ "id": "12345678-1234-1234-1234-123456789012", "url": "https://example.com/verify", "shortUrl": "https://example.com/s/12345678-1234-1234-1234-123456789012?pid=42&s=qr"}Perform jurisdiction appeal POST
Starts a jurisdiction appeal, letting a player contest the jurisdiction applied to them, and returns a hosted URL to display in an iframe. Supply the jurisdiction currently in force and, in `criteria.claimedJurisdiction`, the one the player claims. The player completes the appeal at the returned URL; read the outcome from `/age-verification/get-status` or a webhook.
Perform Connect ID verification POST
Starts a ConnectID verification and returns a hosted URL to display in an iframe. The player proves their age through an Australian bank or identity provider they already hold an account with. Available in Australia only. The player completes it at the returned URL; read the outcome from `/age-verification/get-status` or a webhook.