Vytvárajte bezpečné požiadavky na overenie identity prostredníctvom NFC priamo zo svojho systému. Pozývajte používateľov e-mailom alebo SMS správou, alebo im vygenerovaný odkaz pošlite sami. Používateľ naskenuje čip NFC v mobilnej aplikácii a vy získate len tie polia, ktoré potrebujete pre svoj proces.
Služba ID Scan je určená pre dodávateľov softvéru a organizácie, ktoré chcú zaviesť overovanie totožnosti bez toho, aby museli sami vytvárať kompletný proces mobilného skenovania.
Vytvorte požiadavku na skenovanie vo vašom backende. Pridajte externý odkaz, jazyk, platnosť, nastavenia doručenia, požadované polia a kontroly.
Nechajte aplikáciu ID Scan odoslať e-mail alebo SMS, alebo použite vlastný komunikačný kanál s odoslaným overovacím odkazom.
Používateľ otvorí mobilnú aplikáciu, naskenuje MRZ, prečíta čip NFC a podľa potreby vykoná overenie prostredníctvom selfie v reálnom čase porovnaním s portrétovou fotografiou z DG2.
Prostredníctvom rozhrania API je možné získať stav, kontroly, požadované polia a informácie o audite. Vrátené sú iba nakonfigurované polia.
Volania API sa odosielajú na základnú URL adresu rozhrania ID Scan API a overujú sa pomocou kľúča API vygenerovaného v portáli ID Scan. Kľúč API sa odosiela prostredníctvom špeciálnej hlavičky požiadavky a mal by sa používať výlučne na strane servera. Kľúče API nikdy nezverejňujte v kóde frontendu ani v mobilných aplikáciách.
Po vytvorení žiadosti o naskenovanie vráti rozhranie API identifikačné číslo žiadosti, kľúč žiadosti, čas vypršania platnosti a overovacie odkazy. Vrátenú adresu WebUrl môžete použiť vo svojom e-maile, SMS, portáli alebo pracovnom postupe v prípade, že využívate vlastné doručenie. Na mobilných zariadeniach môže adresa DeepLinkUrl priamo otvoriť aplikáciu.
Môžete si vybrať, akým spôsobom bude používateľ dostávať žiadosť o overenie. Vďaka tomu sa služba ID Scan dá začleniť do plne automatizovaných aj do vlastných komunikačných postupov.
Služba ID Scan odošle pozvánku s logom spoločnosti, ktorá obsahuje bezpečný overovací odkaz.
Služba ID Scan zasiela overovací odkaz prostredníctvom SMS. Je to užitočné pri registračných postupoch zameraných predovšetkým na mobilné zariadenia.
Váš systém prijme odkaz a odošle ho prostredníctvom vášho e-mailu, SMS, portálu alebo systému zasielania správ.
Žiadosť o overenie prechádza niekoľkými stavmi. Integrácie môžu tieto stavy využiť na zobrazenie priebehu, spustenie pripomienok alebo rozhodnutie, či je potrebná nová žiadosť.
| Stav | Popis |
|---|---|
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. |
Pomocou externého odkazu môžete prepojiť žiadosť o overenie so svojím zákazníkom, zamestnancom, dokumentáciou, objednávkou alebo záznamom o registrácii. Pri načítaní podrobností žiadosti sa zobrazí ten istý odkaz.
Priraďte žiadosť k záznamu o vašom zákazníkovi alebo klientovi.
Priraďte výsledok k spisu Wwft, HR alebo spisu týkajúceho sa dodržiavania predpisov.
Po dokončení overenia použite tento odkaz na pokračovanie v automatizovaných pracovných postupoch.
ID Scan podporuje minimalizáciu údajov. Nastavte si presne, ktoré polia sa majú odoslať do vášho systému. Používateľovi sa pred odoslaním môže zobraziť, aké údaje budú zdieľané.
| Pole | Popis | Zdroj |
|---|---|---|
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 |
V rámci overovacieho procesu je možné požiadať o vykonanie niektorých kontrol. Niektoré z nich sú technické kontroly NFC, iné zase kontroly na základe obchodných pravidiel, ako napríklad overenie minimálneho veku alebo overenie prostredníctvom selfie.
| Overiť | Popis | Vrátený výsledok |
|---|---|---|
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 } |
Koncový bod výsledku vráti stav požiadavky, stav overenia, externý odkaz, vybrané polia identity, vybrané obrázky a výsledky kontroly. Polia, ktoré neboli požadované, sa nevracajú.
Požiadané, dokončené, s uplynutou platnosťou, vymazané alebo neúspešné, vrátane časových údajov o vytvorení a dokončení.
Iba zadané identifikačné údaje, ako sú meno, štátna príslušnosť, dátum narodenia alebo dátum platnosti dokladu.
Stav načítania NFC, overenie čipu, platnosť dokumentu, overenie prostredníctvom selfie a voliteľné údaje vo formáte PDF/pre správy.
Obrázkové polia, ako napríklad portrétová fotografia DG2, maskovaný obrázok MRZ a selfie, sa na požiadanie vracajú priamo v texte ako údaje zakódované v Base64. Obrázky sa nevracajú vo forme verejných URL adries.
Použ ite túto hodnotu ako binárne obrazové dáta zakódované v Base64.
Na správne obnovenie obrázka použite typ obsahu, napríklad image/jpeg.
Údaje o obrázku sa zahrnú len vtedy, ak je toto pole v šablóne výslovne požadované.
Číslo dokumentu môže byť vrátené v plnom znení alebo v skrátenej podobe. Skrátenie pomáha obmedziť zbytočné zverejňovanie čísel dokumentov, pričom zároveň umožňuje porovnávanie alebo kontrolu vo vašom vlastnom systéme.
| Hodnota | Voľba | Popis |
|---|---|---|
(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. |
V nasledujúcom príklade sa vytvorí žiadosť o overenie, služba ID Scan sa požiada o zaslanie pozvánky e-mailom a vrátia sa iba vybrané polia a kontroly.
Po dokončení môže váš systém vyhľadať výsledok pomocou ID požiadavky alebo kľúča požiadavky. Externý odkaz môžete použiť na prepojenie výsledku s vaším vlastným systémom.
Nastavenia uchovávania údajov je možné konfigurovať pre každého nájomcu. Overovacie údaje je možné vymazať po uplynutí pevne stanovenej lehoty, po prečítaní alebo v súlade s vašimi nastavenými zásadami ochrany osobných údajov. To pomáha obmedziť zbytočné ukladanie citlivých identifikačných údajov.
Odstráňte overovacie údaje po uplynutí nastaveného počtu dní.
Označiť údaje za prečítané po ich načítaní a naplánovať ich vymazanie po tomto okamihu.
V prípade potreby použite pre pracovné postupy portálu a API odlišné nastavenia uchovávania.
Okrem vytvárania a načítavania žiadostí môžu integrácie opätovne odoslať pozvánky alebo žiadosť zmazať. Zmazanie žiadosti je vhodné v prípade, ak je pracovný postup zrušený alebo overenie už nie je potrebné.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
Testovací režim slúži na overenie celého integračného toku pred spustením do prevádzky. Testovacie požiadavky sú v odpovedi API označené ako „IsTest“, vďaka čomu môže váš systém odlíšiť testovacie údaje od produkčných pracovných postupov.
Overte vytvorenie požiadavky, jej doručenie, skenovanie aplikácie a načítanie výsledkov bez použitia produkčných pracovných postupov.
Odpoveď na požiadavku create obsahuje atrib út IsTest, vďaka čomu je možné testovacie požiadavky ľahko identifikovať.
Začnite s nastavením testovacieho kľúča API alebo testovacieho nájomcu a po overení prejdite na overenie v produkčnom prostredí.
Nie každá požiadavka vedie k úspešnému overeniu. Používateľ môže proces prerušiť, platnosť požiadavky môže vypršať alebo môže zlyhať čítanie prostredníctvom NFC. Na určenie konečného výsledku použite vlastnosti Status, HasResult, IsSuccess a kontrolné polia.
Vytvorte si bezplatný účet, vygenerujte kľúč API a pred spustením do prevádzky si otestujte celý proces.