Skip to main content
GET
Check whether an address is blocked

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

identity_type
enum<string>
required

What kind of address this is. "phone" is stored in international format, "email" is lowercased, and "whatsapp_user_id" is the WhatsApp id of a contact whose phone number is hidden.

Available options:
phone,
email,
whatsapp_user_id
identity_value
string
required

The address itself — e.g. "+962790007001" or "[email protected]".

Required string length: 1 - 320

Response

Default Response

blocked
boolean
required
entries
object[]
required