Luo turvallisia NFC-tunnistautumispyyntöjä omasta järjestelmästäsi. Kutsu käyttäjiä sähköpostilla tai tekstiviestillä tai lähetä luotu linkki itse. Käyttäjä skannaa NFC-sirun mobiilisovelluksessa, ja sinä haet vain ne kentät, joita prosessisi tarvitsee.
ID Scan on suunniteltu ohjelmistotoimittajille ja organisaatioille, jotka haluavat ottaa käyttöön henkilöllisyyden todentamisen ilman, että niiden tarvitsee itse rakentaa koko mobiiliskannausprosessia.
Luo skannauspyyntö hallintapaneelistasi. Lisää ulkoinen viite, kieli, voimassaoloaika, toimitusasetukset, pyydetyt kentät ja tarkistukset.
Anna ID Scanin lähettää sähköposti tai tekstiviesti, tai käytä omaa viestintäkanavaasi, johon palautetaan vahvistuslinkki.
Käyttäjä avaa mobiilisovelluksen, skannaa MRZ-alueen, lukee NFC-sirun tiedot ja voi halutessaan suorittaa reaaliaikaisen selfietarkistuksen vertaamalla kuvaa DG2-passikuvaan.
Hae tila, tarkistukset, pyydetyt kentät ja tarkastustiedot sovellusliittymän (API) kautta. Vain määritetyt kentät palautetaan.
API-pyynnöt lähetetään ID Scan API:n perus-URL-osoitteeseen, ja ne todennetaan ID Scan -portaalissa luodulla API-avaimella. API-avain lähetetään erillisessä pyyntöotsikossa, ja sitä tulisi käyttää ainoastaan palvelinpuolella. Älä koskaan paljasta API-avaimia käyttöliittymäkoodissa tai mobiilisovelluksissa.
Kun skannauspyyntö luodaan, sovellusliittymä palauttaa pyynnön tunnisteen, pyynnön avaimen, voimassaoloajan ja vahvistuslinkit. Käytä palautettua WebUrl-linkkiä omassa sähköpostissasi, tekstiviestissäsi, portaalissasi tai työnkulussasi, kun käytät itsepalvelutoimitusta. Mobiililaitteilla DeepLinkUrl-linkki avaa sovelluksen suoraan.
Voit valita, miten käyttäjä vastaanottaa vahvistuspyynnön. Näin ID Scan sopii sekä täysin automatisoituihin että räätälöityihin viestintäprosesseihin.
ID Scan lähettää yrityksen brändillä varustetun kutsusähköpostin, jossa on suojattu vahvistuslinkki.
ID Scan lähettää vahvistuslinkin tekstiviestillä. Kätevä ratkaisu erityisesti mobiililaitteille suunnitelluissa rekisteröitymisprosesseissa.
Järjestelmäsi vastaanottaa linkin ja välittää sen eteenpäin sähköpostin, tekstiviestin, portaalin tai viestintäprosessin kautta.
Vahvistuspyyntö käy läpi muutaman eri tilan. Integraatiot voivat käyttää näitä tiloja edistymisen näyttämiseen, muistutusten lähettämiseen tai sen päättämiseen, tarvitaanko uusi pyyntö.
| Tila | Kuvaus |
|---|---|
requested | The request has been created and is waiting for the user to start or complete the verification. |
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. |
Käytä ulkoista viitettä liittääksesi vahvistuspyynnön omaan asiakkaaseesi, työntekijääsi, asiakirjakansioosi, tilaukseesi tai rekisteröintitietoihisi. Sama viite palautetaan, kun haet pyynnön tiedot.
Liitä pyyntö omaan asiakastietueeseesi.
Liitä tulos Wwft-, HR- tai sääntöjenmukaisuusasiakirjaan.
Käytä viitettä jatkaaksesi automatisoituja työnkulkuja, kun vahvistus on suoritettu.
ID Scan tukee tietojen rajoittamista. Määritä tarkasti, mitkä kentät palautetaan järjestelmääsi. Käyttäjälle voidaan näyttää, mitkä tiedot jaetaan, ennen kuin tiedot lähetetään.
| Kenttä | Kuvaus | Lähde |
|---|---|---|
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 |
Tarkistuksia voidaan pyytää osana todentamisprosessia. Osa tarkistuksista on teknisiä NFC-tarkistuksia, kun taas toiset koskevat liiketoimintasääntöjä, kuten alaikärajaa tai selfietodentamista.
| Tarkista | Kuvaus | Palautettu tulos |
|---|---|---|
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 } |
Tulospäätepiste palauttaa pyynnön tilan, vahvistustilan, ulkoisen viitteen, valitut henkilötiedot, valitut kuvat ja tarkistustulokset. Kenttiä, joita ei ole pyydetty, ei palauteta.
Pyydetyt, valmiit, vanhentuneet, poistetut tai epäonnistuneet, mukaan lukien luomisen ja valmistumisen aikaleimat.
Ainoastaan määritetyt henkilötiedot, kuten nimi, kansalaisuus, syntymäaika tai asiakirjan voimassaolon päättymispäivä.
NFC-lukutilanne, sirun todentaminen, asiakirjan voimassaolo, kasvojentunnistus sekä valinnainen PDF- ja raportointidata.
Kuvakentät, kuten DG2-muotokuva, peitetty MRZ-kuva ja selfie-kuva, palautetaan pyydettäessä suoraan tekstin sisällä Base64-koodattuina tietoina. Kuvia ei palauteta julkisina URL-osoitteina.
Käytä tietojen arvoa Base64-koodattuna binäärisenä kuvatiedostona.
Käytä content_type-tunnistetta, kuten image/jpeg, jotta kuva näkyy oikein.
Kuvatiedot sisällytetään vain, jos kenttä on nimenomaisesti pyydetty mallissa.
Asiakirjanumero voidaan palauttaa kokonaisuudessaan tai peitettynä. Peittäminen auttaa vähentämään asiakirjanumeroiden tarpeetonta paljastumista, mutta mahdollistaa silti tietojen täsmäytyksen tai tarkastusten suorittamisen omassa järjestelmässäsi.
| Arvo | Valinta | Kuvaus |
|---|---|---|
(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. |
Seuraavassa esimerkissä luodaan vahvistuspyyntö, pyydetään ID Scania lähettämään kutsu sähköpostitse ja palautetaan vain valitut kentät ja tarkistukset.
Kun käsittely on valmis, järjestelmäsi voi hakea tuloksen pyyntötunnuksen tai pyyntöavaimen avulla. Ulkoista viitettä voidaan käyttää tuloksen liittämiseen omaan järjestelmääsi.
Säilytysasetukset voidaan määrittää vuokralaiskohtaisesti. Vahvistustiedot voidaan poistaa tietyn ajan kuluttua, lukemisen jälkeen tai määritetyn tietosuojakäytännön mukaisesti. Tämä auttaa rajoittamaan arkaluonteisten henkilötietojen tarpeetonta tallennusta.
Poista vahvistustiedot määritetyn päivämäärän kuluttua.
Merkitse tiedot luetuiksi, kun ne haetaan, ja ajoita niiden poistaminen sen jälkeen.
Käytä tarvittaessa erillisiä säilytysasetuksia portaalin ja API:n työnkulkuille.
Pyynnön luomisen ja hakemisen lisäksi integraatiot voivat lähettää kutsut uudelleen tai poistaa pyynnön. Pyynnön poistaminen on hyödyllistä, kun työnkulku peruutetaan tai vahvistusta ei enää tarvita.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
Testitilaa voidaan käyttää koko integraatioprosessin testaamiseen ennen tuotantokäyttöön siirtymistä. Testipyynnöt merkitään API-vastauksessa tunnisteella IsTest, jotta järjestelmäsi pystyy erottamaan testitiedot tuotantoprosesseista.
Varmista pyyntöjen luominen, toimitus, sovellusten tarkistus ja tulosten haku ilman tuotantoympäristön työnkulkuja.
Luo-pyynnön vastaus sisältää IsTest-kentän, minkä ansiosta testipyynnöt on helppo tunnistaa.
Aloita testaus-API-avaimella tai testausasiakastilin määrittämisellä ja siirry tuotantoympäristön vahvistukseen, kun asetukset on tarkistettu.
Kaikki pyynnöt eivät johda onnistuneeseen todentamiseen. Käyttäjä voi keskeyttää prosessin, pyyntö voi vanhentua tai NFC-lukeminen voi epäonnistua. Määritä lopullinen tulos Status-, HasResult- ja IsSuccess-kenttien sekä tarkistuskenttien avulla.
Luo ilmainen tili, luo API-avain ja testaa koko prosessi ennen käyttöönottoa.