Skip to navigation

Verify the OTP

View as Markdown

Verifies the SMS code. For a user without a verified digital identity, phone ownership is checked and the number is updated right away (isCompleted: true). For a user with a verified digital identity, needsFaceMatching is true and the change completes after ValidateFaceMatch.

Authentication

ApiKeystring
Static API key issued to your tenant. Required on every request.

Request

This endpoint expects an object.
otpRequestIdstringRequired

The otpRequestId returned by SendOtp.

otpCodestringRequired
The code the user received.

Response

OTP checked.
dataobjectOptional
error_codeinteger or nullOptional
error_messagestring or nullOptional
error_descriptionslist of objects or nullOptional