ID
Scan
API de verificare a identității prin NFC • Confidențialitatea pe primul loc • Compatibil cu API-urile

Integrați funcția de verificare a identității în propriul software.

Creați solicitări sigure de verificare a identității prin NFC direct din sistemul dumneavoastră. Invitați utilizatorii prin e-mail sau SMS sau trimiteți-le personal linkul generat. Utilizatorul scanează cipul NFC în aplicația mobilă, iar dumneavoastră preluați doar câmpurile necesare procesului dumneavoastră.

Verificarea cipului NFCCitiți datele DG1/DG2 și verificați cipul documentului.
Reducerea la minimum a datelorSolicită doar câmpurile și verificările necesare pentru fluxul tău de lucru.
Propriul flux de lucruFolosiți referințe externe pentru a corela rezultatele cu propriile dosare.
Exemplu de flux
1POST /scan-requests
2Invite email / SMS / own channel
3App NFC + optional selfie check
4GET /scan-requests/{id}/details

Fluxul API

ID Scan este conceput pentru furnizorii de software și organizațiile care doresc să integreze funcția de verificare a identității fără a fi nevoiți să dezvolte singuri întregul flux de scanare pe dispozitive mobile.

1

Creează o solicitare

Creează o solicitare de scanare din sistemul tău de backend. Adaugă o referință externă, limba, data de expirare, setările de livrare, câmpurile solicitate și verificările.

2

Invitați utilizatorul

Lasă ID Scan să trimită e-mailul sau SMS-ul, sau folosește propriul canal de comunicare cu linkul de verificare primit.

3

Scanează în aplicație

Utilizatorul deschide aplicația mobilă, scanează zona MRZ, citește cipul NFC și, opțional, efectuează o verificare în timp real a selfie-ului în comparație cu fotografia de tip portret din DG2.

4

Afișează rezultatul

Recuperează starea, verificările, câmpurile solicitate și informațiile de audit prin intermediul API-ului. Sunt returnate doar câmpurile configurate.

URL-ul de bază și autentificarea

Solicitările API sunt trimise la adresa URL de bază a API-ului ID Scan și sunt autentificate folosind o cheie API generată în portalul ID Scan. Cheia API este transmisă printr-un antet de solicitare dedicat și trebuie utilizată exclusiv pe partea de server. Nu expuneți niciodată cheile API în codul frontend sau în aplicațiile mobile.

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

Creare solicitare-răspuns

Atunci când se creează o solicitare de scanare, API-ul returnează ID-ul solicitării, cheia solicitării, ora de expirare și linkurile de verificare. Utilizați adresa WebUrl returnată în propriul e-mail, SMS, portal sau flux de lucru atunci când folosiți livrarea autonomă. Pe dispozitivele mobile, DeepLinkUrl poate deschide aplicația direct.

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

Opțiuni de livrare

Puteți alege modul în care utilizatorul primește solicitarea de verificare. Astfel, ID Scan se poate integra atât în fluxurile de comunicare complet automatizate, cât și în cele personalizate.

E-mail de platformă

ID Scan trimite un e-mail de invitație personalizat, care conține un link de verificare securizat.

Platforma SMS

ID Scan trimite linkul de verificare prin SMS. Este util pentru procesele de înregistrare orientate în primul rând către dispozitivele mobile.

Livrare proprie

Sistemul dumneavoastră primește linkul și îl transmite prin e-mail, SMS, portalul propriu sau fluxul de mesagerie.

Starea cererilor

O cerere de verificare trece printr-o serie restrânsă de stări. Integrările pot utiliza aceste stări pentru a afișa progresul, a declanșa mementouri sau a decide dacă este necesară o nouă cerere.

StareDescriere
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.

Referință externă

Utilizați o referință externă pentru a asocia o cerere de verificare cu propriul client, angajat, dosar, comandă sau înregistrare de înrolare. Aceeași referință este returnată atunci când accesați detaliile cererii.

Client ID

Asociază solicitarea cu fișa propriului client.

Numărul dosarului

Asociați rezultatul unui dosar Wwft, HR sau de conformitate.

ID-ul comenzii sau al fluxului de lucru

Folosiți referința pentru a continua fluxurile de lucru automatizate după finalizarea verificării.

Câmpuri obligatorii

ID Scan susține principiul minimizării datelor. Configurați exact câmpurile care trebuie returnate sistemului dumneavoastră. Utilizatorului i se poate afișa ce date vor fi partajate înainte de trimitere.

CâmpDescriereSursă
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

Cecuri disponibile

Verificările pot fi solicitate în cadrul procesului de verificare. Unele dintre acestea sunt verificări tehnice NFC, în timp ce altele țin de regulile de afaceri, cum ar fi vârsta minimă sau verificarea prin selfie.

BifatDescriereRezultatul obținut
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 }

Câmpurile de rezultat și de returnare

Punctul final al rezultatului returnează starea cererii, starea verificării, referința externă, câmpurile de identitate selectate, imaginile selectate și rezultatele verificării. Câmpurile care nu au fost solicitate nu sunt returnate.

Stare cerere

Solicitate, finalizate, expirate, șterse sau eșuate, inclusiv marcajele temporale de creare și finalizare.

Câmpuri selectate

Numai datele de identitate înregistrate, precum numele, cetățenia, data nașterii sau data de expirare a documentului.

Verificări și audit

Starea citirii NFC, autentificarea cipului, valabilitatea documentului, verificarea selfie-ului și date opționale în format PDF/rapoarte.

Câmpuri imagine

Câmpurile de imagine, cum ar fi fotografia portret DG2, imaginea MRZ mascată și imaginea selfie, sunt returnate direct sub formă de date codificate în Base64 atunci când sunt solicitate. Imaginile nu sunt returnate sub formă de adrese URL publice.

Codificat în Base64

Utilizați valoarea datelor ca date de imagine binare codificate în format Base64.

Tip de Conținut

Folosiți tipul de conținut, cum ar fi image/jpeg, pentru a reconstitui imaginea în mod corect.

Numai la cerere

Datele imaginii sunt incluse numai atunci când câmpul este solicitat în mod explicit în șablon.

Mascarea numărului documentului

Numărul documentului poate fi afișat integral sau mascat. Mascarea contribuie la reducerea expunerii inutile a numerelor de documente, permițând în același timp efectuarea de verificări de corespondență sau de audit în propriul sistem.

ValoareOpțiuneDescriere
(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.

Exemplu de solicitare API

Exemplul de mai jos creează o cerere de verificare, solicită ID Scan să trimită invitația prin e-mail și returnează doar câmpurile și verificările selectate.

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

Exemplu de rezultat

După finalizare, sistemul dumneavoastră poate prelua rezultatul folosind ID-ul cererii sau cheia cererii. Referința externă poate fi utilizată pentru a integra rezultatul în propriul sistem.

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

Păstrarea datelor și confidențialitatea

Setările de păstrare pot fi configurate pentru fiecare client în parte. Datele de verificare pot fi șterse după o perioadă prestabilită, după citire sau în conformitate cu politica de confidențialitate configurată de dumneavoastră. Acest lucru contribuie la limitarea stocării inutile a datelor sensibile de identitate.

Zile fixe

Ștergeți datele de verificare după un număr configurat de zile.

După ce am citit

Marcați datele ca fiind citite în momentul recuperării și programați ștergerea lor după acel moment.

Setări portal și API

Utilizați setări de păstrare distincte pentru fluxurile de lucru din portal și din API, atunci când este necesar.

Parametri suplimentari

Pe lângă crearea și recuperarea cererilor, integrările pot retrimite invitații sau șterge o cerere. Ștergerea unei cereri poate fi utilizată atunci când un flux de lucru este anulat sau când verificarea nu mai este necesară.

Trimite din nou invitația

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

Ștergeți cererea

DELETE /api/scan-requests/{id}

Citește detalii

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

Mod testare

Modul de testare poate fi utilizat pentru a valida întregul flux de integrare înainte de lansarea în producție. Solicitările de testare sunt marcate cu „IsTest” în răspunsul API, astfel încât sistemul dumneavoastră să poată distinge datele de testare de fluxurile de lucru din producție.

Testare în condiții de siguranță

Verificați crearea cererilor, livrarea, scanarea aplicațiilor și preluarea rezultatelor fără a utiliza fluxurile de lucru din mediul de producție.

Vizibil ca răspuns

Răspunsul la cererea de creare conține atributul IsTest, ceea ce facilitează identificarea cererilor de testare.

Vei intra în direct mai târziu

Începeți cu o cheie API de testare sau cu configurarea unui tenant de testare și treceți la verificarea în producție după validare.

Eșecul și rezultatele incomplete

Nu toate solicitările se finalizează cu o verificare reușită. Un utilizator poate întrerupe procesul, solicitarea poate expira sau citirea NFC poate eșua. Folosiți Status, HasResult, IsSuccess și câmpurile de verificare pentru a determina rezultatul final.

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

Sunteți gata să integrați verificarea identității prin NFC?

Creează-ți un cont gratuit, generează o cheie API și testează întregul proces înainte de lansarea oficială.