Skip to main content
GET
Get OTP status

Authorizations

Authorization
string
header
required

Your Robase API key. Starts with robe_. Include as Authorization: Bearer robe_...

Path Parameters

id
string<uuid>
required

OTP ID returned from send

Response

OTP details

id
string<uuid>
required
workspace_id
string<uuid>
required
phone_number
string
required
country_code
string
required

ISO 3166-1 alpha-2 country code

credit_cost
integer
required
status
enum<string>
required
Available options:
pending,
sent,
verified,
expired,
failed
code_length
integer
required
ttl_seconds
integer
required
attempt_count
integer
required

Verification attempts made so far

max_attempts
integer
required

Attempt budget before the OTP is burned

Example:

5

expired_at
string<date-time>
required

When the code stops being verifiable

created_at
string<date-time>
required
sent_at
string<date-time>
delivered_at
string<date-time>
verified_at
string<date-time>
failed_at
string<date-time>

When the OTP was marked failed. Absent otherwise.

failure_reason
string

Reason token behind a failed status. See TimelineItem.

metadata
object
timeline
object[]

Hops the OTP took, oldest first.