API docs by Redocly

Global API Gateway (1.0.0)

Download OpenAPI specification:Download

🔑 Need an API Key?

Get your API key to start using our APIs with higher rate limits and priority support.

Dynamic API Proxy

JSON-driven API proxy; add new APIs by adding JSON only

WhatsApp Number Validation & Profile Lookup

Verify whether phone numbers are registered on WhatsApp and retrieve public profile data in real time: account existence, profile photo (avatar/DP), About status text, presence/last-seen, and full WhatsApp Business profile (name, verified level, description, address, email, website). A two-step flow keeps lookups efficient — first call a check-exist endpoint to confirm the number and obtain a userHash, then pass that userHash to the profile endpoints. RESTful JSON API for lead validation, CRM enrichment, and customer intelligence.

Check WhatsApp Account Exists (by Full Number)

path Parameters
phoneNumber
required
string

e.g. 551121770100

query Parameters
key
required
string

API Key 或 hCaptcha token

Responses

Check WhatsApp Account Exists (CC + Phone Split)

query Parameters
key
required
string

API Key 或 hCaptcha token

cc
required
string

e.g. 55

phone
required
string

e.g. 1121770100

Responses

Get Profile Avatar (Display Photo)

query Parameters
key
required
string

API Key 或 hCaptcha token

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

type
string

type (string)

Responses

Get About / Status Text

query Parameters
key
required
string

API Key 或 hCaptcha token

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

Responses

Get Business Profile

query Parameters
key
required
string

API Key 或 hCaptcha token

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

Responses

Get Presence / Last Seen

query Parameters
key
required
string

API Key 或 hCaptcha token

userHash
required
string

e.g. 8a3e2f4d1c5b6e7f9a0c1d2e3f4a5b6c

Responses

Check Active Status

path Parameters
phoneNumber
required
string

e.g. 551121770100

query Parameters
key
required
string

API Key 或 hCaptcha token

Responses

Batch Check (up to 10 numbers)

query Parameters
key
required
string

API Key 或 hCaptcha token

accounts
required
string

e.g. 551121770100,5511999999999

Responses

Telegram Number Validation & Profile Lookup

Check in real time whether a phone number is registered on Telegram and retrieve public profile fields: username, display name, About bio, Telegram user ID, common-chats count, call availability, last-seen timestamp, and quality/risk flags (premium, verified, bot, scam, fake, deleted, restricted). A single GET by phone number returns a clear registered=true/false plus profile data when available. RESTful JSON API for lead validation, account quality scoring, and contact enrichment.

Telegram Lookup by Phone Number

path Parameters
phoneNumber
required
string

e.g. 16156296515

query Parameters
key
required
string

API Key 或 hCaptcha token

Responses

Signal Number Validation & Profile Lookup

Check in real time whether a phone number is registered on Signal and retrieve a compact set of public profile fields: display name, given/family name, About bio, E.164 phone, stable ACI/PNI UUIDs, avatar color, registration status, and trust flags (blocked, verified, profile-sharing). A single GET by phone number returns a clear registered=true/false plus profile data when available. RESTful JSON API for lead validation, identity resolution, and risk scoring.

Signal Lookup by Phone Number

path Parameters
phoneNumber
required
string

e.g. 17135193910

query Parameters
key
required
string

API Key 或 hCaptcha token

Responses