API flow
Onboarding step-by-step guide
- Complete the onboarding form and send it to the integration team.
- Konduit will send a couple of test leads. Confirm that everything is working before the live flow starts.
Receiving lead information
Receivers receive lead information through query parameters in their configured URL.
Receiver URL setup
Provide the integration team with your receiver URL, including a placeholder for each lead field you want to receive. Konduit URL-encodes field values before substituting them into the URL.
Example receiver URL
https://receiver.example/apply?email={email}&firstName={first_name}&amount={loan_amount}&clickID={tracking_id}Only fields included as placeholders in your configured URL are passed. Without a template, the redirect flow adds only clickID and source=konduit; it does not add the lead's personal details.
Supported URL placeholders
Placeholder overview
| Information | URL placeholders |
|---|---|
| Tracking and source | {tracking_id}, {source_code}, {credit_tier}, {sub_affiliate} |
| Name and contact | {first_name}, {last_name}, {email}, {phone_number} |
| Address | {street_address}, {city}, {state_code}, {zip_code} |
| Loan and income | {loan_amount}, {income} |
| Employment | {emp_status}, {emp_type}, {job_title}, {work_company_name}, {employment_length} |
| Payment details | {pay_frequency}, {direct_deposit_status}, {next_pay_date} |
| Request context | {ip_address}, {user_agent}, {application_timestamp} |
| Marketing status | {marketing_content_status} |
Placeholder reference
Tracking and source4 fields
{tracking_id}Tracking identifier for the lead.
{source_code}Source code associated with the lead.
{credit_tier}The applicant's credit-tier classification.
{sub_affiliate}Sub-affiliate identifier associated with the lead.
Name and contact4 fields
{first_name}The applicant's first name.
{last_name}The applicant's last name.
{email}The applicant's email address.
{phone_number}The applicant's phone number.
Address4 fields
{street_address}The applicant's street address.
{city}The applicant's city.
{state_code}The applicant's state code.
{zip_code}The applicant's ZIP code.
Loan and income2 fields
{loan_amount}The loan amount associated with the lead.
{income}The applicant's reported income.
Employment5 fields
{emp_status}The applicant's employment status.
{emp_type}The applicant's employment type.
{job_title}The applicant's job title or occupation.
{work_company_name}The name of the applicant's employer.
{employment_length}The length of the applicant's employment.
Payment details3 fields
{pay_frequency}How frequently the applicant receives pay.
{direct_deposit_status}The applicant's direct-deposit status.
{next_pay_date}The applicant's next pay date.
Request context3 fields
{ip_address}The IP address associated with the lead.
{user_agent}The browser and device user-agent string associated with the lead.
{application_timestamp}The timestamp associated with the application.
Marketing status1 fields
{marketing_content_status}The marketing-content status associated with the lead.