Udostępnij przez


ID Analyzer (wersja zapoznawcza)

Usługa ID Analyzer udostępnia kilka różnych produktów weryfikacji tożsamości. Aby wybrać najlepsze rozwiązanie dla aplikacji, musisz uzyskać podstawową wiedzę na temat każdego produktu.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Obsługa analizatora identyfikatorów
adres URL https://www.idanalyzer.com/contact.html
Email support@idanalyzer.com
Metadane łącznika
Publisher Eksmitologia techniczna
Witryna internetowa https://www.idanalyzer.com/
Zasady ochrony prywatności https://www.idanalyzer.com/privacy-policy.html
Kategorie Operacje IT; Produktywność

Platforma ID Analyzer udostępnia firmom, organizacjom i osobom fizycznym prawdziwie globalne rozwiązanie do weryfikacji tożsamości, które działa bez granic, rozwiązanie, które można dostosować do konkretnych potrzeb i wymagań oraz system zabezpieczeń, który jest stale uaktualniany i ulepszany.

Zapewnienie pełnego dostępu do weryfikacji tożsamości i informacji w ponad 4000+ różnych formach identyfikatora w 190+ krajach na całym świecie, jest to bardzo globalne rozwiązanie zaprojektowane z myślą o nowoczesnym świecie.

Wymagania wstępne

  • Konto dewelopera z analizatorem identyfikatorów. Możesz zarejestrować się w celu uzyskania bezpłatnego konta na stronie Tworzenie konta
  • Po zarejestrowaniu się na koncie otrzymasz klucz interfejsu API w portalu internetowym usługi ID Analyzer. Użyj tego klucza interfejsu API do uwierzytelniania za pomocą łącznika

Jak uzyskać poświadczenia

  1. Przejdź do pozycji Zarejestruj się
  2. Wprowadź wymagane informacje.
  3. Sprawdź wiadomość e-mail po wyświetleniu monitu o to.
  4. Nowy klucz interfejsu API zostanie wyświetlony w portalu internetowym usługi ID Analyzer ze szczegółami twojego konta. Naciśnij przycisk "Kopiuj", aby zapisać go w schowku do późniejszego użycia.

Często zadawane pytania

Martwię się o prywatność mojego klienta, czy interfejs API zapisuje informacje o moim kliencie?

Wszystko będzie przechowywane tylko w magazynie klienta i nie zostanie przypadkowo ujawnione. Nie będzie on miał żadnej kopii w innym miejscu.

Jakie są "środki" dla, jak mogę kupić środki interfejsu API?

Pozostałe przedpłacone środki dla Twojego konta. Jeśli masz plan miesięczny, miesięczny limit przydziału będzie używany przed przedpłaconym kredytem.

Jak sprawdzić, czy dokument jest prawdziwy, czy fałszywy?

Włącz uwierzytelnianie. Wynik będzie zawierać wynik uwierzytelniania.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: Wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Klucz interfejsu API securestring Klucz interfejsu API dla tego interfejsu API Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie wpisu magazynu

Wartość pojedynczego pola lub wartości wielu pól można zaktualizować we wpisie magazynu, wysyłając żądanie HTTP POST.

Dodawanie obrazu do magazynu

Obraz można przekazać i dodać do istniejącego wpisu magazynu, wysyłając żądanie HTTP POST.

Pobieranie zawartości wpisu magazynu

Po dodaniu wpisów do magazynu zarówno interfejs API Core, jak i interfejs API DocuPass zwróci identyfikator wpisu magazynu o nazwie vaultid. Możesz użyć identyfikatora, aby wykonać zapytanie dotyczące zawartości wpisu w magazynie, przesyłając żądanie HTTP POST do następującego punktu końcowego.

Stan trenowania

Sprawdź, czy szkolenie magazynu jest nadal w toku, czy zostało ukończone.

Szkolenie wyszukiwania twarzy

Przed rozpoczęciem wyszukiwania twarzy należy wydać polecenie train, aby wytrenować zestawy danych dokumentów wewnątrz magazynu. Możesz również trenować dane magazynu za pośrednictwem portalu internetowego. Zadanie trenowania jest asynchroniczne, czas trenowania zależy od liczby wpisów i obrazów magazynu. Może upłynąć od kilku sekund do godziny.

Tworzenie sesji DocuPass

Możesz utworzyć sesję weryfikacji dla każdego użytkownika wymagającego weryfikacji tożsamości.

Tworzenie sesji podpisu DocuPass

Możesz utworzyć sesję podpisu, w której użytkownik będzie przeglądać i podpisywać dokument prawny bez weryfikacji tożsamości. Jeśli chcesz przeprowadzić weryfikację tożsamości i podpisywać jakiś dokument przez użytkownika, utwórz zamiast tego sesję weryfikacji tożsamości.

Ustawienie podstawowego interfejsu API

Interfejs API weryfikacji identyfikatora wielu funkcji w celu zweryfikowania zdalnego dokumentu fizycznego, jego autentyczności i twarzy jest zgodny z dokumentem ze zdjęciem użytkownika.

Usuwanie obrazu z magazynu

Obraz można usunąć wewnątrz wpisu magazynu, wysyłając żądanie HTTP POST. Pamiętaj, że po usunięciu obrazu adres URL obrazu może być nadal dostępny przez krótki czas z powodu buforowania.

Usuwanie wpisu z magazynu

Możesz usunąć pojedyncze lub wiele wpisów magazynu, wysyłając żądanie HTTP POST.

Weryfikowanie wywołania zwrotnego

Aby upewnić się, że dane zostały wysłane z serwera.

Wyszukiwanie bazy danych AML

Interfejs API AML umożliwia wyszukiwanie globalnej bazy danych AML Analizatora identyfikatorów pod kątem sankcji, peps i poszukiwanych przestępców przy użyciu nazwy, numeru dokumentu lub obu tych elementów. Możesz dalej filtrować wyniki z urodzinami i narodowością.

Wyszukiwanie twarzy

Wyszukiwanie twarzy umożliwia przeszukiwanie całego magazynu przy użyciu obrazu osoby. Aby korzystać z funkcji wyszukiwania twarzy, należy włączyć indeksowanie wyszukiwania twarzy w portalu internetowym i okresowo trenować zestawy danych magazynu.

Wyświetlanie listy i filtrowanie wpisów

Aby wyświetlić listę wszystkich wpisów przechowywanych w magazynie lub wyszukać wpisy z określonymi wartościami, wyślij żądanie HTTP POST do następującego punktu końcowego.

Aktualizowanie wpisu magazynu

Wartość pojedynczego pola lub wartości wielu pól można zaktualizować we wpisie magazynu, wysyłając żądanie HTTP POST.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

id
id True string

Identyfikator wpisu magazynu.

adres1
address1 string

Wiersz adresu 1.

adres2
address2 string

Wiersz adresu 2.

blok
block string

Ustaw ten parametr, aby zablokować przesłany ten sam dokument do podstawowego interfejsu API lub docuPass. 0: Brak bloku 1: Blokuj numer dokumentu 2: Blokuj imię/nazwisko 3: Blokuj zarówno numer dokumentu, jak i imię/nazwisko.

customdata1
customdata1 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu.

customdata2
customdata2 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu.

customdata3
customdata3 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu.

customdata4
customdata4 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu.

customdata5
customdata5 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu.

Dob
dob string

Data urodzenia (RRRR-MM-DD).

documentName (nazwa_dokumentu)
documentName string

Nazwa dokumentu.

documentNumber
documentNumber string

Unikatowy identyfikator dokumentu (nr paszportu/nr prawa jazdy itp.)

documentType
documentType string

P: Paszport D: Prawo jazdy I: Karta tożsamości V: Visa R: Karta rezydencji O: Inne

docupass_customid
docupass_customid string

identyfikator customid przekazany podczas tworzenia weryfikacji DocuPass.

docupass_failedreason
docupass_failedreason string

Jeśli weryfikacja docuPass nie powiodła się, przyczyna niepowodzenia.

docupass_reference
docupass_reference string

Kod odwołania do sesji DocuPass.

docupass_success
docupass_success string

0 lub 1, niezależnie od tego, czy weryfikacja DocuPass powiodła się, czy nie powiodła się.

e-mail
email string

Adres e-mail użytkownika.

Upływie terminu ważności
expiry string

Data wygaśnięcia (RRRR-MM-DD)

eyeColor
eyeColor string

Kolor oczu.

imię
firstName string

Imię/imię/imię

firstName_local
firstName_local string

Imię w języku lokalnym.

fullName
fullName string

Pełna nazwa (Aktualizowanie innych pól nazw nie spowoduje aktualizacji fullName)

fullName_local
fullName_local string

Imię w języku lokalnym.

hairColor
hairColor string

Kolor włosów.

height
height string

Wysokość osoby.

issueAuthority
issueAuthority string

Urząd wystawiania dokumentu.

Wydane
issued string

Data wydania (RRRR-MM-DD)

issuerOrg_iso2
issuerOrg_iso2 string

Dokument wystawiony kod kraju w normie ISO2. Przykład: STANY ZJEDNOCZONE

issuerOrg_region_abbr
issuerOrg_region_abbr string

Podregion/skrót stanu wystawcy dokumentu. Przykład: urząd certyfikacji

issuerOrg_region_full
issuerOrg_region_full string

Podregion/stan wystawcy dokumentu. Przykład: Kalifornia

telefon stacjonarny
landline string

Numer telefonu stacjonarnego użytkownika.

nazwisko
lastName string

Nazwisko /Nazwisko/ Nazwisko.

lastName_local
lastName_local string

Nazwisko w języku lokalnym.

drugie imię
middleName string

Nazwy środkowe.

middleName_local
middleName_local string

Nazwa środkowa w języku lokalnym.

mobilne
mobile string

Numer telefonu komórkowego użytkownika.

nationality_iso2
nationality_iso2 string

Narodowość posiadacza dokumentu w iso2. Przykład: STANY ZJEDNOCZONE

optionalData
optionalData string

Dodatkowe niewykonalne dane zawarte w dokumencie.

optionalData2
optionalData2 string

Dodatkowe niewykonalne dane zawarte w dokumencie.

personalNumber
personalNumber string

Numer identyfikatora pomocniczego w dokumencie.

placeOfBirth
placeOfBirth string

Miejsce urodzenia.

Kodów pocztowych
postcode string

Adres — kod pocztowy.

Ograniczenia
restrictions string

Ograniczenia dotyczące jazdy.

płeć
sex string

M: Mężczyzna F: Kobieta X: Nieokreślony

trustlevel
trustlevel string

0: Nieokreślony 1: Nieprawidłowy dokument 2: Podejrzany 3: Prawidłowy wynik jest obliczany automatycznie, jeśli jest włączone uwierzytelnianie.

trustnote
trustnote string
vehicleClass
vehicleClass string

Klasa pojazdów na prawo jazdy.

ciężar
weight string

Waga osoby.

Zwraca

Nazwa Ścieżka Typ Opis
sukces
success integer

Dodawanie obrazu do magazynu

Obraz można przekazać i dodać do istniejącego wpisu magazynu, wysyłając żądanie HTTP POST.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

id
id True string

Identyfikator wpisu magazynu w celu dodania obrazu do

typ
type True string

Ustaw typ obrazu: 0=document i 1=person

obraz
image string

Dane obrazu zakodowane w formacie Base64.

imageurl
imageurl string

Zdalny adres URL obrazu.

Zwraca

Nazwa Ścieżka Typ Opis
sukces
success integer
id
image.id string

Identyfikator obrazu

typ
image.type string

0 dla dokumentu i 1 dla osoby

skrót
image.hash string

Skrót obrazu MD5

URL
image.url string

Adres URL obrazu

createtime
image.createtime string

Obraz godziny został przekazany w formacie UTC

Pobieranie zawartości wpisu magazynu

Po dodaniu wpisów do magazynu zarówno interfejs API Core, jak i interfejs API DocuPass zwróci identyfikator wpisu magazynu o nazwie vaultid. Możesz użyć identyfikatora, aby wykonać zapytanie dotyczące zawartości wpisu w magazynie, przesyłając żądanie HTTP POST do następującego punktu końcowego.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

id
id string

Identyfikator wpisu magazynu.

Zwraca

Nazwa Ścieżka Typ Opis
sukces
success integer
id
data.id string

Identyfikator wpisu magazynu

createtime
data.createtime string

Sygnatura czasowa tworzenia wpisu w formacie UTC

updatetime
data.updatetime string

Znacznik czasu ostatniej modyfikacji w formacie UTC

trustlevel
data.trustlevel string

Ten wynik jest obliczany automatycznie, jeśli jest włączone uwierzytelnianie. (0: Nieokreślone, 1: Nieprawidłowy dokument, 2: Podejrzany, 3: Prawidłowy)

trustnote
data.trustnote string

Ostrzeżenia skojarzone z ważnością dokumentu.

docupass_reference
data.docupass_reference string

Kod odwołania do sesji DocuPass

docupass_success
data.docupass_success string

0 lub 1, niezależnie od tego, czy weryfikacja DocuPass powiodła się, czy nie powiodła się.

docupass_failedreason
data.docupass_failedreason string

Jeśli weryfikacja docuPass nie powiodła się, przyczyna niepowodzenia.

docupass_customid
data.docupass_customid string

identyfikator customid przekazany podczas tworzenia weryfikacji DocuPass.

documentNumber
data.documentNumber string

Unikatowy identyfikator dokumentu (nr paszportu/nr prawa jazdy itp.)

documentNumber_formatted
data.documentNumber_formatted string

Automatycznie wygenerowany ciąg documentNumber bez żadnych symboli, to pole jest przydatne do filtrowania wyników.

personalNumber
data.personalNumber string

Numer identyfikatora pomocniczego w dokumencie

imię
data.firstName string

Imię/imię/imię

drugie imię
data.middleName string

Imię i nazwisko

nazwisko
data.lastName string

Nazwisko/ Nazwisko / Nazwisko

fullName
data.fullName string

Pełna nazwa (Aktualizowanie innych pól nazw nie spowoduje aktualizacji fullName)

firstName_local
data.firstName_local string

Imię w języku lokalnym

middleName_local
data.middleName_local string

Nazwa środkowa w języku lokalnym

lastName_local
data.lastName_local string

Nazwisko w języku lokalnym

fullName_local
data.fullName_local string

Pełna nazwa w języku lokalnym

Dob
data.dob string

Data urodzenia

Wydane
data.issued string

Data wydania

Upływie terminu ważności
data.expiry string

Data wygaśnięcia

płeć
data.sex string

M: Mężczyzna, F: Kobieta, X: Nieokreślony

height
data.height string

Wysokość osoby

ciężar
data.weight string

Waga osoby

hairColor
data.hairColor string

Kolor włosów

eyeColor
data.eyeColor string

Kolor oczu

adres1
data.address1 string

Wiersz adresu 1

adres2
data.address2 string

Wiersz adresu 2

Kodów pocztowych
data.postcode string

Kod pocztowy adresu

placeOfBirth
data.placeOfBirth string

Miejsce urodzenia

documentType
data.documentType string

P: Paszport, D: Prawo jazdy, I: Karta tożsamości, V: Visa, R: Karta rezydencji, O: Inne

documentName (nazwa_dokumentu)
data.documentName string

Nazwa dokumentu

vehicleClass
data.vehicleClass string

Klasa pojazdów na prawo jazdy

Ograniczenia
data.restrictions string

Ograniczenia dotyczące jazdy

popularyzacja
data.endorsement string

Poparcie dla prawa jazdy

e-mail
data.email string

Adres e-mail użytkownika

mobilne
data.mobile string

Numer telefonu komórkowego użytkownika

telefon stacjonarny
data.landline string

Numer telefonu stacjonarnego użytkownika

issueAuthority
data.issueAuthority string

Urząd wystawiania dokumentu

issuerOrg_region_full
data.issuerOrg_region_full string

Podregion/stan wystawcy dokumentu. Przykład: Kalifornia

issuerOrg_region_abbr
data.issuerOrg_region_abbr string

Podregion/skrót stanu wystawcy dokumentu. Przykład: urząd certyfikacji

issuerOrg_iso2
data.issuerOrg_iso2 string

Dokument wystawiony kod kraju w normie ISO2. Przykład: STANY ZJEDNOCZONE

nationality_iso2
data.nationality_iso2 string

Narodowość posiadacza dokumentu w iso2. Przykład: STANY ZJEDNOCZONE

optionalData
data.optionalData string

Dodatkowe niewykonalne dane zawarte w dokumencie

optionalData2
data.optionalData2 string

Dodatkowe niewykonalne dane zawarte w dokumencie

customdata1
data.customdata1 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu

customdata2
data.customdata2 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu

customdata3
data.customdata3 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu

customdata4
data.customdata4 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu

customdata5
data.customdata5 string

5 ciągów niestandardowych, których można użyć do dodawania noty niestandardowej do wpisu

blok
data.block string

Ustaw ten parametr, aby zablokować przesłany ten sam dokument do podstawowego interfejsu API lub docuPass.

kontrakt
data.contract string

Link do dokumentów umownych lub prawnych wygenerowanych/podpisanych przy użyciu podstawowego interfejsu API lub rozwiązania DocuPass

obraz
data.image array of object

Zawiera listę obrazów skojarzonych z wpisem.

id
data.image.id string

Identyfikator obrazu

typ
data.image.type string

0 dla dokumentu i 1 dla osoby

skrót
data.image.hash string

Skrót obrazu MD5

URL
data.image.url string

Adres URL obrazu

createtime
data.image.createtime string

Obraz godziny został przekazany w formacie UTC

Stan trenowania

Sprawdź, czy szkolenie magazynu jest nadal w toku, czy zostało ukończone.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

Zwraca

Nazwa Ścieżka Typ Opis
stan
status string

nottrained: Nigdy nie wytrenowany, niestartowany: trenowanie nie jest uruchomione, uruchomione: Trenowanie jest obecnie uruchomione, powodzenie: Trenowanie powiodło się, niepowodzenie: Trenowanie nie powiodło się

startTime
startTime string

Godzina rozpoczęcia ostatniego szkolenia w formacie UTC.

statusChangeTime
statusChangeTime string

Godzina ostatniej zmiany stanu w formacie UTC.

lastSuccessTime
lastSuccessTime string

Czas ostatniego pomyślnego szkolenia w formacie UTC.

błąd
error string

Komunikat o błędzie skojarzony ze stanem trenowania, który zakończył się niepowodzeniem.

Szkolenie wyszukiwania twarzy

Przed rozpoczęciem wyszukiwania twarzy należy wydać polecenie train, aby wytrenować zestawy danych dokumentów wewnątrz magazynu. Możesz również trenować dane magazynu za pośrednictwem portalu internetowego. Zadanie trenowania jest asynchroniczne, czas trenowania zależy od liczby wpisów i obrazów magazynu. Może upłynąć od kilku sekund do godziny.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

Zwraca

Nazwa Ścieżka Typ Opis
sukces
success integer

Tworzenie sesji DocuPass

Możesz utworzyć sesję weryfikacji dla każdego użytkownika wymagającego weryfikacji tożsamości.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

typ
type integer

0: Moduł Iframe ,1: Moduł mobilny, 2: Moduł przekierowania, 3: Moduł live mobile

nazwa firmy
companyname True string

Nazwa firmy lub produktu.

callbackurl
callbackurl string

Adres URL elementu webhook/wywołania zwrotnego w celu otrzymania wyniku weryfikacji.

biometryczny
biometric integer

Poproś użytkownika o zdjęcie selfie lub wideo selfie na potrzeby weryfikacji twarzy.

biometric_threshold
biometric_threshold float

Określanie minimalnej oceny w celu przekazania weryfikacji biometrycznej twarzy

authenticate_minscore
authenticate_minscore float

Dokument musi spełniać minimalną ocenę autentyczności, aby przejść walidację. Ustaw wartość 0, aby wyłączyć sprawdzanie poprawności/autentyczności.

authenticate_module
authenticate_module integer

Określ moduł używany do sprawdzania poprawności dokumentu.

maxattempt
maxattempt integer

Liczba maksymalnych prób niepowodzenia dla każdego żądania weryfikacji.

successredir
successredir string

Po pomyślnym zakończeniu weryfikacji tożsamości przeglądarka zostanie przekierowana do tego adresu URL.

failredir
failredir string

Przeglądarka zostanie przekierowana do tego adresu URL, gdy weryfikacja tożsamości nie powiodła się.

customid
customid string

Jest to przydatne do identyfikowania użytkownika w bazie danych. Ta wartość będzie przechowywana w obszarze docupass_customid w obszarze Magazyn.

Wielokrotnego użytku
reusable boolean

Włączenie tego parametru umożliwi wielu użytkownikom zweryfikowanie tożsamości za pomocą tego samego adresu URL. Nowy kod referencyjny usługi DocuPass zostanie wygenerowany automatycznie dla każdego użytkownika.

phoneverification
phoneverification boolean

Czy poprosić użytkownika o wprowadzenie numeru telefonu do weryfikacji, aplikacja DocuPass obsługuje zarówno weryfikację numeru telefonu komórkowego, jak i numeru telefonu stacjonarnego. (Tylko subskrybent)

typ dokumentu
documenttype string

Użytkownik musi przekazać określony typ dokumentu. Na przykład "PD" akceptuje zarówno paszport, jak i prawo jazdy.

documentcountry
documentcountry string

Kod kraju ISO ALPHA-2.

documentregion
documentregion string

Pełna nazwa lub skrót stanu/regionu.

dualsidecheck
dualsidecheck boolean

Sprawdź, czy nazwy, numer dokumentu i typ dokumentu są zgodne między frontem a tyłem dokumentu podczas przeprowadzania skanowania dwustronnego. Jeśli zostaną zwrócone jakiekolwiek niezgodności informacji o błędzie 14.

verify_expiry
verify_expiry boolean

Zaakceptuj tylko dokument, który nie wygasł

verify_documentno
verify_documentno string

Numer dokumentu wymagający weryfikacji.

verify_name
verify_name string

Pełna nazwa, w tym imię i nazwisko wymagające weryfikacji.

verify_dob
verify_dob string

Data urodzenia wymagająca weryfikacji w formacie RRRR/MM/DD.

verify_age
verify_age string

Zakres wiekowy, przykład: 18–40

verify_address
verify_address string

Pełny adres wymagający weryfikacji.

verify_postcode
verify_postcode string

Pełny kod pocztowy wymagający weryfikacji.

verify_phone
verify_phone string

Pełny numer telefonu wymagający weryfikacji.

vault_save
vault_save boolean

Zapisz dokumenty użytkownika i przeanalizowane informacje w magazynie.

return_documentimage
return_documentimage boolean

Zwracanie obrazu dokumentu przekazanego przez użytkownika w żądaniu wywołania zwrotnego.

return_faceimage
return_faceimage boolean

Zwracanie obrazu twarzy przekazanego przez użytkownika w żądaniu wywołania zwrotnego.

return_type
return_type integer

Określ typ zwracanego obrazu — zawartość obrazu zakodowanego w formacie base64 lub adres URL obrazu. (Adres URL obrazu będzie przechowywany tylko przez 7 dni)

welcomemessage
welcomemessage string

Zastąp ogólny komunikat powitania na pierwszej stronie dostosowanym tekstem (maksymalnie 1000 znaków)

nobranding
nobranding boolean

Ukryj logo znakowania na wszystkich stronach DocuPass. (Tylko subskrybent)

logo
logo string

Logo znakowania niestandardowego. (Tylko subskrybent)

customhtmlurl
customhtmlurl string

Użyj własnej strony HTML i css dla aplikacji DocuPass. (Tylko subskrybent)

język
language string

DocuPass automatycznie wykrywa język urządzenia użytkownika i wyświetla odpowiedni język.

Upływie terminu ważności
expiry integer

Liczba sekund przed wygaśnięciem sesji DocuPass. Po wygaśnięciu użytkownik nie będzie mógł kontynuować bieżącej sesji. Zostanie również wysłane nieudane wywołanie zwrotne.

qr_color
qr_color string

Kolor pierwszego planu kodu QR. (Tylko w przypadku aplikacji Live Mobile i Standard Mobile)

qr_bgcolor
qr_bgcolor string

Kolor tła kodu QR. (Tylko w przypadku aplikacji Live Mobile i Standard Mobile)

qr_size
qr_size integer

Rozmiar kodu QR (1–50). (Tylko w przypadku aplikacji Live Mobile i Standard Mobile)

qr_margin
qr_margin integer

Grubość obramowania kodu QR (1–50). (Tylko w przypadku aplikacji Live Mobile i Standard Mobile)

Zwraca

Nazwa Ścieżka Typ Opis
odwołanie
reference string

Unikatowy kod referencyjny sesji DocuPass.

typ
type integer

Utworzony typ modułu DocuPass.

customid
customid string

Identyfikator niestandardowy używany podczas tworzenia sesji DocuPass.

URL
url string

Unikatowy adres URL aplikacji internetowej DocuPass. Wyślij ten link do użytkownika lub osadź go w witrynie internetowej lub aplikacji mobilnej, aby rozpocząć weryfikację tożsamości.

qrcode
qrcode string

Adres URL obrazu kodu QR dla użytkownika do skanowania

base_url
base_url string

Możesz wysłać ten link do użytkownika i poprosić go o wprowadzenie kodu referencyjnego w celu rozpoczęcia weryfikacji.

html
html string

Przykładowy kod HTML, który można wstawić do strony internetowej.

smssent
smssent integer

Zawiera numer telefonu jako potwierdzenie, gdy wiadomość SMS została pomyślnie wysłana za pośrednictwem parametru sms_verification_link.

Upływie terminu ważności
expiry integer

Sygnatura czasowa utc systemu UNIX wskazująca, kiedy ta sesja wygaśnie, po wygaśnięciu użytkownik nie będzie już mógł użyć linku i zostanie wysłane wywołanie zwrotne, które zakończyło się niepowodzeniem.

Tworzenie sesji podpisu DocuPass

Możesz utworzyć sesję podpisu, w której użytkownik będzie przeglądać i podpisywać dokument prawny bez weryfikacji tożsamości. Jeśli chcesz przeprowadzić weryfikację tożsamości i podpisywać jakiś dokument przez użytkownika, utwórz zamiast tego sesję weryfikacji tożsamości.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

nazwa firmy
companyname True string

Nazwa firmy będzie wyświetlana na całej stronie weryfikacji, aby użytkownik końcowy wiedział, że przesyła informacje o tożsamości do firmy

template_id
template_id string

Identyfikator szablonu kontraktu do automatycznego wypełniania przy użyciu danych użytkownika.

contract_format
contract_format string

Format dokumentu wyjściowego. (PDF, DOCX, HTML)

callbackurl
callbackurl string

Plik kontraktu zostanie wysłany do tego adresu URL. Musisz włączyć vault_save lub określić wywołanie zwrotne, aby można było zapisać wygenerowany dokument.

successredir
successredir string

Przeglądarka zostanie przekierowana do tego adresu URL po przejrzeniu i podpisaniu dokumentu. Kod referencyjny rozwiązania DocuPass i identyfikator customid zostaną dołączone na końcu adresu URL

customid
customid string

Ciąg niestandardowy, który zostanie wysłany z powrotem do adresu URL wywołania zwrotnego serwera i dołączony do adresów URL przekierowania ustawionych przez successredir i failredir jako ciąg zapytania. Jest to przydatne do identyfikowania użytkownika w bazie danych. Ta wartość będzie przechowywana w obszarze docupass_customid w obszarze Magazyn.

Wielokrotnego użytku
reusable boolean

Nabling ten parametr umożliwi wielu użytkownikom przeglądanie i podpisywanie dokumentów za pomocą tego samego adresu URL. Nowy kod referencyjny usługi DocuPass zostanie wygenerowany automatycznie dla każdego użytkownika.

sms_contract_link
sms_contract_link string

Pełny numer telefonu komórkowego międzynarodowego

vault_save
vault_save boolean

Zapisz wygenerowany dokument w magazynie. Musisz włączyć vault_save lub określić wywołanie zwrotne, aby można było zapisać wygenerowany dokument.

nobranding
nobranding boolean

Ukryj logo znakowania na wszystkich stronach DocuPass.

customhtmlurl
customhtmlurl string

Użyj własnej strony HTML i css dla aplikacji DocuPass. Po wprowadzeniu zmian w kodzie HTML i CSS należy przekazać je na własny serwer, na początku każdej sesji aplikacja DocuPass pobierze najnowszą stronę HTML z serwera.

język
language string

DocuPass automatycznie wykrywa język urządzenia użytkownika i wyświetla odpowiedni język. Ustaw ten parametr, aby zastąpić automatyczne wykrywanie języka. (en, fr, nl, de, es, zh-TW, zh-CN)

Upływie terminu ważności
expiry integer

Liczba sekund przed wygaśnięciem sesji DocuPass. Po wygaśnięciu użytkownik nie będzie mógł kontynuować bieżącej sesji. Zostanie również wysłane nieudane wywołanie zwrotne.

qr_color
qr_color string

Kolor pierwszego planu kodu QR

qr_bgcolor
qr_bgcolor string

Kolor tła kodu QR

qr_size
qr_size integer

Rozmiar kodu QR

qr_margin
qr_margin integer

Grubość obramowania kodu QR

Zwraca

Nazwa Ścieżka Typ Opis
odwołanie
reference string

Unikatowy kod referencyjny sesji DocuPass.

customid
customid string

Identyfikator niestandardowy używany podczas tworzenia sesji DocuPass.

URL
url string

Unikatowy adres URL aplikacji internetowej DocuPass. Wyślij ten link do użytkownika lub osadź go w witrynie internetowej lub aplikacji mobilnej, aby przejrzeć i podpisać dokument.

qrcode
qrcode string

Adres URL obrazu kodu QR dla użytkownika do skanowania

base_url
base_url string

Możesz wysłać ten link do użytkownika i poprosić go o wprowadzenie kodu referencyjnego w celu podpisania dokumentów.

html_qrcode
html_qrcode string

Przykładowy kod HTML do wyświetlania kodu QR na stronie internetowej.

html_iframe
html_iframe string

Przykładowy kod HTML do wstawiania elementu iframe do strony internetowej.

smssent
smssent string

Zawiera numer telefonu jako potwierdzenie, gdy wiadomość SMS została pomyślnie wysłana za pośrednictwem parametru sms_contract_link.

Upływie terminu ważności
expiry integer

Sygnatura czasowa utc systemu UNIX wskazująca, kiedy ta sesja wygaśnie, po wygaśnięciu użytkownik nie będzie już mógł użyć linku i zostanie wysłane wywołanie zwrotne, które zakończyło się niepowodzeniem.

Ustawienie podstawowego interfejsu API

Interfejs API weryfikacji identyfikatora wielu funkcji w celu zweryfikowania zdalnego dokumentu fizycznego, jego autentyczności i twarzy jest zgodny z dokumentem ze zdjęciem użytkownika.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

file_base64
file_base64 string

Obraz zakodowany w formacie base64 można przekazać jako ciąg przy użyciu pliku application/x-www-form-urlencoded lub application/json.

URL
url string

Podstawowy interfejs API umożliwia pobieranie obrazu zdalnego z serwera.

file_back_base64
file_back_base64 string

Obraz zakodowany w formacie Base64 z tyłu dokumentu w celu przeprowadzenia skanowania dwustronnego.

url_back
url_back string

Zdalny obraz z tyłu dokumentu w celu przeprowadzenia skanowania dwustronnego.

face_base64
face_base64 string

Zakodowany w formacie Base64 obraz twarzy osoby w celu przeprowadzenia weryfikacji biometrycznej zdjęcia.

faceurl
faceurl string

Zdalny obraz twarzy osoby do przeprowadzenia weryfikacji biometrycznej.

video_base64
video_base64 string

Wideo selfie zakodowane w formacie Base64 w celu przeprowadzenia weryfikacji biometrycznej wideo.

videourl
videourl string

Zdalne wideo selfie hostowane w celu przeprowadzenia weryfikacji biometrycznej wideo.

kod dostępu
passcode string

4-cyfrowy numer

dokładność
accuracy integer

Skonfiguruj szybkość i dokładność rozpoznawania dokumentów i wyników ocr. Niska dokładność skróci czas odpowiedzi do poniżej 1 sekundy, podczas gdy wysoka dokładność zwykle trwa 2~3 sekundy.

uwierzytelnić
authenticate boolean

Zweryfikuj dokument, aby sprawdzić, czy dokument jest autentyczny i nie został naruszony.

authenticate_module
authenticate_module string

Określ moduł używany do sprawdzania poprawności dokumentu.

biometric_threshold
biometric_threshold float

Określanie minimalnej oceny w celu przekazania weryfikacji biometrycznej twarzy

return_confidence
return_confidence boolean

Zwraca współczynnik ufności dla każdego pola danych.

return_empty
return_empty boolean

Interfejs API może zwrócić wartość null w pustych polach, włączając ten parametr.

ocr_scaledown
ocr_scaledown integer

Liczba z zakresu od 500 do 4000 lub 0

outputimage
outputimage boolean

Utwórz przycięty obraz dokumentu.

outputface
outputface boolean

Utwórz przycięty obraz regionu twarzy w dokumencie.

outputmode
outputmode string

Wyprowadź przycięty dokument i twarz jako adres URL lub zawartość zakodowaną w formacie base64.

dualsidecheck
dualsidecheck boolean

Sprawdź, czy nazwy, numer dokumentu i typ dokumentu są zgodne między frontem a tyłem dokumentu podczas przeprowadzania skanowania dwustronnego. Jeśli zostaną zwrócone jakiekolwiek niezgodności informacji o błędzie 14.

verify_expiry
verify_expiry boolean

Sprawdź, czy dokument jest nadal prawidłowy na podstawie daty wygaśnięcia.

verify_documentno
verify_documentno string

Sprawdź, czy podany numer dokumentu jest zgodny z dokumentem.

verify_dob
verify_dob string

Sprawdź, czy podana data urodzenia jest zgodna z dokumentem. (RRRR/MM/DD)

verify_age
verify_age string

Sprawdź, czy posiadacz dokumentu jest w wieku między danym zakresem. (zakres, przykład: 18-40)

verify_address
verify_address string

Sprawdź, czy podany adres jest zgodny z dokumentem.

verify_postcode
verify_postcode string

Sprawdź, czy podany kod pocztowy jest zgodny z dokumentem.

country
country string

Sprawdź, czy dokument został wystawiony przez określone kraje, jeśli nie zostanie zgłoszony kod błędu 10. Oddzielaj wiele wartości przecinkami. Na przykład "USA,CA" będzie akceptować dokumenty ze Stanów Zjednoczonych i Kanady.

region
region string

Sprawdź, czy dokument został wystawiony przez określony stan, jeśli nie zostanie zgłoszony kod błędu 11. Oddzielaj wiele wartości przecinkami. Na przykład "CA", TX akceptuje dokumenty z Kalifornii i Teksasu.

typ
type string

Sprawdź, czy dokument był jednym z określonych typów, jeśli nie zostanie zgłoszony kod błędu 12. Na przykład "PD" akceptuje zarówno paszport, jak i prawo jazdy.

lista bloków kontrolnych
checkblocklist boolean

Sprawdź dane dokumentu pod kątem zablokowanych wpisów w magazynie. Jeśli dokument pasuje do jednego z zablokowanych błędów wpisu 15 zostanie zgłoszony

vault_save
vault_save boolean

Zapisz obraz dokumentu i przeanalizuj informacje w zabezpieczonym magazynie. Wpisy dokumentów można wyświetlać, wyszukiwać i aktualizować w magazynie za pomocą interfejsu API magazynu lub portalu internetowego.

vault_saveunrecognized
vault_saveunrecognized boolean

Zapisz obraz dokumentu w magazynie, nawet jeśli nie można rozpoznać dokumentu.

vault_noduplicate
vault_noduplicate boolean

Zapobiegaj zapisywaniu zduplikowanych obrazów.

vault_automerge
vault_automerge boolean

Automatyczne scalanie obrazów z tym samym numerem dokumentu w jednym wpisie wewnątrz magazynu.

vault_customdata1
vault_customdata1 string

Dodaj do 5 ciągów niestandardowych, które będą skojarzone z wpisem magazynu. Może to być przydatne w przypadku filtrowania i wyszukiwania wpisów.

vault_customdata2
vault_customdata2 string

Dodaj do 5 ciągów niestandardowych, które będą skojarzone z wpisem magazynu. Może to być przydatne w przypadku filtrowania i wyszukiwania wpisów.

vault_customdata3
vault_customdata3 string

Dodaj do 5 ciągów niestandardowych, które będą skojarzone z wpisem magazynu. Może to być przydatne w przypadku filtrowania i wyszukiwania wpisów.

vault_customdata4
vault_customdata4 string

Dodaj do 5 ciągów niestandardowych, które będą skojarzone z wpisem magazynu. Może to być przydatne w przypadku filtrowania i wyszukiwania wpisów.

vault_customdata5
vault_customdata5 string

Dodaj do 5 ciągów niestandardowych, które będą skojarzone z wpisem magazynu. Może to być przydatne w przypadku filtrowania i wyszukiwania wpisów.

aml_check
aml_check boolean

Sprawdź nazwę i numer dokumentu posiadacza dokumentu względem bazy danych AML analizatora identyfikatorów.

aml_database
aml_database string

Oddziel każdy kod bazy danych przecinkami, na przykład: un_sc,us_ofac.

aml_strict_match
aml_strict_match boolean

Włącz ten parametr, aby zmniejszyć liczbę wyników fałszywie dodatnich, pasując tylko do jednostek o dokładnie takiej samej narodowości i urodzinach.

contract_generate
contract_generate string

Identyfikator szablonu kontraktu do automatycznego wypełniania przy użyciu danych użytkownika.

contract_format
contract_format string

Format dokumentu wyjściowego. Opcjonalne: PDF, DOCX, HTML.

contract_prefill_data
contract_prefill_data object

Zwraca

Nazwa Ścieżka Typ Opis
documentNumber
result.documentNumber string

Unikatowy identyfikator skojarzony z dokumentem (np. numer paszportu/numer licencji kierowcy/numer karty itp.)

personalNumber
result.personalNumber string

Unikatowy identyfikator osobisty skojarzony z osobą w kraju (np. numer identyfikacyjny kraju)

imię
result.firstName string

Imię/imię/imię

nazwisko
result.lastName string

Nazwisko/ Nazwisko / Nazwisko

drugie imię
result.middleName string

Imię i nazwisko

fullName
result.fullName string

Jeśli imię i nazwisko nie można odróżnić pełnej nazwy, zostanie zwrócona zamiast tego

firstName_local
result.firstName_local string

Imię w języku lokalnym, jeśli jest dostępne

lastName_local
result.lastName_local string

Nazwisko w języku lokalnym, jeśli jest dostępne

middleName_local
result.middleName_local string

Nazwa środkowa w języku lokalnym, jeśli jest dostępna

fullName_local
result.fullName_local string

Pełna nazwa w języku lokalnym, jeśli jest dostępna

płeć
result.sex string

Płeć M=Mężczyzna F=Kobieta X=Nieokreślony

height
result.height string

Wysokość osoby

ciężar
result.weight string

Waga osoby

hairColor
result.hairColor string

Kolor włosów - ANSI D-20 kod koloru włosów (3 litery)

eyeColor
result.eyeColor string

Kolor oczu — kod koloru oczu ANSI D-20 (3 litery)

wiek
result.age integer

Wiek posiadacza dokumentu

Dob
result.dob string

Data urodzenia w RRRR/MM/DD

dob_day
result.dob_day integer

Data urodzenia od 1 do 31

dob_month
result.dob_month integer

Data urodzenia od 1 do 12

dob_year
result.dob_year integer

Data urodzenia roku urodzenia w RRRR

Upływie terminu ważności
result.expiry string

Data wygaśnięcia dokumentu w RRRR/MM/DD

expiry_day
result.expiry_day integer

Dzień wygaśnięcia od 1 do 31

expiry_month
result.expiry_month integer

Miesiąc wygaśnięcia od 1 do 12

expiry_year
result.expiry_year integer

Rok wygaśnięcia w RRRR

daysToExpiry
result.daysToExpiry integer

Liczba dni przed wygaśnięciem dokumentu

Wydane
result.issued string

Data wydania w RRRR/MM/DD

issued_day
result.issued_day integer

Dzień wydania od 1 do 31

issued_month
result.issued_month integer

Miesiąc wydania od 1 do 12

issued_year
result.issued_year integer

Rok wydania w RRRR

daysFromIssue
result.daysFromIssue integer

Liczba dni od wydania dokumentu

adres1
result.address1 string

Wiersz adresu 1

adres2
result.address2 string

Wiersz adresu 2

Kodów pocztowych
result.postcode string

Kod pocztowy adresu

placeOfBirth
result.placeOfBirth string

Miejsce urodzenia

vehicleClass
result.vehicleClass string

Klasa pojazdu prawa jazdy

Ograniczenia
result.restrictions string

Ograniczenia licencji kierowcy

popularyzacja
result.endorsement string

Poparcie dla prawa jazdy

optionalData
result.optionalData string

Dodatkowe niewykonalne dane zawarte w dokumencie

optionalData2
result.optionalData2 string

Dodatkowe niewykonalne dane zawarte w dokumencie

documentType
result.documentType string

Typ dokumentu: P=Passport, D=Prawo jazdy, I=Identity Card, V=Visa, R=Residence Card, O=Other

documentSide
result.documentSide string

Strona dokumentu: FRONT, BACK lub BIODATA

issuerOrg_region_full
result.issuerOrg_region_full string

Podregion/stan wystawcy dokumentu. (np. Kalifornia)

issuerOrg_region_abbr
result.issuerOrg_region_abbr string

Podregion/skrót stanu wystawcy dokumentu. (np. urząd certyfikacji)

issuerOrg_full
result.issuerOrg_full string

Kraj wystawiony w dokumencie. (np. Stany Zjednoczone)

issuerOrg_iso2
result.issuerOrg_iso2 string

Dokument wystawiony kod kraju w normie ISO2. (np. Stany Zjednoczone)

issuerOrg_iso3
result.issuerOrg_iso3 string

Dokument wystawiony kod kraju w iso3. (np. USA)

nationality_full
result.nationality_full string

Narodowość posiadacza dokumentu. (np. Stany Zjednoczone)

nationality_iso2
result.nationality_iso2 string

Narodowość posiadacza dokumentu w iso2. (np. Stany Zjednoczone)

nationality_iso3
result.nationality_iso3 string

Narodowość posiadacza dokumentu w ISO3. (np. USA)

internalId
result.internalId string

Służy do identyfikowania unikatowego identyfikatora dokumentu w systemie ID Analyzer, ten sam typ dokumentu powinien mieć ten sam identyfikator.

documentNumber
confidence.documentNumber float

poziom ufności dokumentuNumber

imię
confidence.firstName float

poziom ufności firstName

nazwisko
confidence.lastName float

poziom ufności nazwisko /nazwa rodziny

drugie imię
confidence.middleName float

poziom ufności imienia i nazwiska

dob_month
confidence.dob_month float

poziom ufności dob_month

dob_day
confidence.dob_day float

poziom ufności dob_day

dob_year
confidence.dob_year float

poziom ufności dob_year

issued_month
confidence.issued_month float

poziom ufności issued_month

issued_day
confidence.issued_day float

poziom ufności issued_day

issued_year
confidence.issued_year float

poziom ufności issued_year

expiry_month
confidence.expiry_month float

poziom ufności expiry_month

expiry_day
confidence.expiry_day float

poziom ufności expiry_day

expiry_year
confidence.expiry_year float

poziom ufności expiry_year

płeć
confidence.sex float

poziom ufności płci

height
confidence.height float

poziom ufności wysokości

ciężar
confidence.weight float

poziom ufności wagi

adres1
confidence.address1 float

poziom ufności adresu1

adres2
confidence.address2 float

poziom ufności adresu2

Kodów pocztowych
confidence.postcode float

poziom ufności kodu pocztowego

vehicleClass
confidence.vehicleClass float

poziom ufności pojazduKlasa

Ograniczenia
confidence.restrictions float

poziom ufności ograniczeń

popularyzacja
confidence.endorsement float

poziom zaufania poparcia

eyeColor
confidence.eyeColor float

poziom ufności eyeColor

wiek
confidence.age float

poziom ufności wieku

Dob
confidence.dob float

poziom ufności dob

daysToExpiry
confidence.daysToExpiry float

poziom ufności dniToExpiry

Upływie terminu ważności
confidence.expiry float

poziom ufności wygaśnięcia

Wydane
confidence.issued float

poziom ufności wystawionych

daysFromIssue
confidence.daysFromIssue float

poziom ufności dniFromIssue

fullName
confidence.fullName float

poziom ufności fullName

isIdentical
face.isIdentical boolean

Weryfikacja biometryczna została przekazana lub nie powiodła się

pewność
face.confidence string

Wartość z zakresu od 0 do 1 w zależności od tego, jak podobne są dwie twarze, 1 jest taka sama.

błąd
face.error integer

Kod błędu

error_message
face.error_message string

Komunikat o błędzie. Przykład: nie można odnaleźć danych twarzy w obrazie twarzy

Przekazywane
verification.passed boolean

Jeśli dokument przeszedł wszystkie weryfikacje, zwróci wartość true. Jeśli dokument zakończył się niepowodzeniem co najmniej jednego typu weryfikacji, zwróci wartość false.

twarz
verification.result.face boolean

Jeśli włączono weryfikację biometryczną, czy wskaźnik ufności podobieństwa przekracza próg.

notexpired
verification.result.notexpired boolean

Czy dokument nie wygasł jeszcze.

nazwa
verification.result.name boolean

Czy podana nazwa jest zgodna z nazwą przeanalizowaną z identyfikatora.

Dob
verification.result.dob boolean

Czy podane urodziny pasują do urodziny przeanalizowane z identyfikatora.

documentNumber
verification.result.documentNumber boolean

Określa, czy podany numer dokumentu jest zgodny z numerem dokumentu przeanalizowanym z identyfikatora.

Kodów pocztowych
verification.result.postcode boolean

Czy podany kod pocztowy jest zgodny z kodem pocztowym przeanalizowanym z identyfikatora.

address
verification.result.address boolean

Czy podany adres jest zgodny z adresem przeanalizowanym z identyfikatora.

checkdigit
verification.result.checkdigit boolean

Jeśli typ dokumentu ma algorytm sprawdzania cyfry/dźwięku, czy cyfry kontrolne są prawidłowe.

wiek
verification.result.age boolean

Czy posiadacz dokumentu mieści się w określonym zakresie wiekowym.

cccode
verification.result.cccode boolean

Jeśli typ dokumentu ma implementację chińskiego kodu komercyjnego (CC code), czy kody CC są prawidłowe.

wynik
authentication.score float

Wynik będzie zmiennoprzecinkowy z zakresu od 0 do 1. Prawidłowe dokumenty będą miały wynik bliżej 1, podczas gdy fałszywe lub edytowane dokumenty będą miały wynik bliżej 0. To twoja swoboda decydowania o granicy, dobrym punktem wyjścia byłoby odrzucenie wyniku mniejszego niż 0,5

Przekazywane
authentication.breakdown.data_visibility.passed boolean
Przekazywane
authentication.breakdown.image_quality.passed boolean
Przekazywane
authentication.breakdown.feature_referencing.passed boolean
Przekazywane
authentication.breakdown.exif_check.passed boolean
kod
authentication.breakdown.exif_check.code integer
powód
authentication.breakdown.exif_check.reason string
severity
authentication.breakdown.exif_check.severity string
Przekazywane
authentication.breakdown.publicity_check.passed boolean
kod
authentication.breakdown.publicity_check.code integer
powód
authentication.breakdown.publicity_check.reason string
severity
authentication.breakdown.publicity_check.severity string
Przekazywane
authentication.breakdown.text_analysis.passed boolean
Przekazywane
authentication.breakdown.biometric_analysis.passed boolean
Przekazywane
authentication.breakdown.security_feature_check.passed boolean
kod
authentication.breakdown.security_feature_check.code integer
powód
authentication.breakdown.security_feature_check.reason string
severity
authentication.breakdown.security_feature_check.severity string
Przekazywane
authentication.breakdown.recapture_check.passed boolean
kod
authentication.breakdown.recapture_check.code integer
powód
authentication.breakdown.recapture_check.reason string
severity
authentication.breakdown.recapture_check.severity string
ostrzeżenie
authentication.warning array of string

Tablica ciągów zawierających komunikaty ostrzegawcze dotyczące ważności dokumentu.

aml
aml array of object

Tablica zawierająca listę dopasowań AML zwraca pustą tablicę, jeśli nie znaleziono dopasowania. Szczegółowe informacje można znaleźć w dokumentacji interfejsu API AML.

jednostka
aml.entity string

osoba lub legalność

pełna nazwa
aml.fullname array of string

Nazwisko osoby lub podmiotu prawnego

imię
aml.firstname array of string

Imię i nazwisko osoby

nazwisko
aml.lastname array of string

Nazwisko osoby

middlename
aml.middlename array of string

Imię i nazwisko osoby

alias
aml.alias array of string

Alternatywne lub obce nazwy jednostki

Dob
aml.dob array of string

Urodziny Perona mogą pojawić się w formatach RRRR, RRRR-MM lub RRRR-MM-DD.

address
aml.address array of string

Adres lub kraj zamieszkania jednostki

narodowość
aml.nationality array of string

Kraj lub obywatelstwo jednostki

Miejsce narodzin
aml.birthplace array of string

Miejsce urodzenia Perona

gender
aml.gender array of string

Płeć Perona: M lub F

documentnumber
aml.documentnumber array of object

Lista dokumentów skojarzonych z jednostką.

id
aml.documentnumber.id string

Numer dokumentu

id_formatted
aml.documentnumber.id_formatted string

Alfanumeryczny numer dokumentu

country
aml.documentnumber.country string

Kod kraju ISO2

typ
aml.documentnumber.type string

P = Numer paszportu, I = numer identyfikacyjny, D = numer prawa jazdy, O = Inny/Nieznany typ dokumentu

program
aml.program array of string

Programy sankcji

nuta
aml.note array of string

Dodatkowa uwaga dla jednostki

time
aml.time string

Sygnatura czasowa czasu CZASU UTC, kiedy jednostka została dodana do listy źródłowej lub ostatnia aktualizacja

stan
aml.status string

Stanowisko/tytuł jednostki lub bieżący stan sankcji

przesłać źródło
aml.source array of string

Lista oficjalnych adresów URL źródłowych

baza danych
aml.database string

Kod bazy danych AML analizatora identyfikatorów

schemat
aml.schema string
document_url
contract.document_url string

Adres URL wygenerowanego dokumentu

błąd
contract.error string

W przypadku niepowodzenia wygenerowania kontraktu to pole będzie zawierać przyczynę, taką jak "Nieprawidłowy identyfikator szablonu kontraktu".

vaultid
vaultid string

Unikatowy identyfikator wpisu magazynu, jeśli vault_save jest włączony.

matchrate (szybkość dopasowania)
matchrate float

Współczynnik pól pomyślnie rozpoznanych przez interfejs API, niski współczynnik wskazuje, że obraz dokumentu jest zbyt rozmyty.

We/Wy
output string

Jeśli parametr outputimage jest ustawiony na wartość true, a parametr outputmode to url, to pole będzie zawierać adres URL (lub tablicę adresów URL na potrzeby skanowania dwuside) wskazujący na przycięty obraz dokumentu. Link ma gwarancję wygaśnięcia tylko przez 600 sekund i zostanie usunięty w dowolnym momencie.

outputface
outputface string

Jeśli parametr outputface ma wartość true, a element outputmode to url, to pole będzie zawierać adres URL wskazujący przycięty obraz twarzy. Link ma gwarancję wygaśnięcia tylko przez 600 sekund i zostanie usunięty w dowolnym momencie.

Przycięte
cropped string

Jeśli parametr outputimage jest ustawiony na wartość true, a tryb wyjściowy to base64, to pole będzie zawierać obraz zakodowany w formacie base64 (lub tablicę obrazów zakodowanych w formacie base64 na potrzeby skanowania dwuwymiarowego) przyciętego dokumentu w formacie JPEG

przycięty wierzch
croppedface string

Jeśli parametr outputface jest ustawiony na wartość true, a tryb wyjściowy to base64, to pole będzie zawierać obraz zakodowany w formacie base64 z przyciętą powierzchnią dokumentu w formacie JPEG

czas wykonania
executionTime float

Czas potrzebny na operację interfejsu API w sekundach.

responseID
responseID string

Unikatowy identyfikator identyfikująy żądanie/odpowiedź.

limit przydziału
quota integer

Pozostały limit przydziału interfejsu API, resetuje się na początku każdego miesiąca za bezpłatny lub roczny subskrybent lub na początku każdego cyklu rozliczeniowego dla subskrybenta miesięcznego. Jeśli masz plan subskrypcji, miesięczny limit przydziału będzie używany przed środki.

kredyt
credit integer

Pozostałe środki testowe dla twojego konta. Jeśli masz plan subskrypcji, miesięczny limit przydziału będzie używany przed środki.

Usuwanie obrazu z magazynu

Obraz można usunąć wewnątrz wpisu magazynu, wysyłając żądanie HTTP POST. Pamiętaj, że po usunięciu obrazu adres URL obrazu może być nadal dostępny przez krótki czas z powodu buforowania.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

id
id True string

Identyfikator wpisu magazynu zawierający obraz.

imageid
imageid string

identyfikator obrazu do usunięcia.

Zwraca

Nazwa Ścieżka Typ Opis
sukces
success integer

Usuwanie wpisu z magazynu

Możesz usunąć pojedyncze lub wiele wpisów magazynu, wysyłając żądanie HTTP POST.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

id
id True array of string

id

Zwraca

Nazwa Ścieżka Typ Opis
sukces
success integer

Weryfikowanie wywołania zwrotnego

Aby upewnić się, że dane zostały wysłane z serwera.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

odwołanie
reference True string

Kod referencyjny otrzymany w treści POST.

skrót
hash True string

Skrót otrzymany w treści POST.

Zwraca

Nazwa Ścieżka Typ Opis
sukces
success boolean
odwołanie
reference string

Kod referencyjny sesji DocuPass

Wyszukiwanie bazy danych AML

Interfejs API AML umożliwia wyszukiwanie globalnej bazy danych AML Analizatora identyfikatorów pod kątem sankcji, peps i poszukiwanych przestępców przy użyciu nazwy, numeru dokumentu lub obu tych elementów. Możesz dalej filtrować wyniki z urodzinami i narodowością.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

nazwa
name string

Nazwa lub alias osoby lub organizacji w dowolnym języku.

documentnumber
documentnumber string

Numer paszportu osoby, krajowy numer identyfikacyjny lub numer prawa jazdy itp.

jednostka
entity string

osoba: Osoba; legalność: Firma lub Organizacja

country
country string

Zwracaj tylko jednostki z pasującym krajem/narodowością lub brakiem informacji o kraju.

Dob
dob string

Zwracaj tylko jednostki z pasującymi informacjami urodzinowymi lub bez informacji urodzinowych.

baza danych
database string

Określ źródłowe bazy danych do wykonania sprawdzania AML, jeśli pozostanie puste, wszystkie źródłowe bazy danych zostaną sprawdzone. Oddziel każdy kod bazy danych przecinkami, na przykład: un_sc,us_ofac. Aby uzyskać pełną listę źródłowych baz danych i odpowiedniego kodu, odwiedź stronę Omówienie interfejsu API AML.

Zwraca

Nazwa Ścieżka Typ Opis
aml
items array of object

Tablica zawierająca listę dopasowań AML zwraca pustą tablicę, jeśli nie znaleziono dopasowania. Szczegółowe informacje można znaleźć w dokumentacji interfejsu API AML.

jednostka
items.entity string

osoba lub legalność

pełna nazwa
items.fullname array of string

Nazwisko osoby lub podmiotu prawnego

imię
items.firstname array of string

Imię i nazwisko osoby

nazwisko
items.lastname array of string

Nazwisko osoby

middlename
items.middlename array of string

Imię i nazwisko osoby

alias
items.alias array of string

Alternatywne lub obce nazwy jednostki

Dob
items.dob array of string

Urodziny Perona mogą pojawić się w formatach RRRR, RRRR-MM lub RRRR-MM-DD.

address
items.address array of string

Adres lub kraj zamieszkania jednostki

narodowość
items.nationality array of string

Kraj lub obywatelstwo jednostki

Miejsce narodzin
items.birthplace array of string

Miejsce urodzenia Perona

gender
items.gender array of string

Płeć Perona: M lub F

documentnumber
items.documentnumber array of object

Lista dokumentów skojarzonych z jednostką.

id
items.documentnumber.id string

Numer dokumentu

id_formatted
items.documentnumber.id_formatted string

Alfanumeryczny numer dokumentu

country
items.documentnumber.country string

Kod kraju ISO2

typ
items.documentnumber.type string

P = Numer paszportu, I = numer identyfikacyjny, D = numer prawa jazdy, O = Inny/Nieznany typ dokumentu

program
items.program array of string

Programy sankcji

nuta
items.note array of string

Dodatkowa uwaga dla jednostki

time
items.time string

Sygnatura czasowa czasu CZASU UTC, kiedy jednostka została dodana do listy źródłowej lub ostatnia aktualizacja

stan
items.status string

Stanowisko/tytuł jednostki lub bieżący stan sankcji

przesłać źródło
items.source array of string

Lista oficjalnych adresów URL źródłowych

baza danych
items.database string

Kod bazy danych AML analizatora identyfikatorów

schemat
items.schema string

Wyszukiwanie twarzy

Wyszukiwanie twarzy umożliwia przeszukiwanie całego magazynu przy użyciu obrazu osoby. Aby korzystać z funkcji wyszukiwania twarzy, należy włączyć indeksowanie wyszukiwania twarzy w portalu internetowym i okresowo trenować zestawy danych magazynu.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

obraz
image string

Dane obrazu zakodowane w formacie Base64.

imageurl
imageurl string

Zdalny adres URL obrazu.

maxentry
maxentry integer

Liczba pasujących wpisów do zwrócenia z zakresu od 1 do 10.

próg
threshold float

Ustaw wymagany minimalny wynik podobieństwa twarzy w zakresie od 0 do 1.

Zwraca

Nazwa Ścieżka Typ Opis
items
items array of

Jeśli zostaną znalezione pasujące wpisy, zostanie zwrócona lista dokumentów z pełną zawartością podobną do polecenia listy.

Wyświetlanie listy i filtrowanie wpisów

Aby wyświetlić listę wszystkich wpisów przechowywanych w magazynie lub wyszukać wpisy z określonymi wartościami, wyślij żądanie HTTP POST do następującego punktu końcowego.

Parametry

Nazwa Klucz Wymagane Typ Opis
apikey
apikey True string

Klucz prywatnego interfejsu API jest dostępny w portalu internetowym.

orderby
orderby string

Nazwa pola używanego do zamawiania wyniku.

sortować
sort string

Usługa ASC do sortowania wyników w kolejności rosnącej, DESC do sortowania w kolejności malejącej.

limit
limit integer

Liczba wpisów magazynu do zwrócenia. (od 1 do 100)

przesunąć
offset integer

Zwracana lista rozpoczynająca się od określonego wpisu, na przykład gdy limit=10, aby uzyskać dostęp do trzeciej strony wyników, użyj przesunięcia=20

filtr
filter array of string

filtr

Zwraca

Nazwa Ścieżka Typ Opis
limit
limit integer

Bieżący limit

przesunąć
offset integer

Bieżące przesunięcie

nextoffset
nextoffset integer

Wartość przesunięcia dla następnego zestawu danych. Jeśli bieżący zestaw danych jest ostatnim zestawem danych, to pole nie zostanie zwrócone.

łączny
total integer

Całkowita liczba znalezionych wpisów.

items
items array of

Znaleziono tablicę wpisów i ich pełną zawartość, identyczną z zawartością zwracaną przez metodę GET.