Monime Documentation

A USSD OTP represents a one-time passcode session used to authenticate users through a USSD dial flow.
It enables secure, phone-bound verification, ensuring that the person interacting via USSD is the legitimate account holder. In addition to generating and validating the OTP, the flow may include user-facing feedback messages that confirm the process.

{
    "id": null,
    "status": "pending",
    "dialCode": null,
    "authorizedPhoneNumber": null,
    "verificationMessage": null,
    "createTime": null,
    "expireTime": null,
    "metadata": null
}

Properties

string

Unique identifier for this USSD OTP session.

enum<string>

Status of the OTP session. One of:

pending: Awaiting verification.
verified: OTP was successfully confirmed.
expired: OTP expired before verification.

Available options: pending verified expired

string

USSD dial code that the user should dial (e.g., *715*12345#) to initiate the OTP verification.

string

Authorized phone number (MSISDN) associated with this OTP. May be masked for privacy.

string

Message shown to the user after successful verification, typically rendered on the USSD interface.MaxLength: 255

string

Timestamp when this OTP session was created.

string

Expiration time after which the OTP becomes invalid.

object

Optional metadata for attaching additional context or tracking info to this OTP session.

API Reference

Core Resources

Payins

Payouts

Utilities

Extra Resources

Financial Providers

Ussd Otp