Get the status of an age verification request
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.
Authorization
api-key In: header
Query Parameters
The ID of the age verification request
^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$uuidWhether to include the verified date of birth (dob) when available. An explicit true or false overrides the product's age result setting. If omitted, the product's setting decides.
Response Body
application/json
curl -X GET "https://example.com/age-verification/get-status?id=ae6d4729-af32-42ea-8ef2-ff46c7664802"{ "id": "ae6d4729-af32-42ea-8ef2-ff46c7664802", "status": "PASS", "age": { "low": 18, "high": 20 }, "ageCategory": "adult", "method": "id-document"}Send email POST
Emails the details of a challenge to a recipient — most often a parental consent request to a guardian. The challenge itself must already exist; this only delivers it. Call it again to re-send.
Perform access age verification POST
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.