API for identitetsverifisering via NFC • Personvern i fokus • Klar for API-integrasjon

Integrer ID-verifisering i din egen programvare.

Opprett sikre forespørsler om identitetsverifisering via NFC fra ditt eget system. Inviter brukere via e-post eller SMS, eller send den genererte lenken selv. Brukeren skanner NFC-brikken i mobilappen, og du henter kun de feltene prosessen din trenger.

Be om API-tilgang Se API-eksempler

Verifisering av NFC-brikkeLes inn DG1/DG2-dataene og kontroller dokumentbrikken.

DataminimeringBe om bare de feltene og kontrollene som er nødvendige for arbeidsflyten din.

Egen arbeidsflytBruk eksterne referanser for å knytte resultatene til dine egne dokumenter.

Eksempel på prosess

1POST /scan-requests

2Invite email / SMS / own channel

3App NFC + optional selfie check

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

API-flyt

ID Scan er utviklet for programvareleverandører og organisasjoner som ønsker å innføre identitetsverifisering uten å måtte utvikle hele mobilskanningsprosessen selv.

Opprett en forespørsel

Opprett en skanningsforespørsel fra backend-systemet ditt. Legg til en ekstern referanse, språk, utløpsdato, leveringsinnstillinger, forespurte felt og kontroller.

Inviter brukeren

La ID Scan sende e-posten eller SMS-en, eller bruk din egen kommunikasjonskanal med bekreftelseskoblingen som er sendt tilbake.

Skann i appen

Brukeren åpner mobilappen, skanner MRZ-feltet, leser av NFC-brikken og kan eventuelt gjennomføre en sanntids-selfie-sjekk mot portrettbildet i DG2.

Hent resultatet

Hent status, kontroller, forespurte felt og revisjonsinformasjon via API-et. Kun konfigurerte felt returneres.

Grunn-URL og autentisering

API-forespørsler sendes til ID Scan API-basis-URL-en og autentiseres ved hjelp av en API-nøkkel som er generert i ID Scan-portalen. API-nøkkelen sendes via en egen forespørselshode og bør kun brukes på serversiden. API-nøkler må aldri vises i frontend-kode eller mobilapplikasjoner.

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

Opprett forespørsel og svar

Når en skanningsforespørsel opprettes, returnerer API-et forespørsels-ID, forespørselsnøkkel, utløpstid og bekreftelseslenker. Bruk den returnerte WebUrl-en i din egen e-post, SMS, portal eller arbeidsflyt når du bruker selvlevering. På mobile enheter kan DeepLinkUrl åpne appen direkte.

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

Leveringsalternativer

Du kan velge hvordan brukeren skal motta bekreftelsesforespørselen. Dette gjør at ID Scan kan integreres både i fullt automatiserte og tilpassede kommunikasjonsflyter.

Plattform-e-post

ID Scan sender en e-postinvitasjon med bedriftens logo og en sikker bekreftelseskobling.

Plattform-SMS

ID Scan sender bekreftelseskoblingen via SMS. Dette er nyttig for registreringsprosesser som er tilpasset mobilbruk.

Selvlevering

Systemet ditt mottar lenken og sender den videre via din egen e-post, SMS, portal eller meldingsflyt.

Status for forespørsler

En verifiseringsforespørsel går gjennom en rekke statuser. Integrasjoner kan bruke disse statusene til å vise fremdrift, utløse påminnelser eller avgjøre om det er behov for en ny forespørsel.

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

Ekstern referanse

Bruk en ekstern referanse for å knytte en verifiseringsforespørsel til din egen kunde, ansatt, sak, ordre eller registrering ved oppstart. Den samme referansen vises når du henter frem detaljene for forespørselen.

Kunde-ID

Knytt forespørselen til din egen kunde- eller klientoppføring.

Saksnummer

Knytt resultatet til en Wwft-, HR- eller compliance-mappe.

Ordre- eller arbeidsflyt-ID

Bruk referansen til å fortsette automatiserte arbeidsflyter etter at verifiseringen er fullført.

Obligatoriske felt

ID Scan støtter dataminimering. Du kan selv velge nøyaktig hvilke felt som skal sendes tilbake til systemet ditt. Brukeren får se hvilke opplysninger som vil bli delt før innsending.

Felt	Beskrivelse	Kilde
`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

Tilgjengelige sjekker

Det kan kreves kontrolltiltak som en del av verifiseringsprosessen. Noen av disse er tekniske NFC-kontroller, mens andre er forretningsregler, for eksempel krav til minimumsalder eller selfie-verifisering.

Kryss av	Beskrivelse	Resultatet
`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- og sanksjonskontroll

ID Scan kan, hvis ønskelig, sjekke de verifiserte identitetsopplysningene mot registre over politisk eksponerte personer (PEP), sanksjonslister og registre over tilknyttede personer. Dette bidrar til å støtte arbeidsflyter knyttet til KYC, AML og regelverksetterlevelse etter at dokumentverifiseringen via NFC er fullført.

PEP-screening

Kontroller om den verifiserte personen er oppført som en politisk eksponert person.

Sanksjonskontroll

Sjekk om den verifiserte personen er oppført i sanksjonsrelaterte datasett.

Manuell gjennomgang

Eventuelle funn bør alltid gjennomgås manuelt før det iverksettes tiltak.

Resultat- og returfelter

Resultatet returnerer forespørselsstatus, verifiseringsstatus, ekstern referanse, valgte identitetsfelt, valgte bilder og sjekkresultater. Felt som ikke ble forespurt, returneres ikke.

Status på forespørsel

Forespurt, fullført, utløpt, slettet eller mislykket, inkludert tidsstempler for opprettelse og fullføring.

Utvalgte felt

Kun identitetsopplysninger som navn, nasjonalitet, fødselsdato eller dokumentets utløpsdato.

Kontroll og revisjon

NFC-lesestatus, chip-autentisering, dokumentets gyldighet, selfie-sjekk og valgfrie PDF- og rapporteringsdata.

Bildefelt

Bildefelt som DG2-portrettfoto, MRZ-bilde med maske og selfie-bilde returneres direkte som Base64-kodede data når de blir forespurt. Bildene returneres ikke som offentlige nettadresser.

Base64-kodet

Bruk dataverdien som binære bildedata kodet i Base64.

Innholdstype

Bruk content_type, for eksempel image/jpeg, for å gjenskape bildet riktig.

Kun på forespørsel

Bildedata inkluderes kun når feltet uttrykkelig er angitt i malen.

Skjuling av dokumentnummer

Dokumentnummeret kan returneres i sin helhet eller i maskert form. Maskering bidrar til å redusere unødvendig eksponering av dokumentnumre, samtidig som det fortsatt er mulig å foreta sammenligninger eller revisjonskontroller i ditt eget system.

Verdi	Alternativ	Beskrivelse
`(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.

Eksempel på API-forespørsel

Eksemplet nedenfor oppretter en verifiseringsforespørsel, ber ID Scan om å sende invitasjonen via e-post og returnerer kun de valgte feltene og kontrollene.

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

Eksempel på resultat

Når behandlingen er fullført, kan systemet ditt hente resultatet ved hjelp av forespørsels-ID eller forespørselsnøkkel. Den eksterne referansen kan brukes til å koble resultatet til ditt eget system.

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

Oppbevaring og personvern

Oppbevaringsinnstillingene kan konfigureres for hver enkelt leietaker. Verifiseringsdata kan slettes etter en fastsatt periode, etter at de er lest, eller i henhold til den personvernpolicyen du har konfigurert. Dette bidrar til å begrense unødvendig lagring av sensitive identitetsopplysninger.

Faste dager

Slett bekreftelsesdata etter et angitt antall dager.

Etter å ha lest

Merk dataene som lest når de hentes, og planlegg sletting etter det tidspunktet.

Portal- og API-innstillinger

Bruk om nødvendig separate lagringsinnstillinger for arbeidsflyter i portalen og API-et.

Ytterligere endepunkter

I tillegg til å opprette og hente forespørsler, kan integrasjoner sende invitasjoner på nytt eller slette en forespørsel. Sletting av en forespørsel kan brukes når en arbeidsflyt avbrytes eller en bekreftelse ikke lenger er nødvendig.

Send invitasjonen på nytt

POST /scan-requests/{id}/resend

Slett forespørsel

DELETE /scan-requests/{id}

Les mer

GET /scan-requests/{id}/details

Testmodus

Testmodus kan brukes til å validere hele integrasjonsflyten før systemet settes i drift. Testforespørsler merkes med «IsTest» i API-svaret, slik at systemet ditt kan skille testdata fra produksjonsarbeidsflyter.

Sikker testing

Test opprettelse av forespørsler, levering, skanning av apper og henting av resultater uten å bruke produksjonsarbeidsflyter.

Vises som svar

Svaret på opprettelsesforespørselen inneholder «IsTest», noe som gjør det enkelt å identifisere testforespørsler.

Gå live senere

Begynn med å opprette en test-API-nøkkel eller en testleietaker, og bytt til verifisering i produksjonsmiljøet etter at alt er godkjent.

Eksempel på åpen kildekode for .NET

Se vårt offentlige eksempel på .NET-integrasjon på GitHub. Eksemplet viser hvordan du oppretter verifiseringsforespørsler, henter verifiseringsresultater og integrerer NFC-passverifisering i dine egne applikasjoner.

Fullstendig eksempel

Omfatter arbeidsflyter for oppretting av forespørsler, henting av resultater og identitetsverifisering ved bruk av C# og .NET.

NFC-verifisering

Lær hvordan du behandler resultater fra NFC-passverifisering, dokumentfelt og verifiseringskontroller.

Åpen kildekode

Klon repositoriet, test API-et og bruk det som utgangspunkt for din egen integrasjon.

Se .NET-eksemplet på GitHub

Feil og ufullstendige resultater

Ikke alle forespørsler resulterer i en vellykket verifisering. En bruker kan avbryte prosessen, forespørselen kan utløpe, eller NFC-avlesningen kan mislykkes. Bruk Status, HasResult, IsSuccess og sjekkfeltene for å fastslå det endelige resultatet.

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