Motor Vehicle Accident Leads
The Motor Vehicle Accident Leads endpoint allow you as a Publisher to post Motor Vehicle Accident 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.
| Method | Endpoint | Endpoint Type |
|---|---|---|
| Post | https://api.brighthorizonsmedia.com/post/legal/motor-vehicle-accident/ | JSON |
POST PARAMETERS
To successfully post Motor Vehicle Accident 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.). Inside the transaction[] array is an array called autoaccident[] which contains details about the consumer's motor vehicle accident.
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. |
| 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. |
| autoaccident | ARRAY | Yes |
The autoaccident parameter is an array containing key => value pairs of data related to the consumer's vehicle accident. All fields are required. physicallyinjured (BOOLEAN) - true or false value if the consumer was injured in the auto accident dateofaccident (DATE) - date of the reported accident in YYYY-MM-DD format receivedtreatment (BOOLEAN) - true or false value if the consumer received medical treatment for their injuries atfault (BOOLEAN) - true or false value if the consumer was determined to be at fault for the accident currentlyrepresented (BOOLEAN) - true or false value if the consumer is currently represented notes (VARCHAR) - notes about the accident |
| 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) |
| 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
POST /post/legal/motor-vehicle-accident/ HTTP/1.1
Host: https://api.brighthorizonsmedia.com
Content-Type: application/json; charset=utf-8
Content-Length: 669
{
"xauth":
{
"affiliateid": 9999,
"key": "5269fgb6-fghb-qasw-45g6-vg5hfvg6nh67"
},
"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",
"autoaccident":
{
"physicallyinjured": true,
"dateofaccident": "2023-01-01",
"receivedtreatment": true,
"atfault": false,
"currentlyrepresented": false,
"notes": "injured when another driver hit me"
},
"ip": "192.168.168.1",
"source": "yourdomain.com",
"trustedformcertid": "https://cert.trustedform.com/ZZZWW8ba26XX85bXX16d3cb6c44cc30a7da48ba1",
"sub1": "your sub id",
"sub2": "",
"sub3": "",
"sub4": "",
"sub5": ""
}
}
SAMPLE RESPONSE
When a Motor Vehicle Accident 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": ,
"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 mortgage was not passed in containing the required key/value pairs. Reminder, we do not log or record leads in our system that could not be validated.
{
"validated": 0,
"accepted": 0,
"sold": 0,
"disposition": ,
"messages": [
"Legal > Motor Vehicle Accident Lead could not be validated"
],
"errors":
[
[
"Physically Injured (required): must be true or false",
"Currently Represented (required): must be false"
]
]
}