Sign in

v1

latestOpenAPI 3.1.02026-07-268342124.0 KB
challenge

Claim challenge

Claim an SMS or email-based challenge on behalf of a user, associating it with an ID for a user record in your system.

post/claim

Request body

challengeIdstring required

The ID of the challenge.

userIdstring required

The ID of the user.

skipVerificationCheckboolean

If set to true, the requirement to call Verify Challenge before claiming the challenge on behalf of a user will be skipped. This option may be used in scenarios where an OTP code has been verified independently of Authsignal. It should be used with caution and could introduce security risks if used incorrectly. Defaults to false.

Response

OK

tokenstring required

A short-lived token which can be used subsequently in your integration to validate that the challenge was completed successfully by the user.

verificationMethod'SMS' | 'EMAIL_OTP' required

The verification method used to complete the challenge.