Skip to navigation
Vlens APIRequest OTP

Confirm OTP

View as Markdown

Confirms the action using the OTP sent in step 1. A successful confirmation returns no error_code.

Authentication

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

End-user JWT from registration or login. Required for verification, signing, and user-scoped operations.

Request

This endpoint expects an object.
otpTypeIdintegerRequired

Must match the otpTypeId sent in step 1.

transactionIdstringRequired

Must match the transactionId sent in step 1.

phoneNumberstringRequired

Must match the phoneNumber sent in step 1.

phoneNumberOtpRequestIdstringRequiredformat: "uuid"

Returned by POST /api/OtpRequests/RequestOtp.

phoneNumberOtpstringRequired
The OTP code the customer received via SMS.

Response

Action confirmed.
dataobject or null

To complete in the docs: the full success response body was not provided — only that a successful confirmation has no error_code.

error_codeinteger or null
error_messagestring or null
error_descriptionsstring or null