Twórz bezpieczne żądania weryfikacji tożsamości za pomocą NFC bezpośrednio ze swojego systemu. Zapraszaj użytkowników przez e-mail lub SMS albo samodzielnie wysyłaj wygenerowany link. Użytkownik skanuje chip NFC w aplikacji mobilnej, a Ty pobierasz tylko te pola, które są potrzebne w Twoim procesie.
ID Scan jest przeznaczony dla dostawców oprogramowania i organizacji, które chcą wdrożyć weryfikację tożsamości bez konieczności samodzielnego tworzenia pełnego procesu skanowania mobilnego.
Utwórz zlecenie skanowania w swoim systemie zaplecza. Dodaj odniesienie zewnętrzne, język, termin ważności, ustawienia dostawy, wymagane pola oraz kontrole.
Pozwól, aby aplikacja ID Scan wysłała wiadomość e-mail lub SMS, albo skorzystaj z własnego kanału komunikacji, korzystając z otrzymanego linku weryfikacyjnego.
Użytkownik otwiera aplikację mobilną, skanuje strefę MRZ, odczytuje dane z chipa NFC i, w razie potrzeby, dokonuje weryfikacji na żywo poprzez porównanie selfie ze zdjęciem portretowym w systemie DG2.
Pobierz status, wyniki sprawdzania, żądane pola i informacje audytowe za pośrednictwem interfejsu API. Zwracane są wyłącznie skonfigurowane pola.
Żądania API są wysyłane na podstawowy adres URL interfejsu API ID Scan i uwierzytelniane za pomocą klucza API wygenerowanego w portalu ID Scan. Klucz API jest przekazywany w specjalnym nagłówku żądania i powinien być używany wyłącznie po stronie serwera. Nigdy nie należy ujawniać kluczy API w kodzie interfejsu użytkownika ani w aplikacjach mobilnych.
Po utworzeniu żądania skanowania interfejs API zwraca identyfikator żądania, klucz żądania, czas wygaśnięcia oraz linki weryfikacyjne. W przypadku samodzielnego dostarczania plików należy wykorzystać zwrócony adres WebUrl w wiadomościach e-mail, SMS-ach, na portalu lub w procesie roboczym. Na urządzeniach mobilnych adres DeepLinkUrl umożliwia bezpośrednie otwarcie aplikacji.
Możesz wybrać sposób, w jaki użytkownik otrzyma prośbę o weryfikację. Dzięki temu ID Scan może być wykorzystywany zarówno w całkowicie zautomatyzowanych, jak i niestandardowych procesach komunikacyjnych.
ID Scan wysyła firmową wiadomość e-mail z zaproszeniem zawierającą bezpieczny link weryfikacyjny.
ID Scan wysyła link weryfikacyjny w wiadomości SMS. Przydatne w procesach rejestracji zorientowanych na urządzenia mobilne.
Twój system odbiera link i przekazuje go za pośrednictwem Twojej poczty elektronicznej, wiadomości SMS, portalu lub systemu komunikacyjnego.
Żądanie weryfikacji przechodzi przez kilka etapów. Integracje mogą wykorzystywać te etapy do pokazywania postępów, wysyłania przypomnień lub podejmowania decyzji o konieczności złożenia nowego żądania.
| Status | Opis |
|---|---|
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. |
Użyj zewnętrznego odniesienia, aby powiązać wniosek o weryfikację z konkretnym klientem, pracownikiem, dokumentacją, zamówieniem lub rekordem rejestracji. To samo odniesienie zostanie zwrócone podczas wyświetlania szczegółów wniosku.
Powiąż to zgłoszenie z danymi swojego klienta.
Powiąż wynik z dokumentacją Wwft, kadrową lub dotyczącą zgodności z przepisami.
Skorzystaj z tego odniesienia, aby kontynuować zautomatyzowane procesy po zakończeniu weryfikacji.
ID Scan wspiera zasadę minimalizacji danych. Możesz dokładnie określić, które pola mają być przekazywane do Twojego systemu. Przed wysłaniem danych użytkownik może sprawdzić, jakie informacje zostaną udostępnione.
| Pole | Opis | Źródło |
|---|---|---|
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 |
W ramach procesu weryfikacji można zlecić przeprowadzenie pewnych kontroli. Niektóre z nich to techniczne kontrole NFC, inne natomiast dotyczą zasad biznesowych, takich jak minimalny wiek lub weryfikacja na podstawie zdjęcia selfie.
| Sprawdź | Opis | Wynik |
|---|---|---|
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 } |
Punkt końcowy wyniku zwraca status żądania, status weryfikacji, odniesienie zewnętrzne, wybrane pola tożsamości, wybrane obrazy oraz wyniki sprawdzania. Pola, których nie zamówiono, nie są zwracane.
Zgłoszone, zrealizowane, wygasłe, usunięte lub nieudane, wraz z datami utworzenia i zakończenia.
Wyłącznie skonfigurowane dane osobowe, takie jak imię i nazwisko, obywatelstwo, data urodzenia lub data ważności dokumentu.
Stan odczytu NFC, uwierzytelnianie chipu, ważność dokumentu, weryfikacja tożsamości za pomocą zdjęcia oraz opcjonalne dane w formacie PDF/raporty.
Pola obrazów, takie jak zdjęcie portretowe DG2, zamaskowany obraz MRZ i zdjęcie selfie, są zwracane bezpośrednio w treści jako dane zakodowane w formacie Base64 na żądanie. Obrazy nie są udostępniane w postaci publicznych adresów URL.
Wartość danych należy traktować jako dane obrazu w formacie binarnym zakodowane w Base64.
Użyj typu zawartości, np. image/jpeg, aby poprawnie odtworzyć obraz.
Dane obrazu są dołączane tylko wtedy, gdy pole to zostało wyraźnie wskazane w szablonie.
Numer dokumentu może zostać zwrócony w pełnej postaci lub w formie zamaskowanej. Zamaskowanie pozwala ograniczyć niepotrzebne ujawnianie numerów dokumentów, umożliwiając jednocześnie przeprowadzanie porównań lub kontroli audytowych w Państwa systemie.
| Wartość | Opcja | Opis |
|---|---|---|
(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. |
W poniższym przykładzie tworzone jest żądanie weryfikacji, wysyłane jest polecenie do serwisu ID Scan o przesłanie zaproszenia pocztą elektroniczną, a następnie zwracane są wyłącznie wybrane pola i wyniki weryfikacji.
Po zakończeniu operacji system może pobrać wynik na podstawie identyfikatora żądania lub klucza żądania. Odwołanie zewnętrzne można wykorzystać do powiązania wyniku z własnym systemem.
Ustawienia dotyczące okresu przechowywania można konfigurować indywidualnie dla każdego klienta. Dane weryfikacyjne można usuwać po upływie określonego czasu, po ich odczytaniu lub zgodnie ze skonfigurowaną polityką prywatności. Pomaga to ograniczyć niepotrzebne przechowywanie wrażliwych danych dotyczących tożsamości.
Usuń dane weryfikacyjne po upływie określonej liczby dni.
Oznacz dane jako przeczytane po ich pobraniu i zaplanuj ich usunięcie po tym momencie.
W razie potrzeby należy stosować odrębne ustawienia przechowywania danych dla procesów w portalu i procesów API.
Oprócz tworzenia i pobierania wniosków integracje umożliwiają ponowne wysyłanie zaproszeń lub usuwanie wniosków. Usunięcie wniosku może być przydatne w przypadku anulowania przepływu pracy lub gdy weryfikacja nie jest już potrzebna.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
Tryb testowy pozwala sprawdzić poprawność całego procesu integracji przed uruchomieniem środowiska produkcyjnego. Żądania testowe są oznaczone w odpowiedzi API atrybutem „IsTest”, dzięki czemu system może oddzielić dane testowe od procesów produkcyjnych.
Sprawdź proces tworzenia żądania, jego dostarczenia, skanowania aplikacji oraz pobierania wyników bez korzystania z produkcyjnych procesów roboczych.
Odpowiedź na żądanie tworzenia zawiera atrybut IsTest, co ułatwia wykrywanie żądań testowych.
Zacznij od skonfigurowania testowego klucza API lub testowego dzierżawcy, a po weryfikacji przejdź do weryfikacji w środowisku produkcyjnym.
Nie każde żądanie kończy się pomyślną weryfikacją. Użytkownik może przerwać proces, żądanie może stracić ważność lub odczyt NFC może się nie powieść. Aby ustalić ostateczny wynik, należy skorzystać z właściwości Status, HasResult i IsSuccess oraz pól kontrolnych.
Załóż darmowe konto, wygeneruj klucz API i przetestuj cały proces przed uruchomieniem serwisu.