Skip to main content
POST
Start an OTP Verification Session

Authorizations

Client-ID
string
header
required

Your UgaText Client-ID (e.g. uga_...). Accepted header aliases: X-Client-ID, or combined in Authorization: Bearer : / X-API-Key: :.

Client-Secret
string
header
required

Your UgaText Client-Secret (e.g. sk_live_...). Accepted header alias: X-Client-Secret.

Body

application/json
phone_number
string
required
Example:

"+256700000000"

service_id
string
Example:

"default"

external_reference
string
Example:

"user_reg_9841"

Response

OTP session started

success
boolean
Example:

true

verification_id
string
Example:

"v_1760425200000_8fa12bc3901d"

service_id
string
Example:

"vsvc_1760425200000_1a2b3c4d"

status
string
Example:

"pending"

expires_at
string<date-time>
resend_after
string<date-time>
masked_phone
string
Example:

"+256700 ••• 000"

recipient_masked
string
Example:

"+256700 ••• 000"

test_mode
boolean
Example:

true

mode
enum<string>
Available options:
live,
sandbox
Example:

"sandbox"

carrier_segments
integer
Example:

1

cost_units
integer
Example:

0

cost_ugx
number
Example:

0