Verify Audience Claim

Overview

This API performs entitlement verification for businesses seeking to register with a specific partner. It checks if a business exists in the partner's pre-loaded audience list and is eligible to be claimed.

How It Works

Partners pre-load their eligible businesses into the audiences table (via CSV upload or Audiences API). Each audience record contains a unique_validation_identifier field that uniquely identifies the business (e.g., email address, tax ID, membership number).

This endpoint looks up the audience record by matching:

  • directory_uid (from the Directory token)
  • unique_validation_identifier (from the request body)
  • status is not 'deleted'

Use Case

Before creating a new business account under a partner directory, call this endpoint to verify the business is in the partner's approved audience list.

Available for Directory tokens only.

Body Params
string
required

The unique identifier used to look up the business in the partner's audience table. This value must exactly match the unique_validation_identifier field of an existing audience record for the partner's directory. Common values include: email address (e.g., '[email protected]'), tax ID, membership number, or any partner-specific identifier. The value is provided by the partner when they upload their audience list.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json