User action for suggest verification methods
POST/auth-actions-srv/validation/:track_id
This API allows users to take action on the list of suggested verification methods that are prompted during the suggest_verification_methods precheck step.
When to use this API:
- After receiving a prevalidation response with
validationType: suggest_verification_methods - When the user needs to decide whether to skip or permanently dismiss the verification method suggestions
- The track_id must be from a recent prevalidation (within 1 hour)
Validation Rules:
- The track_id must be associated with
suggest_verification_methodsvalidation type - The action can only be used when the prevalidation metadata reason is
NONEorALLOFMANDATORY DONOTSHOWAGAINcan only be used when all verification methods are optional OR all mandatory methods are already configured by the userSKIPcannot be used if there are mandatory methods without a validskipUntiltime or ifskipUntilhas expired
Security:
- The track_id is validated and sanitized
- The user's
sub(subject identifier) is removed from the response for security reasons - The track_id expires after 1 hour for security purposes
What happens after:
- The user's decision is stored and associated with their account and client
- This preference is used for future login attempts
- If
SKIPis chosen, the user will be prompted again after the configured time period - If
DONOTSHOWAGAINis chosen, the prompt won't appear until admin changes are made
Request
Responses
- 200
- 400
- 404
Success. The user's decision has been saved. The response contains the stored preference (without the user's sub for security).
Bad Request. Possible reasons:
- Invalid track_id format (contains spaces or invalid characters)
- Track_id not found in database
- Invalid action value
- Action must not be empty
- Action not allowed for the current prevalidation state
- Track_id is not associated with
suggest_verification_methodsvalidation type - Invalid request body format
Track_id expired (older than 1 hour from creation time)