SOAP API

To authenticate, you have to use the provided token. Find out more about tokens.

1. Retrieve your token from Self Service Portal > Licenses.
   If you don't have one yet, go to Self Service Portal > Licenses, click Add a Token and enter the required details.
2. Enter your token as the value for CLIENT_ID.

Build a SOAP client based on WSDL specification. The Prospect IQ's WSDL document can be found on:

• Test: https://elstest.experianinteractive.com/els/elsWebService?wsdl
• Production: https://els.experianinteractive.com/els/elsWebService?wsdl

Use the PARTNER_ID and CLIENT_ID assigned to you at time of onboarding.

Sample SOAP Request

<tns:elsgenericmessage xmlns:tns="http://www.experianinteractive.com/els/ELSGenericXMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemalocation="http://www.experianinteractive.com/els/ELSGenericXMLSchema ELSGenericXMLSchema.xsd ">
  <customer>
    <partner_id>xxx</partner_id>
    <client_id>xxx</client_id>
    <cust_ref_no>19163296</cust_ref_no>
  </customer>
  <lead_trans_details>
    <first_name>JANE</first_name>
    <last_name>DOE</last_name>
    <suffix>JR</suffix>
  </lead_trans_details>
  <lead_phone>
    <phone_type>Home</phone_type>
    <phone_number>1234567890</phone_number>
    <phone_extension></phone_extension>
    <phone_country_code>01</phone_country_code>
  </lead_phone>
  <lead_phone>
    <phone_type>Business</phone_type>
    <phone_number>9876543210</phone_number>
    <phone_extension>1234</phone_extension>
    <phone_country_code>02</phone_country_code>
  </lead_phone>
  <lead_address>
    <address_type>Home</address_type>
    <street1>1 MAIN ST</street1>
    <street2></street2>
    <city>HOPKINTON</city>
    <state>MA</state>
    <zip>01748</zip>
    <country>US</country>
  </lead_address>
</tns:elsgenericmessage>

Test the SOAP client by submitting a sample request.

Validate the response by checking for presence of standardized address information.

Sample SOAP Response

<tns:elsgenericmessage xsi:schemalocation="http://www.experianinteractive.com/els/ELSGenericXMLSchema ELSGenericXMLSchema.xsd " xmlns:tns="http://www.experianinteractive.com/els/ELSGenericXMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <nameparser>
        <prefix_cd></prefix_cd>
        <first_name>JANE</first_name>
        <middle_name></middle_name>
        <last_name>DOE</last_name>
        <suffix_cd>JR</suffix_cd>
        <business_name_ind>N</business_name_ind>
        <business_name></business_name>
        <business_title></business_title>
   </nameparser>
   <standardizedaddress>
        <full_address>1 MAIN ST</full_address>
        <street1>1 MAIN ST</street1>
        <street2></street2>
        <prim_range>1</prim_range>
        <sec_range></sec_range>
        <prim_name>ANDREA</prim_name>
        <predir></predir>
        <city>HOPKINTON</city>
        <state>MA</state>
        <zip>01748</zip>
        <zipplus>2026</zipplus>
        <po_box_num></po_box_num>
        <rr_box_num></rr_box_num>
        <rr_num></rr_num>
        <postdir></postdir>
        <suffix>DR</suffix>
        <unit_desig></unit_desig>
        <carrier_route>R008</carrier_route>
        <geo_msa>14460</geo_msa>
        <geo_lng>-71.581243</geo_lng>
        <geo_lat>42.206978</geo_lat>
        <geo_blk>3201023013</geo_blk>
        <dpbc>03</dpbc>
        <checkdigit>7</checkdigit>
        <address_type>S</address_type>
        <county>MIDDLESEX</county>
        <county_code>017</county_code>
        <country>US</country>
        <fipscode>25017</fipscode>
        <address_code>1</address_code>
        <firmline></firmline>
        <geomatch>0</geomatch>
        <matchzipfive>T</matchzipfive>
        <matchzipnine>T</matchzipnine>
        <ziptype></ziptype>
        <suitablefordelivery>F</suitablefordelivery>
        <lacscode></lacscode>
   </standardizedaddress>
   <stage1data>
        <score_result>520</score_result>
        <score_desc>Invalid area code</score_desc>
        <elsresidentialaddressverificationresult>650
        <elsresidentialaddresshighrisk>N</elsresidentialaddresshighrisk>
        <elsresidentialphoneverificationresult>520</elsresidentialphoneverificationresult>
        <elsresidentialphonehighrisk>N</elsresidentialphonehighrisk>
        <elsresidentialphoneappend></elsresidentialphoneappend>
        <elsbusinessphoneappend></elsbusinessphoneappend>
   </elsresidentialaddressverificationresult></stage1data>
   <stage2data>
        <match_type>I</match_type>
        <person>
             <percombinedage>D</percombinedage>
             <pergender>F</pergender>
             <permaritalstatus>1M</permaritalstatus>
             <occupation_model>K01</occupation_model>
             <occupation>04</occupation>
        </person>
        <livu>
             <probable_homeowner>0</probable_homeowner>
             <mosaic_type>A02</mosaic_type>
             <liv_combined_homeownership>H</liv_combined_homeownership>
             <liv_lu_inc_model_v4_2_amt>K</liv_lu_inc_model_v4_2_amt>
        </livu>
        <zip>
             <zipmesscore></zipmesscore>
             <zip_avg_vehicles_hh>00233</zip_avg_vehicles_hh>
        </zip>
   </stage2data>
   <message>
        <type>STATUS</type>
        <category></category>
        <value></value>
        <result_code>S100</result_code>
   </message>
   <transaction_id>13349944</transaction_id>
   <inputdata><![CDATA[<tns:ELSGenericMessage xmlns:tns='http://www.experianinteractive.com/els/ELSGenericXMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.experianinteractive.com/els/ELSGenericXMLSchema ELSGenericXMLSchema.xsd '>
        <customer>
             <partner_id>xxx</partner_id>
             <client_id>xxx</client_id>
             <cust_ref_no>19163296</cust_ref_no>
        </customer>
        <lead_trans_details>
             <first_name>JANE</first_name>
             <last_name>DOE</last_name>
             <suffix>JR</suffix>
        </lead_trans_details>
        <lead_phone>
             <phone_type>Home</phone_type>
             <phone_number>1234567890</phone_number>
             <phone_extension></phone_extension>
             <phone_country_code>01</phone_country_code>
        </lead_phone>
        <lead_phone>
             <phone_type>Business</phone_type>
             <phone_number>9876543210</phone_number>
             <phone_extension>1234</phone_extension>
             <phone_country_code>02</phone_country_code>
        </lead_phone>
        <lead_address>
             <address_type>Home</address_type>
             <street1>1 MAIN ST</street1>
             <street2></street2>
             <city>HOPKINTON</city>
             <state>MA</state>
             <zip>01748</zip>
             <country>US</country>
   </lead_address>
 </inputdata></tns:elsgenericmessage>

]]]]>><![CDATA[</InputData>

Sample Java Client Application

The following is a simple Java program that can be used to test Prospect IQ via the web service interface.

1. Download and install soapUI.
2. Start the program and press Ctrl+N or select File > New soapUI Project.
3. Type in a Project Name and enter the following URL for Initial WSDL/WADL: https://elstest.experianinteractive.com/els/elsWebService?wsdl
4. Click OK.
5. In the project you've created, drill down to IwebServiceRequestHandler > processLeadAsXML > Request1.
6. Double-click on Request1 and the soapUI will open a window for your SOAP request:
   
7. Replace ? with a test XML request and submit it. If successful, the SOAP XML response will be displayed.