Get challenge statuses (bulk)
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.
Authorization
api-key In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/challenge/get-status" \ -H "Content-Type: application/json" \ -d '{ "challengeIds": [ "ae6d4729-af32-42ea-8ef2-ff46c7664802", "f47ac10b-58cc-4372-a567-0e02b2c3d479" ] }'{ "ae6d4729-af32-42ea-8ef2-ff46c7664802": { "status": "PASS", "sessionId": "b1a6482d-5242-4b4a-aa88-3fa52595a672", "approverEmail": "user@example.com" }, "f47ac10b-58cc-4372-a567-0e02b2c3d479": { "status": "IN_PROGRESS" }}{ "error": "INVALID_INPUT", "errorMessage": "Maximum of 100 challenge IDs allowed"}Get challenge status GET
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.
Get challenge GET
Returns a previously created challenge. The `oneTimePassword` and `url` are omitted once the challenge has passed or failed, so capture them while the challenge is still open if you need to re-present it.