Sign in

v1

latestOpenAPI 3.0.32026-07-264414182.7 KB
USSD OTP

Create USSD OTP

Creates a new USSD OTP session for secure phone-bound verification.

post/v1/ussd-otps

Headers

Idempotency-Keystring required

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

This header is used to uniquely identify a logical request, ensuring that it is not processed more than once during retries.

Monime-Version'caph.2025-08-23' | 'caph.2025-06-20' nullable

Specifies which version of the Monime API will handle this request.

Specifies which version of the Monime API will handle this request.

Monime-Space-Idstring required

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

The value is the tenancy parameter that Monime uses to determine which space the request is intended for.

Request body

authorizedPhoneNumberstring required

Phone number (MSISDN) authorized to verify the OTP. Will be used to validate the incoming USSD request.

verificationMessagestring nullable

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

durationstring

How long the OTP code remains valid before expiring. Specified as a duration string (e.g., '30s', '2m').

metadataobject nullable

Optional metadata to associate additional context or tracking info with this OTP session.

Example request

{
  "duration": "5m"
}

Response

OK

successboolean

Represents the status of the query operation, confirming if it was successful. This field is always true