createNewLead
Create a new lead
https://app.lifeinsurancedirect.com.au/ExternalAPI/rest/LifeAPI/CreateNewLead/CreateNewLeadParameters
URL Query Parameters
| Name | Additional Information | Life Insurance | TPD Insurance | Trauma Insurance | Income Protection |
|---|---|---|---|---|---|
| token* |
Will be provided by LID
|
*Required
|
*Required
|
*Required
|
*Required
|
| user_token |
User profile token provided by LID
|
Not required
|
Not required
|
Not required
|
Not required
|
| first_name* |
*First Name
|
*Required
|
*Required
|
*Required
|
*Required
|
| last_name* |
*Last Name
|
*Required
|
*Required
|
*Required
|
*Required
|
| smoking* |
Accept values: Yes and No
|
*Required
|
*Required
|
*Required
|
*Required
|
| street |
Street name eg: 1/271 Alfred Street
|
Not required
|
Not required
|
Not required
|
Not required
|
| city |
City eg: North Sydney
|
Not required
|
Not required
|
Not required
|
Not required
|
| state* |
Accept Format: NSW, ACT, VIC, QLD, NT, TAS, WA, SA
|
*Required
|
*Required
|
*Required
|
*Required
|
| postcode |
Post code eg: 2060
|
Not required
|
Not required
|
Not required
|
Not required
|
| country |
Country, eg: Australia
|
Not required
|
Not required
|
Not required
|
Not required
|
| gender* |
Accept values: Male, Female
|
*Required
|
*Required
|
*Required
|
*Required
|
| height |
We required in "cm". Decimal points are allowed (eg: 185.50)
|
Not required
|
Not required
|
Not required
|
Not required
|
| weight |
We required in "kg". Decimal points are allowed (eg: 100.50)
|
Not required
|
Not required
|
Not required
|
Not required
|
| email* |
Email format required
|
*Required
|
*Required
|
*Required
|
*Required
|
| dob* |
Accept format: dd/mm/yyyy
|
*Required
|
*Required
|
*Required
|
*Required
|
| age* |
Only numbers allowed
|
*Required
|
*Required
|
*Required
|
*Required
|
| mobile* |
Australian phone number format required. i.e. 0489282888, 0291234567
|
*Required
|
*Required
|
*Required
|
*Required
|
| quote_type* |
Accept values: Life Insurance, Life Insurance Referral, Income Protection, Trauma Insurance, TPD Insurance, Keyman Insurance
|
*Required
|
*Required
|
*Required
|
*Required
|
| existing_policy |
AIA, Asteron, BT, Clearview, CommInsure, Metlife, MLC, NEOS, NobleOak, OnePath, TAL, Zurich, AMP, Asgard, Other
|
Not required
|
Not required
|
Not required
|
Not required
|
| other_number |
Other phone number
|
Not required
|
Not required
|
Not required
|
Not required
|
| contact_date_time |
Date time format i.e. 8/02/2018 1:31 PM
|
Not required
|
Not required
|
Not required
|
Not required
|
| occupation
(/GetOccupationList) |
GetOccupationList
Required for TPD Insurance & Income Protection Preferred for Life, and Trauma Insurance however if blank, defaults to "pop up" on response |
Preferred
|
*Required
|
Preferred
|
*Required
|
| life_sum |
Required for Life Insurance
|
*Required
|
Not required
|
Not required
|
Not required
|
| tpd_sum |
Required for TPD Insurance
|
Not required
|
*Required
|
Not required
|
Not required
|
| tpd_definition |
tpd_definition is required if tpd_sum is not null, if no value specified, it will be set to default "Any". Accept Values: "Any" or "Own" |
Not required
|
*Required
|
Not required
|
Not required
|
| trauma_sum |
Required for Trauma Insurance
|
Not required
|
Not required
|
*Required
|
Not required
|
| annual_income |
Required for Income Protection
|
Not required
|
Not required
|
Not required
|
*Required
|
| waiting_period |
30 Days, 14 Days, 60 Days, 180 Days, 90 Days, 365 Days, 730 Days - Default - "30 days"
|
Not required
|
Not required
|
Not required
|
Not required
|
| benefit_period |
2 Years, 5 Years, To Age 65, To Age 70 - Default - "2 Years"
|
Not required
|
Not required
|
Not required
|
Not required
|
| payment_frequency |
Monthly, Annually , Half Annually, Quarterly. Default - "Monthly"
|
Not required
|
Not required
|
Not required
|
Not required
|
| premium_type |
Stepped, Level - Default - "Stepped"
|
Not required
|
Not required
|
Not required
|
Not required
|
| payment_options |
DDR-CR or Super Fund or Combination of Both - Default - "DDR-CR"
|
Not required
|
Not required
|
Not required
|
Not required
|
| ip* |
*IP Address
|
*Required
|
*Required
|
*Required
|
*Required
|
| website |
Website URL
|
Not required
|
Not required
|
Not required
|
Not required
|
| partner_code |
Your internal tracking field
|
Not required
|
Not required
|
Not required
|
Not required
|
| additional_info |
Character limits: 255
|
Not required
|
Not required
|
Not required
|
Not required
|
| tracking_id* |
To be provided by LID
|
*Required
|
*Required
|
*Required
|
*Required
|
| rating* |
It is used to prevent spam leads, aka honey pot. The value must be null or empty
|
*Required
|
*Required
|
*Required
|
*Required
|
| accident_only |
It is used for Accidental Death Insurance with life_sum and quote_type = Accidental Death Insurance Is used for Accident Insurance with annual_income and quote_type = Accident Insurance Accept values "Yes" and "No" |
Not required
|
Not required
|
Not required
|
Not required
|
| origin |
Accept Values: Email, Phone and Web, Wallet
|
Not required
|
Not required
|
Not required
|
Not required
|
| allow_anonymous |
It is used to generate quotes_url without the need to parse contact details(ie. First Name, Last Name, Email & Mobile). Accept Values: Yes or No |
Not required
|
Not required
|
Not required
|
Not required
|
| white_label |
By parsing the brand name (no white space), the quote tool will incorperate with the branding. *You will need to submit your logo and colors to LIDA API team. Accept Values: Strings (no space). |
Not required
|
Not required
|
Not required
|
Not required
|
Sample Responses
Status: 200 - Success Response code:
{"quotes_url":"https://app.lifeinsurancedirect.com.au/quotes/edit/b8e32e1e-2e96-44f7-8e6c-91dfa5487183?tracking_id=111&white_label=brandName","Message":"2000 Success!","has_error":"False","duplicate_lead":"True"}
Error Response codes:
1000 Unauthorised - Your API URL or Token is not currently active or its unauthorised. Please check API URL and try again.
2000 Success!
3000 Duplicate Lead. Duplicate lead (validation from Salesforce)
3001 Lead insertion failed! Please try again later. Contact info@lifeinsurancedirect.com.au if the problem persists. Possible communication error.
3002 First Name is required.
3003 Last Name is required.
3004 Email is required.
3005 Valid value for state is required.
3006 Mobile number format is incorrect.
3007 Tracking ID required.
3008 Quote Type required.
3009 Valid value for Gender is required.
3010 Required a value for Disablement Definition when TPD sum is not 0.
3011 Either Age or DOB is required.
3012 Valid value for Smoking is required.
3013 Other Number format is incorrect.
3014 Occupation is required.
3015 If trauma_sum > 0, payment_options cannot be 'Super Fund'.
3016 If TPD Definition is 'Own', payment_options cannot be 'Super Fund'.
3017 Either one of the fields: 'life_sum', 'tdp_sum','trauma_sum' or 'funeral_sum' are required.
3018 DOB format is not valid.
3019 Trackingid is not valid.
3020 If trauma_sum > 0 and all other sums are 0, payment_options cannot be 'Combination of Both'.