Skip to content
Sendblue Docs
Get Started
API Reference

Verified Contacts

Operations for managing verified-contact access to shared iMessage lines

List verified contacts
GET/v3/verified-contacts
Create a pending verified contact
POST/v3/verified-contacts
Get a verified contact
GET/v3/verified-contacts/{phone_number}
ModelsExpand Collapse
VerifiedContactListResponse object { data }
data: optional object { contacts, line }
contacts: array of object { created_at, phone_number, updated_at, 2 more }
created_at: string
phone_number: string

Contact phone number in E.164 format

updated_at: string
verification_status: "pending" or "verified"
One of the following:
"pending"
"verified"
verified: boolean

Whether this contact has completed verification by messaging the shared line

line: object { phone_number, type }
phone_number: string

Shared Sendblue line the contact must message to complete verification

type: "shared"
VerifiedContactCreateResponse object { data }
data: optional object { contact, line, verification_instructions }
contact: object { created_at, phone_number, updated_at, 2 more }
created_at: string
phone_number: string

Contact phone number in E.164 format

updated_at: string
verification_status: "pending" or "verified"
One of the following:
"pending"
"verified"
verified: boolean

Whether this contact has completed verification by messaging the shared line

line: object { phone_number, type }
phone_number: string

Shared Sendblue line the contact must message to complete verification

type: "shared"
verification_instructions: string

Null when the contact is already verified

VerifiedContactRetrieveResponse object { data }
data: optional object { contact, line }
contact: object { created_at, phone_number, updated_at, 2 more }
created_at: string
phone_number: string

Contact phone number in E.164 format

updated_at: string
verification_status: "pending" or "verified"
One of the following:
"pending"
"verified"
verified: boolean

Whether this contact has completed verification by messaging the shared line

line: object { phone_number, type }
phone_number: string

Shared Sendblue line the contact must message to complete verification

type: "shared"