lead
This allows you to enter new lead information into Intro XL. The fields in blue are required for authentication. The fields in orange are also required, but can be left empty.
File Attachments
Intro XL uses Amazon S3 as the repository for file attachments. If you are set up with an S3 account, you can send file attachments to S3, and then provide Intro XL with the file name and the Key that was used in S3. This will allow you to open file attachments inside of Intro XL. A GUID is typically generated and used as a Key for each individual file, but you can use your own method for generating a unique Key for each file.
Automated E-Signatures
If you are set up to automatically generate an e-signature, the response will include the e-signature information.
Request Fields:
| Field | Description | Max Length |
|---|---|---|
| Company | The company abbreviation in Intro XL | |
| Storeid | Store Number in Intro XL. | |
| Password | Leads Password from Intro XL Store Settings | |
| Store | Store name, Can be empty | |
| leadtype | Use “New” for new leads or “Reapply” for customers that are re-applying for a loan, or leave blank. | |
| GUID | Key for the Lead. Can be left blank. If blank, a GUID will be generated by Intro XL. You can use this to reference the lead afterward. | 50 |
| Source | Where the lead is coming from. The Lead “Source” is used by the rules engine in Intro XL to route new leads. | 50 |
| FirstName | 50 | |
| LastName | 50 | |
| 100 | ||
| Address | 100 | |
| City | 50 | |
| State | 5 | |
| ZipCode | 20 | |
| YearsAtAddress | Suggested values: LT1 = Less than 1 year, 1 = 1 to 2 years, 3 = 3 to 5 years, 6 = 6 to 10 years, 10 = more than 10 years | 5 |
| Renter | true or false | |
| Phone | 20 | |
| TimeReachable | 10 | |
| DateOfBirth | ||
| Citizen | true or false | |
| SSN | 9 | |
| DLNo | Drivers License No | 20 |
| Military | true or false | |
| MilitaryDependant | true or false | |
| BorrowAmount | If no value, please send zero {0} | |
| PaycheckAmount | If no value, please send zero {0} | |
| DirectDeposit | true or false | |
| PayFrequency | 7 = Weekly, 14 = Bi-Weekly, 15 = Semi-Monthly, 31 = Monthly | 5 |
| Last_Payday | Use this field for the person’s Last Payday | |
| Next_Payday | Use this field for the person’s Next Payday | |
| IncomeType | Suggested Values: Employment, Government | 50 |
| Employer | 50 | |
| EmployerAddress | 100 | |
| EmployerCity | 50 | |
| EmployerState | ||
| EmployerZip | 5 | |
| Position | Employee’s Position | 50 |
| YearsEmployed | Suggested values: LT1 = Less than 1 year, 1 = 1 to 2 years, 3 = 3 to 5 years, 6 = 6 to 10 years, 10 = more than 10 years | 5 |
| WorkPhone | 20 | |
| BankName | 50 | |
| ABARoutingNo | 20 | |
| BankAccountNo | 20 | |
| Checking | true for Checking and false for Savings | |
| YearswithBankAccount | 5 | |
| ReferenceFirst | 20 | |
| ReferenceLast | 20 | |
| ReferencePhone | 20 | |
| ReferenceRelationship | Suggested Values: Mother, Father, Wife, Husband, Friend, Other | 20 |
| CellPhone | 20 | |
| CallBackNumber | 20 | |
| IP | IP address of the potential customer | 20 |
| Reference2First | 20 | |
| Reference2Last | 20 | |
| Reference2Phone | 20 | |
| Reference2Relationship | Suggested Values: Mother, Father, Wife, Husband, Friend, Other | 20 |
| Reference3First | 20 | |
| Reference3Last | 20 | |
| Reference3Phone | 20 | |
| Reference3Relationship | Suggested Values: Mother, Father, Wife, Husband, Friend, Other | 20 |
| TextingOption | Whether they have opted IN or OUT of receiving text messages. Valid Values: IN, OUT | |
| MarketingTextingOption | Whether they have opted IN or OUT of Marketing text messages. Valid values: IN, OUT | |
| DoNotSolicit | Valid Values: true, false | |
| OptionValues | Extra information about the lead. If you are entering multiple items here, separate them by a Pipe Character (|). | 500 |
| VehicleMake | 20 | |
| VehicleModel | 20 | |
| VehicleYear | 20 | |
| VehicleBodyStyle | 50 | |
| VehicleTransmission | 10 | |
| VehicleMileage | 10 | |
| VehicleColor | 20 | |
| VehicleVIN | 50 | |
| VehiclePlate | 20 | |
| VehicleInsCompany | 50 | |
| VehicleInsPolicyNo | 20 | |
| VehicleInsPhone | 20 | |
| VehicleTitle | 50 | |
| AffiliateCode | SubID should go here | 100 |
| DecisionLogicCode | Decision Logic Code | 10 |
| ClarityTrackingCode | The Clarity Tracking Code | 50 |
| note | A note that will be inserted into the Lead’s Contact Log | 500 |
| price | The price of the lead | decimal |
| attachments | Root element for attachments list | |
| attachment | Root element for a single attachment | |
| key | Key that was used to store the file in Amazon S3. This is typically a GUID. | 50 |
| filename | Name of file | 100 |
Request XML:
xml
<?xml version="1.0" encoding="utf-8"?>
<introrequest>
<lead>
<Company>cmp</Company>
<Storeid>1</Storeid>
<Password>xxxxx</Password>
<Store ></Store>
<leadtype>New</leadtype>
<GUID>2b3d7b3a-9720-4e4f-b5bf-489d664e51b5</GUID>
<Source>Web</Source>
<FirstName>Tom</FirstName>
<LastName>Tester</LastName>
<Email>test@test.com</Email>
<Address>123 Elm St</Address>
<City>Chicago</City>
<State>IL</State>
<ZipCode>60000</ZipCode>
<YearsAtAddress>LT1</YearsAtAddress>
<Renter>true</Renter>
<Phone>9991112222</Phone>
<TimeReachable>MORNING</TimeReachable>
<DateOfBirth>1/1/1980</DateOfBirth>
<Citizen>true</Citizen>
<SSN>999775555</SSN>
<DLNo>a123435676</DLNo>
<Military>false</Military>
<MilitaryDependant>false</MilitaryDependant>
<BorrowAmount>300</BorrowAmount>
<PaycheckAmount>1000</PaycheckAmount>
<DirectDeposit>false</DirectDeposit>
<PayFrequency>14</PayFrequency>
<Last_Payday>9/20/2011</Last_Payday>
<Next_Payday>10/4/2011</Next_Payday>
<IncomeType>Employment</IncomeType>
<Employer>Test Company</Employer>
<EmployerAddress>455 Test St</EmployerAddress>
<EmployerCity>Chicago</EmployerCity>
<EmployerState>IL</EmployerState>
<EmployerZip>60000</EmployerZip>
<Position>Tester</Position>
<YearsEmployed>3</YearsEmployed>
<WorkPhone>9991112226</WorkPhone>
<BankName>Test Bank</BankName>
<ABARoutingNo>911911911</ABARoutingNo>
<BankAccountNo>765765</BankAccountNo>
<Checking>true</Checking>
<YearsWithBankAccount>2</YearsWithBankAccount>
<ReferenceFirst>Meg</ReferenceFirst>
<ReferenceLast>Tester</ReferenceLast>
<ReferencePhone>9998887777</ReferencePhone>
<ReferenceRelationship>Mother</ReferenceRelationship>
<Reference2First>Amy</Reference2First>
<Reference2Last>Tester</Reference2Last>
<Reference2Phone>9998887777</Reference2Phone>
<Reference2Relationship>Wife</Reference2Relationship>
<Reference3First></Reference3First>
<Reference3Last></Reference3Last>
<Reference3Phone></Reference3Phone>
<Reference3Relationship></Reference3Relationship>
<CallBackNumber>9991112224</CallBackNumber>
<CellPhone>9991112223</CellPhone>
<IP>127.0.0.1</IP>
<OptionValues></OptionValues>
<VehicleMake></VehicleMake>
<VehicleModel></VehicleModel>
<VehicleYear></VehicleYear>
<VehicleBodyStyle></VehicleBodyStyle>
<VehicleTransmission></VehicleTransmission>
<VehicleMileage></VehicleMileage>
<VehicleColor></VehicleColor>
<VehicleVIN></VehicleVIN>
<VehiclePlate></VehiclePlate>
<VehicleInsCompany></VehicleInsCompany>
<VehicleInsPolicyNo></VehicleInsPolicyNo>
<VehicleInsPhone></VehicleInsPhone>
<VehicleTitle></VehicleTitle>
<AffiliateCode></AffiliateCode>
<DecisionLogicCode></DecisionLogicCode>
<ClarityTrackingCode></ClarityTrackingCode>
<note></note>
<price>35.00</price>
<attachments>
<attachment>
<key>63f86b96-db15-3071-b97f-cbbe6fb51522</key>
<filename>test.pdf</filename>
</attachment>
</attachments>
<esig>
<agreementdate>5/31/2013</agreementdate>
<loandate>5/31/2013</loandate>
<interestrate>399.00</interestrate>
<numberofpayments>12</numberofpayments>
<frequency>14</frequency>
<frequencydescription>biweekly</frequencydescription>
<duedate>11/11/2013</duedate>
<principal>500</principal>
<sumofpayments>1078.71</sumofpayments>
<balanceatmaturity>1396.38</balanceatmaturity>
<amountfinanced>500</amountfinanced>
<financecharge>578.71</financecharge>
<apr>397.9066</apr>
<fee1>8/1/2012</fee1>
<fee2>8/1/2012</fee2>
<fee3>8/1/2012</fee3>
<fee4>8/1/2012</fee4>
<fee5>8/1/2012</fee5>
<fee6>8/1/2012</fee6>
<fee7>8/1/2012</fee7>
<fee8>8/1/2012</fee8>
<fee9>8/1/2012</fee9>
<fee10>8/1/2012</fee10>
<payments>
<payment>
<date>6/10/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>6/24/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>7/8/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>7/22/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>8/5/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>8/19/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>9/2/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>9/16/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>9/30/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>10/14/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>10/28/2013</date>
<amount>89.90</amount>
</payment>
<payment>
<date>11/11/2013</date>
<amount>89.81</amount>
</payment>
</payments>
</esig>
<Decision>Approved</Decision>
<ReturnURL>https://test.com</ReturnURL>
<Statuscode>success</Statuscode>
<Description>Lead Inserted</Description>
<bid>25.00</bid>
</lead>
</introrequest>Response Fields:
| Field | Description |
|---|---|
| Statuscode | “success” means that the lead was successfully received by Intro XL. |
| Description | Return Description. This will give more information if an error occurred. |
| Decision | “Approved”, “Rejected”, or “None”. “Approved” means that the lead has passed the rules engine. If this lead is coming from a lead generator, then “Approved” means that the lead has been purchased. |
| bid | If the lead fails on price, the lender’s bid price will be returned. |
| ReturnURL | The URL to redirect the user to. |
| esig | Root element for the Esig data. This will only be returned if you are set up to automatically generate an e-signature. (See getesig fields for sub-elements) |
Leave A Comment?