NFC API za provjeru identiteta • Privatnost na prvom mjestu • Spremno za API

Integrirajte provjeru identiteta u vlastiti softver.

Kreirajte sigurne zahtjeve za provjeru NFC identiteta iz vlastitog sustava. Pozovite korisnike e-poštom ili SMS-om ili sami pošaljite generirani link. Korisnik skenira NFC čip u mobilnoj aplikaciji, a vi preuzimate samo ona polja koja vaš proces treba.

Zatražite pristup API-ju Pregledajte primjere API-ja

Verifikacija NFC čipaPročitajte podatke DG1/DG2 i provjerite čip dokumenta.

Minimizacija podatakaZatražite samo polja i provjere potrebne za vaš tijek rada.

Vlastiti tijek radaKoristite vanjske reference kako biste povezali rezultate sa svojim dosjeima.

Primjer tijeka

1POST /scan-requests

2Invite email / SMS / own channel

3App NFC + optional selfie check

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

API protok

ID Scan je namijenjen dobavljačima softvera i organizacijama koje žele dodati provjeru identiteta bez samostalnog izrade cjelovitog mobilnog procesa skeniranja.

Stvorite zahtjev

Stvorite zahtjev za skeniranje iz vašeg backenda. Dodajte vanjsku referencu, jezik, rok isteka, postavke isporuke, tražena polja i provjere.

Pozovi korisnika

Neka ID Scan pošalje e-poštu ili SMS, ili upotrijebite vlastiti komunikacijski kanal s vraćenim poveznicom za provjeru.

Skenirajte u aplikaciji

Korisnik otvara mobilnu aplikaciju, skenira MRZ, čita NFC čip i po želji provodi provjeru uživo selfieja u usporedbi s DG2 portretnom fotografijom.

Preuzmi rezultat

Preuzmite status, provjere, zatražena polja i informacije o reviziji putem API-ja. Vraćaju se samo konfigurirana polja.

Osnovna URL adresa i autentifikacija

API pozivi se šalju na baznu URL adresu ID Scan API-ja i autentificiraju se pomoću API ključa generiranog u ID Scan portalu. API ključ se šalje putem posebnog zaglavlja zahtjeva i treba se koristiti samo na strani poslužitelja. Nikada ne izlažite API ključeve u frontend kodu ili mobilnim aplikacijama.

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

Stvorite odgovor na zahtjev

Kada se stvori zahtjev za skeniranje, API vraća ID zahtjeva, ključ zahtjeva, vrijeme isteka i poveznice za provjeru. Koristite vraćenu WebUrl u vlastitoj e-pošti, SMS-u, portalu ili tijeku rada prilikom samostalnog slanja. Na mobilnim uređajima DeepLinkUrl može izravno otvoriti aplikaciju.

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

Opcije dostave

Možete odabrati kako korisnik prima zahtjev za provjeru. To omogućuje da se ID Scan uklopi u potpuno automatizirane i prilagođene komunikacijske tokove.

Platforma e-pošte

ID Scan šalje brendirani pozivni e-mail s sigurnim poveznicom za provjeru.

SMS platforma

ID Scan šalje poveznicu za provjeru putem SMS-a. Korisno za mobile-first postupke registracije.

Samostalna dostava

Vaš sustav prima poveznicu i prosljeđuje je putem vašeg e-maila, SMS-a, portala ili tijeka poruka.

Statusni zahtjevi

Zahtjev za verifikaciju prolazi kroz mali skup statusa. Integracije mogu koristiti te statusa za prikaz napretka, pokretanje podsjetnika ili odlučivanje je li potreban novi zahtjev.

Status	Opis
`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.

Vanjski referent

Koristite vanjsku referencu za povezivanje zahtjeva za provjeru s vlastitim kupcem, zaposlenikom, dosjeom, narudžbom ili evidencijom o prijemu. Ista referenca se vraća kada dohvaćate detalje zahtjeva.

ID klijenta

Povežite zahtjev sa svojim zapisom o kupcu ili klijentu.

Broj predmeta ili dosjea

Povežite rezultat s Wwft, HR ili compliance dosjeom.

ID narudžbe ili tijeka rada

Koristite referencu za nastavak automatiziranih tijekova rada nakon dovršetka provjere.

Obavezna polja

ID Scan podržava minimizaciju podataka. Konfigurirajte točno koja polja trebaju biti vraćena u vaš sustav. Korisniku se prije slanja može prikazati koje će se podatke dijeliti.

Polje	Opis	Izvor
`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

Dostupni čekovi

Provjere se mogu zatražiti kao dio postupka verifikacije. Neke su provjere tehničke NFC provjere, dok su druge poslovna pravila poput minimalne dobi ili verifikacije selfieja.

Provjeri	Opis	Vraćeni rezultat
`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 i provjera sankcija

ID Scan može po želji provjeriti potvrđene podatke o identitetu u odnosu na skupove podataka o PEP-ovima, sankcijama i povezanim osobama. To pomaže u podršci KYC, AML i procesima usklađenosti nakon dovršetka NFC provjere dokumenata.

PEP skrining

Provjerite pojavljuje li se verificirana osoba kao politički izložena osoba.

Provjera sankcija

Provjerite pojavljuje li se verificirana osoba u skupovima podataka vezanim uz sankcije.

Ručni pregled

Mogući nalazi uvijek se trebaju ručno pregledati prije poduzimanja radnji.

Polja za rezultat i povrat

Krajnja točka rezultata vraća status zahtjeva, status provjere, vanjsku referencu, odabrana polja identiteta, odabrane slike i rezultate provjere. Polja koja nisu zatražena se ne vraćaju.

Zahtjev za status

Zatraženo, dovršeno, isteklo, izbrisano ili neuspjelo, uključujući stvorene i dovršene vremenske oznake.

Odabrana polja

Samo konfigurirani identifikacijski podaci kao što su ime, državljanstvo, datum rođenja ili datum isteka dokumenta.

Provjere i revizija

Status čitanja NFC-a, autentifikacija čipa, valjanost dokumenta, provjera selfija i opcionalni PDF/podaci za izvještavanje.

Polja slike

Polja slika, poput DG2 portretne fotografije, maskiranog MRZ-slike i selfie-slike, vraćaju se u tekstu kao Base64 kodirani podaci kada se zatraže. Slike se ne vraćaju kao javni URL-ovi.

Bazen64 kodirano

Koristite vrijednost podataka kao Base64 kodirane binarne podatke slike.

Vrsta sadržaja

Koristite content_type, na primjer image/jpeg, kako biste ispravno rekonstruirali sliku.

Samo na zahtjev

Podaci o slici uključuju se samo kada je polje izričito zatraženo u predlošku.

Maskiрање broja dokumenta

Broj dokumenta može se vratiti u cijelosti ili maskiran. Maskiranje pomaže smanjiti nepotrebno otkrivanje brojeva dokumenata, a istovremeno omogućuje usklađivanje ili revizijske provjere u vašem vlastitom sustavu.

Vrijednost	Opcija	Opis
`(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.

Primjer API zahtjeva

Primjer u nastavku stvara zahtjev za verifikaciju, traži od ID Scana da pošalje pozivnicu e-poštom i vraća samo odabrana polja i provjere.

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, "compliance_screening": true } } }

Primjer rezultata

Nakon dovršetka, vaš sustav može dohvatiti rezultat po ID-u zahtjeva ili ključu zahtjeva. Eksterna referenca može se koristiti za povezivanje rezultata s vašim vlastitim sustavom.

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_birth": "1985-04-12", "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" } }, "compliance": { "requested": true, "provider": "OpenSanctions", "match_found": false, "pep_match": false, "sanctions_match": false, "rca_match": false, "highest_score": 0.00, "matches": [] } }, "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" }

Održavanje i privatnost

Postavke zadržavanja mogu se konfigurirati za svakog najmoprimca. Podaci za provjeru mogu se izbrisati nakon određenog razdoblja, nakon čitanja ili u skladu s vašom konfiguriranom politikom privatnosti. To pomaže ograničiti nepotrebno pohranjivanje osjetljivih podataka o identitetu.

Fiksni dani

Obrišite podatke provjere nakon konfiguriranog broja dana.

Nakon čitanja

Označite podatke kao pročitanima pri dohvaćanju i zakažite njihovo brisanje nakon toga.

Postavke portala i API-ja

Koristite odvojena podešavanja zadržavanja za radne procese portala i API-ja kada je to potrebno.

Dodatni krajnji ciljevi

Osim stvaranja i dohvaćanja zahtjeva, integracije mogu ponovno poslati pozivnice ili izbrisati zahtjev. Brisanje zahtjeva može se koristiti kada je tijek rada otkazan ili verifikacija više nije potrebna.

Ponovno pošalji pozivnicu

POST /scan-requests/{id}/resend

Obradi zahtjev

DELETE /scan-requests/{id}

Pročitajte detalje

GET /scan-requests/{id}/details

Način ispitivanja

Testni način rada može se koristiti za provjeru cjelokupnog tijeka integracije prije puštanja u produkciju. Testni zahtjevi označeni su atributom IsTest u API odgovoru, što vašem sustavu omogućuje razdvajanje testnih podataka od produkcijskih tijekova.

Sigurno testiranje

Potvrdite stvaranje zahtjeva, isporuku, skeniranje aplikacije i dohvaćanje rezultata bez korištenja produkcijskih tijekova rada.

Vidljivo u odgovoru

Odgovor na zahtjev za stvaranje sadrži IsTest, što olakšava otkrivanje testnih zahtjeva.

Prijenos uživo kasnije

Počnite s postavkom testnog API ključa ili testnog najmoprimca i prije validacije prijeđite na verifikaciju uživo.

Primjer otvorenog koda za .NET

Istražite naš javni primjer integracije .NET-a na GitHubu. Primjer pokazuje kako kreirati zahtjeve za provjeru, dohvatiti rezultate provjere i integrirati provjeru NFC putovnica u vlastite aplikacije.

Potpuni primjer

Obuhvaća radne procese za izradu zahtjeva, dohvaćanje rezultata i provjeru identiteta koristeći C# i .NET.

NFC provjera

Naučite kako obrađivati rezultate provjere NFC putovnice, polja dokumenata i provjere valjanosti.

Otvoreni kod

Kloni spremište, testiraj API i upotrijebi ga kao polaznu točku za vlastitu integraciju.

Pogledajte .NET primjer na GitHubu

Neuspjeh i nepotpuni rezultati

Ne svaki zahtjev rezultira uspješnom verifikacijom. Korisnik može prekinuti tijek, zahtjev može isteći ili NFC čitanje može ne uspjeti. Koristite Status, HasResult, IsSuccess i polja za provjeru kako biste utvrdili konačni ishod.

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