Perform access age verification
Starts an access age verification and returns a hosted URL to display in an iframe. Use it to gate entry to a product or feature on a proven age, rather than to upgrade an existing session. The player completes verification 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 access age verification
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/age-verification/perform-access-age-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"}Get the status of an age verification request GET
Returns the current state of an age verification request. Poll it after starting a verification, or use it to confirm a webhook server-side. A request moves from `PENDING` to `IN_PROGRESS` and settles on `PASS` or `FAIL`. A settled request also carries what was established — the age estimate, age category and method used — and, on failure, the reason. Treat anything other than `PASS` or `FAIL` as still in flight.
Perform age appeal POST
Starts an age appeal, letting a player who failed an age check prove their age another way, and returns a hosted URL to display in an iframe. The player completes the appeal at the returned URL; read the outcome from `/age-verification/get-status` or a webhook.