enter/personen

Liefert als Ergebnis eine URL, die direkt zur Kundenauswahl im Tool führt.

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/hug/external/enter/personen

Schema: GET https://bankathon.fb-xpert.fb-preview.de/hug/external/enter/personen/request/schema

Validation: POST https://bankathon.fb-xpert.fb-preview.de/hug/external/enter/personen/validate


property default description options
[ token ] * required
string
Token für die Authentifizierung mit der Schnittstelle
[ separate_token ]
bool
false
Steuert, ob der Token als separates Feld zurückgegeben wird oder in der aufzurufenden Url enthalten ist. Standardmäßig wird er in der Url zurückgegeben.
[ publisher_subscribe_url ]
string
URL die bei bestimmten Aktionen, welche der Anwender in der Oberfläche ausführt, per POST aufgerufen wird.
Hier klicken für weitere Details...
[ exit_url ]
string
URL, welche beim Verlassen des Tools per Redirect (HTTP 302) aufgerufen wird.
[ auto_profession ]
bool
true
Steuert, ob die automatische Berufezuordnung ausgeführt werden soll

object
individuelle Rückgabedaten
property default description options
passbackdata[ download_doctypes_blacklist ]
string[]
Liste der Dokumententypen, die nicht heruntergeladen werden können (auf der Seite Antrag)
Value Label
DOC_BEDINGUNGEN Bedingungen
DOC_ANGEBOT Angebot
DOC_ANTRAG Antrag
DOC_ANGEBOTSMODELL Angebotsmodell
DOC_ANTRAGSMODELL Antragsmodell
DOC_SEPA_MANDAT SEPA-Mandat
DOC_QR_CODE QR Code
DOC_GESUNDHEITSFRAGEN Gesundheitsfragen

array

anyOf: Mehrere verschiedene Subschemas können angegeben werden

property default description options
personen[ customerid ]
int
0
interne ID des ausgewählten Kunden
personen[ alter ]
int
Alter des Kunden
personen[ role ] * required
enumeration
VERSICHERUNGSNEHMER
Rolle der Person. Es darf nur einen Versicherungsnehmer geben.
Value Label
VERSICHERUNGSNEHMER Versicherungsnehmer
personen[ referenz_id ]
string
Eine optionale Fremd-Id für den übergebenen Kunden
personen[ anrede ]
string
Anrede
Value Label
Herr Herr
Frau Frau
personen[ geschlecht ]
enumeration
Geschlecht (required, wenn anrede=Firma)
Value Label
MAENNLICH Herr
WEIBLICH Frau
personen[ titel ]
string
Titel
personen[ vorname ] * required
string
Vorname
personen[ nachname ] * required
string
Nachname
personen[ geburtsdatum ] * required
date_de
maxlength: 10 
Geburtsdatum
personen[ postleitzahl ]
string
maxlength: 5 
Postleitzahl
personen[ ort ]
string
maxlength: 30 
Ort
personen[ strasse ]
string
Straße
personen[ hausnummer ]
string
Hausnummer
personen[ land ]
string
Land des Ortes
Value Label
AFG Afghanistan
AL Albanien
GBA Alderney
DZ Algerien
AND Andorra
ANG Angola
AG Antigua und Barbuda
RA Argentinien
AM Armenien
ARU Aruba
AZ Aserbaidschan
AUS Australien
BS Bahamas
BRN Bahrain
BD Bangladesch
BDS Barbados
BY Belarus (Weißrussland)
B Belgien
BH Belize
DY Benin
BHT Bhutan
BOL Bolivien
BIH Bosnien und Herzegowina
BW Botswana
BR Brasilien
BRU Brunei Darussalam
BG Bulgarien
BF Burkina Faso
RU Burundi
RCH Chile
VR China / Volksrepublik
CR Costa Rica
CW Curacao
D Deutschland
WD Dominica
DOM Dominikanische Republik
DJI Dschibuti
DK Dänemark
EC Ecuador
ES El Salvador
CI Elfenbeinküste
ER Eritrea
EST Estland
FJI Fidschi
FIN Finnland
F Frankreich
FR Färöer
FSM Föderierte Staaten von Mikronesien
G Gabun
WAG Gambia
GE Georgien
GH Ghana
GBZ Gibraltar
WG Grenada
GR Griechenland
GCA Guatemala
GBG Guernsey
RG Guinea
GUB Guinea-Bissau
GUY Guyana
RH Haiti
HN Honduras
HK Hongkong
IND Indien
RI Indonesien
GBM Insel Man
IRQ Irak
IR Iran
IRL Irland
IS Island
IL Israel
I Italien
JA Jamaika
J Japan
YEM Jemen
GBJ Jersey
HKJ Jordanien
YU Jugoslawien
K Kambodscha
CAM Kamerun
CDN Kanada
CV Kap Verde
KZ Kasachstan
Q Katar
EAK Kenia
KS Kirgistan
KI Kiribati
CCK Kokosinseln
CO Kolumbien
COM Komoren
ZRE Kongo / Demokratische Republik (ehem. Zaire)
RCB Kongo / Republik
KP Korea / Demokratische Volksrepublik (Nordkorea)
ROK Korea / Republik (Südkorea)
RKS Kosovo
HR Kroatien
CU Kuba
KWT Kuwait
LAO Laos
LS Lesotho
LV Lettland
RL Libanon
LB Liberia
LAR Libyen
FL Liechtenstein
LT Litauen
L Luxemburg
MAC Macao
RM Madagaskar
MW Malawi
MAL Malaysia
MV Malediven
RMM Mali
M Malta
MA Marokko
MH Marshallinseln
RIM Mauretanien
MS Mauritius
MK Mazedonien
MEX Mexiko
MD Moldau
MC Monaco
MGL Mongolei
MNE Montenegro
MOC Mosambik
BUR Myanmar (Burma)
NAM Namibia
NAU Nauru
NEP Nepal
NZ Neuseeland
NIC Nicaragua
NA Niederl. Antillen
NL Niederlande
RN Niger
WAN Nigeria
NIU Niue
N Norwegen
NMA Nördliche Marianen
OM Oman
PK Pakistan
PAL Palau
- Palästinensische Autonomiegebiete
PA Panama
PNG Papua-Neuguinea
PY Paraguay
PE Peru
RP Philippinen
PL Polen
P Portugal
RWA Ruanda
RO Rumänien
RUS Russland
SOL Salomonen
RNR Sambia
WS Samoa
RSM San Marino
WL Santa Lucia
SA Saudi-Arabien
S Schweden
CH Schweiz
SN Senegal
SRB Serbien
SY Seychellen
WAL Sierra Leone
ZW Simbabwe
SGP Singapur
SK Slowakei
SLO Slowenien
SO Somalia
E Spanien
CL Sri Lanka
SCN St. Kitts und Nevis
SXM St. Maarten
WV St. Vincent und die Grenadinen
SUD Sudan
SME Suriname
SD Swasiland
SYR Syrien
STP São Tomé und Príncipe
ZA Südafrika
TJ Tadschikistan
RC Taiwan (Formosa)
EAT Tansania
T Thailand
TL Timor-Leste
TG Togo
TON Tonga
TT Trinidad und Tobago
TD Tschad
CZ Tschechische Republik
TN Tunesien
TM Turkmenistan
TUC Turks- und Caicosinseln
TUV Tuvalu
TR Türkei
EAU Uganda
UA Ukraine
H Ungarn
ROU Uruguay
UZ Usbekistan
VAN Vanuatu
V Vatikanstadt
YV Venezuela
UAE Vereinigte Arabische Emirate
USA Vereinigte Staaten von Amerika
GB Vereinigtes Königreich Großbritannien
VN Vietnam
RCA Zentralafrikanische Republik
CY Zypern
ET Ägypten
GQ Äquatorialguinea
ETH Äthiopien
A Österreich
personen[ lebenssituation ]
enumeration
Lebenssituation
Value Label
Familie Familie/ Partnerschaft mit Kind
Partnerschaft Familie/ Partnerschaft ohne Kind
Alleinerziehend Alleinerziehend
Single Single
personen[ familienstandid ]
enumeration
Familienstand
Value Label
Eheaehnlichegemeinschaft Eheähnliche Gemeinschaft
Geschieden geschieden
Getrenntlebend getrennt lebend
Ledig ledig
Verheiratet verheiratet
Verwitwet verwitwet
personen[ birthplace ]
string
Geburtsort
personen[ country_of_birth ]
string
Geburtsland
Value Label
AFG Afghanistan
AL Albanien
GBA Alderney
DZ Algerien
AND Andorra
ANG Angola
AG Antigua und Barbuda
RA Argentinien
AM Armenien
ARU Aruba
AZ Aserbaidschan
AUS Australien
BS Bahamas
BRN Bahrain
BD Bangladesch
BDS Barbados
BY Belarus (Weißrussland)
B Belgien
BH Belize
DY Benin
BHT Bhutan
BOL Bolivien
BIH Bosnien und Herzegowina
BW Botswana
BR Brasilien
BRU Brunei Darussalam
BG Bulgarien
BF Burkina Faso
RU Burundi
RCH Chile
VR China / Volksrepublik
CR Costa Rica
CW Curacao
D Deutschland
WD Dominica
DOM Dominikanische Republik
DJI Dschibuti
DK Dänemark
EC Ecuador
ES El Salvador
CI Elfenbeinküste
ER Eritrea
EST Estland
FJI Fidschi
FIN Finnland
F Frankreich
FR Färöer
FSM Föderierte Staaten von Mikronesien
G Gabun
WAG Gambia
GE Georgien
GH Ghana
GBZ Gibraltar
WG Grenada
GR Griechenland
GCA Guatemala
GBG Guernsey
RG Guinea
GUB Guinea-Bissau
GUY Guyana
RH Haiti
HN Honduras
HK Hongkong
IND Indien
RI Indonesien
GBM Insel Man
IRQ Irak
IR Iran
IRL Irland
IS Island
IL Israel
I Italien
JA Jamaika
J Japan
YEM Jemen
GBJ Jersey
HKJ Jordanien
YU Jugoslawien
K Kambodscha
CAM Kamerun
CDN Kanada
CV Kap Verde
KZ Kasachstan
Q Katar
EAK Kenia
KS Kirgistan
KI Kiribati
CCK Kokosinseln
CO Kolumbien
COM Komoren
ZRE Kongo / Demokratische Republik (ehem. Zaire)
RCB Kongo / Republik
KP Korea / Demokratische Volksrepublik (Nordkorea)
ROK Korea / Republik (Südkorea)
RKS Kosovo
HR Kroatien
CU Kuba
KWT Kuwait
LAO Laos
LS Lesotho
LV Lettland
RL Libanon
LB Liberia
LAR Libyen
FL Liechtenstein
LT Litauen
L Luxemburg
MAC Macao
RM Madagaskar
MW Malawi
MAL Malaysia
MV Malediven
RMM Mali
M Malta
MA Marokko
MH Marshallinseln
RIM Mauretanien
MS Mauritius
MK Mazedonien
MEX Mexiko
MD Moldau
MC Monaco
MGL Mongolei
MNE Montenegro
MOC Mosambik
BUR Myanmar (Burma)
NAM Namibia
NAU Nauru
NEP Nepal
NZ Neuseeland
NIC Nicaragua
NA Niederl. Antillen
NL Niederlande
RN Niger
WAN Nigeria
NIU Niue
N Norwegen
NMA Nördliche Marianen
OM Oman
PK Pakistan
PAL Palau
- Palästinensische Autonomiegebiete
PA Panama
PNG Papua-Neuguinea
PY Paraguay
PE Peru
RP Philippinen
PL Polen
P Portugal
RWA Ruanda
RO Rumänien
RUS Russland
SOL Salomonen
RNR Sambia
WS Samoa
RSM San Marino
WL Santa Lucia
SA Saudi-Arabien
S Schweden
CH Schweiz
SN Senegal
SRB Serbien
SY Seychellen
WAL Sierra Leone
ZW Simbabwe
SGP Singapur
SK Slowakei
SLO Slowenien
SO Somalia
E Spanien
CL Sri Lanka
SCN St. Kitts und Nevis
SXM St. Maarten
WV St. Vincent und die Grenadinen
SUD Sudan
SME Suriname
SD Swasiland
SYR Syrien
STP São Tomé und Príncipe
ZA Südafrika
TJ Tadschikistan
RC Taiwan (Formosa)
EAT Tansania
T Thailand
TL Timor-Leste
TG Togo
TON Tonga
TT Trinidad und Tobago
TD Tschad
CZ Tschechische Republik
TN Tunesien
TM Turkmenistan
TUC Turks- und Caicosinseln
TUV Tuvalu
TR Türkei
EAU Uganda
UA Ukraine
H Ungarn
ROU Uruguay
UZ Usbekistan
VAN Vanuatu
V Vatikanstadt
YV Venezuela
UAE Vereinigte Arabische Emirate
USA Vereinigte Staaten von Amerika
GB Vereinigtes Königreich Großbritannien
VN Vietnam
RCA Zentralafrikanische Republik
CY Zypern
ET Ägypten
GQ Äquatorialguinea
ETH Äthiopien
A Österreich
personen[ citizenship ]
enumeration
Staatsangehörigkeit
Value Label
Bitte wählen
DEUTSCH deutsch
OESTERREICHISCH österreichisch
AFGHANISCH afghanisch
AEGYPTISCH ägyptisch
ALBANISCH albanisch
ALDERNEY alderney
ALGERISCH algerisch
ANDORRANISCH andorranisch
ANGOLANISCH angolanisch
ANTIGUANISCH antiguanisch
AEQUATORIAL_GUINEISCH äquatorialguinisch
ARGENTINISCH argentinisch
ARMENISCH armenisch
ARUBA aruba
ASERBAIDSCHANISCH aserbaidschanisch
AETHIOPISCH äthiopisch
AUSTRALISCH australisch
BAHAMISCH bahamisch
BAHRAINISCH bahrainisch
BANGLADESISCH bangladesisch
BARBADISCH barbadisch
BELARUSSISCH belarussisch
BELGISCH belgisch
BELIZISCH belizisch
BENINISCH beninisch
BHUTANISCH bhutanisch
BOLIVIANISCH bolivianisch
BOSNISCH_HERZEGOWINISCH bosnisch-herzegowinisch
BOTSWANISCH botswanisch
BRASILIANISCH brasilianisch
BRUNEIISCH bruneiisch
BULGARISCH bulgarisch
BURKINISCH burkinisch
BURUNDISCH burundisch
CHILENISCH chilenisch
CHINESISCH chinesisch
COSTARICANISCH costaricanisch
CURACAO curacao
DAENISCH dänisch
DOMINICANISCH dominicanisch
DOMINIKANISCH dominikanisch
DSCHIBUTISCH dschibutisch
ECUADORIANISCH ecuadorianisch
SALVADORIANISCH salvadorianisch
ELFENBEINKUESTE ivorisch (Elfenbeinküste)
ERITREISCH eritreisch
ESTNISCH estnisch
FAEROEISCH färöisch
FIDSCHIANISCH fidschianisch
FINNISCH finnisch
MIKRONESISCH mikronesisch
FRANZOESISCH französisch
GABUNISCH gabunisch
GAMBISCH gambisch
GEORGISCH georgisch
GHANAISCH ghanaisch
GIBRALTARISCH gibraltarisch
GRENADINISCH grenadinisch
GRIECHISCH griechisch
GUATEMALTEKISCH guatemaltekisch
GUERNSEY guernsey
GUINEISCH guineisch
GUINEA_BISSAUISCH guinea-bissauisch
GUYANISCH guyanisch
HAITIANISCH haitianisch
HONDURANISCH honduranisch
HONGKONG chinesisch (Hongkonger)
INDISCH indisch
INDONESISCH indonesisch
INSEL_MAN Insel Man
IRAKISCH irakisch
IRANISCH iranisch
IRISCH irisch
ISLAENDISCH isländisch
ISRAELISCH israelisch
ITALIENISCH italienisch
JAMAIKANISCH jamaikanisch
JAPANISCH japanisch
JEMENITISCH jemenitisch
JERSEY britisch (Jersey)
JORDANISCH jordanisch
JUGOSLAWISCH jugoslawisch
KAMBODSCHANISCH kambodschanisch
KAMERUNISCH kamerunisch
KANADISCH kanadisch
KAPVERDISCH kapverdisch
KASACHISCH kasachisch
KATARISCH katarisch
KENIANISCH kenianisch
KIRGISISCH kirgisisch
KIRIBATISCH kiribatisch
KOKOSINSELN kokos-malayisch
KOLUMBIANISCH kolumbianisch
KOMORISCH komorisch
KONGOLESISCH_DR kongolesisch (Demokratische Republik)
KONGOLESISCH kongolesisch (Republik)
NORDKOREANISCH nordkoreanisch
SUEDKOREANISCH südkoreanisch
KOSOVARISCH kosovarisch
KROATISCH kroatisch
KUBANISCH kubanisch
KUWAITISCH kuwaitisch
LAOTISCH laotisch
LESOTHISCH lesothisch
LETTISCH lettisch
LIBANESISCH libanesisch
LIBERIANISCH liberianisch
LIBYSCH libysch
LIECHTENSTEINISCH liechtensteinisch
LITAUISCH litauisch
LUXEMBURGISCH luxemburgisch
MACAOISCH macaoisch
MADAGASSISCH madagassisch
MALAWISCH malawisch
MALAYSISCH malaysisch
MALEDIVISCH maledivisch
MALISCH malisch
MALTESISCH maltesisch
MAROKKANISCH marokkanisch
MARSHALLISCH marshallisch
MAURETANISCH mauretanisch
MAURITISCH mauritisch
MAZEDONISCH mazedonisch
MEXIKANISCH mexikanisch
MOLDAUISCH moldauisch
MONEGASSISCH monegassisch
MONGOLISCH mongolisch
MONTENEGRINISCH montenegrinisch
MOSAMBIKANISCH mosambikanisch
MYANMARISCH_BURMESISCH myanmarisch burmesisch
NAMIBISCH namibisch
NAURISCH naurisch
NEPALESISCH nepalesisch
NEUSEELAENDISCH neuseeländisch
NICARAGUANISCH nicaraguanisch
NIEDERL_ANTILLEN niederländisch (Antillen)
NIEDERLAENDISCH niederländisch
NIGRISCH nigrisch
NIGERIANISCH nigerianisch
NIUEANISCH niueanisch
NOERDLICHE_MARIANEN mikronesisch polynesisch (Nördliche Marianen)
NORWEGISCH norwegisch
OMANISCH omanisch
PAKISTANISCH pakistanisch
PALÄSTINENSISCHE_AUTONOMIEGEBIETE arabisch (Palästinensische Autonomiegebiete)
PALAUISCH palauisch
PANAMAISCH panamaisch
PAPUA_NEUGUINEISCH papua-neuguineisch
PARAGUAYISCH paraguayisch
PERUANISCH peruanisch
PHILIPPINISCH philippinisch
POLNISCH polnisch
PORTUGIESISCH portugiesisch
RUANDISCH ruandisch
RUMAENISCH rumänisch
RUSSISCH russisch
SALOMONISCH salomonisch
SAMBISCH sambisch
SAMOANISCH samoanisch
SAN_MARINESISCH san-marinesisch
LUCIANISCH lucianisch
SAO_TOMAEISCH portugiesisch (São Tomé und Príncipe)
SAUDI_ARABISCH saudi-arabisch
SCHWEDISCH schwedisch
SCHWEIZERISCH schweizerisch
SENEGALESISCH senegalesisch
SERBISCH serbisch
SEYCHELLISCH seychellisch
SIERRA_LEONISCH sierra-leonisch
SIMBABWISCH simbabwisch
SINGAPURISCH singapurisch
SLOWAKISCH slowakisch
SLOWENISCH slowenisch
SOMALISCH somalisch
SPANISCH spanisch
SRI_LANKISCH sri-lankisch
ST_KITTS_UND_NEVIS britisch (St. Kitts und Nevis)
ST_MAARTEN niederländisch (St. Maarten)
VINCENTISCH vincentisch
SUEDAFRIKANISCH südafrikanisch
SUDANESISCH sudanesisch
SURINAMISCH surinamisch
SWASILAENDISCH swasiländisch
SYRISCH syrisch
TADSCHIKISCH tadschikisch
TAIWANESISCH taiwanesisch
TANSANISCH tansanisch
THAILAENDISCH thailändisch
TIMOR_LESTE tetum/portugisisch (Timor-Leste)
TOGOISCH togoisch
TONGAISCH tongaisch
TRINIDAD_TOBAGO britisch (Trinidad und Tobago)
TSCHADISCH tschadisch
TSCHECHISCH tschechisch
TUNESISCH tunesisch
TUERKISCH tuerkisch
TURKMENISCH turkmenisch
TURKS_UND_CAICOSINSELN britisch (Turks- und Caicosinseln)
TUVALUISCH tuvaluisch
UGANDISCH ugandisch
UKRAINISCH ukrainisch
UNGARISCH ungarisch
URUGUAYISCH uruguayisch
USBEKISCH usbekisch
VANUATUISCH vanuatuisch
VATIKANISCH vatikanisch
VENEZOLANISCH venezolanisch
VEREINIGTE_ARABISCHE_EMIRATE arabische (Vereinigte Arabische Emirate)
BRITISCH britisch
AMERIKANISCH amerikanisch
VIETNAMESISCH vietnamesisch
ZENTRALAFRIKANISCH zentralafrikanisch
ZYPRISCH zyprisch
personen[ email ]
string
E-Mail
personen[ telefon_vorwahl ]
string
maxlength: 6 
Ortsvorwahl (ohne Ländervorwahl)
personen[ telefon ]
string
maxlength: 15 
Rufnummer (ohne Vorwahl)
personen[ raucher ]
bool
Raucherstatus
Value Label
true ja
false nein
personen[ nichtraucher_seit ]
string
10
Nichtraucher seit wie vielen Jahren? (nur relevant wenn Nichtraucher)
Value Label
1 weniger als 10 Jahren
10 10 Jahren oder länger
personen[ groesse ]
int
maxlength: 3 min: 30 max: 250 
Größe in cm
personen[ gewicht ]
int
maxlength: 3 min: 1 max: 250 
Gewicht in kg
personen[ designation ]
string
Berufsbezeichnung
personen[ berufsstatus_id ]
int
Berufsstatus
Value Label
0 Angestellter
1 Beamter
2 Angestellter des öff. Dienstes
3 Selbständiger
4 Selbständiger Handwerker
5 Freiberufler
7 Schüler
8 Hausfrau/Hausmann
9 Rentner/Senior/Pension
10 Auszubildender
11 Nicht erwerbstätig
12 Kind
13 ohne Einkommen
15 Gesellschafter GF
16 Vorstand
17 Gesellschafter GF mit Pensionszusage
18 Soldat
19 Student
personen[ beamtenstatus ]
enumeration
Beamtenstatus (relevant wenn berufsstatus_id = 1)
Value Label
AUF_LEBENSZEIT Beamter auf Lebenszeit
AUF_PROBE Beamter auf Probe
AUF_WIDERRUF Beamter auf Widerruf
personen[ salery_grade ]
enumeration
Besoldungsgruppe (u.a. für Beamte und Soldaten, relevant wenn berufsstatus_id = 1 oder 18)
Value Label
A2 A2
A3 A3
A4 A4
A5 A5
A6 A6
A7 A7
A8 A8
A9 A9
A10 A10
A11 A11
A12 A12
A13 A13
A14 A14
A15 A15
A16 A16
B1 B1
B2 B2
B3 B3
B4 B4
B5 B5
B6 B6
B7 B7
B8 B8
B9 B9
B10 B10
B11 B11
W1 W1
W2 W2
W3 W3
R1 R1
R2 R2
R3 R3
R4 R4
R5 R5
R6 R6
R7 R7
R8 R8
R9 R9
R10 R10
personen[ selbststaendigseit ]
date_de
Beginn der Selbstständigkeit (TT.MM.JJJJ) (relevant wenn berufsstatus_id = 3,4,5)
personen[ ausbildungsstatus ]
string
höchster Bildungsabschluss: required, wenn berufsstatus_id != 7, 12
Value Label
AbgeschlossenesStudium abgeschlossenes Studium
Abitur Abitur
Fachabitur Fachabitur
MittlereReife Realschulabschluss/Mittlere Reife
AllgemeinbildenderSchulabschluss (qualifizierter) Hauptschulabschluss
OhneAbschluss kein Abschluss
personen[ akademischer_abschluss ]
string
Definition Studium: nur nötig bei AbgeschlossenesStudium unter ausbildungsstatus
Value Label
Bachelor Bachelor
Master Master
Diplom Diplom
Magister Magister
Staatsexamen Staatsexamen
Doktor Doktor
personen[ professional_training ]
string
required, wenn berufsstatus_id != 7, 12 und wenn ausbildungsstatus != OhneAbschluss
Value Label
AbgeschlAusbildung abgeschlossene Ausbildung
AbschlussUniFH abgeschlossenes Studium
Meister Meister
Techniker Techniker
Betriebswirt Fach-/Betriebswirt
Unbestimmt keine oder noch nicht abgeschlossene Berufsausbildung
personen[ definition_professional_training ]
string
Definition Ausbildung (fällt weg, wenn berufsstatus_id = 7, 12, wenn ausbildungsstatus = OhneAbschluss oder wenn professional_training = Unbestimmt)
Value Label
AbgeschlosseneKaufmaennische kaufmännische Ausbildung
AbgeschlosseneHandwerkliche handwerkliche Ausbildung
AbgeschlosseneIndustrielle industrielle Ausbildung
Kurzausbildung Kurzausbildung
Sonstige sonstige Ausbildung
personen[ employment_mode ]
int
1
Art des Beschäftigungsverhältnisses
Value Label
1 Vollzeit
2 Teilzeit
3 Geringfügig
4 saisonal
personen[ staff_responsibility ]
int
maxlength: 5 
0
Anzahl Personalverantwortung
personen[ max_physical_work ]
int
min: 0 max: 100 
0
Ausprägung der körperlichen Tätigkeit in %
personen[ max_office_work ]
int
min: 0 max: 100 
100
Ausprägung der kaufmännischen (Büro-) Tätigkeit in %
personen[ business_travel ]
int
maxlength: 3 max: 100 
0
Reisetätigkeit in %
personen[ vorjahreseinkommen ]
int
maxlength: 10 
Vorjahresbruttoeinkommen in €
personen[ after_tax_income ]
int
maxlength: 10 
Vorjahresnettoeinkommen in €
personen[ kontoinhaber ]
string
Vor- und Nachname des Kontoinhabers
personen[ iban ]
string
IBAN
personen[ bic ]
string
BIC
personen[ geldinstitut ]
string
Name des Geldinstituts
personen[ sitz_geldinstitut ]
string
Sitz des Geldinstituts

object
Informationen zu den Ausweisdaten
property default description options
identity_card[ type ] * required
string
PERSONALAUSWEIS
Angaben zum Ausweistyp
Value Label
KEINE_ANGABE Keine Angabe
PERSONALAUSWEIS Personalausweis
REISEPASS Reisepass
SONSTIGER Sonstiger
identity_card[ number ] * required
string
Ausweisnummer
identity_card[ expiry_date ] * required
date
Verfallsdatum des Ausweises
identity_card[ issued_on ] * required
date
Ausstelldatum des Ausweises
identity_card[ issuing_authority ]
string
Angaben zur ausstellenden Behörde des Ausweises
identity_card[ country_code ]
string
D
Länderkennzeichen
Value Label
AFG Afghanistan
AL Albanien
GBA Alderney
DZ Algerien
AND Andorra
ANG Angola
AG Antigua und Barbuda
RA Argentinien
AM Armenien
ARU Aruba
AZ Aserbaidschan
AUS Australien
BS Bahamas
BRN Bahrain
BD Bangladesch
BDS Barbados
BY Belarus (Weißrussland)
B Belgien
BH Belize
DY Benin
BHT Bhutan
BOL Bolivien
BIH Bosnien und Herzegowina
BW Botswana
BR Brasilien
BRU Brunei Darussalam
BG Bulgarien
BF Burkina Faso
RU Burundi
RCH Chile
VR China / Volksrepublik
CR Costa Rica
CW Curacao
D Deutschland
WD Dominica
DOM Dominikanische Republik
DJI Dschibuti
DK Dänemark
EC Ecuador
ES El Salvador
CI Elfenbeinküste
ER Eritrea
EST Estland
FJI Fidschi
FIN Finnland
F Frankreich
FR Färöer
FSM Föderierte Staaten von Mikronesien
G Gabun
WAG Gambia
GE Georgien
GH Ghana
GBZ Gibraltar
WG Grenada
GR Griechenland
GCA Guatemala
GBG Guernsey
RG Guinea
GUB Guinea-Bissau
GUY Guyana
RH Haiti
HN Honduras
HK Hongkong
IND Indien
RI Indonesien
GBM Insel Man
IRQ Irak
IR Iran
IRL Irland
IS Island
IL Israel
I Italien
JA Jamaika
J Japan
YEM Jemen
GBJ Jersey
HKJ Jordanien
YU Jugoslawien
K Kambodscha
CAM Kamerun
CDN Kanada
CV Kap Verde
KZ Kasachstan
Q Katar
EAK Kenia
KS Kirgistan
KI Kiribati
CCK Kokosinseln
CO Kolumbien
COM Komoren
ZRE Kongo / Demokratische Republik (ehem. Zaire)
RCB Kongo / Republik
KP Korea / Demokratische Volksrepublik (Nordkorea)
ROK Korea / Republik (Südkorea)
RKS Kosovo
HR Kroatien
CU Kuba
KWT Kuwait
LAO Laos
LS Lesotho
LV Lettland
RL Libanon
LB Liberia
LAR Libyen
FL Liechtenstein
LT Litauen
L Luxemburg
MAC Macao
RM Madagaskar
MW Malawi
MAL Malaysia
MV Malediven
RMM Mali
M Malta
MA Marokko
MH Marshallinseln
RIM Mauretanien
MS Mauritius
MK Mazedonien
MEX Mexiko
MD Moldau
MC Monaco
MGL Mongolei
MNE Montenegro
MOC Mosambik
BUR Myanmar (Burma)
NAM Namibia
NAU Nauru
NEP Nepal
NZ Neuseeland
NIC Nicaragua
NA Niederl. Antillen
NL Niederlande
RN Niger
WAN Nigeria
NIU Niue
N Norwegen
NMA Nördliche Marianen
OM Oman
PK Pakistan
PAL Palau
- Palästinensische Autonomiegebiete
PA Panama
PNG Papua-Neuguinea
PY Paraguay
PE Peru
RP Philippinen
PL Polen
P Portugal
RWA Ruanda
RO Rumänien
RUS Russland
SOL Salomonen
RNR Sambia
WS Samoa
RSM San Marino
WL Santa Lucia
SA Saudi-Arabien
S Schweden
CH Schweiz
SN Senegal
SRB Serbien
SY Seychellen
WAL Sierra Leone
ZW Simbabwe
SGP Singapur
SK Slowakei
SLO Slowenien
SO Somalia
E Spanien
CL Sri Lanka
SCN St. Kitts und Nevis
SXM St. Maarten
WV St. Vincent und die Grenadinen
SUD Sudan
SME Suriname
SD Swasiland
SYR Syrien
STP São Tomé und Príncipe
ZA Südafrika
TJ Tadschikistan
RC Taiwan (Formosa)
EAT Tansania
T Thailand
TL Timor-Leste
TG Togo
TON Tonga
TT Trinidad und Tobago
TD Tschad
CZ Tschechische Republik
TN Tunesien
TM Turkmenistan
TUC Turks- und Caicosinseln
TUV Tuvalu
TR Türkei
EAU Uganda
UA Ukraine
H Ungarn
ROU Uruguay
UZ Usbekistan
VAN Vanuatu
V Vatikanstadt
YV Venezuela
UAE Vereinigte Arabische Emirate
USA Vereinigte Staaten von Amerika
GB Vereinigtes Königreich Großbritannien
VN Vietnam
RCA Zentralafrikanische Republik
CY Zypern
ET Ägypten
GQ Äquatorialguinea
ETH Äthiopien
A Österreich
identity_card[ original_document ]
bool
Ausweis lag im Original vor (ja / nein)
identity_card[ copy_attached ]
bool
Kopie des vorgelegten Ausweisdokument liegt dem Antrag bei (ja / nein)
personen[ birth_name ]
string
Geburtsname
personen[ tax_identification_number ]
string
Steuer-Identifikationsnummer
personen[ social_insurance_number ]
string
Sozialversicherungsnummer, muss in folgendem Format angegeben werden: 66290250K001

array
Gesellschaftsbezogene Berufsdaten des Kunden
property default description options
professions[ company_id ]
int
GesellschaftsId
professions[ bafin_nr ]
string
Bafinnummer der Gesellschaft
professions[ designation ]
string
Berufsbezeichnung
property default description options
personen[ customerid ]
int
0
interne ID des ausgewählten Kunden
personen[ alter ]
int
Alter des Kunden
personen[ role ] * required
enumeration
BEITRAGSZAHLER
Rolle der Person
Value Label
BEITRAGSZAHLER Beitragszahler
personen[ referenz_id ]
string
Eine optionale Fremd-Id für den übergebenen Kunden
personen[ anrede ]
string
Anrede
Value Label
Herr Herr
Frau Frau
personen[ geschlecht ]
enumeration
Geschlecht (required, wenn anrede=Firma)
Value Label
MAENNLICH Herr
WEIBLICH Frau
personen[ titel ]
string
Titel
personen[ vorname ] * required
string
Vorname
personen[ nachname ] * required
string
Nachname
personen[ geburtsdatum ]
date_de
maxlength: 10 
Geburtsdatum
personen[ postleitzahl ]
string
maxlength: 5 
Postleitzahl
personen[ ort ]
string
maxlength: 30 
Ort
personen[ strasse ]
string
Straße
personen[ hausnummer ]
string
Hausnummer
personen[ land ]
string
Land des Ortes
Value Label
AFG Afghanistan
AL Albanien
GBA Alderney
DZ Algerien
AND Andorra
ANG Angola
AG Antigua und Barbuda
RA Argentinien
AM Armenien
ARU Aruba
AZ Aserbaidschan
AUS Australien
BS Bahamas
BRN Bahrain
BD Bangladesch
BDS Barbados
BY Belarus (Weißrussland)
B Belgien
BH Belize
DY Benin
BHT Bhutan
BOL Bolivien
BIH Bosnien und Herzegowina
BW Botswana
BR Brasilien
BRU Brunei Darussalam
BG Bulgarien
BF Burkina Faso
RU Burundi
RCH Chile
VR China / Volksrepublik
CR Costa Rica
CW Curacao
D Deutschland
WD Dominica
DOM Dominikanische Republik
DJI Dschibuti
DK Dänemark
EC Ecuador
ES El Salvador
CI Elfenbeinküste
ER Eritrea
EST Estland
FJI Fidschi
FIN Finnland
F Frankreich
FR Färöer
FSM Föderierte Staaten von Mikronesien
G Gabun
WAG Gambia
GE Georgien
GH Ghana
GBZ Gibraltar
WG Grenada
GR Griechenland
GCA Guatemala
GBG Guernsey
RG Guinea
GUB Guinea-Bissau
GUY Guyana
RH Haiti
HN Honduras
HK Hongkong
IND Indien
RI Indonesien
GBM Insel Man
IRQ Irak
IR Iran
IRL Irland
IS Island
IL Israel
I Italien
JA Jamaika
J Japan
YEM Jemen
GBJ Jersey
HKJ Jordanien
YU Jugoslawien
K Kambodscha
CAM Kamerun
CDN Kanada
CV Kap Verde
KZ Kasachstan
Q Katar
EAK Kenia
KS Kirgistan
KI Kiribati
CCK Kokosinseln
CO Kolumbien
COM Komoren
ZRE Kongo / Demokratische Republik (ehem. Zaire)
RCB Kongo / Republik
KP Korea / Demokratische Volksrepublik (Nordkorea)
ROK Korea / Republik (Südkorea)
RKS Kosovo
HR Kroatien
CU Kuba
KWT Kuwait
LAO Laos
LS Lesotho
LV Lettland
RL Libanon
LB Liberia
LAR Libyen
FL Liechtenstein
LT Litauen
L Luxemburg
MAC Macao
RM Madagaskar
MW Malawi
MAL Malaysia
MV Malediven
RMM Mali
M Malta
MA Marokko
MH Marshallinseln
RIM Mauretanien
MS Mauritius
MK Mazedonien
MEX Mexiko
MD Moldau
MC Monaco
MGL Mongolei
MNE Montenegro
MOC Mosambik
BUR Myanmar (Burma)
NAM Namibia
NAU Nauru
NEP Nepal
NZ Neuseeland
NIC Nicaragua
NA Niederl. Antillen
NL Niederlande
RN Niger
WAN Nigeria
NIU Niue
N Norwegen
NMA Nördliche Marianen
OM Oman
PK Pakistan
PAL Palau
- Palästinensische Autonomiegebiete
PA Panama
PNG Papua-Neuguinea
PY Paraguay
PE Peru
RP Philippinen
PL Polen
P Portugal
RWA Ruanda
RO Rumänien
RUS Russland
SOL Salomonen
RNR Sambia
WS Samoa
RSM San Marino
WL Santa Lucia
SA Saudi-Arabien
S Schweden
CH Schweiz
SN Senegal
SRB Serbien
SY Seychellen
WAL Sierra Leone
ZW Simbabwe
SGP Singapur
SK Slowakei
SLO Slowenien
SO Somalia
E Spanien
CL Sri Lanka
SCN St. Kitts und Nevis
SXM St. Maarten
WV St. Vincent und die Grenadinen
SUD Sudan
SME Suriname
SD Swasiland
SYR Syrien
STP São Tomé und Príncipe
ZA Südafrika
TJ Tadschikistan
RC Taiwan (Formosa)
EAT Tansania
T Thailand
TL Timor-Leste
TG Togo
TON Tonga
TT Trinidad und Tobago
TD Tschad
CZ Tschechische Republik
TN Tunesien
TM Turkmenistan
TUC Turks- und Caicosinseln
TUV Tuvalu
TR Türkei
EAU Uganda
UA Ukraine
H Ungarn
ROU Uruguay
UZ Usbekistan
VAN Vanuatu
V Vatikanstadt
YV Venezuela
UAE Vereinigte Arabische Emirate
USA Vereinigte Staaten von Amerika
GB Vereinigtes Königreich Großbritannien
VN Vietnam
RCA Zentralafrikanische Republik
CY Zypern
ET Ägypten
GQ Äquatorialguinea
ETH Äthiopien
A Österreich
personen[ birthplace ]
string
Geburtsort
personen[ country_of_birth ]
string
Geburtsland
Value Label
AFG Afghanistan
AL Albanien
GBA Alderney
DZ Algerien
AND Andorra
ANG Angola
AG Antigua und Barbuda
RA Argentinien
AM Armenien
ARU Aruba
AZ Aserbaidschan
AUS Australien
BS Bahamas
BRN Bahrain
BD Bangladesch
BDS Barbados
BY Belarus (Weißrussland)
B Belgien
BH Belize
DY Benin
BHT Bhutan
BOL Bolivien
BIH Bosnien und Herzegowina
BW Botswana
BR Brasilien
BRU Brunei Darussalam
BG Bulgarien
BF Burkina Faso
RU Burundi
RCH Chile
VR China / Volksrepublik
CR Costa Rica
CW Curacao
D Deutschland
WD Dominica
DOM Dominikanische Republik
DJI Dschibuti
DK Dänemark
EC Ecuador
ES El Salvador
CI Elfenbeinküste
ER Eritrea
EST Estland
FJI Fidschi
FIN Finnland
F Frankreich
FR Färöer
FSM Föderierte Staaten von Mikronesien
G Gabun
WAG Gambia
GE Georgien
GH Ghana
GBZ Gibraltar
WG Grenada
GR Griechenland
GCA Guatemala
GBG Guernsey
RG Guinea
GUB Guinea-Bissau
GUY Guyana
RH Haiti
HN Honduras
HK Hongkong
IND Indien
RI Indonesien
GBM Insel Man
IRQ Irak
IR Iran
IRL Irland
IS Island
IL Israel
I Italien
JA Jamaika
J Japan
YEM Jemen
GBJ Jersey
HKJ Jordanien
YU Jugoslawien
K Kambodscha
CAM Kamerun
CDN Kanada
CV Kap Verde
KZ Kasachstan
Q Katar
EAK Kenia
KS Kirgistan
KI Kiribati
CCK Kokosinseln
CO Kolumbien
COM Komoren
ZRE Kongo / Demokratische Republik (ehem. Zaire)
RCB Kongo / Republik
KP Korea / Demokratische Volksrepublik (Nordkorea)
ROK Korea / Republik (Südkorea)
RKS Kosovo
HR Kroatien
CU Kuba
KWT Kuwait
LAO Laos
LS Lesotho
LV Lettland
RL Libanon
LB Liberia
LAR Libyen
FL Liechtenstein
LT Litauen
L Luxemburg
MAC Macao
RM Madagaskar
MW Malawi
MAL Malaysia
MV Malediven
RMM Mali
M Malta
MA Marokko
MH Marshallinseln
RIM Mauretanien
MS Mauritius
MK Mazedonien
MEX Mexiko
MD Moldau
MC Monaco
MGL Mongolei
MNE Montenegro
MOC Mosambik
BUR Myanmar (Burma)
NAM Namibia
NAU Nauru
NEP Nepal
NZ Neuseeland
NIC Nicaragua
NA Niederl. Antillen
NL Niederlande
RN Niger
WAN Nigeria
NIU Niue
N Norwegen
NMA Nördliche Marianen
OM Oman
PK Pakistan
PAL Palau
- Palästinensische Autonomiegebiete
PA Panama
PNG Papua-Neuguinea
PY Paraguay
PE Peru
RP Philippinen
PL Polen
P Portugal
RWA Ruanda
RO Rumänien
RUS Russland
SOL Salomonen
RNR Sambia
WS Samoa
RSM San Marino
WL Santa Lucia
SA Saudi-Arabien
S Schweden
CH Schweiz
SN Senegal
SRB Serbien
SY Seychellen
WAL Sierra Leone
ZW Simbabwe
SGP Singapur
SK Slowakei
SLO Slowenien
SO Somalia
E Spanien
CL Sri Lanka
SCN St. Kitts und Nevis
SXM St. Maarten
WV St. Vincent und die Grenadinen
SUD Sudan
SME Suriname
SD Swasiland
SYR Syrien
STP São Tomé und Príncipe
ZA Südafrika
TJ Tadschikistan
RC Taiwan (Formosa)
EAT Tansania
T Thailand
TL Timor-Leste
TG Togo
TON Tonga
TT Trinidad und Tobago
TD Tschad
CZ Tschechische Republik
TN Tunesien
TM Turkmenistan
TUC Turks- und Caicosinseln
TUV Tuvalu
TR Türkei
EAU Uganda
UA Ukraine
H Ungarn
ROU Uruguay
UZ Usbekistan
VAN Vanuatu
V Vatikanstadt
YV Venezuela
UAE Vereinigte Arabische Emirate
USA Vereinigte Staaten von Amerika
GB Vereinigtes Königreich Großbritannien
VN Vietnam
RCA Zentralafrikanische Republik
CY Zypern
ET Ägypten
GQ Äquatorialguinea
ETH Äthiopien
A Österreich
personen[ citizenship ]
enumeration
Staatsangehörigkeit
Value Label
Bitte wählen
DEUTSCH deutsch
OESTERREICHISCH österreichisch
AFGHANISCH afghanisch
AEGYPTISCH ägyptisch
ALBANISCH albanisch
ALDERNEY alderney
ALGERISCH algerisch
ANDORRANISCH andorranisch
ANGOLANISCH angolanisch
ANTIGUANISCH antiguanisch
AEQUATORIAL_GUINEISCH äquatorialguinisch
ARGENTINISCH argentinisch
ARMENISCH armenisch
ARUBA aruba
ASERBAIDSCHANISCH aserbaidschanisch
AETHIOPISCH äthiopisch
AUSTRALISCH australisch
BAHAMISCH bahamisch
BAHRAINISCH bahrainisch
BANGLADESISCH bangladesisch
BARBADISCH barbadisch
BELARUSSISCH belarussisch
BELGISCH belgisch
BELIZISCH belizisch
BENINISCH beninisch
BHUTANISCH bhutanisch
BOLIVIANISCH bolivianisch
BOSNISCH_HERZEGOWINISCH bosnisch-herzegowinisch
BOTSWANISCH botswanisch
BRASILIANISCH brasilianisch
BRUNEIISCH bruneiisch
BULGARISCH bulgarisch
BURKINISCH burkinisch
BURUNDISCH burundisch
CHILENISCH chilenisch
CHINESISCH chinesisch
COSTARICANISCH costaricanisch
CURACAO curacao
DAENISCH dänisch
DOMINICANISCH dominicanisch
DOMINIKANISCH dominikanisch
DSCHIBUTISCH dschibutisch
ECUADORIANISCH ecuadorianisch
SALVADORIANISCH salvadorianisch
ELFENBEINKUESTE ivorisch (Elfenbeinküste)
ERITREISCH eritreisch
ESTNISCH estnisch
FAEROEISCH färöisch
FIDSCHIANISCH fidschianisch
FINNISCH finnisch
MIKRONESISCH mikronesisch
FRANZOESISCH französisch
GABUNISCH gabunisch
GAMBISCH gambisch
GEORGISCH georgisch
GHANAISCH ghanaisch
GIBRALTARISCH gibraltarisch
GRENADINISCH grenadinisch
GRIECHISCH griechisch
GUATEMALTEKISCH guatemaltekisch
GUERNSEY guernsey
GUINEISCH guineisch
GUINEA_BISSAUISCH guinea-bissauisch
GUYANISCH guyanisch
HAITIANISCH haitianisch
HONDURANISCH honduranisch
HONGKONG chinesisch (Hongkonger)
INDISCH indisch
INDONESISCH indonesisch
INSEL_MAN Insel Man
IRAKISCH irakisch
IRANISCH iranisch
IRISCH irisch
ISLAENDISCH isländisch
ISRAELISCH israelisch
ITALIENISCH italienisch
JAMAIKANISCH jamaikanisch
JAPANISCH japanisch
JEMENITISCH jemenitisch
JERSEY britisch (Jersey)
JORDANISCH jordanisch
JUGOSLAWISCH jugoslawisch
KAMBODSCHANISCH kambodschanisch
KAMERUNISCH kamerunisch
KANADISCH kanadisch
KAPVERDISCH kapverdisch
KASACHISCH kasachisch
KATARISCH katarisch
KENIANISCH kenianisch
KIRGISISCH kirgisisch
KIRIBATISCH kiribatisch
KOKOSINSELN kokos-malayisch
KOLUMBIANISCH kolumbianisch
KOMORISCH komorisch
KONGOLESISCH_DR kongolesisch (Demokratische Republik)
KONGOLESISCH kongolesisch (Republik)
NORDKOREANISCH nordkoreanisch
SUEDKOREANISCH südkoreanisch
KOSOVARISCH kosovarisch
KROATISCH kroatisch
KUBANISCH kubanisch
KUWAITISCH kuwaitisch
LAOTISCH laotisch
LESOTHISCH lesothisch
LETTISCH lettisch
LIBANESISCH libanesisch
LIBERIANISCH liberianisch
LIBYSCH libysch
LIECHTENSTEINISCH liechtensteinisch
LITAUISCH litauisch
LUXEMBURGISCH luxemburgisch
MACAOISCH macaoisch
MADAGASSISCH madagassisch
MALAWISCH malawisch
MALAYSISCH malaysisch
MALEDIVISCH maledivisch
MALISCH malisch
MALTESISCH maltesisch
MAROKKANISCH marokkanisch
MARSHALLISCH marshallisch
MAURETANISCH mauretanisch
MAURITISCH mauritisch
MAZEDONISCH mazedonisch
MEXIKANISCH mexikanisch
MOLDAUISCH moldauisch
MONEGASSISCH monegassisch
MONGOLISCH mongolisch
MONTENEGRINISCH montenegrinisch
MOSAMBIKANISCH mosambikanisch
MYANMARISCH_BURMESISCH myanmarisch burmesisch
NAMIBISCH namibisch
NAURISCH naurisch
NEPALESISCH nepalesisch
NEUSEELAENDISCH neuseeländisch
NICARAGUANISCH nicaraguanisch
NIEDERL_ANTILLEN niederländisch (Antillen)
NIEDERLAENDISCH niederländisch
NIGRISCH nigrisch
NIGERIANISCH nigerianisch
NIUEANISCH niueanisch
NOERDLICHE_MARIANEN mikronesisch polynesisch (Nördliche Marianen)
NORWEGISCH norwegisch
OMANISCH omanisch
PAKISTANISCH pakistanisch
PALÄSTINENSISCHE_AUTONOMIEGEBIETE arabisch (Palästinensische Autonomiegebiete)
PALAUISCH palauisch
PANAMAISCH panamaisch
PAPUA_NEUGUINEISCH papua-neuguineisch
PARAGUAYISCH paraguayisch
PERUANISCH peruanisch
PHILIPPINISCH philippinisch
POLNISCH polnisch
PORTUGIESISCH portugiesisch
RUANDISCH ruandisch
RUMAENISCH rumänisch
RUSSISCH russisch
SALOMONISCH salomonisch
SAMBISCH sambisch
SAMOANISCH samoanisch
SAN_MARINESISCH san-marinesisch
LUCIANISCH lucianisch
SAO_TOMAEISCH portugiesisch (São Tomé und Príncipe)
SAUDI_ARABISCH saudi-arabisch
SCHWEDISCH schwedisch
SCHWEIZERISCH schweizerisch
SENEGALESISCH senegalesisch
SERBISCH serbisch
SEYCHELLISCH seychellisch
SIERRA_LEONISCH sierra-leonisch
SIMBABWISCH simbabwisch
SINGAPURISCH singapurisch
SLOWAKISCH slowakisch
SLOWENISCH slowenisch
SOMALISCH somalisch
SPANISCH spanisch
SRI_LANKISCH sri-lankisch
ST_KITTS_UND_NEVIS britisch (St. Kitts und Nevis)
ST_MAARTEN niederländisch (St. Maarten)
VINCENTISCH vincentisch
SUEDAFRIKANISCH südafrikanisch
SUDANESISCH sudanesisch
SURINAMISCH surinamisch
SWASILAENDISCH swasiländisch
SYRISCH syrisch
TADSCHIKISCH tadschikisch
TAIWANESISCH taiwanesisch
TANSANISCH tansanisch
THAILAENDISCH thailändisch
TIMOR_LESTE tetum/portugisisch (Timor-Leste)
TOGOISCH togoisch
TONGAISCH tongaisch
TRINIDAD_TOBAGO britisch (Trinidad und Tobago)
TSCHADISCH tschadisch
TSCHECHISCH tschechisch
TUNESISCH tunesisch
TUERKISCH tuerkisch
TURKMENISCH turkmenisch
TURKS_UND_CAICOSINSELN britisch (Turks- und Caicosinseln)
TUVALUISCH tuvaluisch
UGANDISCH ugandisch
UKRAINISCH ukrainisch
UNGARISCH ungarisch
URUGUAYISCH uruguayisch
USBEKISCH usbekisch
VANUATUISCH vanuatuisch
VATIKANISCH vatikanisch
VENEZOLANISCH venezolanisch
VEREINIGTE_ARABISCHE_EMIRATE arabische (Vereinigte Arabische Emirate)
BRITISCH britisch
AMERIKANISCH amerikanisch
VIETNAMESISCH vietnamesisch
ZENTRALAFRIKANISCH zentralafrikanisch
ZYPRISCH zyprisch
personen[ salery_grade ]
enumeration
Besoldungsgruppe (u.a. für Beamte und Soldaten, relevant wenn berufsstatus_id = 1 oder 18)
Value Label
A2 A2
A3 A3
A4 A4
A5 A5
A6 A6
A7 A7
A8 A8
A9 A9
A10 A10
A11 A11
A12 A12
A13 A13
A14 A14
A15 A15
A16 A16
B1 B1
B2 B2
B3 B3
B4 B4
B5 B5
B6 B6
B7 B7
B8 B8
B9 B9
B10 B10
B11 B11
W1 W1
W2 W2
W3 W3
R1 R1
R2 R2
R3 R3
R4 R4
R5 R5
R6 R6
R7 R7
R8 R8
R9 R9
R10 R10
personen[ after_tax_income ]
int
maxlength: 10 
Vorjahresnettoeinkommen in €
personen[ kontoinhaber ]
string
Vor- und Nachname des Kontoinhabers
personen[ iban ]
string
IBAN
personen[ bic ]
string
BIC
personen[ geldinstitut ]
string
Name des Geldinstituts
personen[ sitz_geldinstitut ]
string
Sitz des Geldinstituts

object
Informationen zu den Ausweisdaten
property default description options
identity_card[ type ] * required
string
PERSONALAUSWEIS
Angaben zum Ausweistyp
Value Label
KEINE_ANGABE Keine Angabe
PERSONALAUSWEIS Personalausweis
REISEPASS Reisepass
SONSTIGER Sonstiger
identity_card[ number ] * required
string
Ausweisnummer
identity_card[ expiry_date ] * required
date
Verfallsdatum des Ausweises
identity_card[ issued_on ] * required
date
Ausstelldatum des Ausweises
identity_card[ issuing_authority ]
string
Angaben zur ausstellenden Behörde des Ausweises
identity_card[ country_code ]
string
D
Länderkennzeichen
Value Label
AFG Afghanistan
AL Albanien
GBA Alderney
DZ Algerien
AND Andorra
ANG Angola
AG Antigua und Barbuda
RA Argentinien
AM Armenien
ARU Aruba
AZ Aserbaidschan
AUS Australien
BS Bahamas
BRN Bahrain
BD Bangladesch
BDS Barbados
BY Belarus (Weißrussland)
B Belgien
BH Belize
DY Benin
BHT Bhutan
BOL Bolivien
BIH Bosnien und Herzegowina
BW Botswana
BR Brasilien
BRU Brunei Darussalam
BG Bulgarien
BF Burkina Faso
RU Burundi
RCH Chile
VR China / Volksrepublik
CR Costa Rica
CW Curacao
D Deutschland
WD Dominica
DOM Dominikanische Republik
DJI Dschibuti
DK Dänemark
EC Ecuador
ES El Salvador
CI Elfenbeinküste
ER Eritrea
EST Estland
FJI Fidschi
FIN Finnland
F Frankreich
FR Färöer
FSM Föderierte Staaten von Mikronesien
G Gabun
WAG Gambia
GE Georgien
GH Ghana
GBZ Gibraltar
WG Grenada
GR Griechenland
GCA Guatemala
GBG Guernsey
RG Guinea
GUB Guinea-Bissau
GUY Guyana
RH Haiti
HN Honduras
HK Hongkong
IND Indien
RI Indonesien
GBM Insel Man
IRQ Irak
IR Iran
IRL Irland
IS Island
IL Israel
I Italien
JA Jamaika
J Japan
YEM Jemen
GBJ Jersey
HKJ Jordanien
YU Jugoslawien
K Kambodscha
CAM Kamerun
CDN Kanada
CV Kap Verde
KZ Kasachstan
Q Katar
EAK Kenia
KS Kirgistan
KI Kiribati
CCK Kokosinseln
CO Kolumbien
COM Komoren
ZRE Kongo / Demokratische Republik (ehem. Zaire)
RCB Kongo / Republik
KP Korea / Demokratische Volksrepublik (Nordkorea)
ROK Korea / Republik (Südkorea)
RKS Kosovo
HR Kroatien
CU Kuba
KWT Kuwait
LAO Laos
LS Lesotho
LV Lettland
RL Libanon
LB Liberia
LAR Libyen
FL Liechtenstein
LT Litauen
L Luxemburg
MAC Macao
RM Madagaskar
MW Malawi
MAL Malaysia
MV Malediven
RMM Mali
M Malta
MA Marokko
MH Marshallinseln
RIM Mauretanien
MS Mauritius
MK Mazedonien
MEX Mexiko
MD Moldau
MC Monaco
MGL Mongolei
MNE Montenegro
MOC Mosambik
BUR Myanmar (Burma)
NAM Namibia
NAU Nauru
NEP Nepal
NZ Neuseeland
NIC Nicaragua
NA Niederl. Antillen
NL Niederlande
RN Niger
WAN Nigeria
NIU Niue
N Norwegen
NMA Nördliche Marianen
OM Oman
PK Pakistan
PAL Palau
- Palästinensische Autonomiegebiete
PA Panama
PNG Papua-Neuguinea
PY Paraguay
PE Peru
RP Philippinen
PL Polen
P Portugal
RWA Ruanda
RO Rumänien
RUS Russland
SOL Salomonen
RNR Sambia
WS Samoa
RSM San Marino
WL Santa Lucia
SA Saudi-Arabien
S Schweden
CH Schweiz
SN Senegal
SRB Serbien
SY Seychellen
WAL Sierra Leone
ZW Simbabwe
SGP Singapur
SK Slowakei
SLO Slowenien
SO Somalia
E Spanien
CL Sri Lanka
SCN St. Kitts und Nevis
SXM St. Maarten
WV St. Vincent und die Grenadinen
SUD Sudan
SME Suriname
SD Swasiland
SYR Syrien
STP São Tomé und Príncipe
ZA Südafrika
TJ Tadschikistan
RC Taiwan (Formosa)
EAT Tansania
T Thailand
TL Timor-Leste
TG Togo
TON Tonga
TT Trinidad und Tobago
TD Tschad
CZ Tschechische Republik
TN Tunesien
TM Turkmenistan
TUC Turks- und Caicosinseln
TUV Tuvalu
TR Türkei
EAU Uganda
UA Ukraine
H Ungarn
ROU Uruguay
UZ Usbekistan
VAN Vanuatu
V Vatikanstadt
YV Venezuela
UAE Vereinigte Arabische Emirate
USA Vereinigte Staaten von Amerika
GB Vereinigtes Königreich Großbritannien
VN Vietnam
RCA Zentralafrikanische Republik
CY Zypern
ET Ägypten
GQ Äquatorialguinea
ETH Äthiopien
A Österreich
identity_card[ original_document ]
bool
Ausweis lag im Original vor (ja / nein)
identity_card[ copy_attached ]
bool
Kopie des vorgelegten Ausweisdokument liegt dem Antrag bei (ja / nein)
personen[ birth_name ]
string
Geburtsname
personen[ tax_identification_number ]
string
Steuer-Identifikationsnummer
personen[ social_insurance_number ]
string
Sozialversicherungsnummer, muss in folgendem Format angegeben werden: 66290250K001

object
Produktfilter
property default description options
productfilter[ branch ]
string
Name des Produktwarenkorbs aus fb-backoffice. Die Tarifliste wird mit den Tarifen aus dem Produktwarenkorb eingeschränkt.
productfilter[ tarif_ids ]
string[]
Tarif IDs für die initiale Filterung der Tarifliste

object
Es kann ein Profil vorausgewählt werden
property default description options

object
Vertragsdaten des Kunden
property default description options
contractdata[ versbeginn ] * required
date_de
@tomorrow
Datum des Versicherungsbeginn
contractdata[ vertragsdauer ] * required
int
1
Vertragsdauer
Value Label
1 1 Jahr
3 3 Jahre
5 5 Jahre
contractdata[ versbeitrag ] * required
string
Jaehrlich
Zahlweise
Value Label
Monatlich monatlich
Vierteljaehrlich vierteljährlich
Halbjaehrlich halbjährlich
Jaehrlich jährlich
contractdata[ zahlungsweg ] * required
string
Lastschrift
Zahlungsart
Value Label
Lastschrift Lastschrift
Ueberweisung Überweisung
contractdata[ deckungssumme ]
int
3000000
Mindestdeckungssumme
Value Label
1000000 1.000.000
1500000 1.500.000
2000000 2.000.000
2500000 2.500.000
3000000 3.000.000
4000000 4.000.000
5000000 5.000.000
6000000 6.000.000
7000000 7.000.000
7500000 7.500.000
8000000 8.000.000
9000000 9.000.000
10000000 10.000.000
12000000 12.000.000
15000000 15.000.000
20000000 20.000.000
contractdata[ selbstbeteiligung ]
int
0
Selbstbehalt
Value Label
0 kein
150 bis 150 €
300 bis 300 €
500 bis 500 €
999999 über 500 €
contractdata[ bebautes_grundstueck ]
string
@none
bebautes Grundstück
Value Label
@none nein
true ja
contractdata[ objektart ]
string
Einfamilienhaus
bebautes Grundstück: Gebäudeart
Value Label
Einfamilienhaus Einfamilienhaus
Zweifamilienhaus Zweifamilienhaus
Wohnung Wohnung
Mehrfamilienhaus Mehrfamilienhaus
contractdata[ eigentuemerart_bebautes_grundstueck ]
string
Hauseigentuemer
bebautes Grundstück: Eigentümerart
Value Label
Hauseigentuemer Hauseigentümer
Wohnungseigentuemergemeinschaft Wohnungseigentümergemeinschaft
Wohnungsbaugesellschaft Wohnungsbaugesellschaft
contractdata[ einheiten_wohnen ]
int
maxlength: 5 min: 1 
Anzahl der Wohneinheiten
contractdata[ einheiten_gewerbe ]
int
maxlength: 5 min: 1 
Anzahl der Gewerbeeinheiten
contractdata[ bruttojahresmiete_wohneinheit ]
int
maxlength: 9 
Bruttojahresmiete je Wohneinheit in €
contractdata[ bruttojahresmiete_gewerbeeinheit ]
int
maxlength: 9 
Bruttojahresmiete je Gewerbeeinheit in €
contractdata[ garagen ]
string
@none
Garagen
Value Label
@none nein
true ja
contractdata[ anzahl_garagen ]
int
maxlength: 5 min: 1 
Anzahl der Garagen
contractdata[ eigentuemerart_garagen ]
string
Hauseigentuemer
Garagen: Eigentümerart
Value Label
Hauseigentuemer Hauseigentümer
Wohnungseigentuemergemeinschaft Wohnungseigentümergemeinschaft
Wohnungsbaugesellschaft Wohnungsbaugesellschaft
contractdata[ bruttojahresmiete_garagen ]
int
maxlength: 7 
Garagen: Bruttojahresmiete in €
contractdata[ unbebautes_grundstueck ]
string
@none
unbebautes Grundstück
Value Label
@none nein
true ja
contractdata[ grundstuecks_flaeche ]
int
maxlength: 5 min: 1 
Fläche in qm
contractdata[ eigentuemerart_unbebautes_grundstueck ]
string
Grundstueckseigentuemer
unbebautes Grundstück: Eigentümerart
Value Label
Grundstueckseigentuemer Grundstückseigentümer
Wohnungseigentuemergemeinschaft Wohnungseigentümergemeinschaft
Wohnungsbaugesellschaft Wohnungsbaugesellschaft
contractdata[ bruttojahrespacht ]
int
maxlength: 9 
unbebautes Grundstück: Bruttojahrespacht in €
contractdata[ bestehen_vorversicherung ]
bool
false
Vorversicherung
contractdata[ vorversicherer ]
enumeration
Angabe zu Vorversicherern
Value Label
-1 sonstige
603 AachenMünchener Versicherung AG
2352 ADCURI GmbH (Barmenia)
709 Alte Leipziger Versicherung AG
737 ARAG Allgemeine Versicherungs-AG
764 AXA Versicherung AG
877 Badische Allgemeine Versicherung AG
3002 Baloise Sachversicherung AG Deutschland
2289 Basler Sachversicherungs-AG
727 Basler Versicherungen
734 Bayerische Beamten Versicherung AG
839 Bayerische Hausbesitzer-Versicherungsgesellschaft a.G
872 BdV Mitgliederservice GmbH
696 BGV-Versicherung AG
2419 ConceptIF PRO GmbH
735 Concordia Versicherungs-Gesellschaft auf Gegenseitigkeit
688 Condor Versicherungen
762 Continentale Sachversicherung AG
741 Cosmos Versicherung Aktiengesellschaft
714 DA direkt Deutsche Allgemeine Versicherung
601 D.A.S. Direktion München
854 DBV Deutsche Beamtenversicherung, Zweigniederlassung der AXA Versicherung AG
683 Debeka Allgemeine Versicherung AG
105 Deutscher Ring Sachversicherungs-AG
689 DEVK Allgemeine Versicherungs-AG
2912 Dialog Versicherung AG
738 Die Haftpflichtkasse VVaG
684 EUROPA Versicherung AG
755 Garanta Versicherungs-AG (Nürnberger Versicherungsgruppe)
823 Gegenseitigkeit Versicherung Oldenburg
2936 Generali Deutschland Versicherung AG
106 Generali Versicherung AG
701 Gerling-Konzern Allgemeine Versicherungs-AG
691 GEV Grundeigentümer-Versicherung VVaG
687 Gothaer Allgemeine Versicherung AG
730 GVV Direktversicherung AG
2269 Hamburger Feuerkasse Versicherungs-AG
108 Hamburg-Mannheimer Sachversicherungs-AG
858 HanseMerkur Allgemeine Versicherung AG
2166 HDI-Gerling Firmen und Privat Versicherung AG
713 HDI Privat Versicherung
685 Helvetia Schweizerische Versicherungsgesellschaft
724 HUK24 AG
695 HUK-COBURG-ALLGEMEINE
110 INTER Allgemeine Versicherung AG
744 Interlloyd Versicherungs-AG
693 InterRisk Versicherungs-AG Vienna Insurance Group
123 Itzehoer Versicherungen
2211 Landesschadenhilfe Versicherung VaG (LSH)
907 Lippische Landesbrandversicherung AG
111 LVM Landwirtschaftlicher Versicherungsverein Münster a. G.
1106 Mecklenburgische Versicherungsgruppe
115 NÜRNBERGER Allgemeine Versicherungs-AG
754 NÜRNBERGER Beamten Allgemeine Versicherung AG
690 NV-Versicherungen VVaG
733 Öffentliche Sachversicherung Braunschweig
2630 Öffentliche Versicherungen Oldenburg
731 Ostdeutsche Versicherung AG
856 Provinzial Nord Brandkasse AG
769 Provinzial Versicherung AG (ehemals Provinzial Rheinland)
779 Provinzial Versicherung AG (ehemals Westfälische Provinzial)
2212 Rhion Versicherung AG
748 R+V Allgemeine Versicherung AG
117 Schweizer-National Versicherungs-AG in Deutschland
851 S.L.P. AG
2964 smart und easy
863 SV SparkassenVersicherung Gebäudeversicherung AG
743 uniVersa Allgemeine Versicherung AG
869 VdVA Versicherungsservice
602 Versicherer im Raum der Kirchen Sachversicherung AG
750 Versicherungskammer Bayern Versicherungsanstalt des öffentlichen Rechts
739 VGH Landschaftliche Brandkasse Hannover
119 VHV Versicherungen
711 VICTORIA Versicherungen
708 VOLKSWOHL BUND Sachversicherung AG
604 VPV Allgemeine Versicherungs-AG
124 WGV-Versicherung AG
882 Württembergische Gemeinde-Versicherung a.G.
742 Württembergische Versicherung AG
753 Zurich Insurance Europe AG
contractdata[ vorversicherer_vertragsnummer ]
string
Vertragsnummer beim Vorversicherer (nur rel., wenn bestehen_vorversicherung=true). Für die Übergabe der Vertragsnummer sind nur Ziffern und Buchstaben (ohne Umlaut und ß oder Leerzeichen) zulässig. Ungültige Zeichen werden entfernt.
contractdata[ vorversicherung_gekuendigt_durch ]
enumeration
Vertragsstatus (nur rel. wenn "bestehen_vorversicherung = true")
Value Label
UNGEKUENDIGT ungekündigt
GEKUENDIGT_DURCH_VN gekündigt durch Versicherungsnehmer
GEKUENDIGT_DURCH_GSL gekündigt durch Gesellschaft
contractdata[ vorversicherung_vertragsbeginn ]
date_de
Vertragsbeginn (nur rel. wenn "bestehen_vorversicherung = true")
contractdata[ vorversicherung_vertragsende ]
date_de
Vertragsende (nur rel. wenn "bestehen_vorversicherung = true")
contractdata[ bestehen_vorschaeden ]
bool
false
Vorschäden der letzten 5 Jahre

array
Vorschäden
property default description options
vorschaeden[ id ]
int
Id
vorschaeden[ schadendatum ]
date_de
Schadentag
vorschaeden[ schadenhoehe ]
float
maxlength: 7 min: 1 
Schadenhöhe

object
Auswahl der Gesellschaften
property default description options
companyselection[ selected_companies ]
array
ausgewählte Gesellschaften (Bafinnummern)
companyselection[ company_whitelist ]
array
anzuzeigende Gesellschaften (Bafinnummern)
companyselection[ company_blacklist ]
array
ausgegrenzte Gesellschaften (Bafinnummern)
companyselection[ excluded_companies ]
array
auszugrenzende Gesellschaften (Bafinnummern)

array
Enthält eine Liste von Produkten die Sie aus der Schnittstelle get/provisions bezogen haben
property default description options
additional_products[ pkfg ]
string
Produktkonfigurations-Id
additional_products[ tarif_id ]
string
Tarif-Id
additional_products[ bafin_register_nr ]
int
Bafinnummer
additional_products[ company_id ]
int
GesellschaftsId
additional_products[ company ]
string
Gesellschaftsname
additional_products[ product ]
string
Name des Produktes
additional_products[ product_names ]
array
Namen der enthaltenen Produkte und Optionen
additional_products[ main_producttype ]
string
Hauptproduktbereich
additional_products[ producttypes ]
array
Produktbereiche
Value Label
TYPE_BU Berufsunfähigkeit
TYPE_BU_BASIS BU basis: Berufsunfähigkeitsversicherung mit der Möglichkeit einer abstrakten Verweisung
TYPE_BU_KOMFORT BU komfort: Berufsunfähigkeitsversicherung mit Verzicht auf abstrakte Verweisung
TYPE_RLV Risikoleben
TYPE_EU EU: Produkte zur Absicherung bei Verlust der Erwerbsfähigkeit
TYPE_GF Grundfähigkeit: Produkte zur Absicherung bei Verlust bestimmter Grundfähigkeiten wie z.B. sehen, hören oder greifen
TYPE_MR Multirisk
TYPE_MR_LEBEN Multirisk: Produkte mit Leistungen aus den Bereichen Grundfähigkeit, Dread Disease und Pflege
TYPE_MR_UNFALL Multirisk: Produkte mit Leistungen aus den Bereichen Grundfähigkeit, Dread Disease, Pflege und Unfall
TYPE_DD Dread Disease: Produkte zur Absicherung bei Eintritt schwerer Erkrankungen
additional_products[ calculated ]
bool
Gibt an ob das Produkt berechnet wurde
additional_products[ calculation_code ]
int
Vom Rechner zurückgegebener Code, der den Berechnungsstatus angibt.
Value Label
300 Fachlicher Fehler
301 Fachlicher Fehler
400 Fachlicher Fehler
401 Fachlicher Fehler
500 Technischer Fehler
501 Technischer Fehler
600 Unbekannter Fehler
601 Unbekannter Fehler
1200 Fachlicher Fehler
additional_products[ calculation_date ]
string
Zeitstempel der Berechnung
additional_products[ contract_beginning ]
date_de
Datum des Versicherungsbeginn

array
property default description options
contributions[ type ]
string
Beitragsart
Value Label
GESAMTBEITRAG Gesamtbeitrag (HV + Zusatz)
HAUPTVERSICHERUNG Haupversicherung
ZUSATZ_BUZ_GESAMT Zusatzversicherung BUZ Gesamt (Rente + Befreiung)
ZUSATZ_BUZ_RENTE Zusatzversicherung BUZ Rente
ZUSATZ_BUZ_BEFREIUNG Zusatzversicherung BUZ Befreiung
contributions[ form ]
string
Beitrag
Value Label
BRUTTO Bruttobeitrag (bei vermindertem Anfangsbeitrag ist dies der Bruttozielbeitrag)
NETTO Nettobeitrag (bei vermindertem Anfangsbeitrag ist dies der Nettozielbeitrag)
BRUTTO_START Bruttostartbeitrag (bei vermindertem Anfangsbeitrag)
NETTO_START Nettostartbeitrag (bei vermindertem Anfangsbeitrag)
NETTO_JAHRESBEITRAG Netto Jahresbeitrag
BRUTTO_JAHRESBEITRAG Brutto Jahresbeitrag
STEUERBETRAG Steuerbetrag
STEUERSATZ Steuersatz
contributions[ unit ]
string
Einheit
Value Label
EURO Euro
PROZENT Prozent
contributions[ value ]
float
Wert
additional_products[ brutto ]
float
Bruttobeitrag in Euro gemäß Zahlweise
additional_products[ netto ]
float
Nettobeitrag in Euro gemäß Zahlweise
additional_products[ zahlweise ]
enumeration
Versicherungsbeitrag
Value Label
Monatlich monatlich
Vierteljaehrlich vierteljährlich
Halbjaehrlich halbjährlich
Jaehrlich jährlich
Einmalig einmalig
additional_products[ contract_expiration ]
date_de
Versicherungsende/Vertragsende

array
property default description options
expiration[ type ]
enumeration
Produktebene
Value Label
MAIN Hauptprodukt
ADDITIONAL_BENEFIT Zusatzleistung
ADDITIONAL_DELIVERANCE Zusatzleistung Beitragsbefreiung
expiration[ form ]
enumeration
Was endet?
Value Label
CONTRACT Vertrag
BENEFIT Leistung
PAYMENT Beitragszahlung
expiration[ date ]
date_de
Enddatum
expiration[ age ]
int
Endalter
expiration[ years ]
int
Laufzeit
expiration[ lifetime ]
bool
Lebenslange Dauer
additional_products[ error ]
array
Aufgetretene Fehler aus der Berechnung. Die Unterscheidung ob fachlicher oder technischer Fehler kann anhand des calculation_code erfolgen
additional_products[ information ]
string
Informationstext
additional_products[ additional_info ]
string
Informationstext
additional_products[ managed_no_contract ]
bool
Gibt an ob für das Produkt Dokumente erstellt werden dürfen
additional_products[ profile_name ]
string
Erfüllung: Name des gewählten Profils
additional_products[ index_percentage ]
int
Erfüllung: in %
additional_products[ level_erfuellt ]
int
Erfüllung: erfüllte Kriterien
additional_products[ level_gesamt ]
int
Erfüllung: Gesamtanzahl der Kriterien
additional_products[ has_onlineoffer ]
bool
Gibt an, ob für das Produkt eine Onlinebeantragung zur Verfügung steht
additional_products[ has_setorderqualified ]
bool
Gibt an, ob für das Produkt setOrderQualified zur Verfügung steht
additional_products[ need_digitalsignature ]
bool
Gibt an, ob für die Onlinebeantragung eine digitale Unterschrift erforderlich ist
additional_products[ best_rating ]
bool
Produkt mit dem besten Rating.
additional_products[ best_price ]
bool
Das günstigste Produkt
additional_products[ best_ratio ]
bool
Das Produkt mit dem besten Preis Leisungsverhältnis
additional_products[ provisions ]
array
Name der Provisions welche abweichend zu den Basisdaten beim Produkt verändert wurden (z.B. "contractdata" bei der Neuberechnung über den Tarifvergleich).
additional_products[ singlecalculation ]
object
false
Daten zur Vorbelegung für den Wiedereinstieg in AVV

object
Vertragsdaten, welche bei der Neuberechnung eines Produktes auf dem Tarifvergleich angegeben wurden
property default description options
contractdata[ versbeginn ] * required
date_de
@tomorrow
Datum des Versicherungsbeginn
contractdata[ vertragsdauer ] * required
int
1
Vertragsdauer
Value Label
1 1 Jahr
3 3 Jahre
5 5 Jahre
contractdata[ versbeitrag ] * required
string
Jaehrlich
Zahlweise
Value Label
Monatlich monatlich
Vierteljaehrlich vierteljährlich
Halbjaehrlich halbjährlich
Jaehrlich jährlich
contractdata[ zahlungsweg ] * required
string
Lastschrift
Zahlungsart
Value Label
Lastschrift Lastschrift
Ueberweisung Überweisung
contractdata[ deckungssumme ]
int
3000000
Mindestdeckungssumme
Value Label
1000000 1.000.000
1500000 1.500.000
2000000 2.000.000
2500000 2.500.000
3000000 3.000.000
4000000 4.000.000
5000000 5.000.000
6000000 6.000.000
7000000 7.000.000
7500000 7.500.000
8000000 8.000.000
9000000 9.000.000
10000000 10.000.000
12000000 12.000.000
15000000 15.000.000
20000000 20.000.000
contractdata[ selbstbeteiligung ]
int
0
Selbstbehalt
Value Label
0 kein
150 bis 150 €
300 bis 300 €
500 bis 500 €
999999 über 500 €
contractdata[ bebautes_grundstueck ]
string
@none
bebautes Grundstück
Value Label
@none nein
true ja
contractdata[ objektart ]
string
Einfamilienhaus
bebautes Grundstück: Gebäudeart
Value Label
Einfamilienhaus Einfamilienhaus
Zweifamilienhaus Zweifamilienhaus
Wohnung Wohnung
Mehrfamilienhaus Mehrfamilienhaus
contractdata[ eigentuemerart_bebautes_grundstueck ]
string
Hauseigentuemer
bebautes Grundstück: Eigentümerart
Value Label
Hauseigentuemer Hauseigentümer
Wohnungseigentuemergemeinschaft Wohnungseigentümergemeinschaft
Wohnungsbaugesellschaft Wohnungsbaugesellschaft
contractdata[ einheiten_wohnen ]
int
maxlength: 5 min: 1 
Anzahl der Wohneinheiten
contractdata[ einheiten_gewerbe ]
int
maxlength: 5 min: 1 
Anzahl der Gewerbeeinheiten
contractdata[ bruttojahresmiete_wohneinheit ]
int
maxlength: 9 
Bruttojahresmiete je Wohneinheit in €
contractdata[ bruttojahresmiete_gewerbeeinheit ]
int
maxlength: 9 
Bruttojahresmiete je Gewerbeeinheit in €
contractdata[ garagen ]
string
@none
Garagen
Value Label
@none nein
true ja
contractdata[ anzahl_garagen ]
int
maxlength: 5 min: 1 
Anzahl der Garagen
contractdata[ eigentuemerart_garagen ]
string
Hauseigentuemer
Garagen: Eigentümerart
Value Label
Hauseigentuemer Hauseigentümer
Wohnungseigentuemergemeinschaft Wohnungseigentümergemeinschaft
Wohnungsbaugesellschaft Wohnungsbaugesellschaft
contractdata[ bruttojahresmiete_garagen ]
int
maxlength: 7 
Garagen: Bruttojahresmiete in €
contractdata[ unbebautes_grundstueck ]
string
@none
unbebautes Grundstück
Value Label
@none nein
true ja
contractdata[ grundstuecks_flaeche ]
int
maxlength: 5 min: 1 
Fläche in qm
contractdata[ eigentuemerart_unbebautes_grundstueck ]
string
Grundstueckseigentuemer
unbebautes Grundstück: Eigentümerart
Value Label
Grundstueckseigentuemer Grundstückseigentümer
Wohnungseigentuemergemeinschaft Wohnungseigentümergemeinschaft
Wohnungsbaugesellschaft Wohnungsbaugesellschaft
contractdata[ bruttojahrespacht ]
int
maxlength: 9 
unbebautes Grundstück: Bruttojahrespacht in €
contractdata[ bestehen_vorversicherung ]
bool
false
Vorversicherung
contractdata[ vorversicherer ]
enumeration
Angabe zu Vorversicherern
Value Label
-1 sonstige
603 AachenMünchener Versicherung AG
2352 ADCURI GmbH (Barmenia)
709 Alte Leipziger Versicherung AG
737 ARAG Allgemeine Versicherungs-AG
764 AXA Versicherung AG
877 Badische Allgemeine Versicherung AG
3002 Baloise Sachversicherung AG Deutschland
2289 Basler Sachversicherungs-AG
727 Basler Versicherungen
734 Bayerische Beamten Versicherung AG
839 Bayerische Hausbesitzer-Versicherungsgesellschaft a.G
872 BdV Mitgliederservice GmbH
696 BGV-Versicherung AG
2419 ConceptIF PRO GmbH
735 Concordia Versicherungs-Gesellschaft auf Gegenseitigkeit
688 Condor Versicherungen
762 Continentale Sachversicherung AG
741 Cosmos Versicherung Aktiengesellschaft
714 DA direkt Deutsche Allgemeine Versicherung
601 D.A.S. Direktion München
854 DBV Deutsche Beamtenversicherung, Zweigniederlassung der AXA Versicherung AG
683 Debeka Allgemeine Versicherung AG
105 Deutscher Ring Sachversicherungs-AG
689 DEVK Allgemeine Versicherungs-AG
2912 Dialog Versicherung AG
738 Die Haftpflichtkasse VVaG
684 EUROPA Versicherung AG
755 Garanta Versicherungs-AG (Nürnberger Versicherungsgruppe)
823 Gegenseitigkeit Versicherung Oldenburg
2936 Generali Deutschland Versicherung AG
106 Generali Versicherung AG
701 Gerling-Konzern Allgemeine Versicherungs-AG
691 GEV Grundeigentümer-Versicherung VVaG
687 Gothaer Allgemeine Versicherung AG
730 GVV Direktversicherung AG
2269 Hamburger Feuerkasse Versicherungs-AG
108 Hamburg-Mannheimer Sachversicherungs-AG
858 HanseMerkur Allgemeine Versicherung AG
2166 HDI-Gerling Firmen und Privat Versicherung AG
713 HDI Privat Versicherung
685 Helvetia Schweizerische Versicherungsgesellschaft
724 HUK24 AG
695 HUK-COBURG-ALLGEMEINE
110 INTER Allgemeine Versicherung AG
744 Interlloyd Versicherungs-AG
693 InterRisk Versicherungs-AG Vienna Insurance Group
123 Itzehoer Versicherungen
2211 Landesschadenhilfe Versicherung VaG (LSH)
907 Lippische Landesbrandversicherung AG
111 LVM Landwirtschaftlicher Versicherungsverein Münster a. G.
1106 Mecklenburgische Versicherungsgruppe
115 NÜRNBERGER Allgemeine Versicherungs-AG
754 NÜRNBERGER Beamten Allgemeine Versicherung AG
690 NV-Versicherungen VVaG
733 Öffentliche Sachversicherung Braunschweig
2630 Öffentliche Versicherungen Oldenburg
731 Ostdeutsche Versicherung AG
856 Provinzial Nord Brandkasse AG
769 Provinzial Versicherung AG (ehemals Provinzial Rheinland)
779 Provinzial Versicherung AG (ehemals Westfälische Provinzial)
2212 Rhion Versicherung AG
748 R+V Allgemeine Versicherung AG
117 Schweizer-National Versicherungs-AG in Deutschland
851 S.L.P. AG
2964 smart und easy
863 SV SparkassenVersicherung Gebäudeversicherung AG
743 uniVersa Allgemeine Versicherung AG
869 VdVA Versicherungsservice
602 Versicherer im Raum der Kirchen Sachversicherung AG
750 Versicherungskammer Bayern Versicherungsanstalt des öffentlichen Rechts
739 VGH Landschaftliche Brandkasse Hannover
119 VHV Versicherungen
711 VICTORIA Versicherungen
708 VOLKSWOHL BUND Sachversicherung AG
604 VPV Allgemeine Versicherungs-AG
124 WGV-Versicherung AG
882 Württembergische Gemeinde-Versicherung a.G.
742 Württembergische Versicherung AG
753 Zurich Insurance Europe AG
contractdata[ vorversicherer_vertragsnummer ]
string
Vertragsnummer beim Vorversicherer (nur rel., wenn bestehen_vorversicherung=true). Für die Übergabe der Vertragsnummer sind nur Ziffern und Buchstaben (ohne Umlaut und ß oder Leerzeichen) zulässig. Ungültige Zeichen werden entfernt.
contractdata[ vorversicherung_gekuendigt_durch ]
enumeration
Vertragsstatus (nur rel. wenn "bestehen_vorversicherung = true")
Value Label
UNGEKUENDIGT ungekündigt
GEKUENDIGT_DURCH_VN gekündigt durch Versicherungsnehmer
GEKUENDIGT_DURCH_GSL gekündigt durch Gesellschaft
contractdata[ vorversicherung_vertragsbeginn ]
date_de
Vertragsbeginn (nur rel. wenn "bestehen_vorversicherung = true")
contractdata[ vorversicherung_vertragsende ]
date_de
Vertragsende (nur rel. wenn "bestehen_vorversicherung = true")
contractdata[ bestehen_vorschaeden ]
bool
false
Vorschäden der letzten 5 Jahre

array
Vorschäden
property default description options
vorschaeden[ id ]
int
Id
vorschaeden[ schadendatum ]
date_de
Schadentag
vorschaeden[ schadenhoehe ]
float
maxlength: 7 min: 1 
Schadenhöhe
additional_products[ passthrough ]
object
Parameter zum Transport von Tarif individuelle Informationen
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "separate_token": true,
    "publisher_subscribe_url": "https:\/\/www.external-target.com\/",
    "exit_url": "https:\/\/www.external-target.com\/",
    "auto_profession": true,
    "passbackdata": {
        "download_doctypes_blacklist": [
            "DOC_ANGEBOT",
            "DOC_ANGEBOTSMODELL"
        ]
    },
    "personen": [
        {
            "role": "VERSICHERUNGSNEHMER",
            "referenz_id": "12345",
            "anrede": "Herr",
            "geschlecht": "MAENNLICH",
            "titel": "Dr.",
            "vorname": "Max",
            "nachname": "Mustermann",
            "geburtsdatum": "10.10.1988",
            "postleitzahl": "30159",
            "ort": "Hannover",
            "strasse": "Musterstraße",
            "hausnummer": "12b",
            "land": "D",
            "lebenssituation": "Single",
            "familienstandid": "Ledig",
            "birthplace": "Hannover",
            "country_of_birth": "D",
            "citizenship": "DEUTSCH",
            "email": "example.versicherungsnehmer@fb-preview.de",
            "telefon_vorwahl": "0511",
            "telefon": "35771700",
            "raucher": "true",
            "nichtraucher_seit": 10,
            "groesse": 178,
            "gewicht": 72,
            "designation": "Bankkaufmann",
            "berufsstatus_id": 1,
            "beamtenstatus": "AUF_LEBENSZEIT",
            "salery_grade": "A2",
            "selbststaendigseit": "01.07.2006",
            "ausbildungsstatus": "MittlereReife",
            "akademischer_abschluss": "Master",
            "professional_training": "AbgeschlAusbildung",
            "definition_professional_training": "AbgeschlosseneKaufmaennische",
            "employment_mode": 1,
            "staff_responsibility": 1,
            "max_physical_work": 20,
            "max_office_work": 20,
            "business_travel": 60,
            "vorjahreseinkommen": 30000,
            "after_tax_income": 22400,
            "kontoinhaber": "Max Muster",
            "iban": "DE12345678912345678912",
            "bic": "BEISPI2HXXX",
            "geldinstitut": "Beispielbank",
            "sitz_geldinstitut": "Ortsname",
            "identity_card": {
                "type": "PERSONALAUSWEIS",
                "number": "T220001293",
                "expiry_date": "2018-10-01",
                "issued_on": "2015-10-01",
                "issuing_authority": "Landeshauptstadt Hannover",
                "country_code": "D",
                "original_document": true,
                "copy_attached": true
            },
            "birth_name": "Müller",
            "tax_identification_number": "123456789",
            "social_insurance_number": "66290250K001",
            "professions": [
                {
                    "company_id": 12345678,
                    "bafin_nr": "123",
                    "designation": "Bankkaufmann"
                }
            ]
        }
    ],
    "productfilter": {
        "branch": "produkte_innendienst",
        "tarif_ids": [
            "12345",
            "56789"
        ]
    },
    "contractdata": {
        "versbeginn": "@first-next-month",
        "vertragsdauer": 1,
        "versbeitrag": "Monatlich",
        "zahlungsweg": "Lastschrift",
        "deckungssumme": 3000000,
        "selbstbeteiligung": 150,
        "bebautes_grundstueck": "true",
        "objektart": "Einfamilienhaus",
        "eigentuemerart_bebautes_grundstueck": "Hauseigentuemer",
        "einheiten_wohnen": 2,
        "einheiten_gewerbe": 2,
        "bruttojahresmiete_wohneinheit": 100000,
        "bruttojahresmiete_gewerbeeinheit": 100000,
        "garagen": "true",
        "anzahl_garagen": 2,
        "eigentuemerart_garagen": "Hauseigentuemer",
        "bruttojahresmiete_garagen": 100000,
        "unbebautes_grundstueck": "true",
        "grundstuecks_flaeche": 200,
        "eigentuemerart_unbebautes_grundstueck": "Grundstueckseigentuemer",
        "bruttojahrespacht": 100000,
        "bestehen_vorversicherung": "false",
        "vorversicherer": "-1",
        "vorversicherer_vertragsnummer": "123456789",
        "vorversicherung_gekuendigt_durch": "UNGEKUENDIGT",
        "vorversicherung_vertragsbeginn": "01.05.2010",
        "vorversicherung_vertragsende": "01.05.2020",
        "bestehen_vorschaeden": "true",
        "vorschaeden": [
            {
                "schadendatum": "01.01.2015",
                "schadenhoehe": 1500
            }
        ]
    },
    "companyselection": {
        "selected_companies": [
            1134,
            5085,
            1001,
            1103,
            8888,
            5515,
            5312,
            8998,
            4147,
            5312,
            8970,
            8888,
            4039,
            8888,
            5312,
            1115,
            5414,
            4001,
            4043,
            4034,
            65873,
            5472,
            5338,
            8976,
            5146
        ],
        "company_whitelist": [
            1134,
            508,
            1001,
            1103,
            8888,
            5515,
            5312,
            4147,
            5312,
            8970,
            8888,
            4039,
            8888,
            5312,
            1115,
            8998,
            5414,
            4001,
            4043,
            4034,
            65873,
            5472,
            5338,
            8976,
            5146
        ],
        "company_blacklist": [
            8723,
            7723,
            1056
        ],
        "excluded_companies": [
            8723,
            7723,
            1056
        ]
    },
    "additional_products": [
        {
            "pkfg": "123456789",
            "tarif_id": "12345",
            "bafin_register_nr": 111,
            "company_id": 111,
            "company": "Pfefferminzia GmbH",
            "product": "SBU, Stand 01.2016",
            "product_names": [
                "SBU TOP",
                "Spezialoption"
            ],
            "main_producttype": "TYPE_GF",
            "producttypes": [
                "TYPE_GF",
                "TYPE_MR_LEBEN"
            ],
            "calculated": true,
            "calculation_code": 300,
            "calculation_date": "2016-01-01T08:40:44",
            "contract_beginning": "01.10.2014",
            "contributions": [
                {
                    "type": "HAUPTVERSICHERUNG",
                    "form": "NETTO",
                    "unit": "EURO",
                    "value": 150.5
                }
            ],
            "brutto": 12.12,
            "netto": "9,05",
            "zahlweise": "Jaehrlich",
            "contract_expiration": "01.10.2014",
            "expiration": [
                {
                    "type": "MAIN",
                    "form": "CONTRACT",
                    "date": "01.10.2014",
                    "age": 67,
                    "years": 33,
                    "lifetime": true
                }
            ],
            "error": [
                "Bitte geben Sie eine gültige Telefonnummer ein."
            ],
            "information": "Zusätzliche Information zu der Berechnung.",
            "additional_info": "Zusätzliche Information",
            "managed_no_contract": true,
            "profile_name": "fb-Angestellte (Single)",
            "index_percentage": 53,
            "level_erfuellt": 87,
            "level_gesamt": 144,
            "has_onlineoffer": true,
            "has_setorderqualified": true,
            "need_digitalsignature": true,
            "best_rating": "false",
            "best_price": "false",
            "best_ratio": "false",
            "provisions": [
                "contractdata"
            ],
            "singlecalculation": {
                "pkfg": "123456",
                "payload": "{}"
            },
            "contractdata": {
                "versbeginn": "@first-next-month",
                "vertragsdauer": 1,
                "versbeitrag": "Monatlich",
                "zahlungsweg": "Lastschrift",
                "deckungssumme": 3000000,
                "selbstbeteiligung": 150,
                "bebautes_grundstueck": "true",
                "objektart": "Einfamilienhaus",
                "eigentuemerart_bebautes_grundstueck": "Hauseigentuemer",
                "einheiten_wohnen": 2,
                "einheiten_gewerbe": 2,
                "bruttojahresmiete_wohneinheit": 100000,
                "bruttojahresmiete_gewerbeeinheit": 100000,
                "garagen": "true",
                "anzahl_garagen": 2,
                "eigentuemerart_garagen": "Hauseigentuemer",
                "bruttojahresmiete_garagen": 100000,
                "unbebautes_grundstueck": "true",
                "grundstuecks_flaeche": 200,
                "eigentuemerart_unbebautes_grundstueck": "Grundstueckseigentuemer",
                "bruttojahrespacht": 100000,
                "bestehen_vorversicherung": "false",
                "vorversicherer": "-1",
                "vorversicherer_vertragsnummer": "123456789",
                "vorversicherung_gekuendigt_durch": "UNGEKUENDIGT",
                "vorversicherung_vertragsbeginn": "01.05.2010",
                "vorversicherung_vertragsende": "01.05.2020",
                "bestehen_vorschaeden": "true",
                "vorschaeden": [
                    {
                        "schadendatum": "01.01.2015",
                        "schadenhoehe": 1500
                    }
                ]
            },
            "passthrough": {
                "parameter1": "test1",
                "parameter2": "test2"
            }
        }
    ]
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9"
}

Response

Schema: GET https://bankathon.fb-xpert.fb-preview.de/hug/external/enter/personen/response/schema


property description options
[ status ] * required
string
Status des Aufrufs
OK: Anfrage erfolgreich
ERROR: Anfrage verlief fehlerhaft
[ errors ]
string[]
Aufgetretene Fehler (Wird nur bei "status: ERROR" gefüllt!)
[ accessurl ]
string
aufzurufende URL
[ token ]
string
Token zur Authentifizierung
[ validation ]
object
Validierungsergebnisse der mitgeschickten Daten
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "accessurl": "https:\/\/Toolname.de\/Bereich\/index.php?token=...",
    "token": "0123456789abcdefghijklmnop",
    "validation": {
        "status": "OK",
        "valid": false,
        "errors": [
            "There are no duplicates allowed in the array (pointer: \/companyselection\/selected_companies)"
        ],
        "warnings": []
    }
}