SSDI Leads

The SSDI enpoints allow you as a Publisher to ping and post SSDI 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 SSDI leads. Leads are posted in JSON format.

Method	Endpoint	Endpoint Type
Ping	https://api.brighthorizonsmedia.com/ping/ssdi/	JSON
Post	https://api.brighthorizonsmedia.com/post/ssdi/	JSON

POST PARAMETERS

To successfully ping or post SSDI 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	Description
firstname	STRING	Yes	First name as provided by the consumer
lastname	STRING	Yes	Last name as provided by the consumer
email	STRING	Yes	Email address 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.
address	STRING	Yes	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	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.
dob	DATE	Yes	The date of birth as provided by the consumer. Must be passed in YYYY-MM-DD format.
ssdi	ARRAY	Yes	The ssdi parameter is an array containing key => value pairs of data related to the ssdi request. All fields are required. currentlyreceivingbenefits (BOOLEAN) - whether the consumer is currently receiving social security benefits. must be true or false. timeoutofwork (STRING) - how long the consumer expects to be out of work. must be one of: lessthan1year, 1yearormore. disabilitypreventsworking (BOOLEAN) - whether the disability prevents the consumer from working. must be true or false. currentlyrepresented (BOOLEAN) - whether the consumer is currently represented by an attorney or advocate. must be true or false. notes (STRING) - notes provided by the consumer about their situation/case.
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
trustedformcertid	STRING	Optional	Optional but pass if available
jornayaleadid	STRING	Optional

REQUESTS & RESPONSES

SAMPLE REQUEST

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

{
  "xauth": {
	"affiliateid": 123456, 
	"key": "96852585-58lk-5g5r-63jk8-25lp2574poiu"
  },
  "transaction": {
	"firstname": "JJ",
	"lastname": "McClure",
	"email": "jjmcclure@example.com",
	"phone": "7025551212",
	"address": "123 Cannonball Lane",
	"city": "Boulder City",
	"state": "NV",
	"zip": 89002,
	"dob": "1974-06-14",
	"ssdi": {
		"currentlyreceivingbenefits": false,
		"timeoutofwork": "lessthan1year",
		"disabilitypreventsworking": true,
		"currentlyrepresented": false,
		"notes": "Lorem ipsum"
	},
	"ip": "184.248.249.118",
	"source": "https://www.yourwebsite.com/form/",
	"sub1": "yourSub1",
	"sub2": "",
	"sub3": "",
	"sub4": "",
	"sub5": "",
	"trustedformcertid": ""
  }
}

SAMPLE RESPONSE

When a SSDI 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) means the lead was accepted by a buyer and is billable. Sold = 0 (or "sold":0) is NOT billable.

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

{
	"validated": "true",
	"status": "accepted",
	"errors": ,
	"messages": ,
	"transactionid": 123456789,
	"leadid": 234567891
}

FAILED RESPONSE

If the request failed, the response will include an errors object which may contain 1 or more error messages. This example will return an error message because the Email Address could not be validated and the phone number was blank.

{
	"validated": "false",
	"status": "rejected",
	"errors": [
		{"Email Address (required): could not validate email address"},
		{"Phone (required): can not be blank"}
	],
	"messages": ,
	"transactionid": ,
	"leadid":
}