Credit Repair Leads

The Credit Repair Leads endpoint allow you as a Publisher to post Credit Repair 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 Credit Repair leads. Leads are posted in JSON format.

Creative and TCPA must be approved before running. "The Credit Pros" must be added to TCPA/marketing partners list. Filters must be setup on your end including: must be employed, $2,000/month minimum income, has negative items on their credit report like late payments and collections, interested in speaking with a repair specialist, 21 years old or older. State exclusions: Maine, Kansas, Minnesota & Oregon.

Method	Endpoint	Endpoint Type
Post	https://api.brighthorizonsmedia.com/post/credit-repair/	JSON

POST PARAMETERS

To successfully post Credit Repair 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, vehicle details, 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.
phone2	STRING	Optional	Second 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	Yes	Street address as provided by the consumer
address2	STRING	Optional	Street address as provided by the consumer
city	STRING	Yes	City as provided by the consumer. If not provided, we will map the city based on the zip code provided.
state	CHAR (2)	Yes	The state abbreviation as provided by the consumer. If not provided, we will map the state based on the zip code provided.
zip	STRING	Yes	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.
credit	ARRAY	Optional	The optional credit parameter is an array containing key => value pairs of data related to the credit repair request. Over time, more credit repair specific parameters may be added to the array. creditscore (INT) - the self-reported credit score of the consumer. Must be an INT between 350 - 850. goal (STRING) - the reason the consumer is seeking credit repair. Can either be selected by the consumer on your form or implied based on your path. Must be one of: buyhouse, buycar, fixerrors, improvescore, alleviatedebt, idtheft, autoloan, creditcard, creditrepair, businessloan, debtconsolidation, mortgagepurchase, mortgagerefinance, personalloan, homeequity.
partnerleadid	STRING	Yes	Your lead id. Max string length 48.
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 of the webpage where the lead was generated (excluding any query string parameters)
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

POST /post/credit-repair/ HTTP/1.1
Host: https://api.brighthorizonsmedia.com
Content-Type: application/json; charset=utf-8
Content-Length: 528

{
    "xauth":
    {
        "affiliateid": 123456,
        "key": "8526df83-yy6u-fg7k-3d4f-3d4b9m2z3bb9"
    },
    "transaction":
    {
        "firstname": "JJ",
        "lastname": "McClure",
        "phone": "7025551212",
        "email": "jjmcclure@example.com",
        "address": "123 Cannonball Lane",
        "address2": "Apt 3",
        "city": "Boulder City",
        "state": "NV",
        "zip": "89002",
        "credit":
        {
            "goal": "buyhouse",
            "creditscore": "789"
        },
        "ip": "192.168.168.1",
        "source": "yourdomain.com",
        "partnerleadid": "rr5t8683-9sdf-5t7m-e9o7-2z3bb93d4b9m",
        "sub1": "your sub id",
        "sub2": "",
        "sub3": "",
        "sub4": "",
        "sub5": ""
    }
}

SAMPLE RESPONSE

When a Credit Repair 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.

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

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 state was not passed in. Reminder, we do not log or record leads in our system that could not be validated.

{
    "validated": 0,
    "accepted": 0,
    "sold": 0,
    "disposition": ,
    "messages": [
        "Credit Repair Lead could not be validated"
    ],
    "errors":
    [
        [
            "State (required): can not be empty"
        ]
    ]
}