GET Lead 2.0

The ressource represents a lead export. This method returns all financing-/appointment-requests of a given timeframe.

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).

http://rest.immobilienscout24.de/restapi/api/financing/construction/v2/lead

Supported media types

  • XML (Accept: application/xml)
  • JSON (Accept: application/json)

Authorization requirements

  • At least a System Key is required for this operation. See Authentication via Two-legged OAuth for further details.

Request

Path Parameters

  • none

Query Paramters   

  • scoutid - ScoutID
  • from - date string, format: yyyy-MM-dd'T'HH:mm:ss
  • to - date string, format: yyyy-MM-dd'T'HH:mm:ss
  • test - if set to true, some test leads are returned

Response

The following section includes the HTTP status code, a short description and examples for the response body content of a successful processed request.
Error responses as well as other simple message responses are described in detail within the common message responses.

  • Status 200 OK
  • The requested operation was successful.

Header

No special headers.

Body

The following two paragraphs show an example Lead export with XML and JSON.

XML

<?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>
        <note>Notes entered in the Baufi-Manager</note>
        <effectiveInterestRate>2.75</effectiveInterestRate>
        <nominalInterestRate>2.47</nominalInterestRate>
        <requestDate>2014-07-03T20:50:12</requestDate>
        <requestType>FINANCING_REQUEST</requestType>
        <contactRequest>
            <useType>OWNER_OCCUPATION</useType>
            <financingTerms>
                <amortizationRate>2.00</amortizationRate>
                <geoCode>1276003001046</geoCode>
                <locationName>Berlin-Mitte</locationName>
                <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>
            <availability>EIGHT_TO_TWELVE</availability>
            <salutation>MRS</salutation>
            <surname>Muster</surname>
            <forename>Max</forename>
            <email>max.muster@gmail.com</email>
            <areaCode>030</areaCode>
            <phoneNumber>55555</phoneNumber>
            <message>Message of the requester</message>
            <subscribeToNewsletter>false</subscribeToNewsletter>
            <netIncome>2500.00</netIncome>
            <contactAddress>
                <street>Andreasstraße</street>
                <streetNumber>10</streetNumber>
                <postalCode>10243</postalCode>
                <location>Berlin</location>
            </contactAddress>
            <exposeId>987654321</exposeId>
            <dateOfBirth>1990-10-01</dateOfBirth>
            <bank>Parkbank</bank>
            <numberOfBorrowers>2</numberOfBorrowers>
            <currentCredits>20000.00</currentCredits>
        </contactRequest>
        <realEstate>
            <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>
        <arvatoScore>
            <addressCheck>true</addressCheck>
            <addressRating>5</addressRating>
            <addressRatingDetail>Bestätigung auf Haushaltsebene</addressRatingDetail>
            <addressRatingType>PHB</addressRatingType>
            <creditRating>3</creditRating>
            <creditRatingScore>400</creditRatingScore>
            <creditRatingType>BSP</creditRatingType>
            <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>
    </lead>
</ns3:leads>

JSON

{
    "lead": [{
        "id": 987654,
        "providerId": 111,
        "providerName": "Name of the bank or finance broker",
        "shortName": "a short name or the name of a branch",
        "note": "Notes entered in the Baufi-Manager",
        "effectiveInterestRate": "2.75",
        "nominalInterestRate": "2.47",
        "requestDate": "2014-07-03T20:50:12",
        "requestType": "FINANCING_REQUEST",
        "contactRequest": {
            "financingTerms": {
                "amortizationRate": 2.00,
                "geoCode": "1276003001046",
                "locationName": "Berlin-Mitte",
                "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",
            "availability": "EIGHT_TO_TWELVE",
            "salutation": "MR",
            "surname": "Muster",
            "forename": "Max",
            "email": "max.muster@gmail.com",
            "areaCode": "030",
            "phoneNumber": "55555",
            "message": "Message of the requester",
            "subscribeToNewsletter": false,
            "netIncome": 2500.00,
            "contactAddress": {
                "street": "Andreasstraße",
                "streetNumber": "10",
                "postalCode": "10243",
                "location": "Berlin"
            },
            "useType": "OWNER_OCCUPATION",
            "exposeId": 987654321,
            "dateOfBirth":"2010-10-01",
	    "bank": "Parkbank",
	    "numberOfBorrowers": 2,
	    "currentCredits": 20000.00
        },
        "realEstate":{
            "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"
            }
        }, 
        "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, 
            "creditRatingType": "BSP", 
            "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"
                }
            ]
         }
    }]
}

1 BASIC LEAD DATA

 

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.processingStatus (status set by bank)

  • NEW=Unbearbeitet
  • CLIENT_NOT_REACHABLE=Nicht erreichbar
  • DECLINED_BY_CLIENT=Ablehnung durch Interessenten
  • APPOINTMENT_ARRANGED=Termin vereinbart
  • APPOINTMENT_MISSED=Interessent nicht erschienen
  • OFFER_SENT=Finanzierungsangebot
  • CONSULTING_NO_DEAL=Beratung ohne Abschluss
  • CONSULTING_DEAL_OTHER=Beratung mit anderem Abschluss
  • CONSULTING_DEAL_MORTGAGE=Beratung mit Baufi-Abschluss
  • IN_PROGRESS=In Bearbeitung
  • UNKNOWN=Unbekannt
  • NO_INTEREST=Kein Interesse
  • DECLINED_BY_BANK=Ablehnung durch Bank
  • CLAIMED=Reklamiert

lead.note (notes entered in the BaufiManager, may not be present)

lead.effectiveInterestRate (may not be present)

lead.nominalInterestRate (may not be present)

lead.requestDate (creation date and time the lead)

lead.requestType

  • APPOINTMENT_REQUEST=Premium-Terminanfrage
  • FINANCING_REQUEST=Finanzierungsanfrage

lead.contactRequest.useType  (use type of the financing object)

  • OWNER_OCCUPATION=Eigennutzung
  • PARTIALLY_RENTING=Teilvermietung
  • RENTING=Vermietung
  • UNKNOWN=keine Angaben

lead.contactRequest.financingTerms.financing.type (Finanzierungsart)

  • BuildingFinancing=Finanzierung eines Neubaus
  • PurchaseFinancing=Finanzierung eines Kaufs
  • FollowupFinancing=Anschlussfinanzierung

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.contactChannel (preferred way of contact)

  • TELEPHONE=Telefon
  • MEETING_AT_PROVIDERS_PLACE=Gespräch beim Anbieter
  • MEETING_AT_REQUESTERS_PLACE=Hausbesuch
  • EMAIL=Email
  • UNKNOWN=keine Angaben

lead.contactRequest.financingTerms.fixedNominalInterestRate (Sollzinsbindung)

  • FIVE_YEARS=5 Jahre
  • TEN_YEARS=10 Jahre
  • FIFTEEN_YEARS=15 Jahre
  • TWENTY_YEARS=20 Jahre

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 (Beschäftigungsverhältnis)

  • CIVIL_SERVANT=Beamter
  • EMPLOYED=Angestellt
  • FREELANCER=Freiberufler
  • PENSIONER=Rentner
  • SELFEMPLOYED=Selbstständig
  • UNEMPLOYED=Arbeitssuchend
  • WORKER=Arbeiter/in
  • HOUSEWIFE=Hausfrau/mann

lead.contactRequest.salutation (Anrede)

  • MR=Herr
  • MRS=Frau

lead.contactRequest.surname (second name of the requester)

lead.contactRequest.forename (first name of the requester)

lead.contactRequest.email (email address of the requester)

lead.contactRequest.areaCode (phonenumber's area code)

lead.contactRequest.phoneNumber (Phone number of the requester)

lead.contactRequest.netIncome (net income of the requester)

  • BELOW_500
  • OVER_500_UPTO_1000
  • OVER_1000_UPTO_1500
  • OVER_1500_UPTO_2000
  • OVER_2000_UPTO_2500
  • OVER_2500_UPTO_3000
  • OVER_2000_UPTO_3000
  • OVER_3000_UPTO_3500
  • OVER_3500_UPTO_4000
  • OVER_3000_UPTO_4000
  • OVER_4000_UPTO_5000

 

Address of the requester:

contactRequest.contactAddress.street (street of the requester)

contactRequest.contactAddress.streetNumber (street no. of the requester)

contactRequest.contactAddress.postalCode (postal code of the requester)

contactRequest.contactAddress.location (location of the requester)


Expose related data:

contactRequest.exposeId (if contact request is related to an expose)

contactRequest.objectId (if contact request is related to an expose; it is the field realEstate.externalId returned by the ExposeAPI)

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.type (Immobilientyp)

  • APARTMENT_BUY=Wohnungskauf
  • HOUSE_BUY=Hauskauf
  • INVESTMENT=Anlageimmobilie

Please note that the field names in the RealEstateAddress differ from the ones in the ContactAddress.

 

Depending on the financing type the following information is provided by the financing:

 

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

lead.contactRequest.financingTerms.financing.purchasePrice(Kaufpreis des Objektes)

lead.contactRequest.financingTerms.financing.ownFunds (Eigenkapital)

lead.contactRequest.financingTerms.financing.additionalCosts(Nebenkosten)

lead.contactRequest.financingTerms.financing.financingStart  (Zeitpunkt der Finanzierung)

  • NA
  • IN_LESS_THAN_THREE_MONTH=in weniger als 3 Monaten
  • IN_BETWEEN_THREE_AND_SIX_MONTHS=in 3-6 Monaten
  • IN_MORE_THAN_SIX_MONTH=in mehr als 6 Monaten

lead.contactRequest.financingTerms.financing.projectState(Stand des Immobilienkaufs)

  • NA
  • NOT_YET_IN_PLANNING=noch nicht in Planung
  • LAND_PROPERTY_EXISTS=Grundstück vorhanden
  • LAND_PROPERTY_AND_COMPANY_EXIST=Grundstück und Haushersteller vorhanden
  • PROPERTY_FOUND = Grundstück/Bauträger gefunden
  • NOTARY_APPOINTMENT_PLANNED = Notartermin geplant
  • ON_BUILDER_SEARCH = Auf Grundstück/Bauträgersuche

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

lead.contactRequest.financingTerms.financing.purchasePrice(Kaufpreis des Objektes)

lead.contactRequest.financingTerms.financing.ownFunds (Eigenkapital)

lead.contactRequest.financingTerms.financing.additionalCosts(Nebenkosten)

lead.contactRequest.financingTerms.financing.financingStart (Zeitpunkt der Finanzierung)

  • NA
  • IN_LESS_THAN_THREE_MONTH=in weniger als 3 Monaten
  • IN_BETWEEN_THREE_AND_SIX_MONTHS=in 3-6 Monaten
  • IN_MORE_THAN_SIX_MONTH=in mehr als 6 Monaten

lead.contactRequest.financingTerms.financing.projectState(Stand des Bauprojekts)

  • NA
  • REAL_ESTATE_VISITED=Objekt besichtigt
  • REAL_ESTATE_NOT_YET_VISITED=Objekt nicht besichtigt
  • PURCHASING_NEGOTIATIONS=In Kaufverhandlung
  • CONCRETE_OBJECT_FOUND = Konkretes Objekt bereits gefunden
  • NOTARY_APPOINTMENT_PLANNED = Notartermin geplant
  • ON_OBJECT_SEARCH = Auf Objektsuche

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

lead.financingTerms.financing.propertyValue(Objektwert)

lead.financingTerms.financing.remainingDebt (Restschuld)

lead.financingTerms.financing.financingStart(Zeitpunkt der Anschlussfinanzierung)

  • NA
  • IN_LESS_THAN_ONE_YEAR=in weniger als 1 Jahr
  • IN_ONE_YEAR=in 1 Jahr
  • IN_TWO_YEARS=in 2 Jahren
  • IN_THREE_YEARS=in 3 Jahren
  • IN_FOUR_YEARS=in 4 Jahren
  • IN_FIVE_YEARS=in 5 Jahren

 

Appointments / Availability:

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. 

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:

  • TEN_UNTIL_ELEVEN=10 bis 11 Uhr
  • ELEVEN_UNTIL_TWELVE=11 bis 12 Uhr
  • TWELVE_UNTIL_THIRTEEN=12 bis 13 Uhr
  • THIRTEEN_UNTIL_FOURTEEN=13 bis 14 Uhr
  • FOURTEEN_UNTIL_FIFTEEN=14 bis 15 Uhr
  • FIFTEEN_UNTIL_SIXTEEN=15 bis 16 Uhr
  • SIXTEEN_UNTIL_SEVENTEEN=16 bis 17 Uhr
  • SEVENTEEN_UNTIL_EIGHTEEN=17 bis 18 Uhr
  • EIGHTEEN_UNTIL_NINETEEN=18 bis 19 Uhr
  • NINETEEN_UNTIL_TWENTY=19 bis 20 Uhr
  • TWENTY_UNTIL_TWENTYONE=20 bis 21 Uhr

Leads with lead.requestType=FINANCING_REQUEST

lead.contactRequest.availability:

  • ALL_DAY=ganztags
  • EIGHT_TO_TWELVE=Vormittags
  • TWELVE_TO_SIXTEEN=Nachmittags
  • SIXTEEN_TO_NINETEEN=Abends
  • UNKNOWN=keine Angaben

Be aware that additional values for availability and appointmentTime may be added in the future.

--------------------------------------------------------------------------------------------------------------------------

2 ARVATO SCORE DATA

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

 

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 (address class rating 1-6   [1-3 green / 4 yellow / 5 red / 6 grey])

lead.arvatoScore.addressRatingType (address rating type for this address class rating, Its String so new values can be added later)

  •     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

lead.arvatoScore.addressRatingDetail (address rating type detailed message for this address class rating)

lead.arvatoScore.emailRating (email class rating 1-6   [1-3 green / 4 yellow / 5 red / 6 grey])

lead.arvatoScore.emailRatingDetail (specific characteristic for this email class rating)

lead.arvatoScore.creditRating (general class rating 1-6   [1-3 green / 4 yellow / 5 red / 6 grey])

lead.arvatoScore.creditRatingScore (rating points)

lead.arvatoScore.softNegativeRecords.recordType (soft negative record type, Its String so new values can be added later)

  •     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)

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 (hard negative record type, Its String so new values can be added later)

  •     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

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.

 

lead.contactRequest.borrowerRelationship (Verhältnis der Darlehensnehmer)

  • MARRIED=verheiratet
  • LIVING_TOGETHER=zusammenlebend
  • OTHER=andere Beziehung

lead.contactRequest.nationality (Staatsangehörigkeit)

lead.contactRequest.workContractType (Vertragsverhältnis)

  • LIMITED=befristet
  • PERMANENT=unbefristet
  • PROBATION=Probezeit

lead.contactRequest.workContractEndDate (Befristet bis)

lead.contactRequest.numberOfChildren (Anzahl der Kinder)

lead.contactRequest.maritalStatus (Familienstand)

  • SINGLE=Single
  • MARRIED=verheiratet
  • SEPARATED=getrennt lebend
  • DIVORCED=geschieden
  • WIDOWED=verwitwet
  • PARTNERSHIP=Lebenspartnerschaft

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 (Beschäftigungsverhältnis )

  • CIVIL_SERVANT
  • EMPLOYED
  • FREELANCER
  • PENSIONER
  • SELFEMPLOYED
  • UNEMPLOYED
  • WORKER
  • HOUSEWIFE

lead.contactRequest.secondBorrower.workContractType (Vertragsverhältnis)

  • LIMITED
  • PERMANENT
  • PROBATION

lead.contactRequest.secondBorrower.workContractEndDate (Befristet bis)

lead.contactRequest.secondBorrower.maritalStatus (Familienstand)

 

Income (1st borrower)

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)

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)

 

Income (2nd borrower)

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)

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

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 (Haustyp)

  • APARTMENT_BUY=Wohnung
  • HOUSE_BUY=Haus
  • LIVING_BUY_SITE=Grundstück

lead.contactRequest.financingObject.subType (Wohnungstyp)

  • 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

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.requestType 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.objectId optional optional
lead.contactRequest.netIncome optional mandatory
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.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.contactRquest.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.realEstate optional optional
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