Bright Horizons Media API - Integration Docs

Debt Sub-10k Leads

The Debt Sub-10k Leads endpoint allow you as a Publisher to post Debt Sub-10k leads directly to Bright Horizons Media. Leads sent to the API use the POST method and require both credentials and your Publisher to be enabled for posting leads. Leads are posted in JSON format.

Creative and TCPA must be approved before running. "Upside Legal, LLC" added to marketing partners list.

Nationwide EXCLUDING: Alaska, California, Hawaii, Idaho, Kansas, Maine, Oregon, Washington

Method	Endpoint	Endpoint Type
Post	https://api.brighthorizonsmedia.com/post/debt/sub10k/	JSON

POST PARAMETERS

To successfully post Debt Sub-10k leads, two arrays need to be passed to the JSON endpoint: the xauth[] array and the transaction[] array.

The xauth[] array contains your Publisher ID and the API key assigned by your Account Manager.

The transaction[] contains all the details about the lead (first name, last name, email, consumer IP, etc.).

xauth[] Parameters

Field	Type	Required?	Description
affiliateid	INT	Yes	Your Publisher Id (aka Affiliate Id) provided by your Account Manager
key	STRING (36)	Yes	The API Key provided by your Account Manager.

transaction[] Parameters

Field	Type	Required	Description
firstname	STRING	Yes	First name as provided by the consumer
lastname	STRING	Yes	Last name as provided by the consumer
phone	STRING	Yes	Phone number as provided by the consumer. Can be passed in any format (see following examples) but must be a valid phone number with 10 digits. Examples: 3105551212, (310) 555-1212, 310-555-1212, 310.555.1212.
email	STRING	Yes	Email address as provided by the consumer
address	STRING	OPTIONAL	Street address as provided by the consumer
address2	STRING	OPTIONAL	Street address as provided by the consumer
city	STRING	OPTIONAL	City as provided by the consumer. If not provided, we will map the city based on the zip code provided.
state	CHAR (2)	OPTIONAL	The state abbreviation as provided by the consumer. If not provided, we will map the state based on the zip code provided.
zip	STRING	OPTIONAL	The zip code as provided by the consumer. For US zip codes, make sure to include any leading zeros to ensure the zip code has a length of 5 characters.
finances	ARRAY	OPTIONAL	The finances parameter is OPTIONAL and an array containing key => value pairs of data related to the consumer's finances. unsecureddebtamount (INTEGER) - the estimated unsecured debt value as provided by consumer (example: 14750). If you do not collect this information, you can exclude this parameter or pass 0 (zero). unsecureddebtamountrange (VARCHAR) - a range of the unsecured debt amount provided the consumer. If you do not collect this information, you can exclude this parameter or pass an empty string. debttype (VARCHAR) - the type of debt as provided by the consumer. If you do not collect this information, you can exclude this parameter or pass an empty string.
credit	ARRAY	OPTIONAL	The credit parameter is OPTIONAL and an array containing key => value pairs of data related to the consumer's credit. creditscore (INTEGER) - the credit score as provided by consumer (example: 650). If you do not collect this information, you can exclude this parameter or pass 0 (zero).
optin	BOOLEAN	Yes	Whether the consumer opted in to be contacted. Set this value to true unless your Account Manager has provided other instructions.
ip	STRING	Yes	The IP address of the consumer when the form was submitted on your website (not your server IP address). Can be either IPV4 or IPv6.
source	STRING	Yes	The fully qualified URL (or domain) of the webpage where the lead was generated (excluding any query string parameters)
trustedformcertid	STRING	Yes	The TrustedForm URL
sub1	STRING	Yes	Additional field for tracking purposes
sub2	STRING	Optional	Additional field for tracking purposes
sub3	STRING	Optional	Additional field for tracking purposes
sub4	STRING	Optional	Additional field for tracking purposes
sub5	STRING	Optional	Additional field for tracking purposes

REQUESTS & RESPONSES

SAMPLE REQUEST

This sample post includes the OPTIONAL fields.


POST /post/debt/sub10k/ HTTP/1.1
Host: https://api.brighthorizonsmedia.com
Content-Type: application/json; charset=utf-8
Content-Length: 590

{
    "xauth":
    {
        "affiliateid": 123456,
        "key": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz"
    },
    "transaction":
    {
        "firstname": "JJ",
        "lastname": "McClure",
        "email": "jjmcclure@example.com",
        "phone": "7025551212",
        "address": "123 happy lane",
        "city": "Boulder City",
        "state": "NV",
        "zip": "89002",
        "ip": "192.168.168.1",
        "source": "yourdomain.com",
        "sub1": "yoursubid",
        "sub2": "",
        "sub3": "",
        "sub4": "",
        "sub5": "",
        "trustedformcertid": "https://cert.trustedform.com/Z667435837e00ZZZZd961885bZZZZ997e00fZZZZ",
        "finances":
        {
            "unsecureddebtamount": 7500,
            "unsecureddebtamountrange": "5000-7500",
            "debttype": "Credit Cards"
        },
        "credit":
        {
            "creditscore": 650
        }
    }
}

SAMPLE RESPONSE

When a Debt Sub-10k lead is posted to us, a JSON response will be returned containing useful information about whether the lead was accepted and any additional information we can provide. Below is an example of a successful response.

A response with sold = 1 (or "sold":1) ONLY means the lead was accepted by a buyer. Sold does not mean revenue was generated.

The "accepted" parameter is not to be used for determining whether a lead is billable.


{
    "validated": 1,
    "accepted": 1,
    "sold": 1,
    "disposition": "SOLD",
    "messages": [],
    "errors": [],    
    "transactionid": 123456789,
    "leadid": 123456789,
    "payout": 0
}

FAILED RESPONSE

If the request failed, the response will include an errors object which may contain 1 or more messages/errors. This example will return an errors because the last name and phone number values were not passed. Reminder, we do not log or record leads in our system that could not be validated.


{
    "validated": 0,
    "accepted": 0,
    "sold": 0,
    "disposition": null,
    "messages": [
        "Debt Sub10k Lead could not be validated"
    ],
    "errors": [
        "Last Name (required): can not be empty",
        "Phone (required): can not be empty"
    ]
}