ID
Scan
API επαλήθευσης ταυτότητας NFC • Προτεραιότητα στην προστασία της ιδιωτικής ζωής • Έτοιμο για API

Ενσωματώστε την επαλήθευση ταυτότητας στο δικό σας λογισμικό.

Δημιουργήστε ασφαλή αιτήματα επαλήθευσης ταυτότητας μέσω NFC από το δικό σας σύστημα. Προσκαλέστε τους χρήστες μέσω email ή SMS ή στείλτε εσείς οι ίδιοι τον σύνδεσμο που δημιουργήθηκε. Ο χρήστης σαρώνει το τσιπ NFC στην εφαρμογή για κινητά και εσείς λαμβάνετε μόνο τα πεδία που απαιτεί η διαδικασία σας.

Επαλήθευση τσιπ NFCΔιαβάστε τα δεδομένα DG1/DG2 και ελέγξτε το τσιπ του εγγράφου.
Ελαχιστοποίηση δεδομένωνΖητήστε μόνο τα πεδία και τους ελέγχους που απαιτούνται για τη ροή εργασιών σας.
Δική σας ροή εργασιώνΧρησιμοποιήστε εξωτερικές αναφορές για να συνδέσετε τα αποτελέσματα με τα δικά σας αρχεία.
Παράδειγμα ροής
1POST /scan-requests
2Invite email / SMS / own channel
3App NFC + optional selfie check
4GET /scan-requests/{id}/details

Ροή API

Το ID Scan έχει σχεδιαστεί για προμηθευτές λογισμικού και οργανισμούς που επιθυμούν να ενσωματώσουν την επαλήθευση ταυτότητας χωρίς να χρειαστεί να δημιουργήσουν οι ίδιοι ολόκληρη τη διαδικασία σάρωσης μέσω κινητού.

1

Δημιουργία αιτήματος

Δημιουργήστε ένα αίτημα σάρωσης από το backend σας. Προσθέστε μια εξωτερική αναφορά, τη γλώσσα, την ημερομηνία λήξης, τις ρυθμίσεις παράδοσης, τα απαιτούμενα πεδία και τους ελέγχους.

2

Προσκαλέστε τον χρήστη

Αφήστε το ID Scan να στείλει το email ή το SMS, ή χρησιμοποιήστε το δικό σας κανάλι επικοινωνίας με τον σύνδεσμο επαλήθευσης που θα λάβετε.

3

Σάρωση μέσα από την εφαρμογή

Ο χρήστης ανοίγει την εφαρμογή για κινητά, σαρώνει τη ζώνη MRZ, διαβάζει το τσιπ NFC και, προαιρετικά, πραγματοποιεί έλεγχο μέσω ζωντανής selfie σε σύγκριση με τη φωτογραφία πορτρέτου του DG2.

4

Ανάκτηση του αποτελέσματος

Ανάκτηση κατάστασης, ελέγχων, ζητούμενων πεδίων και πληροφοριών ελέγχου μέσω του API. Επιστρέφονται μόνο τα πεδία που έχουν ρυθμιστεί.

Βασική διεύθυνση URL και έλεγχος ταυτότητας

Οι κλήσεις API αποστέλλονται στη βασική διεύθυνση URL του API ID Scan και πιστοποιούνται μέσω ενός κλειδιού API που δημιουργείται στην πύλη ID Scan. Το κλειδί API αποστέλλεται μέσω μιας ειδικής κεφαλίδας αιτήματος και πρέπει να χρησιμοποιείται αποκλειστικά από την πλευρά του διακομιστή. Μην αποκαλύπτετε ποτέ κλειδιά API στον κώδικα του frontend ή σε εφαρμογές για κινητά.

Base URL https://api.id-scan.app Example request GET https://api.id-scan.app/api/scan-requests/{id}/details X-API-KEY: YOUR_API_KEY Accept: application/json

Δημιουργία αιτήματος-απάντησης

Όταν δημιουργείται ένα αίτημα σάρωσης, το API επιστρέφει τον αναγνωριστικό αιτήματος, το κλειδί αιτήματος, την ώρα λήξης και τους συνδέσμους επαλήθευσης. Χρησιμοποιήστε τη διεύθυνση WebUrl που επιστρέφεται στο δικό σας email, SMS, στην πύλη ή στη ροή εργασιών σας όταν χρησιμοποιείτε την αυτόματη παράδοση. Στις κινητές συσκευές, η διεύθυνση DeepLinkUrl μπορεί να ανοίξει απευθείας την εφαρμογή.

{ "ScanRequestId": "2153ae29-0b77-4601-87b6-17ce9037ef3d", "Status": "requested", "LanguageCode": "nl", "ExternalReference": "customer-12345", "RequestKey": "ab6f1c05de29", "ExpiresAtUtc": "2026-05-28T06:58:17.9384521Z", "DeepLinkUrl": "idcheck://scan/ab6f1c05de29", "WebUrl": "https://id-scan.app/ab6f1c05de29", "IsTest": false }

Επιλογές παράδοσης

Μπορείτε να επιλέξετε τον τρόπο με τον οποίο ο χρήστης θα λάβει το αίτημα επαλήθευσης. Αυτό επιτρέπει στο ID Scan να ενσωματώνεται τόσο σε πλήρως αυτοματοποιημένες όσο και σε προσαρμοσμένες ροές επικοινωνίας.

Ηλεκτρονικό ταχυδρομείο της πλατφόρμας

Το ID Scan στέλνει ένα επώνυμο email πρόσκλησης με έναν ασφαλή σύνδεσμο επαλήθευσης.

Πλατφόρμα SMS

Το ID Scan στέλνει τον σύνδεσμο επαλήθευσης μέσω SMS. Χρήσιμο για διαδικασίες εγγραφής που δίνουν προτεραιότητα στα κινητά.

Παράδοση από τον ίδιο τον πελάτη

Το σύστημά σας λαμβάνει τον σύνδεσμο και τον προωθεί μέσω του δικού σας email, SMS, της πύλης ή της ροής εργασιών ανταλλαγής μηνυμάτων.

Κατάσταση αιτήσεων

Ένα αίτημα επαλήθευσης περνάει από μια μικρή σειρά καταστάσεων. Οι ενσωματώσεις μπορούν να χρησιμοποιούν αυτές τις καταστάσεις για να εμφανίζουν την πρόοδο, να ενεργοποιούν υπενθυμίσεις ή να αποφασίζουν αν απαιτείται νέο αίτημα.

ΚατάστασηΠεριγραφή
requestedThe request has been created and is waiting for the user to start or complete the verification.
completedThe user completed the flow. Use IsSuccess and the check fields to determine whether verification passed.
expiredThe request expired before the user completed the verification.
deletedThe request was deleted and is no longer available for completion.
failedThe request could not be completed successfully because of an error or failed verification step.

Εξωτερική αναφορά

Χρησιμοποιήστε μια εξωτερική αναφορά για να συνδέσετε ένα αίτημα επαλήθευσης με τον δικό σας πελάτη, υπάλληλο, φάκελο, παραγγελία ή αρχείο εγγραφής. Η ίδια αναφορά εμφανίζεται όταν ανακτάτε τις λεπτομέρειες του αιτήματος.

ID ασθενούς

Συνδέστε το αίτημα με το αρχείο του πελάτη σας.

Αριθμός υπόθεσης ή φακέλου

Συνδέστε το αποτέλεσμα με έναν φάκελο Wwft, HR ή συμμόρφωσης.

Αριθμός παραγγελίας ή ροής εργασιών

Χρησιμοποιήστε τον κωδικό αναφοράς για να συνεχίσετε τις αυτοματοποιημένες ροές εργασίας μετά την ολοκλήρωση της επαλήθευσης.

Υποχρεωτικά πεδία

Το ID Scan υποστηρίζει την ελαχιστοποίηση των δεδομένων. Ρυθμίστε ακριβώς ποια πεδία θα πρέπει να επιστρέφονται στο σύστημά σας. Ο χρήστης μπορεί να δει ποια δεδομένα θα κοινοποιηθούν πριν από την υποβολή.

ΠεδίοΠεριγραφήΠηγή
surnameSurname / family name from the identity document.NFC DG1
given_namesGiven names from the identity document.NFC DG1
date_of_birthDate of birth. Can also be used for age checks.NFC DG1
date_of_expiryDocument expiry date.NFC DG1
document_numberDocument number. Can be returned full or masked depending on template settings.NFC DG1
document_typeDocument type, such as passport or identity card.NFC DG1
issuing_countryCountry that issued the document.NFC DG1
country_of_issueCountry of issue when available.NFC DG1
nationalityNationality from the identity document.NFC DG1
genderGender marker from the document, if requested.NFC DG1
photoPortrait photo from the NFC chip. Only return when explicitly needed.NFC DG2
mrz_masked_imageMasked MRZ image as proof of scan without exposing all MRZ data.Camera/MRZ
selfie_imageLive selfie image. Usually only included for manual review.Camera/selfie

Διαθέσιμες επιταγές

Οι έλεγχοι μπορούν να ζητηθούν στο πλαίσιο της διαδικασίας επαλήθευσης. Ορισμένοι έλεγχοι είναι τεχνικοί έλεγχοι NFC, ενώ άλλοι αφορούν επιχειρηματικούς κανόνες, όπως η ελάχιστη ηλικία ή η επαλήθευση μέσω selfie.

ΕλεγχοςΠεριγραφήΑποτέλεσμα που επιστράφηκε
nfc_read_successIndicates whether the NFC chip was successfully read.true / false
chip_authentication_successIndicates whether chip authentication or chip verification succeeded.true / false
document_not_expiredChecks if the document expiry date is in the future.true / false
minimum_ageChecks whether the person meets a configured minimum age without necessarily returning the date of birth.{ required, passed }
sod_signature_validChecks the SOD signature when available.true / false
dg1_hash_validChecks whether DG1 data matches the signed document data.true / false
dg2_hash_validChecks whether the portrait photo data matches the signed document data.true / false
active_auth_okOptional active authentication result when supported by the document.true / false / not available
selfie_checkOptional live selfie verification matched against the DG2 portrait photo.{ requested, consent_given, passed, status, method }

Πεδία αποτελεσμάτων και επιστροφής

Το τελικό αποτέλεσμα επιστρέφει την κατάσταση του αιτήματος, την κατάσταση της επαλήθευσης, την εξωτερική αναφορά, τα επιλεγμένα πεδία ταυτότητας, τις επιλεγμένες εικόνες και τα αποτελέσματα του ελέγχου. Τα πεδία που δεν ζητήθηκαν δεν επιστρέφονται.

Κατάσταση αίτησης

Ζητήθηκαν, ολοκληρώθηκαν, έληξαν, διαγράφηκαν ή απέτυχαν, συμπεριλαμβανομένων των χρονικών σημάνσεων δημιουργίας και ολοκλήρωσης.

Επιλεγμένα πεδία

Μόνο τα στοιχεία ταυτότητας που έχουν καταχωριστεί, όπως το όνομα, η εθνικότητα, η ημερομηνία γέννησης ή η ημερομηνία λήξης του εγγράφου.

Έλεγχοι και επιθεώρηση

Κατάσταση ανάγνωσης NFC, επαλήθευση γνησιότητας τσιπ, ισχύς εγγράφου, έλεγχος αυτοφωτογραφίας και προαιρετικά δεδομένα PDF/αναφορών.

Πεδία εικόνας

Τα πεδία εικόνας, όπως η φωτογραφία πορτρέτου DG2, η εικόνα MRZ με κάλυμμα και η εικόνα selfie, επιστρέφονται ενσωματωμένα ως δεδομένα κωδικοποιημένα σε Base64 όταν ζητηθούν. Οι εικόνες δεν επιστρέφονται ως δημόσιες διευθύνσεις URL.

Κωδικοποιημένο σε Base64

Χρησιμοποιήστε την τιμή των δεδομένων ως δυαδικά δεδομένα εικόνας κωδικοποιημένα σε Base64.

Τύπος περιεχομένου

Χρησιμοποιήστε τον τύπο περιεχομένου, όπως image/jpeg, για να αναδημιουργήσετε σωστά την εικόνα.

Μόνο κατόπιν αιτήματος

Τα δεδομένα εικόνας περιλαμβάνονται μόνο όταν το πεδίο ζητείται ρητά στο πρότυπο.

Απόκρυψη αριθμού εγγράφου

Ο αριθμός εγγράφου μπορεί να εμφανιστεί πλήρης ή με κρυμμένα στοιχεία. Η απόκρυψη στοιχείων συμβάλλει στη μείωση της περιττής έκθεσης των αριθμών εγγράφων, ενώ παράλληλα επιτρέπει την πραγματοποίηση ελέγχων αντιστοίχισης ή ελέγχων στο δικό σας σύστημα.

ΑξίαΕπιλογήΠεριγραφή
(empty)No maskingReturn the document number as read from the identity document. Only use when the full document number is required.
last4_visibleLast 4 visibleMask the document number and only return the last four characters, for example *****7P44.
first4_visibleFirst 4 visibleMask the document number and only return the first four characters.

Παράδειγμα αιτήματος API

Το παρακάτω παράδειγμα δημιουργεί ένα αίτημα επαλήθευσης, ζητά από το ID Scan να στείλει την πρόσκληση μέσω email και επιστρέφει μόνο τα επιλεγμένα πεδία και ελέγχους.

POST /api/scan-requests X-API-KEY: YOUR_API_KEY Content-Type: application/json { "externalReference": "customer-12345", "language": "en", "expiresInHours": 72, "delivery": { "mode": "platform", "channels": ["email"], "emailAddress": "client@example.com", "phoneNumber": null }, "template": { "fields": { "given_names": { "requested": true }, "surname": { "requested": true }, "document_number": { "requested": true, "masking": "last4_visible" }, "country_of_issue": { "requested": true }, "photo": { "requested": true }, "date_of_expiry": { "requested": true }, "nationality": { "requested": true }, "mrz_masked_image": { "requested": true } }, "checks": { "document_not_expired": true, "nfc_read_success": true, "chip_authentication_success": true, "selfie_check": true, "minimum_age": 18 } } }

Παράδειγμα αποτελέσματος

Μετά την ολοκλήρωση, το σύστημά σας μπορεί να ανακτήσει το αποτέλεσμα χρησιμοποιώντας τον αναγνωριστικό αιτήματος ή το κλειδί αιτήματος. Η εξωτερική αναφορά μπορεί να χρησιμοποιηθεί για τη σύνδεση του αποτελέσματος με το δικό σας σύστημα.

GET /api/scan-requests/{id}/details X-API-KEY: YOUR_API_KEY { "VerificationRequestId": "912eef5b-7ec7-4825-9125-b5a0e68eb878", "Name": "Jane Doe", "EmailAddress": "jane@example.com", "PhoneNumber": "31612345678", "PreferredLanguage": "en", "Status": "completed", "RequestType": "identity_check", "DeliveryMode": "platform", "DeliveryChannels": "sms,email", "ResultJson": { "fields": { "country_of_issue": "NLD", "nationality": "NLD", "given_names": "JANE MARIA", "surname": "DOE", "date_of_expiry": "2034-01-03", "document_number": "*****7P44", "photo": { "available": true, "content_type": "image/jpeg", "data": "/9j/..." }, "mrz_masked_image": { "available": true, "content_type": "image/jpeg", "data": "/9j/4AAQSQ==..." } }, "checks": { "nfc_read_success": true, "chip_authentication_success": true, "document_not_expired": true, "minimum_age": { "required": 18, "passed": true }, "selfie_check": { "requested": true, "consent_given": true, "passed": true, "status": "passed", "method": "on_device_face_match" } } }, "CreatedDateTimeUtc": "2026-05-26T06:14:26", "InvitationSentDateTimeUtc": "2026-05-26T06:14:26", "CompletedDateTimeUtc": "2026-05-26T06:16:04", "HasResult": true, "IsSuccess": true, "NfcReadSuccess": true, "ChipAuthenticationSuccess": true, "Summary": "Passport chip successfully read", "DocumentType": "PASSPORT" }

Διατήρηση δεδομένων και προστασία της ιδιωτικής ζωής

Οι ρυθμίσεις διατήρησης μπορούν να διαμορφωθούν ανά χρήστη. Τα δεδομένα επαλήθευσης μπορούν να διαγραφούν μετά από ένα καθορισμένο χρονικό διάστημα, μετά την ανάγνωση ή σύμφωνα με την πολιτική απορρήτου που έχετε διαμορφώσει. Αυτό συμβάλλει στον περιορισμό της περιττής αποθήκευσης ευαίσθητων δεδομένων ταυτότητας.

Καθορισμένες ημέρες

Διαγραφή των δεδομένων επαλήθευσης μετά από έναν καθορισμένο αριθμό ημερών.

Αφού διαβάσετε

Σημειώστε τα δεδομένα ως αναγνωσμένα κατά την ανάκτησή τους και προγραμματίστε τη διαγραφή τους μετά από αυτό το σημείο.

Ρυθμίσεις πύλης και API

Χρησιμοποιήστε ξεχωριστές ρυθμίσεις διατήρησης για τις ροές εργασιών του portal και του API, όταν απαιτείται.

Πρόσθετα καταληκτικά σημεία

Εκτός από τη δημιουργία και την ανάκτηση αιτημάτων, οι ενσωματώσεις μπορούν να επαναστέλουν προσκλήσεις ή να διαγράψουν ένα αίτημα. Η διαγραφή ενός αιτήματος μπορεί να χρησιμοποιηθεί όταν μια ροή εργασιών ακυρωθεί ή όταν η επαλήθευση δεν είναι πλέον απαραίτητη.

Επανάληψη αποστολής πρόσκλησης

POST /api/scan-requests/{id}/resend

Διαγραφή αιτήματος

DELETE /api/scan-requests/{id}

Διαβάστε περισσότερα

GET /api/scan-requests/{id}/details

Δοκιμαστική λειτουργία

Η λειτουργία δοκιμής μπορεί να χρησιμοποιηθεί για την επαλήθευση της πλήρους ροής ενσωμάτωσης πριν από την έναρξη της λειτουργίας. Τα αιτήματα δοκιμής επισημαίνονται με την ένδειξη «IsTest» στην απόκριση του API, ώστε το σύστημά σας να μπορεί να διαχωρίζει τα δεδομένα δοκιμής από τις ροές εργασίας παραγωγής.

Ασφαλείς δοκιμές

Επαληθεύστε τη δημιουργία αιτήματος, την παράδοση, τη σάρωση εφαρμογών και την ανάκτηση αποτελεσμάτων χωρίς να χρησιμοποιείτε ροές εργασίας παραγωγής.

Εμφανίζεται ως απάντηση

Η απόκριση της αίτησης δημιουργίας περιέχει το IsTest, γεγονός που διευκολύνει τον εντοπισμό των δοκιμαστικών αιτήσεων.

Να ξεκινήσει αργότερα

Ξεκινήστε με τη δημιουργία ενός δοκιμαστικού κλειδιού API ή ενός δοκιμαστικού λογαριασμού και μεταβείτε στην επαλήθευση σε πραγματικό περιβάλλον μετά την επικύρωση.

Αποτυχία και ατελή αποτελέσματα

Δεν οδηγεί κάθε αίτημα σε επιτυχή επαλήθευση. Ο χρήστης μπορεί να διακόψει τη διαδικασία, το αίτημα μπορεί να λήξει ή η ανάγνωση μέσω NFC μπορεί να αποτύχει. Χρησιμοποιήστε τις παραμέτρους Status, HasResult, IsSuccess και τα πεδία ελέγχου για να προσδιορίσετε το τελικό αποτέλεσμα.

{ "VerificationRequestId": "912eef5b-7ec7-4825-9125-b5a0e68eb878", "Status": "completed", "HasResult": true, "IsSuccess": false, "NfcReadSuccess": false, "ChipAuthenticationSuccess": false, "Summary": "NFC chip could not be read", "DocumentType": null, "ResultJson": { "checks": { "nfc_read_success": false, "chip_authentication_success": false, "document_not_expired": null, "selfie_check": { "requested": true, "consent_given": false, "passed": false, "status": "not_completed", "method": "on_device_face_match" } } } }

Είστε έτοιμοι να ενσωματώσετε την επαλήθευση ταυτότητας μέσω NFC;

Δημιουργήστε έναν δωρεάν λογαριασμό, δημιουργήστε ένα κλειδί API και δοκιμάστε την πλήρη ροή πριν τη θέσετε σε λειτουργία.