Integrieren Sie die Identitätsprüfung in Ihre eigene Software.
Erstellen Sie sichere NFC-Identitätsprüfungsanfragen direkt aus Ihrem eigenen System heraus. Laden Sie Nutzer per E-Mail oder SMS ein oder versenden Sie den generierten Link selbst. Der Nutzer scannt den NFC-Chip in der mobilen App, und Sie rufen nur die Felder ab, die Ihr Prozess benötigt.
API-Ablauf
ID Scan richtet sich an Softwareanbieter und Unternehmen, die eine Identitätsprüfung integrieren möchten, ohne den gesamten mobilen Scan-Prozess selbst entwickeln zu müssen.
Anfrage erstellen
Erstellen Sie einen Scan-Auftrag über Ihr Backend. Fügen Sie eine externe Referenz, die Sprache, das Ablaufdatum, die Zustellungseinstellungen, die angeforderten Felder und die Prüfungen hinzu.
Den Benutzer einladen
Lassen Sie ID Scan die E-Mail oder SMS versenden, oder nutzen Sie Ihren eigenen Kommunikationskanal mit dem zurückgesendeten Bestätigungslink.
In der App scannen
Der Nutzer öffnet die mobile App, scannt den MRZ-Bereich, liest den NFC-Chip aus und führt optional einen Live-Selfie-Vergleich mit dem DG2-Porträtfoto durch.
Das Ergebnis abrufen
Rufen Sie über die API den Status, Prüfungen, angeforderte Felder und Audit-Informationen ab. Es werden nur konfigurierte Felder zurückgegeben.
Basis-URL und Authentifizierung
API-Aufrufe werden an die Basis-URL der ID Scan-API gesendet und mithilfe eines im ID Scan-Portal generierten API-Schlüssels authentifiziert. Der API-Schlüssel wird über einen speziellen Request-Header übermittelt und sollte ausschließlich serverseitig verwendet werden. API-Schlüssel dürfen niemals im Frontend-Code oder in mobilen Anwendungen offengelegt werden.
Anfrage-Antwort erstellen
Wenn eine Scan-Anfrage erstellt wird, gibt die API die Anfrage-ID, den Anfrage-Schlüssel, die Ablaufzeit und die Verifizierungslinks zurück. Verwenden Sie die zurückgegebene WebUrl in Ihrer eigenen E-Mail, SMS, Ihrem Portal oder Ihrem Workflow, wenn Sie die Selbstzustellung nutzen. Auf Mobilgeräten kann die DeepLinkUrl die App direkt öffnen.
Anliefermöglichkeiten
Sie können festlegen, wie der Benutzer die Bestätigungsanfrage erhält. Dadurch lässt sich ID Scan sowohl in vollautomatische als auch in individuell angepasste Kommunikationsabläufe integrieren.
Plattform-E-Mail
ID Scan versendet eine E-Mail mit einer Einladung im eigenen Design und einem sicheren Bestätigungslink.
Plattform-SMS
ID Scan versendet den Bestätigungslink per SMS. Nützlich für Onboarding-Abläufe, bei denen das Mobilgerät im Vordergrund steht.
Selbstabholung
Ihr System empfängt den Link und leitet ihn über Ihre eigene E-Mail, SMS, Ihr Portal oder Ihren Messaging-Workflow weiter.
Anfragestatus
Eine Verifizierungsanfrage durchläuft eine Reihe von Statusmeldungen. Integrationen können diese Statusmeldungen nutzen, um den Fortschritt anzuzeigen, Erinnerungen auszulösen oder zu entscheiden, ob eine neue Anfrage erforderlich ist.
| Status | Beschreibung |
|---|---|
requested | The request has been created and is waiting for the user to start or complete the verification. |
compliance_pending | The identity verification has been completed and optional compliance screening is being processed. |
completed | The user completed the flow. Use IsSuccess and the check fields to determine whether verification passed. |
expired | The request expired before the user completed the verification. |
deleted | The request was deleted and is no longer available for completion. |
failed | The request could not be completed successfully because of an error or failed verification step. |
Externer Verweis
Verwenden Sie eine externe Referenz, um eine Verifizierungsanfrage mit Ihrem eigenen Kunden, Mitarbeiter, Dossier, Auftrag oder Onboarding-Datensatz zu verknüpfen. Beim Abrufen der Anfragedetails wird dieselbe Referenz zurückgegeben.
Kundennummer
Verknüpfen Sie die Anfrage mit Ihrem eigenen Kunden- oder Mandantenstamm.
Aktenzeichen
Verknüpfen Sie das Ergebnis mit einer Wwft-, HR- oder Compliance-Akte.
Auftrags- oder Workflow-ID
Verwenden Sie die Referenz, um automatisierte Arbeitsabläufe nach Abschluss der Überprüfung fortzusetzen.
Pflichtfelder
ID Scan unterstützt die Datenminimierung. Legen Sie genau fest, welche Felder an Ihr System zurückgesendet werden sollen. Dem Benutzer kann vor dem Absenden angezeigt werden, welche Daten weitergegeben werden.
| Feld | Beschreibung | Quelle |
|---|---|---|
surname | Surname / family name from the identity document. | NFC DG1 |
given_names | Given names from the identity document. | NFC DG1 |
date_of_birth | Date of birth. Can also be used for age checks. | NFC DG1 |
date_of_expiry | Document expiry date. | NFC DG1 |
document_number | Document number. Can be returned full or masked depending on template settings. | NFC DG1 |
document_type | Document type, such as passport or identity card. | NFC DG1 |
issuing_country | Country that issued the document. | NFC DG1 |
country_of_issue | Country of issue when available. | NFC DG1 |
nationality | Nationality from the identity document. | NFC DG1 |
gender | Gender marker from the document, if requested. | NFC DG1 |
photo | Portrait photo from the NFC chip. Only return when explicitly needed. | NFC DG2 |
mrz_masked_image | Masked MRZ image as proof of scan without exposing all MRZ data. | Camera/MRZ |
selfie_image | Live selfie image. Usually only included for manual review. | Camera/selfie |
Verfügbare Schecks
Im Rahmen des Verifizierungsablaufs können verschiedene Überprüfungen angefordert werden. Bei einigen handelt es sich um technische NFC-Prüfungen, während andere auf Geschäftsregeln basieren, wie beispielsweise die Mindestalterprüfung oder die Selfie-Verifizierung.
| Prüfen | Beschreibung | Rückgabewert |
|---|---|---|
nfc_read_success | Indicates whether the NFC chip was successfully read. | true / false |
chip_authentication_success | Indicates whether chip authentication or chip verification succeeded. | true / false |
document_not_expired | Checks if the document expiry date is in the future. | true / false |
minimum_age | Checks whether the person meets a configured minimum age without necessarily returning the date of birth. | { required, passed } |
sod_signature_valid | Checks the SOD signature when available. | true / false |
dg1_hash_valid | Checks whether DG1 data matches the signed document data. | true / false |
dg2_hash_valid | Checks whether the portrait photo data matches the signed document data. | true / false |
active_auth_ok | Optional active authentication result when supported by the document. | true / false / not available |
selfie_check | Optional live selfie verification matched against the DG2 portrait photo. | { requested, consent_given, passed, status, method } |
compliance_screening | Optional PEP, sanctions and related person screening after the NFC identity verification has completed. | { requested, match_found, pep_match, sanctions_match, rca_match, highest_score, matches } |
PEP- und Sanktionsprüfung
ID Scan kann die verifizierten Identitätsdaten optional mit Datenbanken zu politisch exponierten Personen (PEP), Sanktionen und verbundenen Personen abgleichen. Dies unterstützt KYC-, AML- und Compliance-Workflows, nachdem die NFC-Dokumentenüberprüfung abgeschlossen ist.
PEP-Screening
Prüfen Sie, ob die zu prüfende Person als politisch exponierte Person aufgeführt ist.
Sanktionsprüfung
Prüfen Sie, ob die überprüfte Person in sanktionsbezogenen Datenbeständen aufgeführt ist.
Manuelle Überprüfung
Mögliche Befunde sollten stets manuell überprüft werden, bevor Maßnahmen ergriffen werden.
Ergebnis- und Rückgabefelder
Der Ergebnis-Endpunkt gibt den Anforderungsstatus, den Verifizierungsstatus, die externe Referenz, die ausgewählten Identitätsfelder, die ausgewählten Bilder und die Prüfergebnisse zurück. Felder, die nicht angefordert wurden, werden nicht zurückgegeben.
Anfragestatus
Angefordert, abgeschlossen, abgelaufen, gelöscht oder fehlgeschlagen, einschließlich Zeitstempeln für die Erstellung und den Abschluss.
Ausgewählte Felder
Ausschließlich erfasste Identitätsdaten wie Name, Staatsangehörigkeit, Geburtsdatum oder Ablaufdatum des Ausweises.
Kontrollen und Prüfungen
NFC-Lesestatus, Chip-Authentifizierung, Gültigkeit des Dokuments, Selfie-Prüfung sowie optionale PDF- und Berichtsdaten.
Bildfelder
Bildfelder wie das DG2-Porträtfoto, das maskierte MRZ-Bild und das Selfie-Bild werden bei Abfrage inline als Base64-kodierte Daten zurückgegeben. Bilder werden nicht als öffentliche URLs zurückgegeben.
Base64-kodiert
Verwende den Daten wert als Base64-kodierte binäre Bilddaten.
Inhaltstyp
Verwenden Sie den Content-Type, z. B. „image/jpeg“, um das Bild korrekt wiederherzustellen.
Nur auf Anfrage
Bilddaten werden nur dann einbezogen, wenn das Feld in der Vorlage ausdrücklich angefordert wird.
Maskierung von Dokumentennummern
Die Dokumentennummer kann vollständig oder maskiert ausgegeben werden. Durch die Maskierung wird die unnötige Offenlegung von Dokumentennummern vermieden, während Abgleiche oder Prüfungen in Ihrem eigenen System weiterhin möglich sind.
| Wert | Option | Beschreibung |
|---|---|---|
(empty) | No masking | Return the document number as read from the identity document. Only use when the full document number is required. |
last4_visible | Last 4 visible | Mask the document number and only return the last four characters, for example *****7P44. |
first4_visible | First 4 visible | Mask the document number and only return the first four characters. |
Beispiel für eine API-Anfrage
Im folgenden Beispiel wird eine Verifizierungsanfrage erstellt, ID Scan wird beauftragt, die Einladung per E-Mail zu versenden, und es werden nur die ausgewählten Felder und Prüfungen zurückgegeben.
Beispielergebnis
Nach Abschluss des Vorgangs kann Ihr System das Ergebnis anhand der Anfrage-ID oder des Anfrageschlüssels abrufen. Mithilfe der externen Referenz können Sie das Ergebnis mit Ihrem eigenen System verknüpfen.
Datenspeicherung und Datenschutz
Die Aufbewahrungseinstellungen können für jeden Mandanten individuell konfiguriert werden. Verifizierungsdaten können nach einer festgelegten Frist, nach dem Lesen oder gemäß Ihrer konfigurierten Datenschutzrichtlinie gelöscht werden. Dies trägt dazu bei, die unnötige Speicherung sensibler Identitätsdaten zu begrenzen.
Feste Tage
Verifizierungsdaten nach einer festgelegten Anzahl von Tagen löschen.
Nach dem Lesen
Daten beim Abruf als gelesen markieren und die Löschung für einen späteren Zeitpunkt planen.
Portal- und API-Einstellungen
Verwenden Sie bei Bedarf unterschiedliche Aufbewahrungseinstellungen für Portal- und API-Workflows.
Weitere Endpunkte
Neben dem Erstellen und Abrufen von Anfragen können Integrationen Einladungen erneut versenden oder eine Anfrage löschen. Das Löschen einer Anfrage ist sinnvoll, wenn ein Workflow abgebrochen wird oder eine Verifizierung nicht mehr erforderlich ist.
Einladungen erneut Versenden
POST /scan-requests/{id}/resend
Löschanfrage
DELETE /scan-requests/{id}
Details lesen
GET /scan-requests/{id}/details
Testmodus
Der Testmodus kann genutzt werden, um den gesamten Integrationsablauf vor der Inbetriebnahme zu überprüfen. Testanfragen werden in der API-Antwort mit „IsTest“ gekennzeichnet, sodass Ihr System Testdaten von den Produktionsabläufen unterscheiden kann.
Sicheres Testen
Überprüfen Sie die Erstellung von Anfragen, die Zustellung, das Scannen von Apps und den Abruf von Ergebnissen, ohne Produktions-Workflows zu verwenden.
Als Antwort sichtbar
Die Antwort auf die Create-Anfrage enthält Parameter „IsTest“, wodurch Testanfragen leicht zu erkennen sind.
Später online gehen
Beginnen Sie mit der Einrichtung eines Test-API-Schlüssels oder eines Test-Tenants und wechseln Sie nach der Validierung zur Live-Verifizierung.
Open-Source-.NET-Beispiel
Sehen Sie sich unser öffentliches .NET-Integrationsbeispiel auf GitHub an. Das Beispiel zeigt, wie Sie Verifizierungsanfragen erstellen, Verifizierungsergebnisse abrufen und die NFC-Passverifizierung in Ihre eigenen Anwendungen integrieren können.
Vollständiges Beispiel
Umfasst Workflows zur Erstellung von Anfragen, zum Abruf von Ergebnissen und zur Identitätsprüfung unter Verwendung von C# und .NET.
NFC-Überprüfung
Erfahren Sie, wie Sie die Ergebnisse der NFC-Passüberprüfung, die Datenfelder und die Überprüfungsschritte bearbeiten.
Open Source
Klonen Sie das Repository, testen Sie die API und nutzen Sie sie als Ausgangspunkt für Ihre eigene Integration.
Fehlschläge und unvollständige Ergebnisse
Nicht jede Anfrage führt zu einer erfolgreichen Überprüfung. Ein Benutzer kann den Ablauf abbrechen, die Anfrage kann verfallen oder das Auslesen per NFC kann fehlschlagen. Verwenden Sie die Felder „Status“, „HasResult“, „IsSuccess“ und die Überprüfungsfelder, um das endgültige Ergebnis zu ermitteln.
Sind Sie bereit für die Integration der NFC-Identitätsprüfung?
Erstellen Sie ein kostenloses Konto, generieren Sie einen API-Schlüssel und testen Sie den gesamten Ablauf, bevor Sie live gehen.