service_type ws_avatar
Check whether a phone number has a public WhatsApp avatar, get the image URL, and read the portrait attributes of that avatar.
POST /api/v1/checkWhatsApp Avatar ProfileNo sign-in required. Daily demo limits apply.
API contract
Send one phone number and select this product with service_type. Authentication uses your API key.
Copy the curl command below and replace only the example API key with your own.
POST /api/v1/checkcurl -X POST "https://avatarlookup.com/api/v1/check" \
-H "X-API-Key: sk_your_api_key" \
-H "Content-Type: application/json" \
-d '{ "service_type": "ws_avatar", "identifier": "+14155552671" }'200 OK{
"code": 0,
"msg": "ok",
"data": {
"service_type": "ws_avatar",
"identifier": "+14155552671",
"registered": true,
"avatar": true,
"avatar_url": "https://pps.whatsapp.net/v/example.jpg",
"extra": {
"profile_available": "true",
"category": "individual portrait",
"gender": "male",
"age": "39",
"skin_color": "white",
"hair_color": "brown"
}
}
}Use the result well
A phone number in E.164 form (a plus sign, the country code, then the number) for WhatsApp, or a full email address for the email product.
registered says whether the account exists, avatar says whether it publishes a photo, avatar_url carries the image. All three come back on every successful lookup.
avatar_url points at the platform's own CDN and may expire on their schedule. Treat it as a pointer: download or cache the image if you need to keep it.
What it checks
registered · boolean — Whether the phone number is registered on WhatsApp.avatar · boolean — Whether a public profile photo is set.avatar_url · string — URL of the public profile photo; empty string when no photo is set.extra.profile_available · boolean — Whether portrait attributes were produced this time. Read it together with avatar: false/false means there is no avatar to analyse, true/false means the avatar could not be recognized.extra.category · string — What the picture is: individual portrait, group photo, game avatar, cartoon avatar, landscape, pet avatar or object.extra.gender · string — male, female or unknown.extra.age · number — Estimated age, accurate to about 3 years and clamped to 0-80. Empty when no gender was determined — there is no placeholder number.extra.skin_color · string — Descriptive skin tone, for example white, east_asian or hispanic. Treat it as an open set.extra.hair_color · string — Descriptive hair colour, for example black, brown, blond or gray white. Treat it as an open set.Best for
Direct answer
WhatsApp Avatar Profile returns whether the number has a public WhatsApp avatar, and the image URL when it does. Use service_type ws_avatar (the parameter that selects a product) with one phone number in E.164 form, for example +14155552671, and read the extra object in the same API response.
Clear boundaries
Product FAQ
It checks one identifier and returns whether the number has a public WhatsApp avatar, and the image URL when it does in the same synchronous response.
Balance is charged only for completed checks. Failed or undetermined checks do not keep the charge.
Submit the identifier the product accepts: a phone number in E.164 form for WhatsApp, or a full email address for the email product. Sending the wrong form is rejected before any charge.
No. It only reports whether the platform publishes an avatar at that moment. It says nothing about whether the account is in use or online, and it is not permission to contact anyone. Consent and applicable rules remain your responsibility.
Related products
Create an account to use every product from the SaaS dashboard or the API: realtime checks and async bulk checks draw on the same balance.