/infoservice/schufa/identcheck/childprotection/
Response Daten
Bei einer erfolgreichen Anfrage HTTP-Statuscode = 200
werden als Antwort immer folgende Datentypen als JSON encoded String zurückgeliefert:
Response ⬆️
Das Response Objekt wird sowohl bei erfolgreichen als auch fehlerbehafteten Schufa Antworten zurückgeliefert
Feld | Beschreibung | Feldeigenschaften | mögliche Werte |
---|---|---|---|
bSuccess | Zeigt an, ob eine Anfrage an die Schufa erfolgreich war | type: boolean | true oder false |
aMessage | Beinhaltet zusätzliche Informationen zum Anfrageergebnis | type: array of infoserviceResponseMessage | siehe infoserviceResponseMessage |
sRaw | enthält die originale Schufa Antwort, als XML string (Schufa Format) | type: string format: XML |
Unterschiedlich je nach Anfrage und ermittelter Daten, siehe Beispieldaten. |
Data ⬆️
Das Data Objekt wird nur bei erfolgreichen Anfragen (bSuccess=true
) befüllt. Im Fehlerfall ist deren Wert null.
Feld | Beschreibung | Feldeigenschaften | mögliche Werte | Hinweis |
---|---|---|---|---|
ServiceReference | Eindeutige Referenz/ID von der Schufa für eventuelle Rückfragen | type: string | example: "1234567891011" | |
CustomerReference | Eine von Ihnen vergebene eindeutige Referenz/ID zur Anfrage | type: string | example: "Ihr Zeichen 123" | Wird nur befüllt, wenn in der Anfrage die Variable CustomerReference angegeben wurde |
ReturnCode | Ergebnistyp | type: string | example: "KEIN TREFFER" | |
FoundWithPreviousAddress | Signalisiert, dass die angefragten Adressdaten des Verbrauchers als Voradresse im SCHUFA-Datenbestand gefunden wurden | type: boolean | true oder false | |
IdentityVerified | Gibt an, ob die Identität des Verbrauchers geprüft wurde | type: boolean | true oder false | |
Match | Bewertungen der Ähnlichkeit zwischen den Anfragedaten und den entsprechenden Einträgen im SCHUFA-Datenbestand | type: array of Match | siehe Match | Enthält sowohl zu jedem Consumer Eintrag eine Einzelbewertung als auch ein Gesamtergebnis |
Consumer | Verbraucherdaten | type: object | siehe Consumer |
Match ⬆️
Feldweise Einzeltreffergüte der Verbraucherdaten, das Gesamtergebnis wird mit dem Pseudofeld "Complete" angegeben
Feld | Beschreibung | Feldeigenschaften | mögliche Werte | Hinweis |
---|---|---|---|---|
sField | Feldname | type: string | example: "LastName" | bezieht sich auf dem Feldname vom Consumer Objekt, Pseudoangabe: "Complete" als Gesamtergebnis |
sMatchQuality | Treffergüte | type: string | example: "100.0" | Diese Werte können in einem Bereich von 0.0 bis 100.0 liegen, wobei 100.0 eine exakte Übereinstimmung angibt. |
Consumer ⬆️
Beinhaltet die Verbraucherdaten
Feld | Beschreibung | Feldeigenschaften | mögliche Werte |
---|---|---|---|
FirstName | Vorname zu einer Person | type: string | example:"Max" |
LastName | Nachname zu einer Person | type: string | example: "Mustermann" |
Gender | Geschlecht zu einer Person | type: string | "m" = männlich "f" = weiblich "u" = unbekannt |
BirthDate | Geburtstag zu einer Person | type: string format: date [dd.mm.yyyy] |
example: "08.05.2001" |
Street | Straße und Hausnummer | type: string | example: "Muster Straße 5" |
PostalCode | Postleitzahl | type: string | example: "12345" |
City | Stadt | type: string | example: "Musterhausen" |
CountryCode | Länderkürzel | type: string | "DE" für Deutschland |
infoserviceResponseMessage ⬆️
Beinhaltet zusätzliche Informationen zum Anfrageergebnis.
Feld | Beschreibung | Feldeigenschaften | mögliche Werte |
---|---|---|---|
sKey | Gibt die Art der Information an | type: string | "code" "info" "error" |
sValue | Information in textueller Form | type: string | example: "Operation successful" |
✅ Beispiel Response - erfolgreiche Schufa Antwort
{
"Response": {
"bSuccess": true,
"aMessage": [
{
"sKey": "info",
"sValue": "request successfully completed"
}
],
"sRaw": "\"<iden:Identitaetspruefung xmlns:iden=\\\"http:\\\/\\\/ifd-schema.de\\\/IdentitaetsCheckSCHUFA\\\">...<\\\/iden:Identitaetspruefung>\""
},
"Data": {
"ServiceReference": "15469078",
"CustomerReference": "MF484267876",
"ReturnCode": "KEIN TREFFER",
"FoundWithPreviousAddress": false,
"IdentityVerified": false,
"Match": [
{
"sField": "Complete",
"sMatchQuality": "0"
},
{
"sField": "LastName",
"sMatchQuality": "0"
},
{
"sField": "FirstName",
"sMatchQuality": "0"
},
{
"sField": "BirthDate",
"sMatchQuality": "0.0"
},
{
"sField": "Street",
"sMatchQuality": "0.0"
},
{
"sField": "PostalCode",
"sMatchQuality": "0.0"
},
{
"sField": "City",
"sMatchQuality": "0.0"
}
],
"Consumer": {
"FirstName": "Max",
"LastName": "Mustermann",
"Gender": "u",
"BirthDate": "28.02.2001",
"Street": "Hauptstraße 45a",
"PostalCode": "49080",
"City": "Osnabrück",
"CountryCode": "DE"
}
}
}
🚫 Beispiel Response - Schufa Antwort mit Fehlermeldung
{
"Response": {
"bSuccess": false,
"aMessage": [
{
"sKey": "error",
"sValue": "Bei der Verarbeitung der Businesslogik aufgetretene Ausnahme"
},
{
"sKey": "code_1",
"sValue": "VAL0003"
},
{
"sKey": "info_1",
"sValue": "Geburtsdatum - Datum liegt außerhalb des gültigen Bereichs"
}
],
"sRaw": "\"<iden:AusnahmeAntwort xmlns:iden=\\\"http:\\\/\\\/ifd-schema.de\\\/IdentitaetsCheckSCHUFA\\\">...<\\\/iden:AusnahmeAntwort>\""
},
"Data": null
}