Verify challenge

Verify an SMS or email-based challenge by submitting a verification code.

post/verify

Request body

challengeIdstring required

The ID of the challenge.

verificationCodestring required

The verification code submitted by the user.

Response

isVerifiedboolean required

True if the verification code is valid.

verificationMethod'SMS' | 'EMAIL_OTP' | 'WHATSAPP'

The verification method used for the challenge if successful.

phoneNumberstring

The phone number for which the challenge was initiated. Only present if verification is successful and the verification method is 'SMS' or 'WHATSAPP'.

emailstring

The email address for which the challenge was initiated. Only present if verification is successful and the verification method is 'EMAIL_OTP'.

failureReason'CODE_INVALID_OR_EXPIRED' | 'MAX_ATTEMPTS_EXCEEDED'

Changes

No recorded changes to this endpoint across all 1 revision of this API.