API Docs

WhatsApp verification API for single-number checks

Choose a service type, submit one phone number, and receive a synchronous product-specific result.

API at a glanceOne synchronous endpoint, three service types, and a consistent code / msg / data response envelope.

Authentication

Use an API key created in Settings and send it with every request.

X-API-Key: wac_your_api_key

Single check

POST /api/v1/check

service_typews, ws_avatar, or ws_business

identifierE.164 phone number with country code

Request body

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

Products and result fields

wsWhatsApp Registration CheckConfirm whether a phone number is registered on WhatsApp.

1 credit

ws_avatarWhatsApp Avatar CheckCheck registration, whether the WhatsApp account has set an avatar, and return the avatar URL when available.

2 credits

ws_businessWhatsApp Business Account CheckCheck registration and identify whether the number uses a WhatsApp Business account.

2 credits

avatar=false and business=false do not mean the number is unregistered. Always use registered for registration status.

Response examples

Every product returns the same code / msg / data envelope. The fields inside data depend on the service_type you request.

wsWhatsApp Registration Check1 credit

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 123,
    "identifier": "+14155552671",
    "registered": true,
    "transaction_id": "chk_example123",
    "status": "success",
    "service_type": "ws",
    "charged_credits": 1
  }
}

ws_avatarWhatsApp Avatar Check2 credits

{
  "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
  }
}

ws_businessWhatsApp Business Account Check2 credits

{
  "code": 0,
  "msg": "ok",
  "data": {
    "id": 123,
    "identifier": "+14155552671",
    "registered": true,
    "transaction_id": "chk_example123",
    "status": "success",
    "service_type": "ws_business",
    "business": true,
    "charged_credits": 2
  }
}

Error codes

40000Unsupported service type or conflicting request fields

40001Invalid JSON body

40002Invalid phone number

40100Missing or invalid API key

40200Insufficient credits

42900Rate limit exceeded

50300Validation service maintenance

cURL example

export WA_CHECKER_API_BASE="https://your-api-domain.com"

curl -X POST "$WA_CHECKER_API_BASE/api/v1/check" \
  -H "X-API-Key: wac_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "service_type": "ws", "identifier": "+14155552671" }'

Replace WA_CHECKER_API_BASE with the actual API base URL.

Create a free account