Service type: ws_avatar

WhatsApp Avatar

Check registration and determine whether the account has a visible avatar.

Usage cost2 credits per check

Response modeSynchronous

API endpointPOST /api/v1/check

What it checks

What does WhatsApp Avatar return?

Adds avatar availability to the registration result, helping review account completeness and enrich workflows that benefit from a profile image signal.

Best for

Use this product when you need

Profile enrichment
Account review
Support workflows
Contact confidence signals

API contract

One request, immediate result

Read full API docs

Send one E.164 phone number and select this product with service_type. Authentication uses your API key.

RequestPOST /api/v1/check

{
  "service_type": "ws_avatar",
  "identifier": "+14155552671"
}

Response200 OK

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 123,
    "identifier": "+14155552671",
    "registered": true,
    "transaction_id": "chk_example123",
    "status": "success",
    "service_type": "ws_avatar",
    "avatar": true,
    "avatar_url": "https://pps.waavatar.xyz/v/example.jpg",
    "charged_credits": 2
  }
}

Result fields

Fields added by this product

registeredboolean

Whether the number is registered on WhatsApp.

avatarboolean

Whether an avatar is available.

avatar_urlstring?

Avatar URL when the upstream service provides one.

Always use registered for registration status. A false product-specific field does not mean the number is unregistered.

Product FAQ

Questions about Avatar Check

What does WhatsApp Avatar check?

It checks one phone number and returns registration status, avatar availability, and an avatar URL when available in the same synchronous response.

How much does Avatar Check cost?

Each completed check uses 2 credits. Failed or undetermined upstream requests do not keep the charge.

What phone number format is required?

Use E.164 format with the country code, for example +14155552671.

Does the response expose cache status?

No. Cache handling is internal and clients must not depend on a cached field.