NFC identitātes pārbaudes API • Privātums pirmajā vietā • Sagatavots API izmantošanai

Integrējiet identitātes pārbaudi savā programmā.

Izveidojiet drošus NFC identitātes pārbaudes pieprasījumus no savas sistēmas. Uzaiciniet lietotājus pa e-pastu vai SMS, vai arī paši nosūtiet ģenerēto saiti. Lietotājs mobilajā lietotnē nolasīs NFC mikroshēmu, un jūs iegūsiet tikai tos laukus, kas nepieciešami jūsu procesam.

Pieprasīt piekļuvi API Apskatīt API piemērus

NFC mikroshēmas pārbaudeIzlasiet DG1/DG2 datus un pārbaudiet dokumenta mikroshēmu.

Datu apjoma samazināšanaPieprasiet tikai tos laukus un pārbaudes, kas nepieciešami jūsu darba plūsmā.

Paša darba plūsmaIzmantojiet ārējās atsauces, lai rezultātus saistītu ar savām lietām.

Piemērs par darbības gaitu

1POST /scan-requests

2Invite email / SMS / own channel

3App NFC + optional selfie check

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

API darbības gaita

„ID Scan“ ir paredzēts programmatūras izstrādātājiem un organizācijām, kas vēlas ieviest identitātes pārbaudi, neizstrādājot pilnīgu mobilo skenēšanas procesu paši.

Izveidot pieprasījumu

Izveidojiet skenēšanas pieprasījumu no savas aizmugures sistēmas. Pievienojiet ārējo atsauci, valodu, derīguma termiņu, piegādes iestatījumus, pieprasītos laukus un pārbaudes.

Uzaicināt lietotāju

Ļaujiet „ID Scan“ nosūtīt e-pastu vai SMS, vai arī izmantojiet savu saziņas kanālu, kurā iekļaujiet atgriezto apstiprinājuma saiti.

Skenējiet lietotnē

Lietotājs atver mobilo lietotni, nolasī MRZ, nolasa NFC mikroshēmu un, ja vēlas, veic pašbildes salīdzināšanu ar DG2 portretfotogrāfiju.

Iegūt rezultātu

Iegūstiet statusu, pārbaudes, pieprasītos laukus un revīzijas informāciju, izmantojot API. Tiek atgriezti tikai konfigurētie lauki.

Bāzes URL un autentifikācija

API izsaukumi tiek nosūtīti uz ID Scan API bāzes URL un autentificēti, izmantojot API atslēgu, kas ģenerēta ID Scan portālā. API atslēga tiek nosūtīta, izmantojot īpašu pieprasījuma galvenes lauku, un to drīkst izmantot tikai servera pusē. Nekādā gadījumā neizpaužiet API atslēgas lietotāja saskarnes kodā vai mobilajās lietotnēs.

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

Izveidot pieprasījuma atbildi

Kad tiek izveidots skenēšanas pieprasījums, API atgriež pieprasījuma ID, pieprasījuma atslēgu, derīguma termiņu un apstiprināšanas saites. Izmantojot pašpiegādi, atgriezto WebUrl izmantojiet savā e-pastā, SMS, portālā vai darba plūsmā. Mobilajās ierīcēs DeepLinkUrl var tieši atvērt lietotni.

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

Piegādes iespējas

Jūs varat izvēlēties, kā lietotājs saņems apstiprinājuma pieprasījumu. Tas ļauj ID Scan integrēt gan pilnībā automatizētās, gan pielāgotās saziņas plūsmās.

Platformas e-pasts

ID Scan nosūta e-pastu ar zīmola logotipu, kurā iekļauta droša apstiprinājuma saite.

SMS platforma

„ID Scan“ nosūta apstiprinājuma saiti ar SMS. Noderīgi reģistrācijas procesiem, kuros galvenā loma ir mobilajām ierīcēm.

Pats nogādā

Jūsu sistēma saņem saiti un nosūta to, izmantojot jūsu e-pastu, SMS, portālu vai ziņojumapmaiņas sistēmu.

Pieprasījumu statusi

Pārbaudes pieprasījums iziet cauri nelielam statusu kopumam. Integrācijas var izmantot šos statusus, lai parādītu procesa gaitu, aktivizētu atgādinājumus vai izlemtu, vai ir nepieciešams jauns pieprasījums.

Statuss	Apraksts
`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.

Ārējā atsauce

Izmantojiet ārējo atsauci, lai pārbaudes pieprasījumu saistītu ar savu klientu, darbinieku, dokumentāciju, pasūtījumu vai reģistrācijas ierakstu. Šī pati atsauce tiek atgriezta, kad izgūstat pieprasījuma informāciju.

Klienta identifikācijas numurs

Saistiet pieprasījumu ar savu klienta ierakstu.

Lietas vai dokumentācijas numurs

Saistiet rezultātu ar Wwft, HR vai atbilstības dokumentāciju.

Pasūtījuma vai darba plūsmas identifikators

Izmantojiet atsauci, lai pēc pārbaudes pabeigšanas turpinātu automatizētās darba plūsmas.

Obligāti aizpildāmie lauki

ID Scan atbalsta datu minimizāciju. Jūs varat precīzi konfigurēt, kuri lauki ir jānosūta atpakaļ uz jūsu sistēmu. Pirms datu nosūtīšanas lietotājam var parādīt, kādi dati tiks nodoti tālāk.

Lauciņš	Apraksts	Avots
`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

Pieejamie pārbaudes veidi

Pārbaudes var pieprasīt kā daļu no verifikācijas procesa. Dažas pārbaudes ir tehniskas NFC pārbaudes, savukārt citas ir saistītas ar biznesa noteikumiem, piemēram, minimālais vecums vai sejas attēla verifikācija.

Pārbaudīt	Apraksts	Saņemtais rezultāts
`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 un sankciju pārbaude

„ID Scan“ pēc izvēles var salīdzināt pārbaudītos identitātes datus ar PEP, sankciju un saistīto personu datu kopām. Tas palīdz nodrošināt KYC, AML un atbilstības nodrošināšanas darba plūsmas pēc NFC dokumentu pārbaudes pabeigšanas.

PEP skrīnings

Pārbaudiet, vai pārbaudītā persona ir iekļauta politiski ietekmīgo personu sarakstā.

Sankciju pārbaude

Pārbaudiet, vai pārbaudītā persona ir iekļauta ar sankcijām saistītajos datu kopumos.

Manuālā pārbaude

Iespējamie rezultāti vienmēr ir jāpārskata manuāli, pirms tiek veikti kādi pasākumi.

Rezultātu un atgriešanas lauki

Rezultātu galapunkts atgriež pieprasījuma statusu, pārbaudes statusu, ārējo atsauci, atlasītos identitātes laukus, atlasītos attēlus un pārbaudes rezultātus. Lauki, kas netika pieprasīti, netiek atgriezti.

Pieprasījuma statuss

Pieprasīti, pabeigti, termiņš beidzies, dzēsti vai neizdevies, ieskaitot izveidotos un pabeigto darbību laika zīmogus.

Atlasītie lauki

Tikai konfigurētie identifikācijas dati, piemēram, vārds, uzvārds, pilsonība, dzimšanas datums vai dokumenta derīguma termiņš.

Pārbaudes un revīzija

NFC nolasīšanas statuss, mikroshēmas autentifikācija, dokumenta derīgums, sejas attēla pārbaude un papildu PDF/ziņojumu dati.

Attēlu lauki

Tādi attēlu lauki kā DG2 portreta foto, maskēts MRZ attēls un selfija attēls pēc pieprasījuma tiek atgriezti teksta rindā kā Base64 kodēti dati. Attēli netiek atgriezti kā publiski pieejamas URL adreses.

Base64 kodēts

Izmantojiet datu vērtību kā Base64 kodētus bināros attēla datus.

Satura tips

Lai attēlu pareizi atjaunotu, izmantojiet content_type, piemēram, image/jpeg.

Tikai pēc pieprasījuma

Attēla dati tiek iekļauti tikai tad, ja šis lauks ir skaidri norādīts veidnē.

Dokumenta numura maskēšana

Dokumenta numuru var atgriezt pilnā formā vai maskētu. Maskēšana palīdz samazināt dokumentu numuru nevajadzīgu publiskošanu, vienlaikus ļaujot veikt saskaņošanu vai revīzijas pārbaudes jūsu sistēmā.

Value	Opcijas	Apraksts
`(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.

API pieprasījuma piemērs

Zemāk redzamajā piemērā tiek izveidots pārbaudes pieprasījums, tiek lūgts „ID Scan“ nosūtīt uzaicinājumu pa e-pastu un tiek atgriezti tikai izvēlētie lauki un pārbaudes.

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

Rezultāta piemērs

Pēc apstrādes pabeigšanas jūsu sistēma var iegūt rezultātu, izmantojot pieprasījuma ID vai pieprasījuma atslēgu. Ārējo atsauci var izmantot, lai rezultātu sasaistītu ar jūsu sistēmu.

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

Datu glabāšana un privātums

Datu glabāšanas iestatījumus var konfigurēt katram nomniekam atsevišķi. Pārbaudes datus var dzēst pēc noteiktā laika perioda, pēc to izlasīšanas vai saskaņā ar jūsu konfigurēto privātuma politiku. Tas palīdz ierobežot nevajadzīgu konfidenciālu identitātes datu glabāšanu.

Fiksētās dienas

Dzēst pārbaudes datus pēc noteiktā dienu skaita.

Pēc izlasīšanas

Pēc datu izguves tos atzīmējiet kā izlasītus un pēc tam plānojiet to dzēšanu.

Portāla un API iestatījumi

Vajadzības gadījumā izmantojiet atsevišķus saglabāšanas iestatījumus portāla un API darba plūsmām.

Papildu iznākuma rādītāji

Papildus pieprasījumu izveidei un izguvei integrācijas var atkārtoti nosūtīt uzaicinājumus vai dzēst pieprasījumu. Pieprasījumu var dzēst, ja darba plūsma tiek atcelta vai vairs nav nepieciešama pārbaude.

Nosūtīt uzaicinājumu atkārtoti

POST /scan-requests/{id}/resend

Dzēšanas pieprasījums

DELETE /scan-requests/{id}

Lasīt sīkāku informāciju

GET /scan-requests/{id}/details

Testa režīms

Testa režīmu var izmantot, lai pārbaudītu pilnu integrācijas plūsmu pirms sistēmas nodošanas ekspluatācijā. Testa pieprasījumi API atbildē tiek atzīmēti ar „IsTest“, tādējādi jūsu sistēma var nošķirt testa datus no ražošanas darba plūsmām.

Droša testēšana

Pārbaudiet pieprasījuma izveidi, nosūtīšanu, lietotnes skenēšanu un rezultātu iegūšanu, neizmantojot ražošanas darba plūsmas.

Redzams atbildē

Atbilde uz izveides pieprasījumu satur parametru „IsTest”, kas ļauj viegli atpazīt testa pieprasījumus.

Sākt darbību vēlāk

Sāciet ar testa API atslēgas vai testa lietotāja konta konfigurēšanu un pēc apstiprināšanas pārejiet uz reālo verifikāciju.

Atvērtā koda .NET piemērs

Iepazīstieties ar mūsu publisko .NET integrācijas piemēru vietnē GitHub. Šis piemērs parāda, kā izveidot verifikācijas pieprasījumus, iegūt verifikācijas rezultātus un integrēt NFC pasu verifikāciju savās lietotnēs.

Pilnīgs piemērs

Ietver pieprasījumu izveides, rezultātu iegūšanas un identitātes pārbaudes darba plūsmas, izmantojot C# un .NET.

NFC pārbaude

Uzziniet, kā apstrādāt NFC pasu pārbaudes rezultātus, dokumentu laukus un pārbaudes.

Atvērtā koda

Klonsējiet repozitoriju, pārbaudiet API un izmantojiet to kā sākumpunktu savai integrācijai.

Apskatīt .NET piemēru GitHub vietnē

Neveiksme un nepilnīgi rezultāti

Ne katrs pieprasījums beidzas ar veiksmīgu pārbaudi. Lietotājs var pārtraukt procesu, pieprasījuma derīguma termiņš var beigties vai NFC nolasīšana var neizdoties. Lai noteiktu galīgo rezultātu, izmantojiet Status, HasResult, IsSuccess un pārbaudes laukus.

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

Vai esat gatavi integrēt NFC identitātes pārbaudi?

Izveidojiet bezmaksas kontu, ģenerējiet API atslēgu un pārbaudiet visu darbības gaitu, pirms sākat darboties.

Izveidot kontu Atvērt portālu