Skip to main content
Version: 3.x

Eligibility API

The Eligibility API is a pre-send eligibility check. You make a single server-side call before showing a survey call-to-action, and TapResearch tells you whether the user currently has an offer available.

In short: one call in, has_offer true/false out. Gate your call-to-action on that answer.

Creating your app

In the Supplier Dashboard, create a new app and select Eligibility API. See the Setup checklist for the full flow.

info

The Eligibility API returns a yes/no and a link — it does not return a list of surveys. If you need to render survey tiles or run a profile-first impanel flow, use the Survey Feed API instead.

How it works​

  1. Before rendering your "Earn rewards" button (or any survey entry point), your backend calls the has-offer check.
  2. TapResearch responds with has_offer:
    • true — the user has at least one offer waiting. Show the call-to-action and link the user to the returned offer_url.
    • false — the user has nothing available right now. Hide or disable the call-to-action so the user never taps into an empty wall.
  3. When the user finishes an offer, TapResearch notifies your server through a callback.

When to use it​

Use the Eligibility API when you want to:

  • Show a survey entry point only when there is something for the user to do.
  • Keep all logic on your server — no SDK, no client-side survey rendering.
  • Control the exact placement, copy, and styling of the call-to-action yourself.

What you need​

  • An API token for your app (from the Publisher Dashboard).
  • A stable user_identifier for each user.
  • An offer_identifier for the placement you are checking.

Next steps​