Skip to main content
POST
imessage.contact.check

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
contact
string
required

Phone number including country code, or an email address.

Maximum string length: 320

Response

The result

supported
boolean
required

Whether iMessage support was detected.

checkedAt
string

Check timestamp, ISO 8601 UTC.