Get challenge status
Returns the outcome of a challenge, and is the endpoint to poll while waiting for a guardian to act. Call it after `/age-gate/check` returns `CHALLENGE`. Once it reports `PASS`, follow with `/session/get` to read the now-`ACTIVE` session and the permissions it grants. `FAIL` means the challenge is settled and will not progress.
Authorization
api-key In: header
Query Parameters
The ID of the challenge
^[A-z0-9]{8}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{4}-[A-z0-9]{12}$uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/challenge/get-status?challengeId=ae6d4729-af32-42ea-8ef2-ff46c7664802"{ "status": "PASS", "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672", "approverEmail": "user@example.com"}{ "error": "NOT_FOUND", "errorMessage": "Challenge not found"}Generate a new OTP for the challenge POST
This API is used to generate a new one-time password (OTP) for a given challenge.
Get challenge statuses (bulk) POST
Returns the status of multiple challenges in a single request. Accepts up to 100 challenge IDs and returns an object keyed by challenge ID. Each value is either a challenge status or a `ClientErrorResponse` when the challenge could not be retrieved.