Server API
Validate Challenge
Validate the result of a challenge using a token obtained after redirecting back from the pre-built UI or returned by a client SDK.
POST
/
validate
Body
application/json
token
string
requiredThe token obtained after a redirect or returned by a client SDK.
userId
string
The ID of the user. Only pass this if doing step-up auth on an existing user session (i.e. not for login).
action
string
The action which was tracked. Use this to ensure that the action being validated matches the action that was tracked.
Response
200 - application/json
isValid
boolean
requiredTrue if the challenge was completed successfully.
state
enum<string>
The current state of the action.
Available options:
ALLOW
, BLOCK
, CHALLENGE_REQUIRED
, CHALLENGE_FAILED
, CHALLENGE_SUCCEEDED
, REVIEW_REQUIRED
, REVIEW_FAILED
, REVIEW_SUCCEEDED
stateUpdatedAt
string
The time in ISO 8061 format when the state of the action was last updated.
userId
string
The ID of the user.
action
string
idempotencyKey
string
verificationMethod
enum<string>
Available options:
SMS
, AUTHENTICATOR_APP
, EMAIL_MAGIC_LINK
, EMAIL_OTP
, PUSH
, SECURITY_KEY
, PASSKEY
, VERIFF
, IPROOV
, PALM_BIOMETRICS_RR
, IDVERSE
Was this page helpful?