Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
action

Validate action

Validate the result of an action using a token obtained after redirecting back from the pre-built UI or returned by an Authsignal SDK.

post/validate

Request body

tokenstring required

The token obtained after a redirect or returned by an Authsignal SDK.

userIdstring

The ID of the user (if known). If passed, this will be used to validate that the token is for the correct user.

actionstring

The action which was tracked. Use this to ensure that the action being validated matches the action that was tracked.

Response

OK

isValidboolean

true if the challenge's state is CHALLENGE_SUCCEEDED.

state'ALLOW' | 'BLOCK' | 'CHALLENGE_REQUIRED' | 'CHALLENGE_FAILED' | 'CHALLENGE_SUCCEEDED' | 'REVIEW_REQUIRED' | 'REVIEW_FAILED' | 'REVIEW_SUCCEEDED'

The current state of the action.

stateUpdatedAtstring date-time

The time in ISO 8061 format when the state of the action was last updated.

userIdstring

The ID of the user.

actionstring
idempotencyKeystring
verificationMethod'SMS' | 'AUTHENTICATOR_APP' | 'EMAIL_MAGIC_LINK' | 'EMAIL_OTP' | 'PUSH' | 'DEVICE' | 'SECURITY_KEY' | 'PASSKEY' | 'VERIFF' | 'IPROOV' | 'PALM_BIOMETRICS_RR' | 'IDVERSE'
veriffSessionIdstring

The Veriff session ID, returned when the challenge was completed using Veriff. Use this with your own Veriff API credentials to fetch the full decision and provider payload.