API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Otpvalidation

One Time Password SMS

Sends a message including an OTP code to the given phone number

client.otpvalidation.sendCode(OtpvalidationSendCodeParams { message, phoneNumber, xCorrelator } params, RequestOptionsoptions?): OtpvalidationSendCodeResponse { authenticationId }

POST/otpvalidation/send-code

Verifies the OTP received as input

client.otpvalidation.validateCode(OtpvalidationValidateCodeParams { authenticationId, code, xCorrelator } params, RequestOptionsoptions?): void

POST/otpvalidation/validate-code

ModelsExpand Collapse

OtpvalidationSendCodeResponse { authenticationId }

Structure to provide authentication identifier

authenticationId: string

unique id of the verification attempt the code belongs to.

maxLength36