Monime Documentation

GET

/

v1

/

ussd-otps

/

{id}

Get USSD OTP

curl --request GET \
  --url https://api.monime.io/v1/ussd-otps/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'

import requests

url = "https://api.monime.io/v1/ussd-otps/{id}"

headers = {
    "Monime-Space-Id": "<monime-space-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Monime-Space-Id': '<monime-space-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.monime.io/v1/ussd-otps/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.monime.io/v1/ussd-otps/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Monime-Space-Id: <monime-space-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/ussd-otps/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Monime-Space-Id", "<monime-space-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/ussd-otps/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "status": "pending",
    "dialCode": "<string>",
    "authorizedPhoneNumber": "<string>",
    "verificationMessage": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "expireTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

Authorizations

Authorization

string

header

required

Bearer HTTP authentication specified with the header Authorization: Bearer <access_token>

Headers

Monime-Version

enum<string> | null

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

Available options:

caph.2025-08-23,

caph.2025-06-20

Monime-Space-Id

string

required

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

Maximum string length: 64

Pattern: ^spc-.*$

Path Parameters

id

string

required

ID of the USSD OTP session to retrieve.

Response

200 - application/json

OK

success

boolean

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

messages

any[]

Contains a list of messages providing relevant information or feedback related to the query or operation

result

USSD OTP · object

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.

Show child attributes

Get USSD OTP

curl --request GET \
  --url https://api.monime.io/v1/ussd-otps/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Monime-Space-Id: <monime-space-id>'

import requests

url = "https://api.monime.io/v1/ussd-otps/{id}"

headers = {
    "Monime-Space-Id": "<monime-space-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Monime-Space-Id': '<monime-space-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.monime.io/v1/ussd-otps/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.monime.io/v1/ussd-otps/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Monime-Space-Id: <monime-space-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.monime.io/v1/ussd-otps/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Monime-Space-Id", "<monime-space-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.monime.io/v1/ussd-otps/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Monime-Space-Id"] = '<monime-space-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "messages": [
    "<unknown>"
  ],
  "result": {
    "id": "<string>",
    "status": "pending",
    "dialCode": "<string>",
    "authorizedPhoneNumber": "<string>",
    "verificationMessage": "<string>",
    "createTime": "2023-11-07T05:31:56Z",
    "expireTime": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}