Product guidance
Choosing Between ws, ws_avatar and ws_business
All three WA Lookup WhatsApp checks use one synchronous call and differ only in the service_type value. Here is how to pick the right one.
WA Lookup offers three WhatsApp checks behind a single call. Picking between them is a question about which fields your workflow will actually read, not a question about capability tiers.
WA Lookup's three WhatsApp checks all use POST /api/v1/check and differ only in the service_type value: ws returns the registration field, ws_avatar adds avatar and avatar_url, and ws_business adds a business boolean.
ws when a single field decides the outcome
If the next step in your workflow branches only on whether a WhatsApp account is present, ws returns exactly that and nothing you will not read. Selecting a richer service_type in this situation adds cost to every call without changing a single decision your code makes.
ws_avatar when profile visibility matters
Choose ws_avatar when something downstream reads the avatar fields: ordering a lead queue, enriching a CRM record, or giving a reviewer additional context. The distinguishing question is whether any code or any person will look at the avatar value. If not, ws is the better choice.
ws_business when the account type drives routing
ws_business adds a business boolean, which suits workflows that treat business accounts differently from other accounts. As with ws_avatar, the test is whether that field reaches a decision — a field returned and ignored is pure cost.
Selecting per call rather than per integration
Because service_type is a body value on the same call, one integration can select different checks for different lists or different stages. Teams commonly run ws across a large list first and then a richer service_type on the subset that matters, which keeps spend proportional to the value of each stage.
FAQ
Do the three checks use different URLs?
No. All three use POST /api/v1/check and are selected by the service_type value in the request body.
Can one integration mix service types?
Yes. service_type is a per-request body value, so different lists or stages can select different checks through the same integration.
Does ws_avatar include what ws returns?
Yes. It returns the registration field and adds the avatar fields on top.