Brand Names as Input Parameters for TCPA Guardian

Updated on 24 Jan 2025
1 Minute to read

Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Summary

The introduction of the brand_names parameter provides enhanced flexibility for Guardian users by enabling them to pass multiple brand names in a single API request. This parameter allows users to send up to 30 brand names in a single API request, enabling TCPA Guardian to validate consent for each brand and return the relevant responses for lead posting.

New Parameter Specifications

Parameter Name: brand_names
- This is an optional parameter
Type: Pipe-delimited string
- Example: ‘company 1, llc|company 2 inc|company 3’
Max Limit: 30 brand names per request

Example Request Structure (GET method)

https://api.leadid.com/SingleQuery?lac=ACCOUNTCODE&id=LEADIDTOKEN&lak=AUDITKEY&lpc=PROVIDERCODE&data=DATA&brand_names={BRANDNAMES}

Example API Response:

{
  "single_query": {
    "lead_id": "A1C2860F-25EA-4937-BC78-222D8C227789",
    "brand_names": "company 1, llc|company 2 inc|company 3"
  }
}

Example API Response:

The response will be the same as documented in the Example Response Structure in the TCPA Guardian (3rd Party) API

Error Handling for Exceeding the Maximum Limit of Brand Names

If more than 30 brand names are sent in a request, the API will return the following error code and message:

{
    "error": {
        "code": 1050,
        "message": "Brand names parameter limit of 30 was reached"
    },
    "transid": "A1C2860F-25EA-4937-BC78-222D8C212348"
}

Reformatting of Brand Names

The brand names returned in the response will be exactly as they were submitted. This means there will be no trimming of spaces, no removal of duplicates, or any other reformatting.

Example:

API input Request: Company Inc!|company, llc| Insurance-company
API Response: Company Inc!|company, llc| Insurance-company

NOTE
If brand names are passed as input in the request, the brand names associated with the account’s profile (if any) will be ignored.

Example Error Response (Exceeding 30 Brands):

{
    "error": {
        "code": 1050,
        "message": "Brand names parameter limit of 30 was reached"
    },
    "transid": "A1C2860F-25EA-4937-BC78-222D8C222828"
}

Notes:

This feature will not be available for Pre-Audit functionality.
If brand_names is not provided in the input, the API will default to using the brand names listed in the account’s profile.

Questions

For strategy & analytics support, reach out to our Customer Success team: customersuccess@jornaya.com

For technical support, reach out to our support team: support@jornaya.com

Was this article helpful?

What's Next

Compliance Reports & Visual Playbacks

Table of contents

Summary