Antwort Datentyp zu Crif Auskünften
Dieser Datentyp wird immer zurückgegeben, wenn der Http Response Statuscode den Wert 200 enthält
Übersicht Hauptdatentypen
Übersicht Unterdatentypen
Response ⬆️
Hinweis
Das Response Objekt wird sowohl bei erfolgreichen als auch fehlerbehafteten Antworten befüllt
| Feld | Beschreibung | Feldeigenschaften | mögliche Werte | Hinweis |
|---|---|---|---|---|
| bSuccess | Zeigt an, ob eine Anfrage an Crif erfolgreich war | type: boolean | true oder false | |
| aMessage | Beinhaltet zusätzliche Informationen zum Anfrageergebnis | type: array | siehe: apiMessage | |
| sRaw | Beinhaltet die komplette Antwort zur Anfrage | type: string format: JSON |
Unterschiedlich je nach Anfrage und ermittelter Daten | Kann dazu dienen Adress- oder Personendaten zu korrigieren |
Data ⬆️
Hinweis
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 Crif für eventuelle Rückfragen an Crif | type: string | "1234567891011" | |
| CustomerReference | Eine von Ihnen vergebene eindeutige Referenz/ID zur Anfrage | type: string | "Ihr Zeichen 123" | Wird nur befüllt, wenn in der Anfrage die Variable CustomerReference angegeben wurde |
| ScoreValue | Bewertung der Bonität in Form einer Schulnote | type: string | "0.0" oder "1.0" bis "6.0" |
"0.0" wird zurückgegeben, wenn keine Risikoeinschätzung vorgenommen werden konnte |
| Identification | Identifikationsmerkmale zur Person/Firma und/oder Adresse | type: object | Siehe Identification/Risk Objekt | |
| Risk | Einschätzung des Ausfallrisikos | type: object | Siehe Identification/Risk Objekt |
DataBase64Encoded ⬆️
| Feld | Beschreibung | Feldeigenschaften | mögliche Werte | Hinweis |
|---|---|---|---|---|
| DataBase64Encoded | PDF Base 64 codiert | type: string | "1234TH56..." | Wird nur befüllt, wenn in der Anfrage die Variable ReportFormat den Wert PDF enhält |
apiMessage ⬆️
Hinweis
Beinhaltet zusätzliche Informationen zum Anfrageergebnis.
Eine apiMessage vom Typ sType = "code" wird im Fehlerfall immer zurückgeliefert.
| Feld | Beschreibung | Feldeigenschaften | mögliche Werte | Hinweis |
|---|---|---|---|---|
| sType | Gibt die Art der Information an | type: string | "code" "info" "error" |
Siehe auch - Fehlermeldungen |
| sValue | Information in textueller Form | type: string | "Operation successful" |
Identification/Risk Objekt ⬆️
Beinhaltet von Crif aufbereitete Informationen zu:
- Identifikationsmerkmalen in der Variable Identification
- Risikoeinschätzungen in der Variable Risk
| Feld | Beschreibung | Feldeigenschaften | mögliche Werte | Hinweis |
|---|---|---|---|---|
| Code | Gibt von Crif vergebene Codes an | type: string | "N0" | Siehe auch - Identification Codes - Risk Codes |
| Text | Information in textueller Form | type: string | "Person unbekannt" |