Skip to main content
Version: 3.x

Authentication and Request Signing

TapResearch’s Partner API uses two mechanisms to control access and verify request integrity:

  1. API Token — identifies your partner account. Only required on endpoints that need authentication.
  2. API Secret — used to generate sech signatures for specific flows. Never sent directly in a request.

All Partner API endpoints require your API token for authentication, so this page focuses on when credentials are needed and how request signing works at a high level.


API Token

Your API token is required on all Partner API endpoints.

Send it via header:

HeaderDescription
X-Api-TokenIdentifies your partner account.

This header is always required.


User Identifiers

For endpoints involving participant context, include the relevant identifiers:

HeaderRequiredDescription
X-User-IdentifierYesUnique user or device identifier (UUIDv4).
X-Device-IdentifierOptionalHardware/device ID for multi-device distinction.

Using the API Secret

Your API secret is never transmitted. It is only used to generate signatures (sech) for two flows:

  1. Impanel Security Hash (/players/impanel)
  2. Redirect Signing (verifying redirect callbacks)

For complete signing instructions, see: