Skip to content
Sendblue Docs
Get Started
API Reference
Messages

V2

V2Verify

V2VerifyServices

V2VerifyServicesVerifications

Sendblue Verify issuance and recovery state

Create a verification
POST/api/v2/verify/services/{service_sid}/verifications
Retrieve a verification
GET/api/v2/verify/services/{service_sid}/verifications/{verification_sid}
ModelsExpand Collapse
VerificationCreateResponse object { account_sid, channel, date_created, 9 more }
account_sid: string
channel: "imessage"
date_created: string
date_updated: string
expires_at: string

ISO timestamp when the Verification expires.

formatdate-time
service_sid: string
sid: string
status: "pending" or "approved" or "expired" or "canceled"
One of the following:
"pending"
"approved"
"expired"
"canceled"
to: string

Expected sender in E.164 format; older durable terminal records may return null.

url: string
delivery_target: optional DeliveryTarget { code, pool_number, sms_deep_link }

Present while the Verification is pending.

code: string

Code the expected sender must text to pool_number.

minLength4
maxLength8
pool_number: string

Sendblue phone number that should receive the verification code.

Messages/SMS deep link with the destination and code prefilled.

hosted: optional HostedVerification { component_script, expires_at, session_id, url }

Present only when hosted options were supplied during creation.

component_script: string

Web-component script URL. Load this value exactly as returned.

formaturi
expires_at: string

ISO timestamp when the Verification expires.

formatdate-time
session_id: string

Hosted widget session identifier.

url: string

Origin-bound widget URL containing a one-session bearer token in its fragment. Do not log, persist, or move the token into a query parameter.

formaturi
VerificationRetrieveResponse object { account_sid, channel, date_created, 8 more }
account_sid: string
channel: "imessage"
date_created: string
date_updated: string
expires_at: string

ISO timestamp when the Verification expires.

formatdate-time
service_sid: string
sid: string
status: "pending" or "approved" or "expired" or "canceled"
One of the following:
"pending"
"approved"
"expired"
"canceled"
to: string

Expected sender in E.164 format; older durable terminal records may return null.

url: string
delivery_target: optional DeliveryTarget { code, pool_number, sms_deep_link }

Present while the Verification is pending.

code: string

Code the expected sender must text to pool_number.

minLength4
maxLength8
pool_number: string

Sendblue phone number that should receive the verification code.

Messages/SMS deep link with the destination and code prefilled.