Vytvářejte bezpečné žádosti o ověření identity pomocí NFC přímo ze svého systému. Pozvěte uživatele e-mailem nebo SMS, případně jim vygenerovaný odkaz zašlete sami. Uživatel naskenuje čip NFC v mobilní aplikaci a vy získáte pouze ty údaje, které váš proces potřebuje.
Služba ID Scan je určena pro dodavatele softwaru a organizace, které chtějí zavést ověřování totožnosti, aniž by musely samy vyvíjet kompletní proces mobilního skenování.
Vytvořte požadavek na skenování ve svém backendu. Zadejte externí odkaz, jazyk, dobu platnosti, nastavení doručení, požadovaná pole a kontroly.
Nechte aplikaci ID Scan odeslat e-mail nebo SMS, nebo využijte svůj vlastní komunikační kanál s odeslaným ověřovacím odkazem.
Uživatel spustí mobilní aplikaci, naskenuje MRZ, načte data z čipu NFC a případně provede ověření pomocí živé selfie s porovnáním s portrétní fotografií v systému DG2.
Získejte prostřednictvím API informace o stavu, kontrolách, požadovaných polích a auditu. Vrátí se pouze nakonfigurovaná pole.
Volání API se odesílají na základní adresu URL rozhraní ID Scan API a ověřují se pomocí klíče API vygenerovaného v portálu ID Scan. Klíč API se odesílá prostřednictvím vyhrazené hlavičky požadavku a měl by být používán pouze na straně serveru. Nikdy neuvádějte klíče API v kódu frontendu ani v mobilních aplikacích.
Při vytvoření žádosti o skenování vrátí API ID žádosti, klíč žádosti, dobu platnosti a ověřovací odkazy. Vrátěnou adresu WebUrl použijte ve svém e-mailu, SMS, portálu nebo pracovním postupu, pokud využíváte vlastní doručení. Na mobilních zařízeních lze pomocí adresy DeepLinkUrl aplikaci otevřít přímo.
Můžete si vybrat, jakým způsobem uživatel obdrží ověřovací žádost. Díky tomu se služba ID Scan hodí jak pro plně automatizované, tak i pro individuálně přizpůsobené komunikační procesy.
Služba ID Scan odešle e-mail s pozvánkou v firemním designu, který obsahuje zabezpečený ověřovací odkaz.
Služba ID Scan zasílá ověřovací odkaz prostřednictvím SMS. Hodí se zejména pro registrační procesy zaměřené na mobilní zařízení.
Váš systém obdrží odkaz a předá jej prostřednictvím vašeho e-mailu, SMS, portálu nebo systému pro zasílání zpráv.
Žádost o ověření prochází několika různými stavy. Integrace mohou tyto stavy využít k zobrazení průběhu, spuštění připomínek nebo k rozhodnutí, zda je třeba podat novou žádost.
| 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. |
Pomocí externího odkazu můžete propojit žádost o ověření s vaším zákazníkem, zaměstnancem, dokumentací, objednávkou nebo záznamem o registraci. Při načítání podrobností žádosti se zobrazí stejný odkaz.
Propojte žádost se záznamem o vašem zákazníkovi nebo klientovi.
Výsledek přiřaďte k spisu Wwft, HR nebo spisu týkajícího se dodržování předpisů.
Po dokončení ověření použijte tento odkaz k pokračování v automatizovaných pracovních postupech.
ID Scan podporuje minimalizaci dat. Nastavte si přesně, která pole se mají do vašeho systému odeslat. Uživateli lze před odesláním zobrazit, jaká data budou sdílená.
| 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 ověřovacího procesu lze vyžádat provedení různých kontrol. Některé z nich jsou technické kontroly NFC, jiné pak souvisejí s obchodními pravidly, jako je například minimální věk nebo ověření pomocí selfie.
| Zkontrolovat | Popis | Vrácený výsledek |
|---|---|---|
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 } |
Výstupní bod vrací stav požadavku, stav ověření, externí odkaz, vybraná identifikační pole, vybrané obrázky a výsledky kontroly. Pole, která nebyla vyžádána, se nevracejí.
Požadované, dokončené, prošlé, smazané nebo neúspěšné, včetně časových razítek vytvoření a dokončení.
Pouze zadané údaje o totožnosti, jako je jméno, státní příslušnost, datum narození nebo datum platnosti dokladu.
Stav čtení NFC, ověření čipu, platnost dokumentu, kontrola selfie a volitelná data pro PDF/výkazy.
Obrazová pole, jako je například portrétní fotografie DG2, maskovaný obrázek MRZ a selfie, se na vyžádání vrací přímo v textu jako data zakódovaná v Base64. Obrázky se nevrací jako veřejné URL adresy.
Použijte hodnotu dat jako binární obrazová data zakódovaná v kódování Base64.
K správnému obnovení obrázku použijte typ obsahu, například image/jpeg.
Data obrázku se zahrnou pouze v případě, že je toto pole v šabloně výslovně požadováno.
Číslo dokumentu lze vrátit v plném znění nebo v maskované podobě. Maskování pomáhá omezit zbytečné zveřejňování čísel dokumentů, přičemž ve vašem systému zůstává zachována možnost porovnávání nebo kontrolních auditů.
| Hodnota | Možnost | 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 následujícím příkladu se vytvoří ověřovací žádost, požádá se služba ID Scan o zaslání pozvánky e-mailem a vrátí se pouze vybraná pole a kontroly.
Po dokončení může váš systém výsledek načíst pomocí ID požadavku nebo klíče požadavku. Externí odkaz lze použít k propojení výsledku s vaším vlastním systémem.
Nastavení uchovávání lze konfigurovat pro každého nájemce. Ověřovací údaje lze smazat po uplynutí stanovené lhůty, po jejich přečtení nebo v souladu s vašimi nastavenými zásadami ochrany osobních údajů. To pomáhá omezit zbytečné ukládání citlivých identifikačních údajů.
Odstraňte ověřovací data po uplynutí nastaveného počtu dnů.
Označit data jako přečtená při načtení a naplánovat jejich smazání po tomto okamžiku.
V případě potřeby použijte pro pracovní postupy portálu a API odlišná nastavení uchovávání dat.
Kromě vytváření a načítání žádostí mohou integrace také znovu odesílat pozvánky nebo žádosti mazat. K odstranění žádosti lze přistoupit v případě, že je pracovní postup zrušen nebo již není nutné ověření.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
Testovací režim lze využít k ověření celého integračního toku před spuštěním do ostrého provozu. Testovací požadavky jsou v odpovědi API označeny jako „IsTest“, takže váš systém může oddělit testovací data od produkčních pracovních postupů.
Ověřte vytváření požadavků, jejich doručování, skenování aplikací a načítání výsledků bez použití produkčních pracovních postupů.
Odpověď na požadavek create obsahuje atribut IsTest, díky čemuž lze testovací požadavky snadno rozpoznat.
Začněte s nastavením testovacího klíče API nebo testovacího nájemce a po ověření přejděte k ověření v produkčním prostředí.
Ne každý požadavek vede k úspěšnému ověření. Uživatel může proces přerušit, platnost požadavku může vypršet nebo může dojít k selhání čtení NFC. K určení konečného výsledku použijte prom ěnné Status, HasResult, IsSuccess a kontrolní pole.
Vytvořte si bezplatný účet, vygenerujte klíč API a před spuštěním do ostrého provozu si celý proces vyzkoušejte.