Life Insurance. Web Service Integration Guide

Size: px

Start display at page:

Download "Life Insurance. Web Service Integration Guide"

Arthur Cross
8 years ago
Views:

1 Life Insurance Web Service Integration Guide Version Date 17/12/2014

2 Service Description Leads can be sent into LeadStream using the SOAP web service. This enables you to send Life Insurance leads into LeadStream through your own custom designed form. Note: LeadStream cannot be held responsible for the data sent via the web service that does not meet the criteria and subsequently does not get sent into LeadStream. Errors that may occur during lead processing are described later in this document. We recommend thorough testing of your form before making it Live. The SOAP Web Service The LeadStream Life Insurance Web Service can be located on the following URL: Live URL: Test URL: AddLifeLead Method Call Once you have gathered lead details from the client, the first point of interaction with LeadStream should start with a call to our AddLifeLead method on the LeadStream Web Service. Please note that you must validate the data submitted by the client before you post it to the LeadStream web service. <LifeLead xmlns=" <SupplierId></SupplierId> <SupplierKey></SupplierKey> <ChannelId></ChannelId> <LeadTypeId></LeadTypeId> <IpAddress></IpAddress> <MarketingUrl></MarketingUrl> <MarketingSource></MarketingSource> <MarketingMedium></MarketingMedium> <MarketingTerm></MarketingTerm> <MarketingPermission></MarketingPermission> <AffSubId1></AffSubId1> <AffSubId2></AffSubId2> <AffSubId3></AffSubId3> <Title></Title> <FirstName></FirstName> <LastName></LastName> <DobDay></DobDay> <DobMonth></DobMonth>

Errors that may occur during lead processing are described later in this document. We recommend thorough testing of your form before making it Live.

3 <Dobear></Dobear> <Address1></Address1> <Address2></Address2> <Town></Town> <Postcode></Postcode> < ></ > <Phone></Phone> <PhoneAlt></PhoneAlt> <CoverType></CoverType> <PolicyType></PolicyType> <CoverAmount></CoverAmount> <CoverTerm></CoverTerm> <Gender></Gender> <Smoker></Smoker> <p_firstname></p_firstname> <p_lastname></p_lastname> <p_dobday></p_dobday> <p_dobmonth></p_dobmonth> <p_dobear></p_dobear> <p_smoker></p_smoker> <p_gender></p_gender> </LifeLead> Field Name Description Values Req. SupplierId Supplied by LeadStream Int SupplierKey Supplied by LeadStream String ChannelId Supplied by LeadStream Int LeadTypeId Use 4 for Life Insurance Int IpAddress The IP address of the customer s computer making String (15) the original enquiry. MarketingUrl The URL of the landing page used to generate the lead. String (3-50) N MarketingSource The marketing source used to generate the lead (e.g. String (3-50) N google) MarketingMedium The marketing medium used to generate the lead (e.g. ppc) String (3-50) N MarketingTerm The marketing term used to generate the lead (e.g. life String (3-50) N insurance quotes) MarketingPermission Whether the customer has specifically opted in to future Specify: es, No marketing AffSubId1 3 x custom fields for you to submit a custom identification String (0-300) N AffSubId2 string (e.g. your customer s String (0-300) N AffSubId3 ID, or CRM ID number so you can identify the customer at a String (0-300) N

<p_dobmonth></p_dobmonth> <p_dobear></p_dobear> <p_smoker></p_smoker> <p_gender></p_gender> </LifeLead> Field Name Description Values Req.

4 later stage.) Title The customer s title (e.g. Mr, Specify: Mr, Mrs, Mrs, Miss, Dr) Miss, Ms, Dr N FirstName String (3-50) LastName String (3-50) DobDay Integer 1-31 DobMonth Integer 1-12 Dobear Integer: Address1 String (3-50) Address2 String (3-50) N Town String (3-40) Postcode String (5-9) String (3-50) Phone String (11-13) PhoneAlt String (11-13) CoverType Specify: Life Insurance, Mortgage The type of cover the Protection customer is looking for. Insurance, Critical Illness Insurance, Not Sure PolicyType Who the customer is looking Specify: Single, CoverAmount CoverTerm to protect with the policy. The amount of cover the customer is looking for. The length of cover the customer is looking for. Joint Integer Value ( ) Integer Value Gender Specify: Male, Female Smoker Specify: es, No p_firstname Required if Joint is selected. String N p_lastname Required if Joint is selected. String N p_dobday Required if Joint is selected. Integer 1-31 N p_dobmonth Required if Joint is selected. Integer 1-12 N p_dobear Required if Joint is selected. Integer: N p_gender Required if Joint is selected. Specify: Male, Female N p_smoker Required if Joint is selected. Specify: es, No N AddLifeLead Method Response Once the above details are sent to LeadStream using the AddLifeLead method, the web service will respond with a status whether the lead has been successfully submitted or not with the following XML response. <LeadResult>

Mr, Specify: Mr, Mrs, Mrs, Miss, Dr) Miss, Ms, Dr N FirstName String (3-50) LastName String (3-50) DobDay Integer 1-31 DobMonth Integer 1-12 Dobear Integer: 1900-2015 Address1 String (3-50) Address2

5 <Outcome>OK</Outcome> <Status>Valid</Status> <Earnings>37.5</Earnings> <ErrorCode></ErrorCode> <ErrorField></ErrorField> <ErrorMessage></ErrorMessage> </LeadResult> Element Name Description Values Whether the lead was OK Outcome successfully accepted by ERROR LeadStream Status Earnings ErrorCode ErrorField ErrorMessage The status of the lead in the LeadStream system. our earnings (in GBP). Set if Status is Valid. Delivered Valid Invalid Duplicate Test Quality Check Decimal Int String String After receiving the response you must check the Outcome element to ascertain if the delivery was successful. If the lead has been successfully submitted, the value OK will be returned. If ERROR is returned, a reason for the error will be provided in the ErrorCode, ErrorField and ErrorMessage elements. A list of error codes can be found below. Testing The Integration If you want to submit test leads then please change the web service URL as shown below. Test URL: ou may also submit test leads to the live service providing the word test is entered into either the FirstName or LastName fields. Going Live

ERROR LeadStream Status Earnings ErrorCode ErrorField ErrorMessage The status of the lead in the LeadStream system. our earnings (in GBP). Set if Status is Valid.

6 When the integration is ready to go live then make sure that live web service URL is used. Additional Lead Data Validation When LeadStream accepts a lead, a check is made whether the same lead has been submitted to the service (based on a matching telephone number or address) for the same product and validated within the last 30 days. If the lead is a duplicate then the lead will be marked as duplicate and not validated within our system. Telephone numbers, addresses and postal addresses are all validated in real time when leads are submitted via validation systems. Leads with invalid telephone numbers, addresses and postal addresses will be rejected.

number or email address) for the same product and validated within the last 30 days.

Private Medical Insurance

Private Medical Insurance Web Service Integration Guide Version 1.0.0 Date 17/12/2014 Service Description Leads can be sent into LeadStream using the SOAP web service. This enables you to send Private