Skip to content
Sendblue Docs
Get Started
API Reference
Verify
Verifications

Retrieve a verification

GET/api/v2/verify/services/{service_sid}/verifications/{verification_sid}

Returns the authoritative status for one Verification owned by the authenticated account. Twilio-compatible clients may send the API Key ID and API Secret Key with HTTP Basic authentication. Temporary bearer authentication is supported for account-scoped tokens; line-scoped temporary tokens cannot retrieve account-wide Verification state.

Path ParametersExpand Collapse
service_sid: string
verification_sid: string
ReturnsExpand Collapse
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.

Retrieve a verification

curl https://api.sendblue.co/api/v2/verify/services/$SERVICE_SID/verifications/$VERIFICATION_SID \
    -H "sb-api-key-id: $SENDBLUE_API_API_KEY" \
    -H "sb-api-secret-key: $SENDBLUE_API_API_SECRET"
{
  "account_sid": "account_sid",
  "channel": "imessage",
  "date_created": "2019-12-27T18:11:19.117Z",
  "date_updated": "2019-12-27T18:11:19.117Z",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "service_sid": "SVE1CB97d8EBbDbaAae6d9B1ca0D1cFaAD",
  "sid": "VRE1CB97d8EBbDbaAae6d9B1ca0D1cFaAD",
  "status": "pending",
  "to": "+14155551212",
  "url": "https://example.com",
  "delivery_target": {
    "code": "CB6DJ9",
    "pool_number": "+17865640246",
    "sms_deep_link": "sms:+17865640246?body=CB6DJ9"
  }
}
Returns Examples
{
  "account_sid": "account_sid",
  "channel": "imessage",
  "date_created": "2019-12-27T18:11:19.117Z",
  "date_updated": "2019-12-27T18:11:19.117Z",
  "expires_at": "2019-12-27T18:11:19.117Z",
  "service_sid": "SVE1CB97d8EBbDbaAae6d9B1ca0D1cFaAD",
  "sid": "VRE1CB97d8EBbDbaAae6d9B1ca0D1cFaAD",
  "status": "pending",
  "to": "+14155551212",
  "url": "https://example.com",
  "delivery_target": {
    "code": "CB6DJ9",
    "pool_number": "+17865640246",
    "sms_deep_link": "sms:+17865640246?body=CB6DJ9"
  }
}