Kendi sisteminizden güvenli NFC kimlik doğrulama istekleri oluşturun. Kullanıcıları e-posta veya SMS yoluyla davet edin ya da oluşturulan bağlantıyı kendiniz gönderin. Kullanıcı mobil uygulamada NFC çipini tarar ve siz de işlemleriniz için gerekli olan alanları alırsınız.
ID Scan, mobil tarama sürecinin tamamını kendileri oluşturmadan kimlik doğrulama özelliği eklemek isteyen yazılım satıcıları ve kuruluşlar için tasarlanmıştır.
Arka uç sisteminizden bir tarama talebi oluşturun. Harici referans, dil, geçerlilik süresi, teslimat ayarları, istenen alanlar ve kontroller ekleyin.
ID Scan'ın e-posta veya SMS göndermesine izin verin ya da geri gönderilen doğrulama bağlantısını kullanarak kendi iletişim kanalınızı kullanın.
Kullanıcı mobil uygulamayı açar, MRZ’yi tarar, NFC çipini okur ve isteğe bağlı olarak DG2’deki vesikalık fotoğrafla canlı bir selfie kontrolü gerçekleştirir.
API aracılığıyla durumu, kontrolleri, istenen alanları ve denetim bilgilerini alın. Yalnızca yapılandırılmış alanlar döndürülür.
API çağrıları, ID Scan API ana URL'sine gönderilir ve ID Scan portalında oluşturulan bir API anahtarı kullanılarak kimlik doğrulaması yapılır. API anahtarı, özel bir istek başlığı aracılığıyla gönderilir ve yalnızca sunucu tarafında kullanılmalıdır. API anahtarlarını hiçbir zaman ön uç kodunda veya mobil uygulamalarda açıkta bırakmayın.
Bir tarama isteği oluşturulduğunda, API istek kimliğini, istek anahtarını, geçerlilik süresini ve doğrulama bağlantılarını döndürür. Kendi e-postanızda, SMS'inizde, portalınızda veya iş akışınızda, kendi teslimatınızı kullanırken döndürülen WebUrl'yi kullanın. Mobil cihazlarda DeepLinkUrl, uygulamayı doğrudan açabilir.
Kullanıcının doğrulama isteğini nasıl alacağını seçebilirsiniz. Bu sayede ID Scan, hem tamamen otomatik hem de özel iletişim akışlarına uyum sağlayabilir.
ID Scan, güvenli bir doğrulama bağlantısı içeren markalı bir davet e-postası gönderir.
ID Scan, doğrulama bağlantısını SMS yoluyla gönderir. Mobil öncelikli kayıt süreçleri için kullanışlıdır.
Sisteminiz bağlantıyı alır ve bunu kendi e-posta, SMS, portal veya mesajlaşma iş akışınız aracılığıyla gönderir.
Bir doğrulama talebi, birkaç farklı durumdan geçer. Entegrasyonlar bu durumları kullanarak ilerlemeyi gösterebilir, hatırlatıcılar gönderebilir veya yeni bir talebin gerekli olup olmadığına karar verebilir.
| Durum | Açıklama |
|---|---|
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. |
Bir doğrulama talebini kendi müşterinize, çalışanınıza, dosyanıza, siparişinize veya kayıt sürecine bağlamak için harici bir referans kullanın. Talep ayrıntılarını aldığınızda aynı referans geri döndürülür.
Talebi kendi müşteri kaydınızla ilişkilendirin.
Sonucu bir Wwft, İK veya uyum dosyasına ekleyin.
Doğrulama işlemi tamamlandıktan sonra otomatik iş akışlarını sürdürmek için bu referansı kullanın.
ID Scan, veri minimizasyonunu destekler. Sisteminizde hangi alanların görüntüleneceğini tam olarak belirleyebilirsiniz. Kullanıcıya, gönderimden önce hangi verilerin paylaşılacağı gösterilebilir.
| Alan | Açıklama | Kaynak |
|---|---|---|
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 |
Doğrulama sürecinin bir parçası olarak çeşitli kontroller talep edilebilir. Bu kontrollerden bazıları teknik NFC kontrolleriyken, diğerleri ise asgari yaş veya selfie doğrulaması gibi iş kurallarıdır.
| Kontrol | Açıklama | Elde edilen sonuç |
|---|---|---|
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 } |
Sonuç uç noktası, istek durumunu, doğrulama durumunu, harici referansı, seçilen kimlik alanlarını, seçilen resimleri ve kontrol sonuçlarını döndürür. İstenmeyen alanlar döndürülmez.
Talep edilen, tamamlanan, süresi dolan, silinen veya başarısız olanlar; oluşturma ve tamamlanma zaman damgaları dahil.
Yalnızca isim, uyruk, doğum tarihi veya belge geçerlilik süresi gibi kimlik bilgileri.
NFC okuma durumu, çip doğrulama, belge geçerliliği, selfie kontrolü ve isteğe bağlı PDF/raporlama verileri.
DG2 portre fotoğrafı, maskeli MRZ görüntüsü ve selfie görüntüsü gibi görüntü alanları, talep edildiğinde satır içi olarak Base64 kodlu veriler halinde döndürülür. Görüntüler, herkese açık URL’ler olarak döndürülmez.
Veri değerini Base64 kodlu ikili görüntü verisi olarak kullanın.
Görüntüyü doğru şekilde yeniden oluşturmak için image/jpeg gibi bir içerik türü kullanın.
Görüntü verileri, yalnızca şablonda bu alan açıkça talep edildiğinde eklenir.
Belge numarası tam olarak veya maskelenmiş şekilde döndürülebilir. Maskeleme, belge numaralarının gereksiz yere ifşa edilmesini önlerken, kendi sisteminizde eşleştirme veya denetim kontrollerinin yapılmasına da olanak tanır.
| Değer | Seçenek | Açıklama |
|---|---|---|
(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. |
Aşağıdaki örnek bir doğrulama isteği oluşturur, ID Scan'den daveti e-posta yoluyla göndermesini ister ve yalnızca seçilen alanları ve onayları döndürür.
İşlem tamamlandıktan sonra, sisteminiz sonuçları istek kimliği veya istek anahtarıyla alabilir. Dış referans, sonucu kendi sisteminize bağlamak için kullanılabilir.
Saklama ayarları kiracı bazında yapılandırılabilir. Doğrulama verileri, belirli bir süre geçtikten sonra, okunduktan sonra veya yapılandırdığınız gizlilik politikasına göre silinebilir. Bu, hassas kimlik verilerinin gereksiz yere depolanmasını sınırlamaya yardımcı olur.
Belirlenen gün sayısından sonra doğrulama verilerini sil.
Veriler alındıktan sonra okundu olarak işaretlenmeli ve o andan sonra silinmesi planlanmalıdır.
Gerektiğinde portal ve API iş akışları için ayrı saklama ayarları kullanın.
Entegrasyonlar, istek oluşturma ve alma işlemlerinin yanı sıra davetiyeleri yeniden gönderebilir veya bir isteği silebilir. Bir isteğin silinmesi, iş akışı iptal edildiğinde veya doğrulama artık gerekli olmadığında kullanılabilir.
POST /api/scan-requests/{id}/resend
DELETE /api/scan-requests/{id}
GET /api/scan-requests/{id}/details
Canlı ortama geçmeden önce tüm entegrasyon akışını doğrulamak için test modu kullanılabilir. Test istekleri, API yanıtında IsTest etiketiyle işaretlenir; böylece sisteminiz test verilerini üretim iş akışlarından ayırabilir.
Üretim iş akışlarını kullanmadan istek oluşturma, iletim, uygulama tarama ve sonuç alma işlemlerini doğrulayın.
Oluşturma isteği yanıtında IsTest öğesi bulunur; bu sayede test isteklerini kolayca tespit edebilirsiniz.
Öncelikle bir test API anahtarı veya test kiracısı kurulumuyla başlayın ve doğrulama işleminden sonra canlı doğrulamaya geçin.
Her istek başarılı bir doğrulama ile sonuçlanmayabilir. Kullanıcı işlemi durdurabilir, istek süresi dolabilir veya NFC okuma işlemi başarısız olabilir. Nihai sonucu belirlemek için Status, HasResult, IsSuccess ve kontrol alanlarını kullanın.
Canlıya geçmeden önce ücretsiz bir hesap oluşturun, bir API anahtarı oluşturun ve tüm süreci test edin.