Welcome

Call Transfer - SOAP API Reference
This document contains instructions for the ‘Call Transfer’ program. Our Call Transfer program enables our partners to transfer customer data directly into the Answer Rating Tool. In this approach your agent/representative will be able to transfer some or all of the customer information to Answer and Answer will return a unique phone number. It is highly recommended to transfer more than the minimum data to ensure a better customer experience with our Answer agent.

Initial Setup

Contact your Answer account manager to setup and configure the following detail:

  1. GroupID (s)
  2. Base URL
  3. Resources
  4. Header

Base URL

EnvironmentBase URLs
DevelopmentContact your Answer account manager
ProductionContact your Answer account manager

Resources

EnvironmentEndpointDescription
TransferContact your Answer account managerRequest to transfer a customer
HeadersRequiredNotes
TransferContact your Answer account manager

Authentication

GroupIDs are required to confirm identity of the client.

Server Side Authentication
If authenticated, the service will process the request. When an incorrect affinity group is received the service will respond with an xml string indicating 'Invalid Affinity Group' When an incorrect affinity group is received the service will respond with an xml string indicating 'Invalid Affinity Group'

Client Side Authentication
When the user agent wants to send the affinity group, it must be sent as the GroupId parameter.

Request Objects

Call Transfer
- Is in SOAP XML format and requires a POST method to transfer the customer data.

A transfer request contains the following parameters

AttributeTypeDescription
*QuoteRequeststringCustomer Information XML
GroupIDstringAffinity group provided by Answer
AgentID (optional)stringIdentity of transferring agent, up to 20 characters in length
TransferID (optional)stringGUID returned by initial comparative quote request

Example: view hide

Sample SOAP envelope
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
    <Transfer xmlns="http://www.answerfinancial.com/">
      <QuoteRequest>string</QuoteRequest>
      <GroupID>string</GroupID>
      <AgentID>string</AgentID>
      <TransferID>string</TransferID>
    </Transfer>
  </soap:Body>
</soap:Envelope>

Minimum requirements for Quote Request

The quote request is in XML format and contains the following required string fields:

AttributexpathDescription
Surname/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/InsuredOrPrincipal/GeneralPartyInfo/NameInfo/PersonName/SurnameLast Name
GivenName/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/InsuredOrPrincipal/GeneralPartyInfo/NameInfo/PersonName/GivenNameFirst Name
PhoneNumber/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/InsuredOrPrincipal/GeneralPartyInfo/Communications/PhoneInfo[./CommunicationUseCd='Home']/PhoneNumberHome Phone Number
EmailAddr/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/InsuredOrPrincipal/GeneralPartyInfo/Communications/EmailInfo/EmailAddrEmail Address
Addr1/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/PersPolicy/PersApplicationInfo/InsuredOrPrincipal/GeneralPartyInfo/Addr/Addr1[1]Address Line1
City/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/PersPolicy/PersApplicationInfo/InsuredOrPrincipal/GeneralPartyInfo/Addr/City[1]City
StateProvCd/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/PersPolicy/PersApplicationInfo/InsuredOrPrincipal/GeneralPartyInfo/Addr/StateProvCd[1]State
PostalCode/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/PersPolicy/PersApplicationInfo/InsuredOrPrincipal/GeneralPartyInfo/Addr/PostalCode[1]ZipCode
LOBCd/ACORD/InsuranceSvcRq/PersAutoPolicyQuoteInqRq/PersAutoLineBusiness/LOBCdLine Of Business

Example: view hide

Minimum requirements example:
<ACORD>
 <InsuranceSvcRq>
  <PersAutoPolicyQuoteInqRq>
   <InsuredOrPrincipal>
    <GeneralPartyInfo>
     <NameInfo>
      <PersonName>
       <Surname>Lastname</Surname>
       <GivenName>Firstname</GivenName>
      </PersonName>
     </NameInfo>
     <Communications>
      <PhoneInfo>
       <CommunicationUseCd>Home</CommunicationUseCd>
       <PhoneNumber>6265551212</PhoneNumber>
      </PhoneInfo>
      <EmailInfo>
       <EmailAddr>emailaddress@abc.com</EmailAddr>
      </EmailInfo>
     </Communications>
    </GeneralPartyInfo>
    <InsuredOrPrincipalInfo>
     <PersonInfo/>
    </InsuredOrPrincipalInfo>
   </InsuredOrPrincipal>
   <PersPolicy>
    <PersApplicationInfo>
     <InsuredOrPrincipal>
      <GeneralPartyInfo>
       <Addr>
        <AddrTypeCd>MailingAddress</AddrTypeCd>
        <Addr1>999 Murdock Rd</Addr1>
        <City>Marietta</City>
        <StateProvCd>GA</StateProvCd>
        <PostalCode>30062</PostalCode>
       </Addr>
      </GeneralPartyInfo>
     </InsuredOrPrincipal>
    </PersApplicationInfo>
    <QuoteInfo>
     <CompanysQuoteNumber/>
    </QuoteInfo>
   </PersPolicy>
   <PersAutoLineBusiness>
    <LOBCd>AUTO</LOBCd>
    <PersDriver>
     <DriverInfo>
      <PersonInfo/>
     </DriverInfo>
     <GeneralPartyInfo>
      <NameInfo>
       <PersonName>
        <Surname>Lastname</Surname>
        <GivenName>Firstname</GivenName>
       </PersonName>
      </NameInfo>
     </GeneralPartyInfo>
    </PersDriver>
   </PersAutoLineBusiness>
  </PersAutoPolicyQuoteInqRq>
 </InsuranceSvcRq>
</ACORD>

Response Object

A successful quote response will be returned containing a 'status' node with a value of "SUCCESS".

Response Attributes are as follows:

FieldDescriptionNotes
StatusSUCCESS
FirstNameAccount holder's first name
LastNameAccount holder's last name
ZipCodeAccount holder's garaging zip code
CustomerIDCustomer ID associated with created account
GUIDUnique identifier for transaction
TransferNumberPhone number for agent to contact ANSWER representative

Example: view hide

Sample Successful Response
<AFI_Resp>
 <Status>SUCCESS</Status>
 <FirstName>John</FirstName>
 <LastName>Smith</LastName>
 <ZipCode>91401</ZipCode>
 <CustomerID>4ZZXS33</CustomerID>
 <GUID>111444-44-55588-5555</ GUID>
 <TransferPhone>8185555555</TransferPhone>
</AFI_Resp>

Errors

An error quote response will be returned containing a 'status' node with a value of "ERROR"

AttributeDescription
StatusERROR
ErrorDescriptionReason for transaction failure
GUIDUnique identifier for transaction
TransferNumberPhone number for agent to contact ANSWER representative

Example: view hide

Sample Error Response
<AFI_Resp>
    <Status>ERROR</Status>
    <ErrorDescription>Error loading quote request.</ErrorDescription>
    <GUID>111444-44-55588-5555</GUID>
    <TransferPhone>8185555555</TransferPhone>
</AFI_Resp>