Attempt a one-time password verification.

Attempt a one-time password verification.

A verification may only be attempted if the state is PENDING.

NB: Once a verification's state has changed from PENDING, it will cease to exist after a given time.

NB: When the query parameter 'returnJwt' is included and set to 'true', the response will change from a 204 with no content to a 200 with a JSON body. This body will contain an assertion in the form of a JWT, which serves as cryptographic proof of the factor performed. The format of the response body is:
{
    "assertion": "ey..."
}
The 'returnJwt' feature only operates if the entitlement 'authnAnyUser' is not present.

Entitlements:
- authnAnyUser (Authenticate any user)
- authn (Authenticate self)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required

The specific verification identifier.

Query Params
boolean

If included and set to 'true', a JWT will be included in the verification response.

Body Params

The verification data.

string
required

The one-time password value

Responses
204

The supplied one-time password was successfully verified.

Language
URL
LoadingLoading

Response
Choose an example:
application/json