Receiver – Type A
Onboarding step-by-step guide
- Complete the onboarding form and send it to the integration team.
- Follow the relevant setup instructions below for your in-house API, Iterable, or Mailchimp.
- Konduit will send a couple of test leads. Confirm that everything is working before the live flow starts.
Internal system through API
Example API Request body
{
"first_name": "test",
"last_name": "test",
"dob": "12/31/1971",
"address": "35250sw unit191",
"city": "HOMESTEAD",
"state": "FL",
"zipcode": "33034",
"email": "test@konduitworks.com",
"phone": "6186380589",
"income": 2500,
"loan_amount": "2000",
"Credit_tier": "Fair",
"L1_source": "cdfdBB1E",
"L2_source": "5739",
"Lead_id": "2569874",
"Lead_source": "Konduit",
"avg_household_income": 219.401,
"median_household_income": 160.384,
"hh_income_score": 10,
"hh_income_high_low_indicator": "High",
"hh_income_range": "45th-55th percentile",
"avg_w2_income": 139.214,
"median_w2_income": 101.301,
"w2_income_score": 3,
"w2_income_high_low_indicator": "High",
"w2_income_range": "85th-90th"
}Body Parameters
first_namestringFirst name.
last_namestringLast name.
dobstringDate of birth.
addressstringStreet address.
citystringCity.
statestringState.
zipcodestringFive-digit ZIP code.
emailstringEmail address.
phoneintegerPhone number.
incomeintegerSelf-reported income.
loan_amountintegerLoan amount declined.
credit_tierstringSelf-reported credit tier: Poor, fair, or good.
l1_sourcestringNetwork source identifier.
l2_sourcestringSub-network source identifier.
lead_idstringLead identifier.
lead_sourcestringLead source: Konduit.
avg_household_incomefloatAverage household income, for example 219.41.
median_household_incomefloatMedian household income, for example 160.384.
hh_income_scoreintegerHousehold income score, from 1 to 10. A score of 1 indicates the lowest probability that the income is accurate.
hh_income_high_low_indicatorstringHigh or low indicates whether the supplied income is above or below the predicted median household income.
hh_income_rangestringThe percentile (0%–100%) of the supplied income within the predicted household income range, such as 45th–55th percentile.
avg_w2_incomefloatAverage W2 income, for example 139.21.
median_w2_incomefloatMedian W2 income, for example 101.30.
w2_income_scoreintegerW2 income score, from 1 to 10. A score of 1 indicates the lowest probability that the income is accurate based on tax data.
w2_income_high_low_indicatorstringHigh or low indicates whether the supplied income is above or below the predicted income based on tax data.
w2_income_rangestringThe percentile (0%–100%) of the supplied income within the predicted household income range based on tax data, such as 85th–90th.
Response API
Example API success response
{
"status_code": 200,
"message": "successful"
}Example API failure response
{
"status_code": 200 status code>,
"message": "<Description of the failure reason>"
} Replace <Non-200 status code> with a numeric status code and provide the failure reason in message.
Iterable
Iterable setup instructions
Konduit needs an API key and List ID from your Iterable account to send leads.
API key
- Generate an Iterable API key and select a server-side key.
- Provide the API key to the integration team.
List ID
- Create a separate list for Konduit leads.
- Share the ID of the created list with the integration team.
Konduit uses the add subscribers to list API to deliver leads.
Field mapping
- Provide the destination field names in the onboarding form. See the Iterable list subscription reference for an example.
- Specify any field formatting requirements, including the date-of-birth format.
Mailchimp
Mailchimp setup instructions
Konduit needs an API key and an Audience ID from your Mailchimp account to send leads.
API key
- Follow Mailchimp's API key instructions to generate a key.
- Share the API key with the integration team.
Audience ID
- Create an audience to save Konduit contacts.
- Find the Audience ID and share it with the integration team.
Field mapping
The onboarding guide lists First Name, Last Name, Complete Address, Phone, and Birthdate (MM/DD) as the default contact fields.
- Create additional fields for self-reported income, self-reported credit tier, loan amount, and complete date of birth.
- Share the created field names with the integration team.