Erstellt sécher NFC-Identitéitsverifizéierungsufroen aus Ärem eegene System. Invitëiert d'Benotzer per E-Mail oder SMS, oder schéckt de generéierten Link selwer. De Benotzer scannt de NFC-Chip an der Mobilapp, an Dir zitt nëmmen déi Felder eraus, déi Äre Prozess brauch.
ID Scan ass entworf fir Softwareverkeefer a Organisatiounen, déi Identitéitsverifizéierung derbäisetzen wëllen, ouni de komplette mobilen Scannflow selwer opzebauen.
Erstellt eng Scanufro vun Ärem Backend. Füügt eng extern Referenz, eng Sprooch, eng Ablaufdauer, Liwwerungsastellungen, déi ugefrote Felder an Iwwerpréiungen derbäi.
Loosst ID Scan d'E-Mail oder d'SMS verschécken, oder benotzt Ären eegene Kommunikatiounskanal mam zréckgeschéckten Verifizéierungslink.
De Benotzer mécht d'Mobilapp op, scannt d'MRZ, liest de NFC-Chip an optiounal féiert en Live-Selfie-Check géint d'DG2-Portraitfoto duerch.
Rufft de Status, d'Prüfungen, d'ufgefuerderte Felder an d'Audit-Informatiounen iwwer d'API of. Nëmmen déi konfiguréiert Felder ginn zréck.
API-Ufroen ginn un d'Basis-URL vun der ID Scan API geschéckt a mat engem API-Schlëssel authentifizéiert, deen am ID Scan-Portal generéiert gouf. De API-Schlëssel gëtt iwwer e spezielle Request-Header iwwerdroen a soll nëmmen op der Server-Säit benotzt ginn. Nie API-Schlësselen am Frontend-Code oder an mobilen Applikatiounen exponéieren.
Wann eng Scan-Ufro erstallt gëtt, gëtt d'API d'Ufro-ID, d'Ufro-Schlëssel, d'Oflaafzäit an d'Verifizéierungslinks zréck. Benotzt déi zréckginn WebUrl an Ärer eegener E-Mail, SMS, Portal oder am Workflow bei der Selbstliwwerung. Op mobilen Apparater kann d'DeepLinkUrl d'App direkt opmaachen.
Dir kënnt wielen, wéi de Benotzer d'Verifizéierungsufro kritt. Dëst erlaabt et, datt ID Scan souwuel an vollautomatiséiert wéi och personaliséiert Kommunikatiounsflëss integréiert gëtt.
ID Scan schéckt eng markéiert Invitatiouns-E-Mail mat engem sécheren Verifizéierungslink.
ID Scan schéckt de Verifizéierungslink per SMS. Nëtzlech fir mobile-first Onboarding-Flows.
Äert System kritt de Link a schéckt en iwwer Ären eegene E-Mail-, SMS-, Portal- oder Messaging-Workflow.
Eng Verifizéierungsufro geet duerch e klenge Set vu Statusen. Integratiounen kënnen dës Statusen benotzen, fir de Fortschrëtt unzeweisen, Erënnerungen auszeléisen oder ze entscheeden, ob eng nei Ufro néideg ass.
| Status | Beschreiwung |
|---|---|
requested | The request has been created and is waiting for the user to start or complete the verification. |
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. |
Benotzt eng extern Referenz, fir eng Verifizéierungsufro mat Ärem eegene Client, Mataarbechter, Dossier, Bestellung oder Onboarding-Dossier ze verbannen. Déi selwecht Referenz gëtt zréckginn, wann Dir d'Detailer vun der Ufro ofrufft.
Verbënnt d'Ufro mat Ärem eegene Client- oder Kundendossier.
Verbënnt d'Resultat mat engem Wwft-, HR- oder Compliance-Dossier.
Benotzt d'Referenz, fir automatiséiert Workflows no der Ofschloss vun der Verifikatioun weiderzeféieren.
ID Scan ënnerstëtzt d'Dataminimiséierung. Konfiguréiert genee, wéi eng Felder un Äre System zréckgeschéckt solle ginn. Dem Benotzer kann gewisen ginn, wéi eng Donnéeën virum Ofschécken gedeelt ginn.
| Feld | Beschreiwung | Quell |
|---|---|---|
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 |
Kontrollen kënnen als Deel vum Verifikatiounsprozess ugefrot ginn. E puer Kontrollen sinn technesch NFC-Kontrollen, während anerer Geschäftsreegelen sinn, wéi zum Beispill d'Mindestalter oder d'Selfie-Verifikatioun.
| Préift | Beschreiwung | Zréckginn Resultat |
|---|---|---|
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 } |
D'Resultat-Endpunkt liwwert de Request-Status, de Verifizéierungs-Status, eng extern Referenz, déi ausgewielte Identitéitsfelder, déi ausgewielte Biller an d'Kontrollresultater zréck. Felder, déi net ugefrot goufen, ginn net zréckginn.
Ugefrot, ofgeschloss, ofgelaf, geläscht oder net erfollegräich, inklusiv erstallt a ofgeschloss Zäitstempel.
Nëmmen konfiguréiert Identitéitsdaten wéi Numm, Nationalitéit, Gebuertsdatum oder Dokumentverfallsdatum.
NFC-Liesestatus, Chipauthentifikatioun, Dokumentgëltegkeet, Selfie-Check an optional PDF-/Berichtsdaten.
Bildfelder wéi d'DG2-Portraitfoto, d'maskéiert MRZ-Bild an d'Selfie-Bild ginn op Ufro inline als Base64-kodéiert Daten zréck. Biller ginn net als ëffentlech URLs zréckginn.
Benotzt de Datewäert als Base64-kodéiert binär Bilddaten.
Benotzt content_type, wéi image/jpeg, fir d'Bild korrekt ze rekonstruéieren.
Bilddaten ginn nëmmen abegraff, wann d'Feld explizit an der Schabloun ugefrot gëtt.
D'Dokumentnummer kann komplett oder maskéiert zréckginn. D'Maskéierung hëlleft, onnéideg Expositioun vun Dokumentnummeren ze reduzéieren, während se nach ëmmer erlaabt, d'Dokumentnummeren an Ärem eegene System ofzestëmmen oder Auditen duerchzeféieren.
| Wäert | Optioun | Beschreiwung |
|---|---|---|
(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. |
D'Beispill hei ënnen erstellt eng Verifizéierungsufro, bitt ID Scan d'Invitatioun per E-Mail ze schécken a gëtt nëmmen déi ausgewielten Felder an Iwwerpréiungen zréck.
Nodeems et ofgeschloss ass, kann Äert System d'Resultat no der Ufro-ID oder dem Ufro-Schlëssel ofroepen. D'extern Referenz kann benotzt ginn, fir d'Resultat mat Ärem eegene System ze verbannen.
Retentiounsastellungen kënnen pro Tenant konfiguréiert ginn. Verifizéierungsdaten kënnen no enger festgeluechter Frist, no dem Liesen oder no Ärer konfiguréierter Privatsphärpolitik geläscht ginn. Dëst hëlleft, onnéideg Späichere vu sensiblen Identitéitsdaten ze limitéieren.
Läscht d'Verifizéierungsdaten no enger konfiguréierter Zuel vu Deeg.
Markéiert d'Donnéeën als gelies, wann se ofgeruff ginn, a plangt hir Läschung no deem Moment.
Benotzt bei Bedarf getrennte Retentiounsastellungen fir Portal- a API-Workflows.
Ausserdeem kënnen Integratiounen, nieft dem Erstellen an dem Ofruffen vun Ufroen, Invitatiounen nei verschécken oder eng Ufro läschen. D'Läschen vun enger Ufro kann agesat ginn, wann e Workflow annuléiert gëtt oder eng Verifikatioun net méi néideg ass.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
De Testmodus kann benotzt ginn, fir de komplette Integratiounsflow virum Livegang ze validéieren. Testufroen si an der API-Äntwert mat IsTest markéiert, sou datt Äert System Testdaten vun de Produktiounsprozesser trennen kann.
Validéiert d'Erstellung vun Ufroen, d'Liwwerung, d'Scannen vun der Applikatioun an d'Ofhuele vun de Resultater ouni Produktiouns-Workflows ze benotzen.
D'Create-Request-Äntwert enthält IsTest, wat Testufroen einfach z'entdecken mécht.
Fänkt mat enger Test-API-Schlëssel oder engem Test-Tenant-Setup un a wiesselt no der Validatioun op d'Liewen-Verifizéierung.
Net all Ufro resultéiert an enger erfollegräicher Verifikatioun. En Benotzer kann de Prozess stoppen, d'Ufro kann oflafen oder d'NFC-Liesen kann fehlschloen. Benotzt Status, HasResult, IsSuccess an d'Checkfelder fir d'endgülteg Resultat ze bestëmmen.
Maacht e gratis Kont op, generéiert en API-Schlëssel a test de komplette Prozess, ier dir live gitt.