Public API

Send a one-time code or issue a tap-to-verify link

post/v1/verifications

Request

  • Base URL: https://otprun.com
  • URL: https://otprun.com/v1/verifications
  • Auth: HTTP bearer

Request body

app_namestring

Replaces {app} in the text, defaults to the project sender name

channelsstring[] nullable

Tried in order; omit to use the project routing policy (WhatsApp first, Telegram as fallback)

code_lengthinteger
localestring

BCP 47 tag of the message, defaults to the project locale

max_attemptsinteger
mode'outbound' | 'inbound'

Defaults to outbound

tostring

Recipient phone in international format such as +77010000000, required for outbound

ttl_secondsinteger

Response

Created

attemptsinteger required
channel_used'whatsapp_gateway' | 'telegram' | 'telegram_gateway' | 'whatsapp_official' nullable required

Channel that carries the code, null until chosen

code_lengthinteger required
created_atstring date-time required
delivered_atstring date-time nullable required
error_codestring required
expires_atstring date-time required
failed_atstring date-time nullable required
idstring uuid required
inbound_linkstring required

wa.me link for inbound verifications, empty otherwise

localestring required
max_attemptsinteger required
mode'outbound' | 'inbound' | 'relay' | 'login' required

relay: the code came from an auth provider such as Supabase, which also checks it; login: an OTP Run sign-in code

project_idinteger required
sent_atstring date-time nullable required
slot_idstring nullable required
status'pending' | 'sent' | 'delivered' | 'verified' | 'failed' | 'expired' | 'canceled' | 'locked' required
to_phonestring required

E.164 recipient, empty for inbound verifications without an expected phone

verified_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.