Skip to content

Lead

Returns a list of resources identified by the following URL. Returns all financing-/appointment-requests of a given timeframe and ScoutID (The requester must be authorized to receive requests of that ScoutID). If no ScoutID was passed, requests of all ScoutIDs the requester is authorized for are returned. For test purposes the parameter test=true can be passed to receive test leads (any other parameter will be ignored).

GET /financing/construction/v2/lead

Supported media types:
XML
JSON

Request

Query Parameters

parameter value example
scoutid ScoutID 12345
from date string, time format: yyyy-MM-dd'T'HH:mm:ss 2021-12-01T00:00:00
to date string, format: yyyy-MM-dd'T'HH:mm:ss 2021-12-02T00:00:00
test if set to true, some test leads are returned

1 Basic Lead Data:

parameter value description
lead.id id of the lead
lead.providerId id of the bank or financial advisor that was contacted
lead.providerName name of the bank or financial advisor that was contacted
lead.shortName short name or the name of the contacted branch
lead.offerTracking shows if bank offers tracking
lead.processingStatus NEW, CLIENT_NOT_REACHABLE, DECLINED_BY_CLIENT, APPOINTMENT_ARRANGED, APPOINTMENT_MISSED, OFFER_SENT, CONSULTING_NO_DEAL, CONSULTING_DEAL_OTHER, CONSULTING_DEAL_MORTGAGE, IN_PROGRESS, NO_INTEREST, DECLINED_BY_BANK, CLAIMED, FOLLOW_UP status set by bank
lead.processingStatusChanged date and time when status was changed
lead.note notes entered in the BaufiManager, may not be present
lead.price lead price
lead.effectiveInterestRate may not be present
lead.nominalInterestRate may not be present
lead.requestDate creation date and time of the lead
lead.requestType APPOINTMENT_REQUEST, FINANCING_REQUEST, LOCAL_LENDER. for further information on RequestType
lead.shopLead shows if the lead type is shop
lead.contactRequest.useType OWNER_OCCUPATION, PARTIALLY_RENTING, RENTING, UNKNOWN use type of the financing object
lead.contactRequest.financingTerms.financing.type BuildingFinancing, PurchaseFinancing, FollowupFinancing. for further information on FinancingType.
lead.contactRequest.bank the main bank of the requester
lead.contactRequest.dateOfBirth the date of birth of the requester
lead.contactRequest.numberOfBorrowers number of borrowers
lead.contactRequest.currentCredits sum of running credits of the requester
lead.contactRequest.message message of the requester
lead.contactRequest.partnerTracking If the contact request comes from a partner, this field should contain the id of the contact request on the partner's side
lead.contactRequest.contactChannel TELEPHONE, MEETING_AT_PROVIDERS_PLACE, MEETING_AT_REQUESTERS_PLACE, EMAIL, UNKNOWN preferred way of contact
lead.contactRequest.financingTerms.fixedNominalInterestRate FIVE_YEARS, TEN_YEARS, FIFTEEN_YEARS, TWENTY_YEARS, THIRTY_YEARS, FORTY_YEARS
lead.contactRequest.financingTerms.amortizationRate Tilgung p.a. in %
lead.contactRequest.financingTerms.geoCode geocode of the search region(e.g. 1276003001046= Berlin-Mitte)
lead.contactRequest.financingTerms.postalCode postal code of the search region
lead.contactRequest.financingTerms.locationName name of the search region
lead.contactRequest.financingTerms.employment CIVIL_SERVANT, EMPLOYED, FREELANCER, PENSIONER, SELFEMPLOYED, UNEMPLOYED, WORKER, HOUSEWIFE
lead.contactRequest.financingTerms.employmentSector MEDICAL
lead.contactRequest.salutation MR, MRS, UNKNOWN
lead.contactRequest.surname family name
lead.contactRequest.forename first name of the requester)
lead.contactRequest.email email address of the requester
lead.contactRequest.phoneNumber Phone number of the requester
lead.contactRequest.netIncome net income of the requester
lead.contactRequest.netIncomeRange BELOW_500, OVER_500_UPTO_1000, OVER_1000_UPTO_1500, OVER_1500_UPTO_2000, OVER_2000_UPTO_3000, OVER_2000_UPTO_2500, OVER_2500_UPTO_3000, OVER_3000_UPTO_4000, OVER_3000_UPTO_3500, OVER_3500_UPTO_4000, OVER_4000_UPTO_5000, OVER_5000
lead.contactRequest.contactAddress.street street of the requester
lead.contactRequest.contactAddress.streetNumber street no. of the requester
lead.contactRequest.contactAddress.postalCode postal code of the requester
lead.contactRequest.contactAddress.location location of the requester
lead.contactRequest.exposeId if contact request is related to an expose
lead.contactRequest.objectId if contact request is related to an expose; it is the field realEstate.externalId returned by the ExposeAPI
lead.contactRequest.dpaAccepted accepted the Data Processing Agreement
lead.contactRequest.kfwPromotion requester is interested in KfW consulting
lead.contactRequest.arvatoScoringPermitted agree with sending data to Arvato to generate score
lead.contactRequest.title NO_TITLE, DOCTOR, PROFESSOR, PROFESSOR_DOCTOR requester title
lead.contactRequest.segmentClass class that evaluates the quality of the request
lead.contactRequest.experiments experiments in contact request
lead.realEstate If a lead is connected to an Expose you will find information about the expose in this area. The information given depends on the expose. There is no minimum set of required fields.
lead.realEstate.id Id of the real estate
lead.realEstate.title Title of the real estate
lead.realEstate.type APARTMENT_RENT, APARTMENT_BUY, HOUSE_BUY, HOUSE_RENT, GARAGE_RENT, GARAGE_BUY, LIVING_RENT_SITE, LIVING_BUY_SITE, TRADE_SITE, HOUSE_TYPE, FLAT_SHARE_ROOM, SENIOR_CARE, ASSISTED_LIVING, OFFICE, INDUSTRY, STORE, GASTRONOMY, SPECIAL_PURPOSE, INVESTMENT, COMPULSORY_AUCTION, SHORT_TERM_ACCOMMODATION Please note that the field names in the RealEstateAddress differ from the ones in the ContactAddress
lead.realEstate.purchasePrice Purchase price of the real estate
lead.realEstate.livingArea Living area of the real estate
lead.realEstate.siteArea Site area of the real estate
lead.realEstate.constructionDate Construction date of the real estate
lead.realEstate.modernizationDate Modernization date of the real estate
lead.realEstate.address.street Street of the real estate
lead.realEstate.address.houseNumber Number of the real estate
lead.realEstate.address.postcode Postcode of the real estate
lead.realEstate.address.city City of the real estate
lead.realEstate.numberOfRooms Number of rooms of the real estate
lead.realEstate.picture Picture of the real estate


2 ARVATO SCORE DATA:

If user opt-in for arvato score then this object will not be null.

parameter value description
lead.arvatoScore.nameCheck if it was a fake name or not
lead.arvatoScore.addressCheck if it was a fake address or not
lead.arvatoScore.addressRating [1-3 green / 4 yellow / 5 red / 6 grey] address class rating 1-6
lead.arvatoScore.addressRatingType PPB = Bestätigung auf Personenebene, PHB = Bestätigung auf Haushaltsebene, PAB = Bestätigung der Anschrift, ohne Personenbezug, PNP = Adresse nicht prüfbar, PPF = Anschrift postalisch falsch / nicht korrigierbar, PKI = Keine (verwertbare) Information erhältlich, PUG = Gebäude unbekannt, PUZ = Person nicht (mehr) zustellbar , PPV = Person verstorben, ERROR = Fehler bei Serviceausführung, UNKNOWN = Ergebnis nicht eindeutig, NOT_VALIDATED = Adressverifizierung nicht ausgeführt address rating type for this address class rating, Its String so new values can be added later
lead.arvatoScore.addressRatingDetail address rating type detailed message for this address class rating
lead.arvatoScore.emailRating [1-3 green / 4 yellow / 5 red / 6 grey] email class rating 1-6
lead.arvatoScore.emailRatingDetail specific characteristic for this email class rating
lead.arvatoScore.creditRating [1-3 green / 4 yellow / 5 red / 6 grey] general class rating 1-6
lead.arvatoScore.creditRatingScore rating points
lead.arvatoScore.softNegativeRecords.recordType GM = Gläubigermahnung, IA = Inkasso-Mahnverfahren eingeleitet, AM = Fortlauf des außergerichtlichen Inkasso-Mahnverfahrens nach Teil- bzw. bei Ratenzahlung, IE = Einstellung des außergerichtlichen Inkasso-Mahnverfahrens wegen Aussichtslosigkeit, MB = Antrag auf Mahnbescheid, VB = Antrag auf Vollstreckungsbescheid, TR = Ratenzahler nach Forderungstitulierung, ZWA = Zwangsvollstreckung in das bewegliche Vermögen, ZWI = Zwangsvollstreckung in das unbewegliche Vermögen, FRP = Fruchtlose Pfändung, LP = Lohn- oder sonstige Forderungspfändung aufgrund eines gerichtlichen Pfändungs- und Überweisungsbeschlusses, UF = Uneinbringliche, titulierte Forderung, UBV = Unbekannt verzogen (unter Hinterlassung von Verbindlichkeiten aus Geld- oder Warenkrediten), AE = Schriftstück nicht zustellbar (ggf. Adressermittlung) soft negative record type, Its String so new values can be added later
lead.arvatoScore.softNegativeRecords.recordTypeDetail soft negative record type detailed message
lead.arvatoScore.softNegativeRecords.recordDate soft negative record start date
lead.arvatoScore.softNegativeRecords.closingDate soft negative record close date, not mandatory variable
lead.arvatoScore.hardNegativeRecords.recordType HB = Haftbefehl zur Erzwingung der eidesstattlichen Versicherung, HV = Vollstreckung des Haftbefehls zur Erzwingung der eidesstattlichen Versicherung, EV = Eidesstattliche Versicherung (Offenbarungseid), EEV = Ergänzung der eidesstattlichen Versicherung, WEV = Wiederholte eidesstattlichen Versicherung (§ 903 ZPO), SVV = Verweigerung der Vermögensauskunft gem. § 882c Abs. 1 Nr. 1 ZPO SVV, SAV = Erkennbare Aussichtslosigkeit der Vollstreckung gem. § 882c Abs. 1 Nr. 2 ZPO SAV, SNZ = Nichtzahler gem. § 882c Abs. 1 Nr. 3 ZPO SNZ, IVE = Außergerichtlicher Einigungsversuch im Rahmen des Insolvenzverfahrens, IVS = Anordnung von vorläufigen Sicherungsmaßnahmen im Insolvenzverfahren , IVA = Aufhebung von vorläufigen Sicherungsmaßnahmen im Insolvenzverfahren, IBE = Eröffnung des Insolvenzverfahrens/Beschluss, IBA = Abweisung der Verfahrenseröffnung mangels Masse (§ 26 Abs. 2 InsO), IWP = Aufhebung des Insolvenzverfahrens (gerichtliche Zwischenentscheidung, zeitlich vor einer Entscheidung über die ggf. beantragte Restschuldbefreiung). Das Insolvenz-Verfahren ist noch nicht beendet, IRB = Erteilung der Restschuldbefreiung, IRV = Versagung der Restschuldbefreiung, HA = Hinweis zur Adresse, UNKNOWN = Sonstiger Eintrag hard negative record type, Its String so new values can be added later
lead.arvatoScore.hardNegativeRecords.recordTypeDetail hard negative record type detailed message
lead.arvatoScore.hardNegativeRecords.recordDate hard negative record start date
lead.arvatoScore.hardNegativeRecords.closingDate hard negative record close date, not mandatory variable

3 EXTENDED LEAD DATA

User can provide additional (‘’extended”) data.

parameter value description
lead.contactRequest.borrowerRelationship MARRIED=verheiratet, LIVING_TOGETHER=zusammenlebend, OTHER=andere Beziehung Verhältnis der Darlehensnehmer
lead.contactRequest.nationality Staatsangehörigkeit
lead.contactRequest.workContractType LIMITED=befristet, PERMANENT=unbefristet, PROBATION=Probezeit Vertragsverhältnis
lead.contactRequest.workContractEndDate Befristet bis
lead.contactRequest.numberOfChildren Anzahl der Kinder
lead.contactRequest.maritalStatus SINGLE=Single, MARRIED=verheiratet, SEPARATED=getrennt lebend, DIVORCED=geschieden, WIDOWED=verwitwet, PARTNERSHIP=Lebenspartnerschaft Familienstand
lead.contactRequest.secondBorrower.firstName Vorname
lead.contactRequest.secondBorrower.lastName Nachname
lead.contactRequest.secondBorrower.dateOfBirth Geburtsdatum
lead.contactRequest.secondBorrower.nationality Staatsangehörigkeit
lead.contactRequest.secondBorrower.employment CIVIL_SERVANT, EMPLOYED, FREELANCER, PENSIONER, SELFEMPLOYED, UNEMPLOYED, WORKER, HOUSEWIFE Beschäftigungsverhältnis
lead.contactRequest.secondBorrower.workContractType LIMITED, PERMANENT, PROBATION Vertragsverhältnis
lead.contactRequest.secondBorrower.workContractEndDate Befristet bis
lead.contactRequest.secondBorrower.maritalStatus SINGLE=Single, MARRIED=verheiratet, SEPARATED=getrennt lebend, DIVORCED=geschieden, WIDOWED=verwitwet, PARTNERSHIP=Lebenspartnerschaft Familienstand

Income (1st borrower)

parameter value description
lead.contactRequest.income.salary Monatliches Nettoeinkommen
lead.contactRequest.income.numberOfSalaries Anzahl der Monatsgehälter
lead.contactRequest.income.alimony Unterhalt
lead.contactRequest.income.pension Pensionen, Renten o. Ä.
lead.contactRequest.income.rental Einkünfte aus Vermietung und Verpac..
lead.contactRequest.income.childBenefits Kindergeld
lead.contactRequest.income.other Sonstige regelmäßige Einnahmen

Spending (1st borrower)

parameter value description
lead.contactRequest.spending.livingCost Lebenshaltungskostenpauschale
lead.contactRequest.spending.rent Monatliche Warmmiete
lead.contactRequest.spending.buildingSaving Bausparbeitrag
lead.contactRequest.spending.saving Sparbeiträge
lead.contactRequest.spending.alimony Unterhalt
lead.contactRequest.spending.healthInsurance Private Krankenversicherung
lead.contactRequest.spending.pensionInsurance Private Lebens-/ Rentenversicherung
lead.contactRequest.spending.creditRate Kreditaten
lead.contactRequest.spending.numberOfVehicles Anzahl Kfz
lead.contactRequest.spending.other Sonstige regelmäßige Ausgaben

Income (2nd borrower)

parameter value description
lead.contactRequest.secondBorrower.income.salary Monatliches Nettoeinkommen
lead.contactRequest.secondBorrower.income.numberOfSalaries Anzahl der Monatsgehälter
lead.contactRequest.secondBorrower.income.alimony Unterhalt
lead.contactRequest.secondBorrower.income.pension Pensionen, Renten o. Ä.
lead.contactRequest.secondBorrower.income.rental Einkünfte aus Vermietung und Verpac..
lead.contactRequest.secondBorrower.income.childBenefits Kindergeld
lead.contactRequest.secondBorrower.income.other Sonstige regelmäßige Einnahmen

Spending (2nd borrower)

parameter value description
lead.contactRequest.secondBorrower.spending.livingCost Lebenshaltungskostenpauschale
lead.contactRequest.secondBorrower.spending.rent Monatliche Warmmiete
lead.contactRequest.secondBorrower.spending.buildingSaving Bausparbeitrag
lead.contactRequest.secondBorrower.spending.saving Sparbeiträge
lead.contactRequest.secondBorrower.spending.alimony Unterhalt
lead.contactRequest.secondBorrower.spending.healthInsurance Private Krankenversicherung
lead.contactRequest.secondBorrower.spending.pensionInsurance Private Lebens-/ Rentenversicherung
lead.contactRequest.secondBorrower.spending.creditRate Kreditaten
lead.contactRequest.secondBorrower.spending.numberOfVehicles Anzahl Kfz
lead.contactRequest.secondBorrower.spending.other Sonstige regelmäßige Ausgaben

Purchase object data

parameter value description
lead.contactRequest.financingObject.street Straße
lead.contactRequest.financingObject.streetNumber Nr.
lead.contactRequest.financingObject.postalCode PLZ
lead.contactRequest.financingObject.city Ort
lead.contactRequest.financingObject.livingArea Wohnfläche
lead.contactRequest.financingObject.siteArea Grundstücksfläche
lead.contactRequest.financingObject.constructionYear Baujahr der Immobilie
lead.contactRequest.financingObject.type APARTMENT_BUY=Wohnung, HOUSE_BUY=Haus, LIVING_BUY_SITE=Grundstück Haustyp
lead.contactRequest.financingObject.subType SINGLE_FAMILY_HOUSE=Einfamiliehaus, SEMIDETACHED_HOUSE=Doppelhaushälfte, TERRACE_HOUSE=Reihenhaus, MULTI_FAMILY_HOUSE=Mehrfamilienhaus, HALF_BASEMENT=Souterrain, GROUND_FLOOR=Erdgeschoss, APARTMENT=Etagenwohnung, ROOF_STOREY=Dachgeschoss, MAISONETTE=Maisonette, LOFT=Loft Wohnungstyp
lead.contactRequest.financingObject.rooms Anzahl der Räume
lead.contactRequest.financingObject.hasLift Ob das Finanzierungsobjekt einen Aufzug hat
lead.contactRequest.financingObject.hasParking Ob das Finanzierungsobjekt Parkplätze hat
lead.contactRequest.financingObject.hasStorage Ob das Finanzierungsobjekt gespeichert ist
lead.contactRequest.financingObject.hasOutdoorArea Ob das Finanzierungsobjekt einen Außenbereich hat
lead.contactRequest.financingObject.lastModified Das letzte Mal wurde das Finanzierungsobjekt geändert

Financing types

lead.contactRequest.financingTerms.financing.type=BuildingFinancing (Neubau):

parameter value
lead.contactRequest.financingTerms.financing.purchasePrice
lead.contactRequest.financingTerms.financing.ownFunds
lead.contactRequest.financingTerms.financing.additionalCosts
lead.contactRequest.financingTerms.financing.financingStart NA, IN_LESS_THAN_THREE_MONTH, IN_BETWEEN_THREE_AND_SIX_MONTHS, IN_MORE_THAN_SIX_MONTH
lead.contactRequest.financingTerms.financing.projectState NA, NOT_YET_IN_PLANNING, LAND_PROPERTY_EXISTS, LAND_PROPERTY_AND_COMPANY_EXIST, PROPERTY_FOUND, NOTARY_APPOINTMENT_PLANNED, ON_BUILDER_SEARCH

lead.contactRequest.financingTerms.financing.type=PurchaseFinancing (Kauf einer Immobilie):

parameter value
lead.contactRequest.financingTerms.financing.purchasePrice
lead.contactRequest.financingTerms.financing.ownFunds
lead.contactRequest.financingTerms.financing.additionalCosts
lead.contactRequest.financingTerms.financing.financingStart NA, IN_LESS_THAN_THREE_MONTH, IN_BETWEEN_THREE_AND_SIX_MONTHS, IN_MORE_THAN_SIX_MONTH
lead.contactRequest.financingTerms.financing.projectState NA, REAL_ESTATE_VISITED, REAL_ESTATE_NOT_YET_VISITED, PURCHASING_NEGOTIATIONS, CONCRETE_OBJECT_FOUND, NOTARY_APPOINTMENT_PLANNED, ON_OBJECT_SEARCH

lead.contactRequest.financingTerms.financing.type=FollowupFinancing (Anschlussfinanzierung):

parameter value
lead.financingTerms.financing.propertyValue
lead.financingTerms.financing.remainingDebt
lead.financingTerms.financing.financingStart NA, IN_LESS_THAN_ONE_YEAR, IN_ONE_YEAR, IN_TWO_YEARS, IN_THREE_YEARS, IN_FOUR_YEARS, IN_FIVE_YEARS

Request types

lead.requestType=APPOINTMENT_REQUEST: Leads with lead.requestType=APPOINTMENT_REQUEST include up to 2 appointments (primary and secondary). An appointment consists of the date field which is a Unix Timestamp and a time field which is an enum described below.

parameter value
lead.contactRequest.primaryAppointmentDate primary date in miliseconds of prefered appointment
lead.contactRequest.secondaryAppointmentDate secondary date in milliseconds of preferred appointment
lead.contactRequest.primaryAppointmentTime / lead.contactRequest.secondaryAppointmentTime ALL_DAY, EIGHT_TO_TWELVE, TWELVE_TO_SIXTEEN, SIXTEEN_TO_NINETEEN, UNKNOWN, TEN_UNTIL_ELEVEN, ELEVEN_UNTIL_TWELVE, TWELVE_UNTIL_THIRTEEN, THIRTEEN_UNTIL_FOURTEEN, FOURTEEN_UNTIL_FIFTEEN, FIFTEEN_UNTIL_SIXTEEN, SIXTEEN_UNTIL_SEVENTEEN, SEVENTEEN_UNTIL_EIGHTEEN, EIGHTEEN_UNTIL_NINETEEN, NINETEEN_UNTIL_TWENTY, TWENTY_UNTIL_TWENTYONE

lead.requestType=FINANCING_REQUEST:

parameter value
lead.contactRequest.availability ALL_DAY, EIGHT_TO_TWELVE, TWELVE_TO_SIXTEEN, SIXTEEN_TO_NINETEEN, UNKNOWN, TEN_UNTIL_ELEVEN, ELEVEN_UNTIL_TWELVE, TWELVE_UNTIL_THIRTEEN, THIRTEEN_UNTIL_FOURTEEN, FOURTEEN_UNTIL_FIFTEEN, FIFTEEN_UNTIL_SIXTEEN, SIXTEEN_UNTIL_SEVENTEEN, SEVENTEEN_UNTIL_EIGHTEEN, EIGHTEEN_UNTIL_NINETEEN, NINETEEN_UNTIL_TWENTY, TWENTY_UNTIL_TWENTYONE

Overview of mandatory fields

The table below shows which fields are mandatory / optional / not present in ApointmentRequests FinancingRequests.

Field APPOINTMENT_REQUEST FINANCING_REQUESTS
lead.id mandatory mandatory
lead.providerId mandatory mandatory
lead.providerName mandatory mandatory
lead.shortName optional optional
lead.note optional optional
lead.effectiveInterestRate optional optional
lead.nominalInterestRate optional optional
lead.requestDate mandatory mandatory
lead.requestType mandatory mandatory
lead.shopLead mandatory mandatory
lead.contactRequest.useType defaults to "UNKNOWN" mandatory
lead.contactRequest.financingTerms mandatory mandatory
lead.contactRequest.contactChannel mandatory mandatory
lead.contactRequest.salutation mandatory mandatory
lead.contactRequest.surname mandatory mandatory
lead.contactRequest.forename mandatory mandatory
lead.contactRequest.email mandatory mandatory
lead.contactRequest.phoneNumber mandatory mandatory
lead.contactRequest.message optional optional
lead.contactRequest.exposeId optional optional
lead.contactRequest.partnerTracking optional optional
lead.contactRequest.objectId optional optional
lead.contactRequest.netIncome optional mandatory
lead.contactRequest.netIncomeRange optional optional
lead.contactRequest.currentCredits optional optional
lead.contactRequest.numberOfBorrowers optional optional
lead.contactRequest.dateOfBirth optional optional
lead.contactRequest.bank optional optional
lead.contactRequest.contactAddress optional mandatory
lead.contactRequest.availability not present optional
lead.contactRequest.primaryAppointmentDate optional not present
lead.contactRequest.secondaryAppointmentDate optional not present
lead.contactRequest.primaryAppointmentTime optional not present
lead.contactRequest.secondaryAppointmentTime optional not present
lead.contactRequest.dpaAccepted defaults to false defaults to false
lead.contactRequest.kfwPromotion defaults to false defaults to false
lead.contactRequest.arvatoScoringPermitted defaults to false defaults to false
lead.contactRequest.borrowerRelationship not present optional
lead.contactRequest.nationality not present optional
lead.contactRequest.workContractType not present optional
lead.contactRequest.workContractEndDate not present optional
lead.contactRequest.numberOfChildren not present optional
lead.contactRequest.maritalStatus not present optional
lead.contactRequest.secondBorrower not present optional
lead.contactRequest.secondBorrower.firstName not present optional
lead.contactRequest.secondBorrower.lastName not present optional
lead.contactRequest.secondBorrower.dateOfBirth not present optional
lead.contactRequest.secondBorrower.nationality not present optional
lead.contactRequest.secondBorrower.employment not present optional
lead.contactRequest.secondBorrower.workContractType not present optional
lead.contactRequest.secondBorrower.workContractEndDate not present optional
lead.contactRequest.secondBorrower.maritalStatus not present optional
lead.contactRequest.secondBorrower.income not present optional
lead.contactRequest.secondBorrower.spending not present optional
lead.contactRequest.financingObject not present optional
lead.contactRequest.financingObject.street not present optional
lead.contactRequest.financingObject.streetNumber not present optional
lead.contactRequest.financingObject.postalCode not present optional
lead.contactRequest.financingObject.city not present optional
lead.contactRequest.financingObject.type not present optional
lead.contactRequest.financingObject.subType not present optional
lead.contactRequest.financingObject.livingArea not present optional
lead.contactRequest.financingObject.siteArea not present optional
lead.contactRequest.financingObject.constructionYear not present optional
lead.contactRequest.income not present optional
lead.contactRequest.income.salary not present optional
lead.contactRequest.income.numberOfSalaries not present optional
lead.contactRequest.income.alimony not present optional
lead.contactRequest.income.pension not present optional
lead.contactRequest.income.rental not present optional
lead.contactRequest.income.childBenefits not present optional
lead.contactRequest.income.other not present optional
lead.contactRequest.spending not present optional
lead.contactRequest.spending.livingCost not present optional
lead.contactRequest.spending.rent not present optional
lead.contactRequest.spending.buildingSaving not present optional
lead.contactRequest.spending.saving not present optional
lead.contactRequest.spending.alimony not present optional
lead.contactRequest.spending.healthInsurance not present optional
lead.contactRequest.spending.pensionInsurance not present optional
lead.contactRequest.spending.creditRate not present optional
lead.contactRequest.spending.numberOfVehicles not present optional
lead.contactRequest.spending.other not present optional
lead.contactRequest.title defaults to NO_TITLE defaults to NO_TITLE
lead.contactRequest.segmentClass not present optional
lead.contactRequest.experiments not present optional
lead.realEstate optional optional
lead.offerTracking optional optional
lead.processingStatus mandatory mandatory
lead.processingStatusChanged mandatory mandatory
lead.price defaults to 0 defaults to 0
lead.arvatoScore not present optional
lead.arvatoScore.softNegativeRecords not present optional
lead.arvatoScore.softNegativeRecords.closingDate not present optional
lead.arvatoScore.hardNegativeRecords not present optional
lead.arvatoScore.hardNegativeRecords.closingDate not present optional

Response

XML:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:leads xmlns:ns2="http://rest.immobilienscout24.de/schema/financing/construction/2.0"
           xmlns:ns3="http://rest.immobilienscout24.de/schema/financing/construction/1.0">
    <lead>
        <id>987654</id>
        <providerId>111</providerId>
        <providerName>Name of the bank or finance broker</providerName>
        <shortName>a short name or the name of a branch</shortName>
        <requestDate>2014-07-03T20:50:12</requestDate>
        <requestType>APPOINTMENT_REQUEST</requestType>
        <shopLead>false</shopLead>
        <contactRequest>
            <useType>OWNER_OCCUPATION</useType>
            <financingTerms>
                <amortizationRate>2.00</amortizationRate>
                <postalCode>10243</postalCode>
                <employment>EMPLOYED</employment>
                <fixedNominalInterestRate>TEN_YEARS</fixedNominalInterestRate>
                <financing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:PurchaseFinancing">
                    <purchasePrice>300000.00</purchasePrice>
                    <ownFunds>20000.00</ownFunds>
                    <additionalCosts>10000.00</additionalCosts>
                    <financingStart>IN_LESS_THAN_THREE_MONTH</financingStart>
                    <projectState>REAL_ESTATE_NOT_YET_VISITED</projectState>
                </financing>
            </financingTerms>
            <contactChannel>UNKNOWN</contactChannel>
            <salutation>MRS</salutation>
            <surname>Muster</surname>
            <forename>Max</forename>
            <email>max.muster@gmail.com</email>
            <phoneNumber>55555</phoneNumber>
            <message>Message of the requester</message>
            <contactAddress>
                <street>Andreasstraße</street>
                <streetNumber>10</streetNumber>
                <postalCode>10243</postalCode>
                <location>Berlin</location>
            </contactAddress>
            <exposeId>987654321</exposeId>
            <numberOfBorrowers>2</numberOfBorrowers>
            <currentCredits>20000.00</currentCredits>
            <bank>Parkbank</bank>
            <primaryAppointmentDate>1621202400000</primaryAppointmentDate>
            <secondaryAppointmentDate>1621634400000</secondaryAppointmentDate>
            <primaryAppointmentTime>EIGHTEEN_UNTIL_NINETEEN</primaryAppointmentTime>
            <secondaryAppointmentTime>ELEVEN_UNTIL_TWELVE</secondaryAppointmentTime>
            <dpaAccepted>false</dpaAccepted>
            <kfwPromotion>false</kfwPromotion>
            <title>NO_TITLE</title>
        </contactRequest>
        <realEstate>
            <id>29648095</id>
            <title>Großzügiges Landhaus</title>
            <type>HOUSE_BUY</type>
            <purchasePrice>250000</purchasePrice>
            <livingArea>200.00</livingArea>
            <siteArea>1000.00</siteArea>
            <constructionDate>1884</constructionDate>
            <address>
                <street>Platz der Republik</street>
                <houseNumber>1</houseNumber>
                <postcode>11011</postcode>
                <city>Berlin</city>
            </address>
        </realEstate>
        <processingStatus>APPOINTMENT_ARRANGED</processingStatus>
        <processingStatusChanged>2021-05-17T10:54:09</processingStatusChanged>
        <arvatoScore>
            <addressCheck>true</addressCheck>
            <addressRating>5</addressRating>
            <addressRatingDetail>Bestätigung auf Haushaltsebene</addressRatingDetail>
            <addressRatingType>PHB</addressRatingType>
            <creditRating>3</creditRating>
            <creditRatingScore>400</creditRatingScore>
            <emailRating>4</emailRating>
            <emailRatingDetail>Firmen-, Privatdomain oder ISP Namensbestandteile enthalten</emailRatingDetail>
            <hardNegativeRecords>
                <recordDate>28.02.2018</recordDate>
                <recordType>HV</recordType>
                <recordTypeDetail>Vollstreckung des Haftbefehls zur Erzwingung der eidesstattlichen Versicherung</recordTypeDetail>
                <sorting>-1519813549161</sorting>
            </hardNegativeRecords>
            <nameCheck>true</nameCheck>
            <softNegativeRecords>
                <closingDate>28.02.2018</closingDate>
                <recordDate>28.02.2018</recordDate>
                <recordType>VB</recordType>
                <recordTypeDetail>Antrag auf Vollstreckungsbescheid</recordTypeDetail>
            </softNegativeRecords>
        </arvatoScore>
        <price>0</price>
    </lead>
</ns3:leads>

JSON:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
   "lead":[
      {
         "id":987654,
         "providerId":111,
         "providerName":"Name of the bank or finance broker",
         "shortName":"a short name or the name of a branch",
         "requestDate":"2014-07-03T20:50:12",
         "requestType":"APPOINTMENT_REQUEST",
         "shopLead": false,
         "contactRequest":{
            "financingTerms":{
               "amortizationRate":2.00,
               "postalCode":"10243",
               "employment":"EMPLOYED",
               "fixedNominalInterestRate":"TEN_YEARS",
               "financing":{
                  "type":"PurchaseFinancing",
                  "purchasePrice":300000.00,
                  "ownFunds":20000.00,
                  "additionalCosts":10000.00,
                  "financingStart":"IN_LESS_THAN_THREE_MONTH",
                  "projectState":"REAL_ESTATE_NOT_YET_VISITED"
               }
            },
            "contactChannel":"UNKNOWN",
            "salutation":"MR",
            "surname":"Muster",
            "forename":"Max",
            "email":"max.muster@gmail.com",
            "phoneNumber":"55555",
            "message":"Message of the requester",
            "contactAddress":{
               "street":"Andreasstraße",
               "streetNumber":"10",
               "postalCode":"10243",
               "location":"Berlin"
            },
            "exposeId":987654321,
            "numberOfBorrowers":2,
            "currentCredits":20000.00,
            "bank":"Parkbank",
            "primaryAppointmentDate": 1621202400000,
            "secondaryAppointmentDate": 1621634400000,
            "primaryAppointmentTime": "EIGHTEEN_UNTIL_NINETEEN",
            "secondaryAppointmentTime": "ELEVEN_UNTIL_TWELVE",
            "dpaAccepted": false,
            "kfwPromotion": false,
            "title": "NO_TITLE",
            "useType":"OWNER_OCCUPATION"
         },
         "realEstate":{
            "id": 29648095,
            "title":"Großzügiges Landhaus",
            "type":"HOUSE_BUY",
            "purchasePrice":250000,
            "livingArea":200.00,
            "siteArea":1000.00,
            "constructionDate":1884,
            "address":{
               "street":"Platz der Republik",
               "houseNumber":"1",
               "postcode":"11011",
               "city":"Berlin"
            }
         },
         "processingStatus":"APPOINTMENT_ARRANGED",
         "processingStatusChanged":"2021-05-17T10:54:09",
         "arvatoScore":{
            "nameCheck":true,
            "addressCheck":true,
            "addressRating":5,
            "addressRatingType":"PHB",
            "addressRatingDetail":"Bestätigung auf Haushaltsebene",
            "emailRating":4,
            "emailRatingDetail":"Firmen-, Privatdomain oder ISP Namensbestandteile enthalten",
            "creditRating":3,
            "creditRatingScore":400,
            "softNegativeRecords":[
               {
                  "recordType":"VB",
                  "recordTypeDetail":"Antrag auf Vollstreckungsbescheid",
                  "recordDate":"28.02.2018",
                  "closingDate":"28.02.2018"
               }
            ],
            "hardNegativeRecords":[
               {
                  "recordType":"HV",
                  "recordTypeDetail":"Vollstreckung des Haftbefehls zur Erzwingung der eidesstattlichen Versicherung",
                  "recordDate":"28.02.2018"
               }
            ]
         },
         "price": 0
      }
   ]
}