Kimlik Çözümleyicisi (Önizleme)
ID Analyzer birkaç farklı kimlik doğrulama ürünü sağlar. Uygulamanız için en iyi çözümü seçmek için her ürünle ilgili temel bilgileri edinmeniz gerekir.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Id Analyzer Desteği |
| URL | https://www.idanalyzer.com/contact.html |
| E-posta | support@idanalyzer.com |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Evith Techology |
| Web sitesi | https://www.idanalyzer.com/ |
| Gizlilik ilkesi | https://www.idanalyzer.com/privacy-policy.html |
| Kategoriler | BT İşlemleri; Verimli -lik |
ID Analyzer platformu, işletmelere, kuruluşlara ve bireylere sınırlar olmadan çalışan gerçekten küresel bir kimlik doğrulama çözümü, özel ihtiyaçlarınıza ve taleplerinize göre uyarlanabilir bir çözüm ve sürekli yükseltilen ve geliştirilmekte olan bir güvenlik sistemi sağlar.
Dünyanın dört bir yanındaki 190'dan fazla ülkede 4000'den fazla farklı kimlik biçimi arasında tam kimlik doğrulama erişimi ve bilgi sağlayan bu, modern dünya düşünülerek tasarlanmış küresel bir çözümdür.
Önkoşullar
- Id Analyzer ile bir geliştirici hesabı. Kaydolun adresinden ücretsiz bir hesaba kaydolabilirsiniz
- Hesaba kaydoldıktan sonra, ID Analyzer'ın web portalında size bir API anahtarı verilir. Bağlayıcıyla kimlik doğrulaması yapmak için bu API anahtarını kullanın
Kimlik bilgilerini alma
- Kaydolma'ya gidin
- Gerekli bilgileri girin.
- İstendiğinde e-postanızı doğrulayın.
- Id Analyzer'ın web portalında hesap ayrıntılarınızla birlikte yeni API anahtarınızı görürsünüz. Daha sonra kullanmak üzere panonuza kaydetmek için "Kopyala" düğmesine basın.
FAQ
Müşterimin gizliliği konusunda endişeleniyorum, API müşterim hakkındaki bilgileri kaydeder mi?
Her şey yalnızca istemcinin kasasında depolanır ve rastgele sızdırılmaz. Başka bir yerde kopyası olmayacaktır.
"Krediler" ne için, API kredilerini nasıl satın aabilirim?
Hesabınız için kalan ön ödemeli kredi. Aylık planınız varsa, aylık kotanız ön ödemeli krediden önce kullanılır.
Bir belgenin gerçek mi yoksa sahte mi olduğunu nasıl denetleyebilirim?
Kimlik doğrulamasını açın, sonuç kimlik doğrulama puanı içerir.
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| API API Anahtarı | securestring | Bu API için API Anahtarı | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| AML Veritabanında Arama |
AML API'si, ID Analyzer genel AML veritabanında tasdikler, PEP'ler ve aranan suçlular için ad, belge numarası veya her ikisini birden kullanarak arama yapmanızı sağlar. Sonuçları doğum günü ve milliyet ile daha fazla filtreleyebilirsiniz. |
|
Docu |
Kullanıcının kimlik doğrulaması olmadan yasal belgeyi gözden geçirip e-imzaladığı bir imza oturumu oluşturabilirsiniz. Hem kimlik doğrulaması yapmak hem de kullanıcınızın bazı belgeleri imzalamasını istiyorsanız, lütfen bunun yerine bir kimlik doğrulama oturumu oluşturun. |
|
Docu |
Kimlik doğrulaması gerektiren her kullanıcı için bir doğrulama oturumu oluşturabilirsiniz. |
| Eğitim Durumu |
Kasa eğitiminin devam edip etmediğini veya tamamlanıp tamamlanmadığını denetleyin. |
| Geri Çağırmayı Doğrulama |
Verilerin sunucumuzdan gönderildiğinden emin olmak için. |
| Kasa Girdisini Güncelleştir |
HTTP POST isteğinde bulunarak bir kasa girişindeki tek bir alanın veya birden çok alanın değerini güncelleştirebilirsiniz. |
| Kasa Girişi İçeriğini Alma |
Kasaya girdiler eklendiğinde hem Core API hem de DocuPass API'si vaultid adlı bir kasa giriş tanımlayıcısı döndürür. Aşağıdaki uç noktaya bir HTTP POST isteği göndererek kasadaki bir girdinin içeriğini sorgulamak için tanımlayıcıyı kullanabilirsiniz. |
|
Kasadan Girdi |
HTTP POST isteğinde bulunarak tek veya birden çok kasa girdilerini silebilirsiniz. |
| Kasadan Görüntü Sil |
HTTP POST isteğinde bulunarak kasa girdisi içindeki bir görüntüyü silebilirsiniz. Bir görüntü silindikten sonra, önbelleğe alma nedeniyle görüntünün URL'sine kısa bir süre için erişilebilir olmaya devam edebilir. |
| Kasaya görüntü ekleme |
HTTP POST isteğinde bulunarak bir görüntüyü karşıya yükleyebilir ve mevcut bir kasa girişine ekleyebilirsiniz. |
| Liste ve Filtre Girdileri |
Kasada depolanan tüm girişleri listelemek veya belirli değerlere sahip girişleri aramak için aşağıdaki uç noktaya bir HTTP POST isteği gönderin. |
| Yüz Arama |
Yüz araması, bir kişinin görüntüsünü kullanarak kasanın tamamında arama yapmanızı sağlar. Yüz arama özelliğini kullanmak için web portalı altında yüz araması dizini oluşturmayı etkinleştirmeniz ve kasa veri kümelerinizi düzenli aralıklarla eğitmeniz gerekir. |
| Yüz Arama Eğitimi |
Yüz araması gerçekleştirmeden önce, kasanızdaki belge veri kümelerini eğitmek için bir train komutu vermelisiniz. Kasa verilerinizi web portalı aracılığıyla da eğitebilirsiniz. Eğitim görevi zaman uyumsuzdur, eğitim süresi kasa girişlerinin ve görüntülerinin sayısına bağlıdır. Birkaç saniye ile bir saat arasında sürebilir. |
| Çekirdek API Ayarı |
Uzak fiziksel belgeyi, orijinalliğini ve yüzünü doğrulamak için çok işlevli kimlik doğrulama API'si belgeyi kullanıcı fotoğrafınızla eşleştirin. |
AML Veritabanında Arama
AML API'si, ID Analyzer genel AML veritabanında tasdikler, PEP'ler ve aranan suçlular için ad, belge numarası veya her ikisini birden kullanarak arama yapmanızı sağlar. Sonuçları doğum günü ve milliyet ile daha fazla filtreleyebilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız web portalınızın altında kullanılabilir. |
|
name
|
name | string |
Herhangi bir dilde kişinin veya kuruluşun adı veya diğer adı. |
|
|
documentnumber
|
documentnumber | string |
Kişinin pasaport numarası, ulusal kimlik numarası veya ehliyet numarası vb. |
|
|
varlık
|
entity | string |
kişi: Kişi; yasallık: Şirket veya Kuruluş |
|
|
country
|
country | string |
Yalnızca eşleşen ülke/uyruklu veya ülke bilgisi olmayan varlıkları döndürür. |
|
|
Dob
|
dob | string |
Yalnızca eşleşen doğum günü bilgisi olan veya doğum günü bilgisi olmayan varlıkları döndürür. |
|
|
veritabanı
|
database | string |
AML denetimi gerçekleştirilecek kaynak veritabanlarını belirtin; boş bırakılırsa tüm kaynak veritabanları denetlenecektir. Her veritabanı kodunu virgülle ayırın; örneğin: un_sc,us_ofac. Kaynak veritabanlarının ve ilgili kodun tam listesi için AML API'sine Genel Bakış sayfasını ziyaret edin. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
aml
|
items | array of object |
AML eşleşmelerinin listesini içeren dizi, eşleşme bulunamazsa boş bir dizi döndürür. Belirli ayrıntılar için AML API Başvurusu'na bakın. |
|
varlık
|
items.entity | string |
kişi veya yasallık |
|
tam ad
|
items.fullname | array of string |
Kişi veya tüzel kişi adları |
|
isim
|
items.firstname | array of string |
Kişi adları |
|
soyadı
|
items.lastname | array of string |
Kişi soyadı(lar) |
|
middlename
|
items.middlename | array of string |
Kişi ikinci adları |
|
alias
|
items.alias | array of string |
Varlığın alternatif veya yabancı adları |
|
Dob
|
items.dob | array of string |
Peron'un doğum günü YYYY, YYYY-AA veya YYYY-MM-DD biçimlerinde gelebilir. |
|
address
|
items.address | array of string |
Varlığın adresi veya ikamet ettiği ülke |
|
milliyet
|
items.nationality | array of string |
Varlığın ülkesi veya uyrluğu |
|
doğum yeri
|
items.birthplace | array of string |
Peron'un doğum yeri |
|
cinsiyet
|
items.gender | array of string |
Peron'un cinsiyeti: M veya F |
|
documentnumber
|
items.documentnumber | array of object |
Varlıkla ilişkilendirilmiş belgelerin listesi. |
|
kimlik
|
items.documentnumber.id | string |
Belge numarası |
|
id_formatted
|
items.documentnumber.id_formatted | string |
Alfasayısal belge numarası |
|
country
|
items.documentnumber.country | string |
ISO2 ülke kodu |
|
type
|
items.documentnumber.type | string |
P = Pasaport numarası, I = Kimlik numarası, D = Ehliyet numarası, O = Diğer/Bilinmeyen belge türü |
|
program
|
items.program | array of string |
Tasdik programları |
|
not
|
items.note | array of string |
Varlık için ek not |
|
time
|
items.time | string |
Kaynak listeye varlık eklendiğinde veya son güncelleştirmede UTC TZ zaman damgası |
|
statü
|
items.status | string |
Varlığın konumu/unvanı veya tasdikin geçerli durumu |
|
kaynak
|
items.source | array of string |
Resmi kaynak URL'lerinin listesi |
|
veritabanı
|
items.database | string |
Id Analyzer AML veritabanı kodu |
|
şema
|
items.schema | string |
DocuPass İmza Oturumu Oluşturma
Kullanıcının kimlik doğrulaması olmadan yasal belgeyi gözden geçirip e-imzaladığı bir imza oturumu oluşturabilirsiniz. Hem kimlik doğrulaması yapmak hem de kullanıcınızın bazı belgeleri imzalamasını istiyorsanız, lütfen bunun yerine bir kimlik doğrulama oturumu oluşturun.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız web portalınızın altında kullanılabilir. |
|
şirket adı
|
companyname | True | string |
Son kullanıcının şirketinize kimlik bilgileri gönderdiğini bilmesi için şirketinizin adı doğrulama sayfasında görüntülenir |
|
şablon_id
|
template_id | string |
Kullanıcı verileriyle otomatik olarak doldurulacak sözleşme şablonu kimliği. |
|
|
contract_format
|
contract_format | string |
Çıktı belgesi biçimi. (PDF, DOCX, HTML) |
|
|
callbackurl
|
callbackurl | string |
Sözleşme dosyası bu URL'ye gönderilir. Oluşturulan belgeyi kaydedebilmeniz için vault_save etkinleştirmeniz veya bir geri çağırma belirtmelisiniz. |
|
|
successredir
|
successredir | string |
Belge gözden geçirilip imzalandıktan sonra tarayıcı bu URL'ye yeniden yönlendirilir. DocuPass başvuru kodu ve customid URL'nin sonuna eklenir |
|
|
customid
|
customid | string |
Sunucunuzun geri çağırma URL'sine geri gönderilecek ve sorgu dizesi olarak successredir ve failredir tarafından ayarlanan yeniden yönlendirme URL'lerine eklenecek özel bir dize. Veritabanınızda kullanıcınızı tanımlamak için kullanışlıdır. Bu değer, Kasa altında docupass_customid altında depolanır. |
|
|
Yeniden
|
reusable | boolean |
bu parametreyi kullanmak, birden çok kullanıcının belgeleri aynı URL üzerinden gözden geçirmesine ve imzalamasına olanak tanır, her kullanıcı için otomatik olarak yeni bir DocuPass başvuru kodu oluşturulur. |
|
|
sms_contract_link
|
sms_contract_link | string |
Tam uluslararası cep telefonu numarası |
|
|
vault_save
|
vault_save | boolean |
Oluşturulan belgeyi kasaya kaydedin. Oluşturulan belgeyi kaydedebilmeniz için vault_save etkinleştirmeniz veya bir geri çağırma belirtmelisiniz. |
|
|
nobranding
|
nobranding | boolean |
Tüm DocuPass sayfalarında marka logosunu gizleyin. |
|
|
customhtmlurl
|
customhtmlurl | string |
DocuPass için kendi HTML sayfanızı ve CSS'nizi kullanın. HTML ve CSS'de değişiklik yaptıktan sonra bunları kendi sunucunuza yüklemeniz gerekir, her oturumun başında DocuPass sunucunuzdan en son HTML sayfasını indirir. |
|
|
language
|
language | string |
DocuPass, kullanıcı cihaz dilini otomatik olarak algılar ve ilgili dili görüntüler. Otomatik dil algılamayı geçersiz kılmak için bu parametreyi ayarlayın. (en, fr, nl, de, es, zh-TW, zh-CN) |
|
|
Bitiş
|
expiry | integer |
DocuPass oturumunun süresi dolmadan önceki saniye sayısı. Süresi dolmayan kullanıcı geçerli oturuma devam edemeyecek, başarısız bir geri çağırma da gönderilecektir. |
|
|
qr_color
|
qr_color | string |
QR Kodu Ön Plan Rengi |
|
|
qr_bgcolor
|
qr_bgcolor | string |
QR Kodu Arka Planının Rengi |
|
|
qr_size
|
qr_size | integer |
QR Kodunun Boyutu |
|
|
qr_margin
|
qr_margin | integer |
QR Kodunun kenarlık kalınlığı |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
referans
|
reference | string |
DocuPass oturumu için benzersiz bir başvuru kodu. |
|
customid
|
customid | string |
DocuPass oturumu oluşturulurken kullanılan özel kimlik. |
|
url
|
url | string |
DocuPass web uygulamasının benzersiz URL'si. Bu bağlantıyı kullanıcınıza gönderin veya belgeyi gözden geçirmek ve imzalamak için web sitenize veya mobil uygulamanıza ekleyin. |
|
qrcode
|
qrcode | string |
Kullanıcınızın taraması için QR kodu resim URL'si |
|
base_url
|
base_url | string |
Bu bağlantıyı kullanıcınıza gönderebilir ve belge imzalamak için başvuru kodu girmesini isteyebilirsiniz. |
|
html_qrcode
|
html_qrcode | string |
Web sayfanızda QR Kodunu görüntülemek için örnek HTML. |
|
html_iframe
|
html_iframe | string |
Web sayfanıza iframe eklemek için örnek HTML. |
|
smssent
|
smssent | string |
SMS sms_contract_link parametresi aracılığıyla başarıyla gönderildiğinde onay olarak telefon numarasını içerir. |
|
Bitiş
|
expiry | integer |
Bu oturumun süresinin ne zaman dolacağını, süre dolduğunda kullanıcının bağlantıyı artık kullanamayacağını ve başarısız bir geri çağırma gönderileceğini belirten UTC UNIX zaman damgası. |
DocuPass Oturumu Oluşturma
Kimlik doğrulaması gerektiren her kullanıcı için bir doğrulama oturumu oluşturabilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız web portalınızın altında kullanılabilir. |
|
type
|
type | integer |
0: Iframe Modülü,1: Mobil Modül, 2: Yeniden Yönlendirme Modülü, 3: Live Mobile Modülü |
|
|
şirket adı
|
companyname | True | string |
Şirketinizin veya ürününüzün adı. |
|
callbackurl
|
callbackurl | string |
Doğrulama sonucunu almak için Web kancası/Geri Arama URL'si. |
|
|
Biyometrik
|
biometric | integer |
Kullanıcıdan yüz doğrulama için bir selfie fotoğrafı veya selfie videosu çekmesini isteyin. |
|
|
biometric_threshold
|
biometric_threshold | float |
Yüz biyometrik doğrulamasını geçmek için en düşük puanı belirtin |
|
|
authenticate_minscore
|
authenticate_minscore | float |
Belgenin doğrulamayı geçebilmesi için en düşük kimlik doğrulama puanını karşılaması gerekir. Geçerlilik/orijinallik denetimini devre dışı bırakmak için 0'ı ayarlayın. |
|
|
authenticate_module
|
authenticate_module | integer |
Belgeyi doğrulamak için kullanılan modülü belirtin. |
|
|
maxattempt
|
maxattempt | integer |
Her doğrulama isteği için en fazla başarısız deneme sayısı. |
|
|
successredir
|
successredir | string |
Kimlik doğrulaması başarılı olduğunda tarayıcı bu URL'ye yönlendirilir. |
|
|
failredir
|
failredir | string |
Kimlik doğrulaması başarısız olduğunda tarayıcı bu URL'ye yeniden yönlendirilir. |
|
|
customid
|
customid | string |
Veritabanınızda kullanıcınızı tanımlamak için kullanışlıdır. Bu değer, Kasa altında docupass_customid altında depolanır. |
|
|
Yeniden
|
reusable | boolean |
Bu parametrenin etkinleştirilmesi, birden çok kullanıcının kimliğini aynı URL üzerinden doğrulamasını sağlar. Her kullanıcı için otomatik olarak yeni bir DocuPass başvuru kodu oluşturulur. |
|
|
telefon doğrulama
|
phoneverification | boolean |
DocuPass, kullanıcıdan doğrulama için bir telefon numarası girmesini isteyip istemediğinizi sorarsa hem mobil hem de sabit hat numarası doğrulamasını destekler. (Yalnızca Abone) |
|
|
documenttype
|
documenttype | string |
Kullanıcının belirli bir belge türünü karşıya yüklemesi gerekir. Örneğin "PD" hem pasaport hem de sürücü lisansını kabul eder. |
|
|
documentcountry
|
documentcountry | string |
ISO ALPHA-2 Ülke Kodu. |
|
|
documentregion
|
documentregion | string |
Eyalet/Bölge tam adı veya kısaltması. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Çift taraflı tarama gerçekleştirirken adların, belge numarasının ve belge türünün belgenin ön ve arkası arasında eşleşip eşleşmediğini denetleyin. Herhangi bir bilgi uyuşmazlığı varsa hata 14 oluşturulur. |
|
|
verify_expiry
|
verify_expiry | boolean |
Yalnızca süresi dolmamış belgeyi kabul et |
|
|
verify_documentno
|
verify_documentno | string |
Doğrulama gerektiren belge numarası. |
|
|
verify_name
|
verify_name | string |
Doğrulama gerektiren ad ve soyadı da dahil olmak üzere tam ad. |
|
|
verify_dob
|
verify_dob | string |
YYYY/AA/DD biçiminde doğrulama gerektiren doğum tarihi. |
|
|
verify_age
|
verify_age | string |
Yaş aralığı, örnek: 18-40 |
|
|
verify_address
|
verify_address | string |
Doğrulama gerektiren tam adres. |
|
|
verify_postcode
|
verify_postcode | string |
Doğrulama gerektiren tam posta kodu. |
|
|
verify_phone
|
verify_phone | string |
Doğrulama gerektiren tam telefon numarası. |
|
|
vault_save
|
vault_save | boolean |
Kullanıcı belgelerini ve ayrıştırılmış bilgileri kasaya kaydedin. |
|
|
return_documentimage
|
return_documentimage | boolean |
Geri arama isteğinde kullanıcı tarafından karşıya yüklenen belge görüntüsünü döndür. |
|
|
return_faceimage
|
return_faceimage | boolean |
Geri arama isteğinde kullanıcı tarafından karşıya yüklenen geri dönüş yüzü görüntüsü. |
|
|
return_type
|
return_type | integer |
Döndürülen görüntünün türünü (base64 ile kodlanmış görüntü içeriği veya görüntünün URL'si) belirtin. (Görüntünün URL'si yalnızca 7 gün boyunca saklanır) |
|
|
welcomemessage
|
welcomemessage | string |
İlk sayfadaki genel karşılama iletisini özelleştirilmiş metninizle değiştirin (en fazla 1.000 karakter) |
|
|
nobranding
|
nobranding | boolean |
Tüm DocuPass sayfalarında marka logosunu gizleyin. (Yalnızca Abone) |
|
|
logo
|
logo | string |
Özel marka logosu. (Yalnızca Abone) |
|
|
customhtmlurl
|
customhtmlurl | string |
DocuPass için kendi HTML sayfanızı ve CSS'nizi kullanın. (Yalnızca Abone) |
|
|
language
|
language | string |
DocuPass, kullanıcı cihaz dilini otomatik olarak algılar ve ilgili dili görüntüler. |
|
|
Bitiş
|
expiry | integer |
DocuPass oturumunun süresi dolmadan önceki saniye sayısı. Süresi dolmayan kullanıcı geçerli oturuma devam edemeyecek, başarısız bir geri çağırma da gönderilecektir. |
|
|
qr_color
|
qr_color | string |
QR Kodu Ön Planının rengi. (Yalnızca Live Mobile ve Standard Mobile için) |
|
|
qr_bgcolor
|
qr_bgcolor | string |
QR Kodu Arka Planının rengi. (Yalnızca Live Mobile ve Standard Mobile için) |
|
|
qr_size
|
qr_size | integer |
QR Kodunun boyutu (1-50). (Yalnızca Live Mobile ve Standard Mobile için) |
|
|
qr_margin
|
qr_margin | integer |
QR Kodunun kenarlık kalınlığı (1-50). (Yalnızca Live Mobile ve Standard Mobile için) |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
referans
|
reference | string |
DocuPass oturumu için benzersiz bir başvuru kodu. |
|
type
|
type | integer |
DocuPass modül türü oluşturuldu. |
|
customid
|
customid | string |
DocuPass oturumu oluşturulurken kullanılan özel kimlik. |
|
url
|
url | string |
DocuPass web uygulamasının benzersiz URL'si. Bu bağlantıyı kullanıcınıza gönderin veya kimlik doğrulamaya başlamak için web sitenize veya mobil uygulamanıza ekleyin. |
|
qrcode
|
qrcode | string |
Kullanıcınızın taraması için QR kodu resim URL'si |
|
base_url
|
base_url | string |
Bu bağlantıyı kullanıcınıza gönderebilir ve doğrulamayı başlatmak için başvuru kodu girmesini isteyebilirsiniz. |
|
html
|
html | string |
Web sayfanıza ekleyebileceğiniz örnek HTML. |
|
smssent
|
smssent | integer |
SMS sms_verification_link parametresi aracılığıyla başarıyla gönderildiğinde onay olarak telefon numarasını içerir. |
|
Bitiş
|
expiry | integer |
Bu oturumun süresinin ne zaman dolacağını, süre dolduğunda kullanıcının bağlantıyı artık kullanamayacağını ve başarısız bir geri çağırma gönderileceğini belirten UTC UNIX zaman damgası. |
Eğitim Durumu
Kasa eğitiminin devam edip etmediğini veya tamamlanıp tamamlanmadığını denetleyin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
statü
|
status | string |
eğitilmemiş: Hiç eğitilmemiş, başlatılmamış: Eğitim çalışmıyor, çalışıyor: Eğitim şu anda çalışıyor, başarılı: Eğitim başarılı, başarısız: Eğitim başarısız oldu: Eğitim başarısız |
|
startTime
|
startTime | string |
Son eğitimin UTC olarak başlatıldığı saat. |
|
statusChangeTime
|
statusChangeTime | string |
UTC'de son durum değişikliğinin zamanı. |
|
lastSuccessTime
|
lastSuccessTime | string |
UTC'deki son başarılı eğitimin zamanı. |
|
hata
|
error | string |
Başarısız eğitim durumuyla ilişkili hata iletisi. |
Geri Çağırmayı Doğrulama
Verilerin sunucumuzdan gönderildiğinden emin olmak için.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız web portalınızın altında kullanılabilir. |
|
referans
|
reference | True | string |
POST BODY'da alınan başvuru kodu. |
|
Karma
|
hash | True | string |
POST BODY'da alınan karma. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
başarı
|
success | boolean | |
|
referans
|
reference | string |
DocuPass oturumu için başvuru kodu |
Kasa Girdisini Güncelleştir
HTTP POST isteğinde bulunarak bir kasa girişindeki tek bir alanın veya birden çok alanın değerini güncelleştirebilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
|
kimlik
|
id | True | string |
Kasa giriş tanımlayıcısı. |
|
adres1
|
address1 | string |
Adres satırı 1. |
|
|
adres2
|
address2 | string |
Adres satırı 2. |
|
|
blok
|
block | string |
Aynı belgenin Core API veya DocuPass'a gönderilmesini engellemek için bu parametreyi ayarlayın. 0: Blok 1 yok: 2 numaralı belgeyi engelle: Adı/soyadını engelle 3: Hem belge numarasını hem de ad/soyadını engelle. |
|
|
customdata1
|
customdata1 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize. |
|
|
customdata2
|
customdata2 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize. |
|
|
customdata3
|
customdata3 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize. |
|
|
customdata4
|
customdata4 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize. |
|
|
customdata5
|
customdata5 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize. |
|
|
Dob
|
dob | string |
Doğum tarihi (YYYY-MM-DD). |
|
|
belge adı
|
documentName | string |
Belgenin adı. |
|
|
documentNumber
|
documentNumber | string |
Belgenin benzersiz tanımlayıcısı (Passport No./Driver License No vb.) |
|
|
documentType
|
documentType | string |
P: Pasaport D: Ehliyet I: Kimlik Kartı V: Visa R: İkamet Kartı O: Diğer |
|
|
docupass_customid
|
docupass_customid | string |
DocuPass doğrulaması oluşturulurken customid geçirildi. |
|
|
docupass_failedreason
|
docupass_failedreason | string |
DocuPass doğrulaması başarısız olduysa, başarısız olmasının nedeni budur. |
|
|
docupass_reference
|
docupass_reference | string |
DocuPass oturumuna başvuru kodu. |
|
|
docupass_success
|
docupass_success | string |
DocuPass doğrulamasının başarılı veya başarısız olup olmadığı 0 veya 1. |
|
|
e-posta
|
string |
Kullanıcı e-posta adresi. |
||
|
Bitiş
|
expiry | string |
Süre sonu tarihi (YYYY-MM-DD) |
|
|
eyeColor
|
eyeColor | string |
Göz rengi. |
|
|
ön ad
|
firstName | string |
Ad / Verilen ad |
|
|
firstName_local
|
firstName_local | string |
Yerel dilde ad. |
|
|
fullName
|
fullName | string |
Tam ad (Diğer ad alanlarını güncelleştirme fullName'i güncelleştirmez) |
|
|
fullName_local
|
fullName_local | string |
Yerel dilde ad. |
|
|
hairColor
|
hairColor | string |
Saç rengi. |
|
|
height
|
height | string |
Kişinin boyu. |
|
|
issueAuthority
|
issueAuthority | string |
Belgenin verme yetkilisi. |
|
|
Verilen
|
issued | string |
Çıkış tarihi (YYYY-MM-DD) |
|
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
ISO2'de verilen ülke kodunu belgele. Örnek: ABD |
|
|
issuerOrg_region_abbr
|
issuerOrg_region_abbr | string |
Belge veren altbölgesi/durum kısaltması. Örnek: CA |
|
|
issuerOrg_region_full
|
issuerOrg_region_full | string |
Belge veren alt kaydı/durumu. Örnek: California |
|
|
sabit hat
|
landline | string |
Kullanıcı sabit hattı telefon numarası. |
|
|
soyadı
|
lastName | string |
Soyadı / Aile adı. |
|
|
lastName_local
|
lastName_local | string |
Yerel dilde soyadı. |
|
|
ikinci ad
|
middleName | string |
İkinci adlar. |
|
|
middleName_local
|
middleName_local | string |
Yerel dilde ikinci ad. |
|
|
mobile
|
mobile | string |
Kullanıcı cep telefonu numarası. |
|
|
nationality_iso2
|
nationality_iso2 | string |
ISO2'de belge sahibi uyrağı. Örnek: ABD |
|
|
optionalData
|
optionalData | string |
Belgeye ek olarak ek olarak belirtilmeyen veriler. |
|
|
optionalData2
|
optionalData2 | string |
Belgeye ek olarak ek olarak belirtilmeyen veriler. |
|
|
personalNumber
|
personalNumber | string |
Belgedeki ikincil tanımlayıcı numarası. |
|
|
placeOfBirth
|
placeOfBirth | string |
Doğum yeri. |
|
|
posta kodu
|
postcode | string |
Adres posta kodu. |
|
|
Kısıtlama -ları
|
restrictions | string |
Sürüş kısıtlamaları. |
|
|
seks
|
sex | string |
M: Erkek F: Dişi X: Belirtilmemiş |
|
|
güven düzeyi
|
trustlevel | string |
0: Belirlenmeyen 1: Geçersiz belge 2: Şüpheli 3: Geçerli Kimlik doğrulaması etkinse bu puan otomatik olarak hesaplanır. |
|
|
trustnote
|
trustnote | string | ||
|
vehicleClass
|
vehicleClass | string |
Ehliyetli araç sınıfı. |
|
|
weight
|
weight | string |
Kişinin ağırlığı. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
başarı
|
success | integer |
Kasa Girişi İçeriğini Alma
Kasaya girdiler eklendiğinde hem Core API hem de DocuPass API'si vaultid adlı bir kasa giriş tanımlayıcısı döndürür. Aşağıdaki uç noktaya bir HTTP POST isteği göndererek kasadaki bir girdinin içeriğini sorgulamak için tanımlayıcıyı kullanabilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
|
kimlik
|
id | string |
Kasa giriş tanımlayıcısı. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
başarı
|
success | integer | |
|
kimlik
|
data.id | string |
Kasa giriş tanımlayıcısı |
|
createtime
|
data.createtime | string |
UTC'de giriş oluşturma zaman damgası |
|
güncelleştirme zamanı
|
data.updatetime | string |
UTC'de son değişikliğin zaman damgası |
|
güven düzeyi
|
data.trustlevel | string |
Kimlik doğrulaması etkinse bu puan otomatik olarak hesaplanır. (0: Belirsiz, 1: Geçersiz belge, 2: Şüpheli, 3: Geçerli) |
|
trustnote
|
data.trustnote | string |
Belge geçerliliğiyle ilişkili uyarılar. |
|
docupass_reference
|
data.docupass_reference | string |
DocuPass oturumuna başvuru kodu |
|
docupass_success
|
data.docupass_success | string |
DocuPass doğrulamasının başarılı veya başarısız olup olmadığı 0 veya 1. |
|
docupass_failedreason
|
data.docupass_failedreason | string |
DocuPass doğrulaması başarısız olduysa, başarısız olmasının nedeni budur. |
|
docupass_customid
|
data.docupass_customid | string |
DocuPass doğrulaması oluşturulurken customid geçirildi. |
|
documentNumber
|
data.documentNumber | string |
Belgenin benzersiz tanımlayıcısı (Passport No./Driver License No vb.) |
|
documentNumber_formatted
|
data.documentNumber_formatted | string |
Herhangi bir simge olmadan otomatik olarak oluşturulan documentNumber dizesi, bu alan sonuçları filtrelemek için kullanışlıdır. |
|
personalNumber
|
data.personalNumber | string |
Belgedeki ikincil tanımlayıcı numarası |
|
ön ad
|
data.firstName | string |
Ad / Verilen ad |
|
ikinci ad
|
data.middleName | string |
İkinci adlar |
|
soyadı
|
data.lastName | string |
Soyadı / Aile adı |
|
fullName
|
data.fullName | string |
Tam ad (Diğer ad alanlarını güncelleştirme fullName'i güncelleştirmez) |
|
firstName_local
|
data.firstName_local | string |
Yerel dilde ad |
|
middleName_local
|
data.middleName_local | string |
Yerel dilde ikinci ad |
|
lastName_local
|
data.lastName_local | string |
Yerel dilde soyadı |
|
fullName_local
|
data.fullName_local | string |
Yerel dilde tam ad |
|
Dob
|
data.dob | string |
Doğum tarihi |
|
Verilen
|
data.issued | string |
Çıkış tarihi |
|
Bitiş
|
data.expiry | string |
Son kullanma tarihi |
|
seks
|
data.sex | string |
M: Erkek, F: Dişi, X: Belirtilmemiş |
|
height
|
data.height | string |
Kişinin yüksekliği |
|
weight
|
data.weight | string |
Kişinin ağırlığı |
|
hairColor
|
data.hairColor | string |
Saç rengi |
|
eyeColor
|
data.eyeColor | string |
Göz rengi |
|
adres1
|
data.address1 | string |
Adres satırı 1 |
|
adres2
|
data.address2 | string |
Adres satırı 2 |
|
posta kodu
|
data.postcode | string |
Adres posta kodu |
|
placeOfBirth
|
data.placeOfBirth | string |
Doğum yeri |
|
documentType
|
data.documentType | string |
P: Passport, D: Driver's License, I: Identity Card, V: Visa, R: Residence Card, O: Other |
|
belge adı
|
data.documentName | string |
Belgenin adı |
|
vehicleClass
|
data.vehicleClass | string |
Ehliyetli araç sınıfı |
|
Kısıtlama -ları
|
data.restrictions | string |
Sürüş kısıtlamaları |
|
Ciro
|
data.endorsement | string |
Sürücü lisansı onayı |
|
e-posta
|
data.email | string |
Kullanıcı e-posta adresi |
|
mobile
|
data.mobile | string |
Kullanıcı cep telefonu numarası |
|
sabit hat
|
data.landline | string |
Kullanıcı sabit hattı telefon numarası |
|
issueAuthority
|
data.issueAuthority | string |
Belgenin sorun yetkilisi |
|
issuerOrg_region_full
|
data.issuerOrg_region_full | string |
Belge veren alt kaydı/durumu. Örnek: California |
|
issuerOrg_region_abbr
|
data.issuerOrg_region_abbr | string |
Belge veren altbölgesi/durum kısaltması. Örnek: CA |
|
issuerOrg_iso2
|
data.issuerOrg_iso2 | string |
ISO2'de verilen ülke kodunu belgele. Örnek: ABD |
|
nationality_iso2
|
data.nationality_iso2 | string |
ISO2'de belge sahibi uyrağı. Örnek: ABD |
|
optionalData
|
data.optionalData | string |
Belgeye ek olarak ek olarak belirtilmeyen veriler |
|
optionalData2
|
data.optionalData2 | string |
Belgeye ek olarak ek olarak belirtilmeyen veriler |
|
customdata1
|
data.customdata1 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize |
|
customdata2
|
data.customdata2 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize |
|
customdata3
|
data.customdata3 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize |
|
customdata4
|
data.customdata4 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize |
|
customdata5
|
data.customdata5 | string |
Girişe özel not eklemek için kullanılabilecek 5 özel dize |
|
blok
|
data.block | string |
Aynı belgenin Core API veya DocuPass'a gönderilmesini engellemek için bu parametreyi ayarlayın. |
|
sözleşme
|
data.contract | string |
Core API veya DocuPass kullanılarak oluşturulan/imzalanan sözleşme veya yasal belgelere bağlantı |
|
image
|
data.image | array of object |
Girişle ilişkilendirilmiş görüntülerin listesini içerir. |
|
kimlik
|
data.image.id | string |
Görüntü tanımlayıcısı |
|
type
|
data.image.type | string |
Belge için 0 ve kişi için 1 |
|
Karma
|
data.image.hash | string |
Görüntünün MD5 karması |
|
url
|
data.image.url | string |
Resmin URL'si |
|
createtime
|
data.image.createtime | string |
Saat görüntüsü UTC'de karşıya yüklendi |
Kasadan GirdiYi Sil
HTTP POST isteğinde bulunarak tek veya birden çok kasa girdilerini silebilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
|
kimlik
|
id | True | array of string |
kimlik |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
başarı
|
success | integer |
Kasadan Görüntü Sil
HTTP POST isteğinde bulunarak kasa girdisi içindeki bir görüntüyü silebilirsiniz. Bir görüntü silindikten sonra, önbelleğe alma nedeniyle görüntünün URL'sine kısa bir süre için erişilebilir olmaya devam edebilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
|
kimlik
|
id | True | string |
Görüntüyü içeren kasa giriş tanımlayıcısı. |
|
imageid
|
imageid | string |
silinecek görüntünün kimliği. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
başarı
|
success | integer |
Kasaya görüntü ekleme
HTTP POST isteğinde bulunarak bir görüntüyü karşıya yükleyebilir ve mevcut bir kasa girişine ekleyebilirsiniz.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
|
kimlik
|
id | True | string |
Görüntü eklenecek kasa giriş tanımlayıcısı |
|
type
|
type | True | string |
Resim türünü ayarlayın: 0=belge ve 1=kişi |
|
image
|
image | string |
Base64 ile kodlanmış görüntü verileri. |
|
|
imageurl
|
imageurl | string |
Uzak görüntü URL'si. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
başarı
|
success | integer | |
|
kimlik
|
image.id | string |
Görüntü tanımlayıcısı |
|
type
|
image.type | string |
Belge için 0 ve kişi için 1 |
|
Karma
|
image.hash | string |
Görüntünün MD5 karması |
|
url
|
image.url | string |
Resmin URL'si |
|
createtime
|
image.createtime | string |
Saat görüntüsü UTC'de karşıya yüklendi |
Liste ve Filtre Girdileri
Kasada depolanan tüm girişleri listelemek veya belirli değerlere sahip girişleri aramak için aşağıdaki uç noktaya bir HTTP POST isteği gönderin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
|
orderby
|
orderby | string |
Sonucu sıralamak için kullanılan alanın adı. |
|
|
sort
|
sort | string |
Sonuçları artan düzende sıralamak için ASC, azalan düzende sıralamak için DESC. |
|
|
limit
|
limit | integer |
Döndürülecek kasa girdilerinin sayısı. (1 - 100) |
|
|
offset
|
offset | integer |
Sonuçların üçüncü sayfasına erişmek için belirli bir girişte başlayan dönüş listesi, örneğin limit=10 olduğunda offset=20 kullanın |
|
|
filtre
|
filter | array of string |
filtre |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
limit
|
limit | integer |
Geçerli sınır |
|
offset
|
offset | integer |
Geçerli uzaklık |
|
nextoffset
|
nextoffset | integer |
Sonraki veri kümesi için uzaklık değeri. Geçerli veri kümesi son veri kümesiyse, bu alan döndürülmeyecektir. |
|
toplam
|
total | integer |
Bulunan toplam girdi sayısı. |
|
items
|
items | array of |
Bulunan girdi dizisi ve bunların tam içeriği, GET yöntemi tarafından döndürülen içerikle aynıdır. |
Yüz Arama
Yüz araması, bir kişinin görüntüsünü kullanarak kasanın tamamında arama yapmanızı sağlar. Yüz arama özelliğini kullanmak için web portalı altında yüz araması dizini oluşturmayı etkinleştirmeniz ve kasa veri kümelerinizi düzenli aralıklarla eğitmeniz gerekir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
|
image
|
image | string |
Base64 ile kodlanmış görüntü verileri. |
|
|
imageurl
|
imageurl | string |
Uzak görüntü URL'si. |
|
|
maxentry
|
maxentry | integer |
Döndürülecek eşleşen girdilerin sayısı (1 ile 10 arasında). |
|
|
threshold
|
threshold | float |
Gereken en düşük yüz benzerliği puanını 0 ile 1 arasında ayarlayın. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
items
|
items | array of |
Eşleşen girdiler bulunursa, liste komutuna benzer şekilde tam içeriği olan belgelerin listesi döndürülür. |
Yüz Arama Eğitimi
Yüz araması gerçekleştirmeden önce, kasanızdaki belge veri kümelerini eğitmek için bir train komutu vermelisiniz. Kasa verilerinizi web portalı aracılığıyla da eğitebilirsiniz. Eğitim görevi zaman uyumsuzdur, eğitim süresi kasa girişlerinin ve görüntülerinin sayısına bağlıdır. Birkaç saniye ile bir saat arasında sürebilir.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız Web Portalınızın altında kullanılabilir. |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
başarı
|
success | integer |
Çekirdek API Ayarı
Uzak fiziksel belgeyi, orijinalliğini ve yüzünü doğrulamak için çok işlevli kimlik doğrulama API'si belgeyi kullanıcı fotoğrafınızla eşleştirin.
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Özel API anahtarınız web portalınızın altında kullanılabilir. |
|
file_base64
|
file_base64 | string |
application/x-www-form-urlencoded veya application/json kullanarak base64 kodlu bir görüntüyü dize olarak karşıya yükleyebilirsiniz. |
|
|
url
|
url | string |
Çekirdek API, sunucunuzdan uzak görüntü indirebilir. |
|
|
file_back_base64
|
file_back_base64 | string |
Çift taraflı tarama gerçekleştirmek için belgenin arka kısmının Base64 ile kodlanmış görüntüsü. |
|
|
url_back
|
url_back | string |
Çift taraflı tarama gerçekleştirmek için belgenin arka kısmının uzak görüntüsü. |
|
|
face_base64
|
face_base64 | string |
Fotoğraf biyometrik doğrulama gerçekleştirmek için kişinin yüzünün Temel64 kodlu görüntüsü. |
|
|
model
|
faceurl | string |
Fotoğraflı biyometrik doğrulama gerçekleştirmek için bir kişinin yüzünün uzaktan görüntüsü. |
|
|
video_base64
|
video_base64 | string |
Video biyometrik doğrulama gerçekleştirmek için Base64 kodlu özçekim videosu. |
|
|
videourl
|
videourl | string |
Video biyometrik doğrulama gerçekleştirmek için uzaktan barındırılan özçekim videosu. |
|
|
geçiş kodu
|
passcode | string |
4 basamaklı sayı |
|
|
doğruluk
|
accuracy | integer |
Belge tanıma ve ocr sonuçlarının hızını ve doğruluğunu yapılandırın. Düşük doğruluk, yanıt süresini 1 saniyenin altına düşürürken, yüksek doğruluk genellikle 2~3 saniye sürer. |
|
|
authenticate
|
authenticate | boolean |
Belgenin orijinal olup olmadığını ve üzerinde oynanmadığını denetlemek için belgeyi doğrulayın. |
|
|
authenticate_module
|
authenticate_module | string |
Belgeyi doğrulamak için kullanılan modülü belirtin. |
|
|
biometric_threshold
|
biometric_threshold | float |
Yüz biyometrik doğrulamasını geçmek için en düşük puanı belirtin |
|
|
return_confidence
|
return_confidence | boolean |
Her veri alanı için güvenilirlik puanı döndürür. |
|
|
return_empty
|
return_empty | boolean |
Bu parametreyi etkinleştirerek API'nin boş alanlarda null döndürmesini sağlayabilirsiniz. |
|
|
ocr_scaledown
|
ocr_scaledown | integer |
500 ile 4000 veya 0 arasında bir sayı |
|
|
outputimage
|
outputimage | boolean |
Belgenin kırpılmış bir görüntüsünü oluşturma. |
|
|
çıkış biçimi
|
outputface | boolean |
Belgede yüz bölgesinin kırpılmış bir görüntüsünü üretin. |
|
|
outputmode
|
outputmode | string |
Kırpılan belgeyi ve yüzü URL veya base64 ile kodlanmış içerik olarak çıktısını alın. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Çift taraflı tarama gerçekleştirirken adların, belge numarasının ve belge türünün belgenin ön ve arkası arasında eşleşip eşleşmediğini denetleyin. Herhangi bir bilgi uyuşmazlığı varsa hata 14 oluşturulur. |
|
|
verify_expiry
|
verify_expiry | boolean |
Belgenin son kullanma tarihine göre hala geçerli olup olmadığını denetleyin. |
|
|
verify_documentno
|
verify_documentno | string |
Sağlanan belge numarasının belgeyle eşleşip eşleşmediğini denetleyin. |
|
|
verify_dob
|
verify_dob | string |
Verilen doğum tarihinin belgeyle eşleşip eşleşmediğini denetleyin. (YYYY/AA/GG) |
|
|
verify_age
|
verify_age | string |
Belge sahibinin verilen aralık arasında yaşlandığından emin olun. (aralık, örnek: 18-40) |
|
|
verify_address
|
verify_address | string |
Sağlanan adresin belgeyle eşleşip eşleşmediğini denetleyin. |
|
|
verify_postcode
|
verify_postcode | string |
Sağlanan posta kodunun belgeyle eşleşip eşleşmediğini denetleyin. |
|
|
country
|
country | string |
Belgenin belirtilen ülkeler tarafından düzenlenip verilmediğini denetleyin, değilse hata kodu 10 oluşturulur. Birden çok değeri virgülle ayırın. Örneğin "ABD,CA" ABD ve Kanada belgelerini kabul eder. |
|
|
region
|
region | string |
Belgenin belirtilen durum tarafından verilmiş olup olmadığını denetleyin, değilse hata kodu 11 oluşturulur. Birden çok değeri virgülle ayırın. Örneğin"CA,TX", California ve Texas'tan gelen belgeleri kabul eder. |
|
|
type
|
type | string |
Belgenin belirtilen türlerden biri olup olmadığını denetleyin, değilse hata kodu 12 oluşturulur. Örneğin "PD" hem pasaport hem de sürücü lisansını kabul eder. |
|
|
denetim engeli listesi
|
checkblocklist | boolean |
Kasanızdaki engellenen girişlere karşı belge verilerini denetleyin. Belge engellenen giriş hatalarından biriyle eşleşiyorsa 15 oluşturulur |
|
|
vault_save
|
vault_save | boolean |
Belge görüntüsünü ve ayrıştırılmış bilgileri güvenli kasanıza kaydedin. Kasa API'sini veya web portalını kullanarak kasanızdaki belge girdilerini listeleyebilir, arayabilir ve güncelleştirebilirsiniz. |
|
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
Belge tanınmasa bile belge görüntüsünü kasanıza kaydedin. |
|
|
vault_noduplicate
|
vault_noduplicate | boolean |
Yinelenen görüntülerin kaydedilmesini önleyin. |
|
|
vault_automerge
|
vault_automerge | boolean |
Aynı belge numarasına sahip görüntüleri kasa içindeki tek bir girişte otomatik olarak birleştirin. |
|
|
vault_customdata1
|
vault_customdata1 | string |
Kasa girişiyle ilişkilendirilecek en fazla 5 özel dize ekleyin; bu, girdileri filtrelemek ve aramak için yararlı olabilir. |
|
|
vault_customdata2
|
vault_customdata2 | string |
Kasa girişiyle ilişkilendirilecek en fazla 5 özel dize ekleyin; bu, girdileri filtrelemek ve aramak için yararlı olabilir. |
|
|
vault_customdata3
|
vault_customdata3 | string |
Kasa girişiyle ilişkilendirilecek en fazla 5 özel dize ekleyin; bu, girdileri filtrelemek ve aramak için yararlı olabilir. |
|
|
vault_customdata4
|
vault_customdata4 | string |
Kasa girişiyle ilişkilendirilecek en fazla 5 özel dize ekleyin; bu, girdileri filtrelemek ve aramak için yararlı olabilir. |
|
|
vault_customdata5
|
vault_customdata5 | string |
Kasa girişiyle ilişkilendirilecek en fazla 5 özel dize ekleyin; bu, girdileri filtrelemek ve aramak için yararlı olabilir. |
|
|
aml_check
|
aml_check | boolean |
Kimlik Çözümleyicisi AML Veritabanı'nın belge sahibinin adını ve belge numarasını denetleyin. |
|
|
aml_database
|
aml_database | string |
Her veritabanı kodunu virgülle ayırın; örneğin: un_sc,us_ofac. |
|
|
aml_strict_match
|
aml_strict_match | boolean |
Yalnızca tam olarak aynı ulusallığa ve doğum gününe sahip varlıkları eşleştirerek hatalı pozitif değerleri azaltmak için bu parametreyi etkinleştirin. |
|
|
contract_generate
|
contract_generate | string |
Kullanıcı verileriyle otomatik olarak doldurulacak sözleşme şablonu kimliği. |
|
|
contract_format
|
contract_format | string |
Çıktı belgesi biçimi. İsteğe bağlı: PDF, DOCX, HTML. |
|
|
contract_prefill_data
|
contract_prefill_data | object |
Döndürülenler
| Name | Yol | Tür | Description |
|---|---|---|---|
|
documentNumber
|
result.documentNumber | string |
Belgeyle ilişkili benzersiz tanımlayıcı (örneğin, Pasaport No/Sürücü Lisansı No./Kart Numarası vb.) |
|
personalNumber
|
result.personalNumber | string |
Ülke içindeki kişiyle ilişkili benzersiz kişisel tanımlayıcı (örneğin, Ulusal Kimlik Numarası) |
|
ön ad
|
result.firstName | string |
Ad / Verilen ad |
|
soyadı
|
result.lastName | string |
Soyadı / Aile adı |
|
ikinci ad
|
result.middleName | string |
İkinci adlar |
|
fullName
|
result.fullName | string |
Ad ve soyadı ayırt edilemiyorsa bunun yerine tam ad döndürülür |
|
firstName_local
|
result.firstName_local | string |
Varsa yerel dilde ad |
|
lastName_local
|
result.lastName_local | string |
Varsa yerel dilde soyadı |
|
middleName_local
|
result.middleName_local | string |
Varsa yerel dilde ikinci ad |
|
fullName_local
|
result.fullName_local | string |
Varsa yerel dilde tam ad |
|
seks
|
result.sex | string |
Gender M=Male F=Female X=Unspecified |
|
height
|
result.height | string |
Kişinin yüksekliği |
|
weight
|
result.weight | string |
Kişinin ağırlığı |
|
hairColor
|
result.hairColor | string |
Saç Rengi - ANSI D-20 saç rengi kodu (3 harf) |
|
eyeColor
|
result.eyeColor | string |
Göz Rengi - ANSI D-20 göz rengi kodu (3 harf) |
|
yaş
|
result.age | integer |
Belge sahibinin yaşı |
|
Dob
|
result.dob | string |
YYYY/AA/DD'de doğum tarihi |
|
dob_day
|
result.dob_day | integer |
Doğum tarihi 1 - 31 |
|
dob_month
|
result.dob_month | integer |
Doğum tarihi 1 - 12 |
|
dob_year
|
result.dob_year | integer |
YYYY'de doğum tarihi |
|
Bitiş
|
result.expiry | string |
YYYY/AA/DD'de belgenin bitiş tarihi |
|
expiry_day
|
result.expiry_day | integer |
Bitiş günü 1 ile 31 |
|
expiry_month
|
result.expiry_month | integer |
Süre sonu ayı 1 ile 12 |
|
expiry_year
|
result.expiry_year | integer |
YYYY'de sona erme yılı |
|
daysToExpiry
|
result.daysToExpiry | integer |
Belgenin süresi dolmadan önceki gün sayısı |
|
Verilen
|
result.issued | string |
YYYY/AA/GG'de sorun tarihi |
|
issued_day
|
result.issued_day | integer |
Sorun 1 ile 31 gün |
|
issued_month
|
result.issued_month | integer |
Sorun 1 ile 12 ayları |
|
issued_year
|
result.issued_year | integer |
YYYYY'de yıllık sorun |
|
daysFromIssue
|
result.daysFromIssue | integer |
Belgenin verilmesinden bu yanaki gün sayısı |
|
adres1
|
result.address1 | string |
Adres satırı 1 |
|
adres2
|
result.address2 | string |
Adres satırı 2 |
|
posta kodu
|
result.postcode | string |
Adres posta kodu |
|
placeOfBirth
|
result.placeOfBirth | string |
Doğum yeri |
|
vehicleClass
|
result.vehicleClass | string |
Ehliyet araç sınıfı |
|
Kısıtlama -ları
|
result.restrictions | string |
Sürücü lisansı kısıtlamaları |
|
Ciro
|
result.endorsement | string |
Sürücü lisansı onayı |
|
optionalData
|
result.optionalData | string |
Belgeye ek olarak ek olarak belirtilmeyen veriler |
|
optionalData2
|
result.optionalData2 | string |
Belgeye ek olarak ek olarak belirtilmeyen veriler |
|
documentType
|
result.documentType | string |
Belgenin türü: P=Passport, D=Driver's License, I=Identity Card, V=Visa, R=Residence Card, O=Other |
|
documentSide
|
result.documentSide | string |
Belgenin yan tarafı: FRONT, BACK veya BIODATA |
|
issuerOrg_region_full
|
result.issuerOrg_region_full | string |
Belge veren alt kaydı/durumu. (örn. California) |
|
issuerOrg_region_abbr
|
result.issuerOrg_region_abbr | string |
Belge veren altbölgesi/durum kısaltması. (örn. CA) |
|
issuerOrg_full
|
result.issuerOrg_full | string |
Belge verilen ülke. (örn. ABD) |
|
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
ISO2'de verilen ülke kodunu belgele. (ör. ABD) |
|
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
ISO3'te verilen ülke kodunu belgele. (örn. ABD) |
|
nationality_full
|
result.nationality_full | string |
Belge sahibinin uyrağı. (örn. ABD) |
|
nationality_iso2
|
result.nationality_iso2 | string |
ISO2'de belge sahibi uyrağı. (ör. ABD) |
|
nationality_iso3
|
result.nationality_iso3 | string |
ISO3'te belge sahibi uyrağı. (örn. ABD) |
|
internalId
|
result.internalId | string |
Kimlik Çözümleyicisi sistemi altında benzersiz belge kimliğini tanımlamak için kullanılır, aynı belge türü aynı kimlikte olmalıdır. |
|
documentNumber
|
confidence.documentNumber | float |
documentNumber'ın güvenilirlik düzeyi |
|
ön ad
|
confidence.firstName | float |
firstName güvenilirlik düzeyi |
|
soyadı
|
confidence.lastName | float |
Soyadı /Aile adı güvenilirlik düzeyi |
|
ikinci ad
|
confidence.middleName | float |
İkinci Adların güvenilirlik düzeyi |
|
dob_month
|
confidence.dob_month | float |
dob_month güvenilirlik düzeyi |
|
dob_day
|
confidence.dob_day | float |
dob_day güvenilirlik düzeyi |
|
dob_year
|
confidence.dob_year | float |
dob_year güvenilirlik düzeyi |
|
issued_month
|
confidence.issued_month | float |
issued_month güvenilirlik düzeyi |
|
issued_day
|
confidence.issued_day | float |
issued_day güvenilirlik düzeyi |
|
issued_year
|
confidence.issued_year | float |
issued_year güvenilirlik düzeyi |
|
expiry_month
|
confidence.expiry_month | float |
expiry_month güvenilirlik düzeyi |
|
expiry_day
|
confidence.expiry_day | float |
expiry_day güvenilirlik düzeyi |
|
expiry_year
|
confidence.expiry_year | float |
expiry_year güvenilirlik düzeyi |
|
seks
|
confidence.sex | float |
güven düzeyi seks |
|
height
|
confidence.height | float |
güvenilirlik yükseklik düzeyi |
|
weight
|
confidence.weight | float |
güvenilirlik ağırlık düzeyi |
|
adres1
|
confidence.address1 | float |
adres güven düzeyi1 |
|
adres2
|
confidence.address2 | float |
adresin güvenilirlik düzeyi2 |
|
posta kodu
|
confidence.postcode | float |
postcode güvenilirlik düzeyi |
|
vehicleClass
|
confidence.vehicleClass | float |
vehicleClass'ın güvenilirlik düzeyi |
|
Kısıtlama -ları
|
confidence.restrictions | float |
kısıtlamaların güvenilirlik düzeyi |
|
Ciro
|
confidence.endorsement | float |
güvenilirlik düzeyi onayı |
|
eyeColor
|
confidence.eyeColor | float |
eyeColor güvenilirlik düzeyi |
|
yaş
|
confidence.age | float |
güvenilirlik yaş düzeyi |
|
Dob
|
confidence.dob | float |
dob güvenilirlik düzeyi |
|
daysToExpiry
|
confidence.daysToExpiry | float |
günlerin güvenilirlik düzeyiToExpiry |
|
Bitiş
|
confidence.expiry | float |
süre sonu güvenilirlik düzeyi |
|
Verilen
|
confidence.issued | float |
verilen güvenilirlik düzeyi |
|
daysFromIssue
|
confidence.daysFromIssue | float |
günlerin güvenilirlik düzeyiFromIssue |
|
fullName
|
confidence.fullName | float |
fullName güvenilirlik düzeyi |
|
isIdentical
|
face.isIdentical | boolean |
Biyometrik doğrulama başarılı veya başarısız oldu |
|
güven
|
face.confidence | string |
0 ile 1 arasındaki değer, iki yüzün birbirine ne kadar benzer olduğunu ve 1'in aynı olduğunu gösterir. |
|
hata
|
face.error | integer |
Hata Kodu |
|
error_message
|
face.error_message | string |
Hata mesajı. Örnek: Yüz görüntüsünde yüz verileri bulunamadı |
|
Geçirilen
|
verification.passed | boolean |
Belge tüm doğrulamaları geçtiyse true döndürür. Belge en az bir doğrulama türü başarısız olduysa false döndürür. |
|
yüz
|
verification.result.face | boolean |
Biyometrik doğrulama etkinleştirilirse benzerlik güvenilirlik puanının belirlenen eşiğin üzerinde olup olmadığı. |
|
yakınsamadı
|
verification.result.notexpired | boolean |
Belgenin süresinin henüz dolmamış olup olmadığı. |
|
name
|
verification.result.name | boolean |
Sağlanan adın kimlikten ayrıştırılan adla eşleşip eşleşmediği. |
|
Dob
|
verification.result.dob | boolean |
Verilen doğum gününün kimlikten ayrıştırılan doğum günüyle eşleşip eşleşmediği. |
|
documentNumber
|
verification.result.documentNumber | boolean |
Sağlanan belge numarasının kimlikten ayrıştırılan belge numarasıyla eşleşip eşleşmediği. |
|
posta kodu
|
verification.result.postcode | boolean |
Sağlanan posta kodunun kimlikten ayrıştırılan posta koduyla eşleşip eşleşmediği. |
|
address
|
verification.result.address | boolean |
Sağlanan adresin kimlikten ayrıştırılan adresle eşleşip eşleşmediği. |
|
checkdigit
|
verification.result.checkdigit | boolean |
Belgenin türü denetim basamağı/soundex algoritmasına sahipse, denetim basamaklarının geçerli olup olmadığı. |
|
yaş
|
verification.result.age | boolean |
Belge sahibinin belirlenen yaş aralığında olup olmadığı. |
|
cccode
|
verification.result.cccode | boolean |
Belge türü Çince ticari kodu (CC kodu) uygulamasına sahipse, CC kodlarının geçerli olup olmadığı. |
|
Puan
|
authentication.score | float |
Puan 0 ile 1 arasında bir kayan değer olacaktır. Geçerli belgelerin puanı 1'e yakınken sahte veya düzenlenmiş belgelerin puanı 0'a yakın olacaktır. Sınıra karar vermek sizin takdirinize bağlıdır, iyi bir başlangıç noktası 0,5'ten küçük puanı reddetmek olabilir |
|
Geçirilen
|
authentication.breakdown.data_visibility.passed | boolean | |
|
Geçirilen
|
authentication.breakdown.image_quality.passed | boolean | |
|
Geçirilen
|
authentication.breakdown.feature_referencing.passed | boolean | |
|
Geçirilen
|
authentication.breakdown.exif_check.passed | boolean | |
|
kod
|
authentication.breakdown.exif_check.code | integer | |
|
sebep
|
authentication.breakdown.exif_check.reason | string | |
|
severity
|
authentication.breakdown.exif_check.severity | string | |
|
Geçirilen
|
authentication.breakdown.publicity_check.passed | boolean | |
|
kod
|
authentication.breakdown.publicity_check.code | integer | |
|
sebep
|
authentication.breakdown.publicity_check.reason | string | |
|
severity
|
authentication.breakdown.publicity_check.severity | string | |
|
Geçirilen
|
authentication.breakdown.text_analysis.passed | boolean | |
|
Geçirilen
|
authentication.breakdown.biometric_analysis.passed | boolean | |
|
Geçirilen
|
authentication.breakdown.security_feature_check.passed | boolean | |
|
kod
|
authentication.breakdown.security_feature_check.code | integer | |
|
sebep
|
authentication.breakdown.security_feature_check.reason | string | |
|
severity
|
authentication.breakdown.security_feature_check.severity | string | |
|
Geçirilen
|
authentication.breakdown.recapture_check.passed | boolean | |
|
kod
|
authentication.breakdown.recapture_check.code | integer | |
|
sebep
|
authentication.breakdown.recapture_check.reason | string | |
|
severity
|
authentication.breakdown.recapture_check.severity | string | |
|
uyarı
|
authentication.warning | array of string |
Belgenin geçerliliği hakkında uyarı iletileri içeren dize dizisi. |
|
aml
|
aml | array of object |
AML eşleşmelerinin listesini içeren dizi, eşleşme bulunamazsa boş bir dizi döndürür. Belirli ayrıntılar için AML API Başvurusu'na bakın. |
|
varlık
|
aml.entity | string |
kişi veya yasallık |
|
tam ad
|
aml.fullname | array of string |
Kişi veya tüzel kişi adları |
|
isim
|
aml.firstname | array of string |
Kişi adları |
|
soyadı
|
aml.lastname | array of string |
Kişi soyadı(lar) |
|
middlename
|
aml.middlename | array of string |
Kişi ikinci adları |
|
alias
|
aml.alias | array of string |
Varlığın alternatif veya yabancı adları |
|
Dob
|
aml.dob | array of string |
Peron'un doğum günü YYYY, YYYY-AA veya YYYY-MM-DD biçimlerinde gelebilir. |
|
address
|
aml.address | array of string |
Varlığın adresi veya ikamet ettiği ülke |
|
milliyet
|
aml.nationality | array of string |
Varlığın ülkesi veya uyrluğu |
|
doğum yeri
|
aml.birthplace | array of string |
Peron'un doğum yeri |
|
cinsiyet
|
aml.gender | array of string |
Peron'un cinsiyeti: M veya F |
|
documentnumber
|
aml.documentnumber | array of object |
Varlıkla ilişkilendirilmiş belgelerin listesi. |
|
kimlik
|
aml.documentnumber.id | string |
Belge numarası |
|
id_formatted
|
aml.documentnumber.id_formatted | string |
Alfasayısal belge numarası |
|
country
|
aml.documentnumber.country | string |
ISO2 ülke kodu |
|
type
|
aml.documentnumber.type | string |
P = Pasaport numarası, I = Kimlik numarası, D = Ehliyet numarası, O = Diğer/Bilinmeyen belge türü |
|
program
|
aml.program | array of string |
Tasdik programları |
|
not
|
aml.note | array of string |
Varlık için ek not |
|
time
|
aml.time | string |
Kaynak listeye varlık eklendiğinde veya son güncelleştirmede UTC TZ zaman damgası |
|
statü
|
aml.status | string |
Varlığın konumu/unvanı veya tasdikin geçerli durumu |
|
kaynak
|
aml.source | array of string |
Resmi kaynak URL'lerinin listesi |
|
veritabanı
|
aml.database | string |
Id Analyzer AML veritabanı kodu |
|
şema
|
aml.schema | string | |
|
document_url
|
contract.document_url | string |
Oluşturulan belgenin URL'si |
|
hata
|
contract.error | string |
Sözleşmenin oluşturulamaması durumunda, bu alan "Geçersiz sözleşme şablonu kimliği" gibi bir neden içerir. |
|
vaultid
|
vaultid | string |
vault_save etkinse kasa girdisinin benzersiz tanımlayıcısı. |
|
eşleşme hızı
|
matchrate | float |
API tarafından başarıyla tanınan alanların oranı, düşük bir oran belge görüntüsünün çok bulanık olduğunu gösterir. |
|
output
|
output | string |
outputimage true olarak ayarlandıysa ve outputmode url ise, bu alan kırpılan belge görüntüsünü gösteren bir URL (veya çift yönlü tarama için bir URL dizisi) içerir. Bağlantının yalnızca 600 saniye boyunca yaşayacağı garanti edilir ve bundan sonra herhangi bir zaman kaldırılır. |
|
çıkış biçimi
|
outputface | string |
Outputface true olarak ayarlandıysa ve outputmode url ise, bu alan kırpılan yüz resmine işaret eden bir URL içerir. Bağlantının yalnızca 600 saniye boyunca yaşayacağı garanti edilir ve bundan sonra herhangi bir zaman kaldırılır. |
|
Kırpılmış
|
cropped | string |
Outputimage true olarak ayarlandıysa ve outputmode base64 ise, bu alan JPEG biçiminde kırpılmış belgenin base64 kodlu görüntüsünü (veya çift yönlü tarama için base64 ile kodlanmış görüntülerin bir dizisini) içerir |
|
kırpılmış yüz
|
croppedface | string |
Outputface true olarak ayarlanmışsa ve outputmode base64 ise, bu alan belgenin JPEG biçiminde kırpılmış yüz bölgesinin base64 kodlanmış görüntüsünü içerir |
|
yürütme Süresi
|
executionTime | float |
API işlemi için saniye olarak geçen süre. |
|
responseID
|
responseID | string |
İsteği/yanıtı tanımlamak için benzersiz bir tanımlayıcı. |
|
quota
|
quota | integer |
Kalan API kotası, ücretsiz veya yıllık abone için her ayın başında veya aylık abone için her faturalama döneminin başlangıcında sıfırlanır. Abonelik planınız varsa, aylık kotanız kredinizden önce kullanılır. |
|
Kredi
|
credit | integer |
Hesabınız için kalan test kredisi. Abonelik planınız varsa, aylık kotanız kredinizden önce kullanılır. |