ID
Scan
NFC-alapú személyazonosság-ellenőrző API • Az adatvédelem az első • API-kompatibilis

Integrálja az azonosítás ellenőrzését a saját szoftverébe.

Készítsen biztonságos NFC-alapú személyazonosság-ellenőrzési kéréseket a saját rendszeréből. Hívjon meg felhasználókat e-mailben vagy SMS-ben, vagy küldje el nekik saját maga a generált linket. A felhasználó beolvassa az NFC-chipet a mobilalkalmazásban, Ön pedig csak azokat a mezőket tölti le, amelyekre a folyamatához szüksége van.

NFC-chip ellenőrzéseOlvassa be a DG1/DG2 adatokat, és ellenőrizze a dokumentum chipjét.
Az adatok minimalizálásaKérjen csak azokat a mezőket és ellenőrzéseket, amelyekre a munkafolyamatához szüksége van.
Saját munkafolyamatHasználjon külső hivatkozásokat az eredmények és a saját dokumentációi közötti kapcsolat létrehozásához.
Példa a folyamatra
1POST /scan-requests
2Invite email / SMS / own channel
3App NFC + optional selfie check
4GET /scan-requests/{id}/details

API-folyamat

Az ID Scan olyan szoftvergyártók és szervezetek számára készült, amelyek személyazonosság-ellenőrzést szeretnének bevezetni anélkül, hogy maguknak kellene kialakítaniuk a teljes mobil szkennelési folyamatot.

1

Kérelmet benyújtani

Készítsen beolvasási kérést a háttérrendszeréből. Adja meg a külső hivatkozást, a nyelvet, a lejárati időt, a kézbesítési beállításokat, a kért mezőket és az ellenőrzéseket.

2

Hívja meg a felhasználót

Hagyja, hogy az ID Scan küldje el az e-mailt vagy az SMS-t, vagy használja a saját kommunikációs csatornáját a visszaküldött ellenőrző linkkel.

3

Beolvasás az alkalmazásban

A felhasználó megnyitja a mobilalkalmazást, beolvassa az MRZ-kódot, kiolvassa az NFC-chipet, majd – ha szükséges – elvégzi az élő szelfi-ellenőrzést a DG2-es portréfotóval összehasonlítva.

4

Az eredmény lekérése

Az API-n keresztül lekérdezheti az állapotot, az ellenőrzéseket, a kért mezőket és a könyvvizsgálati információkat. Csak a beállított mezők kerülnek visszaadásra.

Alap-URL és hitelesítés

Az API-hívásokat az ID Scan API alap-URL-jére küldik, és az azonosításhoz az ID Scan portálon generált API-kulcsot használják. Az API-kulcsot egy erre a célra szolgáló kérésfejlécben továbbítják, és azt kizárólag szerveroldalon szabad használni. Soha ne tegyék közzé az API-kulcsokat a felhasználói felület kódjában vagy mobilalkalmazásokban.

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

Kérés-válasz létrehozása

Amikor egy szkennelési kérelem létrejön, az API visszaadja a kérelem azonosítóját, kulcsát, a lejárati időt és az ellenőrző linkeket. Saját kézbesítés esetén használja a visszaküldött WebUrl-t az e-mailjeiben, SMS-eiben, portálján vagy munkafolyamatában. Mobil eszközökön a DeepLinkUrl segítségével közvetlenül megnyitható az alkalmazás.

{ "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 }

Szállítási lehetőségek

Kiválaszthatja, hogy a felhasználó milyen módon kapja meg az azonosítási kérést. Ezáltal az ID Scan mind a teljesen automatizált, mind az egyedi kommunikációs folyamatokba beilleszthető.

Platform e-mail

Az ID Scan egy márkajelzéssel ellátott meghívó e-mailt küld, amelyben egy biztonságos ellenőrző link található.

Platform SMS

Az ID Scan SMS-ben küldi el az ellenőrző linket. Hasznos a mobilra optimalizált regisztrációs folyamatokhoz.

Saját kiszállítás

A rendszer megkapja a linket, majd továbbítja azt az Ön e-mailjén, SMS-én, portálján vagy üzenetküldő rendszerén keresztül.

A kérések állapota

Egy ellenőrzési kérelem néhány állapotot végigjár. Az integrációk ezeket az állapotokat felhasználhatják az előrehaladás jelzésére, emlékeztetők küldésére, illetve annak eldöntésére, hogy szükség van-e új kérelemre.

ÁllapotLeírás
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.

Külső hivatkozás

Külső hivatkozás segítségével kapcsolhatja össze az ellenőrzési kérelmet saját ügyfeléhez, alkalmazottjához, ügyiratához, megrendeléséhez vagy regisztrációs adatlapjához. A kérelem részleteinek lekérésénél ugyanaz a hivatkozás jelenik meg.

Vásárló ID

Kössd össze a kérést a saját ügyfél- vagy megbízói adataiddal.

Ügy- vagy aktaszám

Kapcsolja össze az eredményt egy Wwft-, HR- vagy megfelelési dossziéval.

Megrendelés- vagy munkafolyamat-azonosító

Az ellenőrzés befejezése után használja a hivatkozást az automatizált munkafolyamatok folytatásához.

Kötelező mezők

Az ID Scan támogatja az adatok minimalizálását. Beállíthatja, hogy pontosan mely mezők kerüljenek vissza a rendszerébe. A felhasználó számára a beküldés előtt megjeleníthető, hogy mely adatok kerülnek megosztásra.

MezőLeírásForrás
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

Elérhető csekkek

Az ellenőrzések az azonosítási folyamat részeként kérhetők. Egyes ellenőrzések technikai jellegűek (pl. NFC-ellenőrzés), míg mások üzleti szabályokhoz kapcsolódnak, mint például a minimális életkor vagy a szelfi-azonosítás.

EllenőrzésLeírásVisszaadott eredmény
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 }

Eredmény- és visszatérési mezők

Az eredményvégpont visszaadja a kérés állapotát, az ellenőrzés állapotát, a külső hivatkozást, a kiválasztott azonosító mezőket, a kiválasztott képeket és az ellenőrzés eredményeit. A lekérdezésben nem szereplő mezők nem kerülnek visszaadásra.

A kérelem állapota

Kérelmezett, befejezett, lejárt, törölt vagy sikertelen, beleértve a létrehozás és a befejezés időbélyegeit is.

Kijelölt mezők

Kizárólag a személyazonosító adatok, például a név, az állampolgárság, a születési dátum vagy az okmány érvényességi ideje.

Ellenőrzések és könyvvizsgálat

NFC-olvasási állapot, chip-hitelesítés, dokumentum érvényessége, szelfi-ellenőrzés, valamint opcionális PDF- és jelentési adatok.

Képmezők

Az olyan képmezők, mint a DG2 portréfotó, a maszkolt MRZ-kép és a szelfi, kérésre Base64-kódolású adatként jelennek meg a szövegben. A képek nem nyilvános URL-ek formájában kerülnek visszaadásra.

Base64-kódolás

Használja az adatértéket Base64-kódolású bináris képi adatként.

Tartalom típus

Használja a content_type mezőt(például image/jpeg), hogy a kép megfelelően jelenjen meg.

Csak kérésre

A képadatok csak akkor kerülnek beillesztésre, ha a sablonban kifejezetten meg van jelölve az adott mező.

Dokumentumszám elrejtése

A dokumentumszám teljes formában vagy elrejtve is visszaadható. Az elrejtés segít csökkenteni a dokumentumszámok szükségtelen nyilvánosságra hozatalát, miközben továbbra is lehetővé teszi az egyeztetést vagy az ellenőrzést a saját rendszerében.

ÉrtékOpciókLeírás
(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.

Példa API-lekérésre

Az alábbi példában létrehozunk egy hitelesítési kérést, megkérjük az ID Scan szolgáltatást, hogy e-mailben küldje el a meghívót, és csak a kiválasztott mezőket és ellenőrzéseket adjuk vissza.

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 } } }

Példa az eredményre

A feldolgozás befejezése után a rendszer a kérés azonosítója vagy kulcsa alapján lekérheti az eredményt. A külső hivatkozás segítségével az eredményt összekapcsolhatja a saját rendszerével.

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" }

Adatmegőrzés és adatvédelem

A megőrzési beállítások bérlőnként konfigurálhatók. Az ellenőrzési adatok törölhetők egy meghatározott idő elteltével, az olvasást követően, vagy a beállított adatvédelmi irányelveknek megfelelően. Ez segít korlátozni az érzékeny személyazonosító adatok felesleges tárolását.

Rögzített napok

A hitelesítési adatokat a beállított napok számának letelte után törölje.

Elolvasás után

Az adatok letöltésekor jelölje meg őket olvasottként, majd állítsa be a törlést az adott időpont után.

Portál- és API-beállítások

Szükség esetén használjon külön megőrzési beállításokat a portál és az API munkafolyamatokhoz.

További végpontok

A kérések létrehozása és lekérése mellett az integrációk képesek a meghívók újraküldésére vagy a kérések törlésére is. A kérelem törlése akkor jöhet szóba, ha egy munkafolyamatot törölnek, vagy ha a hitelesítésre már nincs szükség.

Meghívó újraküldése

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

Törlési kérelem

DELETE /api/scan-requests/{id}

Részletek

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

Teszt üzemmód

A tesztmód segítségével az élesítés előtt ellenőrizhető a teljes integrációs folyamat. A tesztkéréseket az API-válaszban az „IsTest” jelöléssel látják el, így a rendszered képes elkülöníteni a tesztadatokat a termelési munkafolyamatoktól.

Biztonságos tesztelés

A kérések létrehozásának, kézbesítésének, az alkalmazások vizsgálatának és az eredmények lekérésének ellenőrzése a termelési munkafolyamatok igénybevétele nélkül.

Válaszban látható

A létrehozási kérelem válasza tartalmazza az IsTest mezőt, így a tesztkérelmek könnyen felismerhetők.

Később induljon el

Kezdje egy teszt API-kulccsal vagy tesztbérlő beállítással, majd az érvényesítés után váltson át az éles környezetre.

Kudarc és hiányos eredmények

Nem minden kérés vezet sikeres ellenőrzéshez. Előfordulhat, hogy a felhasználó megszakítja a folyamatot, a kérés lejár, vagy az NFC-olvasás sikertelen lesz. A végső eredmény megállapításához használja a Status, HasResult, IsSuccess tulajdonságokat és az ellenőrző mezőket.

{ "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" } } } }

Készen áll az NFC-alapú személyazonosság-ellenőrzés bevezetésére?

Hozzon létre egy ingyenes fiókot, generáljon egy API-kulcsot, és tesztelje le a teljes folyamatot, mielőtt élesben is bevezetné a rendszert.