Vlens APIFRA Services

Request OTP

View as Markdown

Sends a one-time password to the phone number about to be validated and returns the otpRequestId to echo back on the inquiry call. Only needed when running a PII inquiry with OTP verification — both inquiry endpoints also accept requests with no OTP at all.

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.
phoneNumberstringRequired

Response

dataobject
error_codeinteger or null
error_messagestring