Documentation Leads API

About this API

The REST Api leads service is used by the external provider to register and manage potential clients and queries from current clients about certain products and their policies. This will be visible by Allianz through the Ficha Gestión.

Functionality

Client Data

Send client nif
Get values
Validate if client is managed by partner

Alta Lead

If is managed by the external provider to send client data
Generate lead on Allianz tables
Get leadId

Update Lead

Send update lead using leadId
Set on Allianz tables the update

Process Flow

Client data endpoint

Alta lead endpoint

Update lead endpoint

Detail endpoints values

Client data (request):

Param	Description
nif (requiered)	NIF of the client who makes the request

Client data (response):

Param	Description
agentId	If it is confirmed that the user is already a client, the agentId tells us which agent is already assigned to them and which must be the same one to process the request
client	true/false It returns true or false indicating whether it is a client or not
message	It tells us if the call to the endpoint has been carried out without incident or, on the contrary, it would provide us with an error message
multiAcceso	true/false. true tells us that the assigned agent participates in the general distribution of leads. Different communication depending on whether the response is true or false
nif	Reminder of the NIF that has been consulted in the request
status	OK/KO. Indicates if the call to the endpoint has occurred without incidents
partnerManage	true/false. Indicates whether partner has to manage it (true) or not

Alta lead (request)

Param	Description
acceptTerms (requiered)	true/false Depending on whether or not the user accepts the privacy policy
reference	Received from Allianz through the call to the WS (if it has come through this flow)
idLanding	string
leadOrigin (max 25 cc)	Will have values like: 1: API 2: Callme Now 3: Callme Back 11: Chat 12: Whatsapp 13: ChatBot 16: Google Asistant 17: Alexa 19: Mobile app
partnerLeadId (max 45 cc)
parametersURL (max 999 cc)
partner (max 255 cc)
trafficSource (max 255 cc)
campaign (max 255 cc)
agenteId(requiered)	7-digit numerical value (ex: 0051245). Agent assigned to the client (the one you already had if you are already a client or the agent assigned by supplier)
canal	Channel from which the request was received and if is client or not
dni	The NIF that has been consulted in the request
email (max 50 cc)	Email informed by the client in the form
motivoLlamada (requiered)	Value '1' in case you request a budget, value '2' in case you request help
name (requiered, max 50 cc)	Name reported by the client on the form
origen (max 20 cc)	Values indicated by the Marketing team
phone (requiered)	Telephone number reported by the client on the form
postalcode	Zip code reported by the lead in the form (Ex: 08014)
ramo	Numerical value according to the product the client is interested (car, life, motorcycle insurance)
refExt (max 20 cc)	Different possible values indicated by Marketing team
tresAgentes	Provisionally empty

Alta Lead (response):

Param	Description
idLanding	Identifier value required for Marketing users for the contact-lead relationship
leadId	identifier of the lead that has just been registered in Allianz tables
message	It tells us if the call to the endpoint has been carried out without incident or, on the contrary, it would provide us with an error message

Update Lead (request):

Param	Description
estado (requiered)	Numerical value update based on update reason. Value '20' for GAM closure
leadId (requiered)	To update a lead, it must be identified with the "leadId" that was generated in the “Alta Lead”
observacion (requiered)	Informative note regarding the update that has just been made

Update Lead (response):

Param	Description
leadId	Reminder of the leadId that was updated in the request
message	It tells us if the call to the endpoint has been carried out without incident or, on the contrary, it would provide us with an error message

Test

A test environment is available for development in integration with this API.

TEST ENVIOREMENT

Production

A live production environment is available for this API.

PRODUCTION ENVIOREMENT

Leads Contract API1.2.5-RELEASE