Skip to main content
POST
sms.registration-sole.status

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by a row of sms.registrations.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

state
enum<string>
required

Current proprietor filing stage.

Available options:
brand_pending,
owner_confirmation_required,
brand_approved,
campaign_pending,
approved,
failed
identityVerified
boolean
required

Whether the proprietor confirmed ownership of their mobile.

canSend
boolean
required

Whether brand, identity and campaign are all approved.

nextAction
enum<string>

Next step, if needed.

Available options:
wait,
reply_yes,
submit_campaign,
correct_filing