ID Analyzer (Vorschau)
ID Analyzer bietet verschiedene Identitätsüberprüfungsprodukte, Sie müssen grundlegende Kenntnisse jedes Produkts erwerben, um die beste Lösung für Ihre Anwendung auszuwählen.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | ID Analyzer-Unterstützung |
| URL | https://www.idanalyzer.com/contact.html |
| support@idanalyzer.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | Evith Techology |
| Webseite | https://www.idanalyzer.com/ |
| Datenschutzrichtlinie | https://www.idanalyzer.com/privacy-policy.html |
| Kategorien | IT-Vorgänge; Produktivität |
Die ID Analyzer-Plattform bietet Unternehmen, Organisationen und Einzelpersonen eine wirklich globale Identitätsüberprüfungslösung, die ohne Grenzen funktioniert, eine Lösung, die auf Ihre spezifischen Anforderungen und Anforderungen zugeschnitten werden kann, und ein Sicherheitssystem, das ständig aktualisiert und verbessert wird.
Die Bereitstellung vollständiger Identitätsüberprüfungszugriff und -informationen in mehr als 4000 verschiedenen Formen von ID in 190+ Ländern auf der ganzen Welt ist dies sehr eine globale Lösung, die im Hinblick auf die moderne Welt entwickelt wurde.
Voraussetzungen
- Ein Entwicklerkonto mit ID Analyzer. Sie können sich bei der Registrierung für ein kostenloses Konto registrieren.
- Nach der Registrierung für das Konto erhalten Sie einen API-Schlüssel im Webportal von ID Analyzer. Verwenden Sie diesen API-Schlüssel, um sich beim Connector zu authentifizieren.
So erhalten Sie Anmeldeinformationen
- Navigieren Sie zu "Registrieren".
- Geben Sie die erforderlichen Informationen ein.
- Überprüfen Sie Ihre E-Mail, wenn Sie dazu aufgefordert werden.
- Der neue API-Schlüssel wird im Webportal von ID Analyzer mit Ihren Kontodetails angezeigt. Drücken Sie die Schaltfläche "Kopieren", um sie zur späteren Verwendung in der Zwischenablage zu speichern.
Häufig gestellte Fragen
Ich bin besorgt über den Datenschutz meines Kunden, speichert die API Informationen zu meinem Kunden?
Alles wird nur im Tresor des Kunden gespeichert und wird nicht willkürlich geleeckt. Sie hat keine Kopie an anderer Stelle.
Was sind die "Gutschriften", für die ich API-Guthaben erwerben kann?
Restguthaben im Voraus für Ihr Konto. Wenn Sie über einen monatlichen Plan verfügen, wird Ihr monatliches Kontingent vor prepaid-Gutschrift verwendet.
Wie kann ich überprüfen, ob ein Dokument echt oder falsch ist?
Aktivieren Sie die Authentifizierung, das Ergebnis enthält die Authentifizierungsbewertung.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| API-Schlüssel | securestring | Der API-Schlüssel für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen des Tresoreintragsinhalts |
Wenn dem Tresor Einträge hinzugefügt werden, gibt sowohl die Core-API als auch die DocuPass-API einen Tresoreintragsbezeichner namens Vaultid zurück. Sie können den Bezeichner verwenden, um den Inhalt eines Eintrags im Tresor abzufragen, indem Sie eine HTTP POST-Anforderung an den folgenden Endpunkt senden. |
| Aktualisieren des Tresoreintrags |
Sie können den Wert eines einzelnen Felds oder werte mehrerer Felder in einem Tresoreintrag aktualisieren, indem Sie HTTP POST-Anforderung senden. |
| Bild aus Tresor löschen |
Sie können ein Bild in einem Tresoreintrag löschen, indem Sie http POST-Anforderung senden. Beachten Sie, dass nach dem Löschen eines Bilds die URL zum Bild aufgrund der Zwischenspeicherung für einen kurzen Zeitraum weiterhin zugänglich sein kann. |
| Bild zum Tresor hinzufügen |
Sie können ein Bild hochladen und zu einem vorhandenen Tresoreintrag hinzufügen, indem Sie http POST-Anforderung senden. |
| Durchsuchen der AML-Datenbank |
Mit der AML-API können Sie die globale AML-Datenbank "ID Analyzer" nach Sanktionen, PEPs und gesuchten Kriminellen durchsuchen, die entweder einen Namen, eine Dokumentnummer oder beides verwenden. Sie können die Ergebnisse mit Geburtstag und Nationalität weiter filtern. |
| Eintrag aus Tresor löschen |
Sie können einzelne oder mehrere Tresoreinträge löschen, indem Sie http POST-Anforderung senden. |
| Einträge auflisten und filtern |
Um alle im Tresor gespeicherten Einträge auflisten oder nach Einträgen mit bestimmten Werten zu suchen, senden Sie eine HTTP POST-Anforderung an den folgenden Endpunkt. |
|
Erstellen einer Docu |
Sie können eine Signatursitzung erstellen, in der der Benutzer das legale Dokument ohne Identitätsüberprüfung überprüfen und signieren wird. Wenn Sie sowohl die Identitätsüberprüfung durchführen möchten als auch ihr Benutzer ein Dokument signieren soll, erstellen Sie stattdessen eine Identitätsüberprüfungssitzung. |
|
Erstellen einer Docu |
Sie können eine Überprüfungssitzung für jeden Benutzer erstellen, der eine Identitätsüberprüfung erfordert. |
| Gesichtssuche |
Mithilfe der Gesichtssuche können Sie den gesamten Tresor mithilfe eines Bilds einer Person durchsuchen. Um die Gesichtssuche zu verwenden, müssen Sie die Indizierung der Gesichtssuche im Webportal aktivieren und Ihre Tresor-Datasets regelmäßig trainieren. |
| Kern-API-Einstellung |
Multi-Function ID verification API to verify remote physical document, its authenticity and face match the document with your user photo. |
| Schulung zur Gesichtssuche |
Bevor Sie die Gesichtssuche ausführen, müssen Sie einen Zugbefehl ausgeben, um die Dokumentdatensätze in Ihrem Tresor zu trainieren. Sie können Ihre Tresordaten auch über das Webportal trainieren. Die Schulungsaufgabe ist asynchron, die Schulungszeit hängt von der Anzahl der Tresoreinträge und -bilder ab. Es kann von mehreren Sekunden bis zu einer Stunde dauern. |
| Schulungsstatus |
Überprüfen Sie, ob die Tresorschulung noch läuft oder abgeschlossen ist. |
| Überprüfen des Rückrufs |
Um sicherzustellen, dass die Daten von unserem Server gesendet wurden. |
Abrufen des Tresoreintragsinhalts
Wenn dem Tresor Einträge hinzugefügt werden, gibt sowohl die Core-API als auch die DocuPass-API einen Tresoreintragsbezeichner namens Vaultid zurück. Sie können den Bezeichner verwenden, um den Inhalt eines Eintrags im Tresor abzufragen, indem Sie eine HTTP POST-Anforderung an den folgenden Endpunkt senden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
id
|
id | string |
Tresoreintragsbezeichner. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Erfolgreich
|
success | integer | |
|
id
|
data.id | string |
Tresoreintrags-ID |
|
createtime
|
data.createtime | string |
Zeitstempel der Eintragserstellung in UTC |
|
updatetime
|
data.updatetime | string |
Zeitstempel der letzten Änderung in UTC |
|
Vertrauensebene
|
data.trustlevel | string |
Diese Bewertung wird automatisch berechnet, wenn die Authentifizierung aktiviert ist. (0: Nicht bestimmt, 1: Ungültiges Dokument, 2: Verdächtig, 3: Gültig) |
|
Trustnote
|
data.trustnote | string |
Warnungen im Zusammenhang mit der Dokumentgültigkeit. |
|
docupass_reference
|
data.docupass_reference | string |
Referenzcode auf DocuPass-Sitzung |
|
docupass_success
|
data.docupass_success | string |
0 oder 1, ob die DocuPass-Überprüfung erfolgreich war oder fehlgeschlagen ist. |
|
docupass_failedreason
|
data.docupass_failedreason | string |
Wenn die DocuPass-Überprüfung fehlgeschlagen ist, ist der Grund, warum er fehlgeschlagen ist. |
|
docupass_customid
|
data.docupass_customid | string |
customid passed when creating DocuPass verification. |
|
documentNumber
|
data.documentNumber | string |
Der eindeutige Bezeichner des Dokuments (Passport No./Driver License No. usw.) |
|
documentNumber_formatted
|
data.documentNumber_formatted | string |
Die automatisch generierte Zeichenfolge "documentNumber" ohne Symbole ist für das Filtern von Ergebnissen nützlich. |
|
personalNumber
|
data.personalNumber | string |
Eine sekundäre ID-Nummer im Dokument |
|
Vorname
|
data.firstName | string |
Vorname/ Vorname |
|
MiddleName
|
data.middleName | string |
Zweiter Vorname(n) |
|
lastName
|
data.lastName | string |
Nachname/ Familienname |
|
fullName
|
data.fullName | string |
Vollständiger Name (Beim Aktualisieren anderer Namensfelder wird "fullName" nicht aktualisiert) |
|
firstName_local
|
data.firstName_local | string |
Vorname in der lokalen Sprache |
|
middleName_local
|
data.middleName_local | string |
Zweiter Vorname in der lokalen Sprache |
|
lastName_local
|
data.lastName_local | string |
Nachname in der lokalen Sprache |
|
fullName_local
|
data.fullName_local | string |
Vollständiger Name in der lokalen Sprache |
|
Rohdiamant
|
data.dob | string |
Geburtsdatum |
|
ausgestellt
|
data.issued | string |
Problemdatum |
|
expiry
|
data.expiry | string |
Ablaufdatum |
|
Sex
|
data.sex | string |
M: Männlich, F: Weiblich, X: Nicht spezifiziert |
|
height
|
data.height | string |
Höhe der Person |
|
weight
|
data.weight | string |
Gewicht der Person |
|
hairColor
|
data.hairColor | string |
Haarfarbe |
|
eyeColor
|
data.eyeColor | string |
Augenfarbe |
|
Adresse1
|
data.address1 | string |
Adresszeile 1 |
|
adresse2
|
data.address2 | string |
Adresszeile 2 |
|
Postleitzahl
|
data.postcode | string |
Adresspostcode |
|
placeOfBirth
|
data.placeOfBirth | string |
Geburtsort |
|
documentType
|
data.documentType | string |
P: Reisepass, D: Führerschein, I: Identitätskarte, V: Visum, R: Aufenthaltskarte, O: Andere |
|
Name des Dokuments
|
data.documentName | string |
Name des Dokuments |
|
vehicleClass
|
data.vehicleClass | string |
Fahrzeugklasse auf Führerschein |
|
Einschränkungen
|
data.restrictions | string |
Fahreinschränkungen |
|
Unterstützung
|
data.endorsement | string |
Unterstützung der Treiberlizenz |
|
E-Mail
|
data.email | string |
E-Mail-Adresse des Benutzers |
|
mobile
|
data.mobile | string |
Mobiltelefonnummer des Benutzers |
|
Festnetz
|
data.landline | string |
Telefonnummer für Festnetzbenutzer |
|
issueAuthority
|
data.issueAuthority | string |
Ausstellen der Dokumentautorität |
|
issuerOrg_region_full
|
data.issuerOrg_region_full | string |
Dokumentherausgeber-Unterregion/Status. Beispiel: Kalifornien |
|
issuerOrg_region_abbr
|
data.issuerOrg_region_abbr | string |
Abkürzung für Dokumentherausgeber-Unterregion/Bundesland. Beispiel: Zertifizierungsstelle |
|
issuerOrg_iso2
|
data.issuerOrg_iso2 | string |
Dokument ausgestellter Ländercode in ISO2. Beispiel: US |
|
nationality_iso2
|
data.nationality_iso2 | string |
Staatsangehörigkeit des Dokumentinhabers in ISO2. Beispiel: US |
|
optionalData
|
data.optionalData | string |
Zusätzliche nicht spezifische Daten, die im Dokument enthalten sind |
|
optionalData2
|
data.optionalData2 | string |
Zusätzliche nicht spezifische Daten, die im Dokument enthalten sind |
|
customdata1
|
data.customdata1 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen |
|
customdata2
|
data.customdata2 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen |
|
customdata3
|
data.customdata3 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen |
|
customdata4
|
data.customdata4 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen |
|
customdata5
|
data.customdata5 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen |
|
Block
|
data.block | string |
Legen Sie diesen Parameter fest, um zu verhindern, dass dasselbe Dokument an die Core-API oder DocuPass übermittelt wird. |
|
Vertrag
|
data.contract | string |
Link zu Vertrags- oder rechtlichen Dokumenten, die mit der Core-API oder DocuPass generiert/signiert wurden |
|
image
|
data.image | array of object |
Enthält eine Liste von Bildern, die dem Eintrag zugeordnet sind. |
|
id
|
data.image.id | string |
Bildbezeichner |
|
type
|
data.image.type | string |
0 für Dokument und 1 für Person |
|
hash
|
data.image.hash | string |
MD5-Hash des Bilds |
|
URL
|
data.image.url | string |
URL zum Bild |
|
createtime
|
data.image.createtime | string |
Zeitbild wurde in UTC hochgeladen |
Aktualisieren des Tresoreintrags
Sie können den Wert eines einzelnen Felds oder werte mehrerer Felder in einem Tresoreintrag aktualisieren, indem Sie HTTP POST-Anforderung senden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
id
|
id | True | string |
Tresoreintragsbezeichner. |
|
Adresse1
|
address1 | string |
Adresszeile 1. |
|
|
adresse2
|
address2 | string |
Adresszeile 2. |
|
|
Block
|
block | string |
Legen Sie diesen Parameter fest, um zu verhindern, dass dasselbe Dokument an die Core-API oder DocuPass übermittelt wird. 0: Kein Block 1: Dokumentnummer blockieren 2: Block firstname/lastname 3: Block document number and firstname/lastname. |
|
|
customdata1
|
customdata1 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen. |
|
|
customdata2
|
customdata2 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen. |
|
|
customdata3
|
customdata3 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen. |
|
|
customdata4
|
customdata4 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen. |
|
|
customdata5
|
customdata5 | string |
5 benutzerdefinierte Zeichenfolgen, die verwendet werden können, um dem Eintrag benutzerdefinierte Memo hinzuzufügen. |
|
|
Rohdiamant
|
dob | string |
Geburtsdatum (JJJJ-MM-DD). |
|
|
Name des Dokuments
|
documentName | string |
Name des Dokuments. |
|
|
documentNumber
|
documentNumber | string |
Der eindeutige Bezeichner des Dokuments (Passport No./Driver License No. usw.) |
|
|
documentType
|
documentType | string |
P: Passport D: Führerschein I: Identitätskarte V: Visa R: Aufenthaltskarte O: Andere |
|
|
docupass_customid
|
docupass_customid | string |
customid passed when creating DocuPass verification. |
|
|
docupass_failedreason
|
docupass_failedreason | string |
Wenn die DocuPass-Überprüfung fehlgeschlagen ist, ist der Grund, warum er fehlgeschlagen ist. |
|
|
docupass_reference
|
docupass_reference | string |
Verweisen Sie auf den Code auf die DocuPass-Sitzung. |
|
|
docupass_success
|
docupass_success | string |
0 oder 1, ob die DocuPass-Überprüfung erfolgreich war oder fehlgeschlagen ist. |
|
|
E-Mail
|
string |
E-Mail-Adresse des Benutzers. |
||
|
expiry
|
expiry | string |
Ablaufdatum (JJJJ-MM-DD) |
|
|
eyeColor
|
eyeColor | string |
Augenfarbe. |
|
|
Vorname
|
firstName | string |
Vorname/ Vorname |
|
|
firstName_local
|
firstName_local | string |
Vorname in der lokalen Sprache. |
|
|
fullName
|
fullName | string |
Vollständiger Name (Beim Aktualisieren anderer Namensfelder wird "fullName" nicht aktualisiert) |
|
|
fullName_local
|
fullName_local | string |
Vorname in der lokalen Sprache. |
|
|
hairColor
|
hairColor | string |
Haarfarbe. |
|
|
height
|
height | string |
Höhe der Person. |
|
|
issueAuthority
|
issueAuthority | string |
Stellen Sie die Autorität des Dokuments aus. |
|
|
ausgestellt
|
issued | string |
Ausgabedatum (JJJJ-MM-DD) |
|
|
issuerOrg_iso2
|
issuerOrg_iso2 | string |
Dokument ausgestellter Ländercode in ISO2. Beispiel: US |
|
|
issuerOrg_region_abbr
|
issuerOrg_region_abbr | string |
Abkürzung für Dokumentherausgeber-Unterregion/Bundesland. Beispiel: Zertifizierungsstelle |
|
|
issuerOrg_region_full
|
issuerOrg_region_full | string |
Dokumentherausgeber-Unterregion/Status. Beispiel: Kalifornien |
|
|
Festnetz
|
landline | string |
Telefonnummer für Festnetzbenutzer. |
|
|
lastName
|
lastName | string |
Nachname/Familienname. |
|
|
lastName_local
|
lastName_local | string |
Nachname in der lokalen Sprache. |
|
|
MiddleName
|
middleName | string |
Zweiter Vorname(n). |
|
|
middleName_local
|
middleName_local | string |
Zweiter Vorname in der lokalen Sprache. |
|
|
mobile
|
mobile | string |
Mobiltelefonnummer des Benutzers. |
|
|
nationality_iso2
|
nationality_iso2 | string |
Staatsangehörigkeit des Dokumentinhabers in ISO2. Beispiel: US |
|
|
optionalData
|
optionalData | string |
Zusätzliche nicht spezifische Daten, die im Dokument enthalten sind. |
|
|
optionalData2
|
optionalData2 | string |
Zusätzliche nicht spezifische Daten, die im Dokument enthalten sind. |
|
|
personalNumber
|
personalNumber | string |
Eine sekundäre ID-Nummer im Dokument. |
|
|
placeOfBirth
|
placeOfBirth | string |
Geburtsort. |
|
|
Postleitzahl
|
postcode | string |
Adresse Postcode. |
|
|
Einschränkungen
|
restrictions | string |
Fahreinschränkungen. |
|
|
Sex
|
sex | string |
M: Männlicher F: Weiblicher X: Nicht spezifiziert |
|
|
Vertrauensebene
|
trustlevel | string |
0: Nicht festgelegt 1: Ungültiges Dokument 2: Verdächtig 3: Gültig Diese Bewertung wird automatisch berechnet, wenn die Authentifizierung aktiviert ist. |
|
|
Trustnote
|
trustnote | string | ||
|
vehicleClass
|
vehicleClass | string |
Fahrzeugklasse auf Führerschein. |
|
|
weight
|
weight | string |
Gewicht der Person. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Erfolgreich
|
success | integer |
Bild aus Tresor löschen
Sie können ein Bild in einem Tresoreintrag löschen, indem Sie http POST-Anforderung senden. Beachten Sie, dass nach dem Löschen eines Bilds die URL zum Bild aufgrund der Zwischenspeicherung für einen kurzen Zeitraum weiterhin zugänglich sein kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
id
|
id | True | string |
Tresoreintragsbezeichner, der das Bild enthält. |
|
Imageid
|
imageid | string |
id des zu löschenden Bilds. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Erfolgreich
|
success | integer |
Bild zum Tresor hinzufügen
Sie können ein Bild hochladen und zu einem vorhandenen Tresoreintrag hinzufügen, indem Sie http POST-Anforderung senden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
id
|
id | True | string |
Tresoreintragsbezeichner zum Hinzufügen eines Bilds zu |
|
type
|
type | True | string |
Festlegen des Bildtyps: 0=Dokument und 1=Person |
|
image
|
image | string |
Base64-codierte Bilddaten. |
|
|
imageurl
|
imageurl | string |
Remotebild-URL. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Erfolgreich
|
success | integer | |
|
id
|
image.id | string |
Bildbezeichner |
|
type
|
image.type | string |
0 für Dokument und 1 für Person |
|
hash
|
image.hash | string |
MD5-Hash des Bilds |
|
URL
|
image.url | string |
URL zum Bild |
|
createtime
|
image.createtime | string |
Zeitbild wurde in UTC hochgeladen |
Durchsuchen der AML-Datenbank
Mit der AML-API können Sie die globale AML-Datenbank "ID Analyzer" nach Sanktionen, PEPs und gesuchten Kriminellen durchsuchen, die entweder einen Namen, eine Dokumentnummer oder beides verwenden. Sie können die Ergebnisse mit Geburtstag und Nationalität weiter filtern.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
name
|
name | string |
Name oder Alias einer Person oder Organisation in einer beliebigen Sprache. |
|
|
Dokumentnummer
|
documentnumber | string |
Reisepassnummer der Person, nationale ID oder Führerscheinnummer usw. |
|
|
Entität
|
entity | string |
Person: Person; Legalität: Unternehmen oder Organisation |
|
|
country
|
country | string |
Gibt nur Entitäten mit übereinstimmendem Land/Staatsangehörigkeit oder keine Länderinformationen zurück. |
|
|
Rohdiamant
|
dob | string |
Gibt nur Entitäten mit übereinstimmenden Geburtstags- oder keine Geburtstagsinformationen zurück. |
|
|
Datenbank
|
database | string |
Geben Sie die Quelldatenbanken an, die amL überprüft werden sollen, wenn sie leer bleiben, werden alle Quelldatenbanken überprüft. Trennen Sie jeden Datenbankcode durch Komma, z. B. un_sc,us_ofac. Eine vollständige Liste der Quelldatenbanken und den entsprechenden Code finden Sie in der AML-API-Übersicht. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
aml
|
items | array of object |
Array, das eine Liste von AML-Übereinstimmungen enthält, gibt ein leeres Array zurück, wenn keine Übereinstimmung gefunden wurde. Spezifische Details finden Sie in der AML-API-Referenz. |
|
Entität
|
items.entity | string |
Person oder Rechtmäßigkeit |
|
Vollständiger Name
|
items.fullname | array of string |
Name der Person oder juristischen Person(n) |
|
Vorname
|
items.firstname | array of string |
Vorname(n) der Person |
|
Nachname
|
items.lastname | array of string |
Nachname(n) der Person |
|
Vorname
|
items.middlename | array of string |
Vorname(n) der Person |
|
alias
|
items.alias | array of string |
Alternative oder fremder Name(en) der Entität |
|
Rohdiamant
|
items.dob | array of string |
Perons Geburtstag könnte in den Formaten JJJJ, JJJJ-MM oder JJJJ-MM-DD kommen. |
|
address
|
items.address | array of string |
Adresse oder Wohnsitzland der Entität |
|
Nationalität
|
items.nationality | array of string |
Land oder Staatsangehörigkeit der Entität |
|
Geburtsort
|
items.birthplace | array of string |
Perons Geburtsstätte |
|
gender
|
items.gender | array of string |
Perons Geschlecht: M oder F |
|
Dokumentnummer
|
items.documentnumber | array of object |
Eine Liste der Dokumente, die der Entität zugeordnet sind. |
|
id
|
items.documentnumber.id | string |
Dokumentnummer |
|
id_formatted
|
items.documentnumber.id_formatted | string |
Alphanumerische Dokumentnummer |
|
country
|
items.documentnumber.country | string |
ISO2-Ländercode |
|
type
|
items.documentnumber.type | string |
P = Reisepassnummer, I = ID-Nummer, D = Führerscheinnummer, O = Anderer/unbekannter Dokumenttyp |
|
Programm
|
items.program | array of string |
Sanktionsprogramm(n) |
|
Anmerkung
|
items.note | array of string |
Zusätzliche Notiz für die Entität |
|
time
|
items.time | string |
UTC-TZ-Zeitstempel beim Hinzufügen der Entität zur Quellliste oder letzten Aktualisierung |
|
status
|
items.status | string |
Position/Titel der Entität oder des aktuellen Status der Sanktion |
|
source
|
items.source | array of string |
Eine Liste der offiziellen Quell-URL(n) |
|
Datenbank
|
items.database | string |
ID Analyzer AML-Datenbankcode |
|
schema
|
items.schema | string |
Eintrag aus Tresor löschen
Sie können einzelne oder mehrere Tresoreinträge löschen, indem Sie http POST-Anforderung senden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
id
|
id | True | array of string |
id |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Erfolgreich
|
success | integer |
Einträge auflisten und filtern
Um alle im Tresor gespeicherten Einträge auflisten oder nach Einträgen mit bestimmten Werten zu suchen, senden Sie eine HTTP POST-Anforderung an den folgenden Endpunkt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
orderby
|
orderby | string |
Name des Felds, das zum Sortieren des Ergebnisses verwendet wird. |
|
|
sort
|
sort | string |
ASC zum Sortieren von Ergebnissen in aufsteigender Reihenfolge, DESC zum Sortieren in absteigender Reihenfolge. |
|
|
Begrenzung
|
limit | integer |
Anzahl der zurückzugebenden Tresoreinträge. (1 bis 100) |
|
|
offset
|
offset | integer |
Zurückgeben einer Liste beginnend mit einem bestimmten Eintrag, z. B. wenn limit=10, um auf die dritte Seite der Ergebnisse zuzugreifen, verwenden Sie offset=20 |
|
|
Filter
|
filter | array of string |
Filter |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Begrenzung
|
limit | integer |
Aktueller Grenzwert |
|
offset
|
offset | integer |
Aktueller Offset |
|
nextoffset
|
nextoffset | integer |
Offsetwert für die nächste Datenmenge. Wenn die aktuelle Datenmenge die endgültige Datenmenge ist, wird dieses Feld nicht zurückgegeben. |
|
gesamt
|
total | integer |
Die Gesamtanzahl der gefundenen Einträge. |
|
items
|
items | array of |
Ein Array von Einträgen, die gefunden wurden, und deren vollständiger Inhalt, identisch mit dem inhalt, der von der GET-Methode zurückgegeben wird. |
Erstellen einer DocuPass-Signatursitzung
Sie können eine Signatursitzung erstellen, in der der Benutzer das legale Dokument ohne Identitätsüberprüfung überprüfen und signieren wird. Wenn Sie sowohl die Identitätsüberprüfung durchführen möchten als auch ihr Benutzer ein Dokument signieren soll, erstellen Sie stattdessen eine Identitätsüberprüfungssitzung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
Firmenname
|
companyname | True | string |
Ihr Firmenname wird auf der Gesamten Überprüfungsseite angezeigt, sodass der Endbenutzer weiß, dass er Identitätsinformationen an Ihr Unternehmen übermittelt. |
|
template_id
|
template_id | string |
Vertragsvorlagen-ID zum automatischen Ausfüllen mit Benutzerdaten. |
|
|
contract_format
|
contract_format | string |
Ausgabedokumentformat. (PDF, DOCX, HTML) |
|
|
callbackurl
|
callbackurl | string |
Die Vertragsdatei wird an diese URL gesendet. Sie müssen entweder vault_save aktivieren oder einen Rückruf angeben, damit Sie das generierte Dokument speichern können. |
|
|
successredir
|
successredir | string |
Der Browser wird an diese URL umgeleitet, nachdem das Dokument überprüft und signiert wurde. DocuPass-Referenzcode und customid werden am Ende der URL angefügt. |
|
|
customid
|
customid | string |
Eine benutzerdefinierte Zeichenfolge, die an die Rückruf-URL Ihres Servers zurückgesendet und an Umleitungs-URLs angefügt wird, die von successredir und failredir als Abfragezeichenfolge festgelegt wurden. Es ist nützlich, den Benutzer in Ihrer Datenbank zu identifizieren. Dieser Wert wird unter docupass_customid unter Vault gespeichert. |
|
|
mehrweg
|
reusable | boolean |
Durch das Nabling dieses Parameters können mehrere Benutzer Dokumente über dieselbe URL überprüfen und signieren. Für jeden Benutzer wird automatisch ein neuer DocuPass-Referenzcode generiert. |
|
|
sms_contract_link
|
sms_contract_link | string |
Vollständige internationale Mobiltelefonnummer |
|
|
vault_save
|
vault_save | boolean |
Speichern Sie generiertes Dokument im Tresor. Sie müssen entweder vault_save aktivieren oder einen Rückruf angeben, damit Sie generiertes Dokument speichern können. |
|
|
nobranding
|
nobranding | boolean |
Brandinglogo auf allen DocuPass-Seiten ausblenden. |
|
|
customhtmlurl
|
customhtmlurl | string |
Verwenden Sie Ihre eigene HTML-Seite und CSS für DocuPass. Nachdem Sie Änderungen am HTML- und CSS-Code vorgenommen haben, müssen Sie sie auf Ihren eigenen Server hochladen, lädt docuPass zu Beginn jeder Sitzung die neueste HTML-Seite von Ihrem Server herunter. |
|
|
language
|
language | string |
DocuPass erkennt automatisch die Sprache des Benutzergeräts und zeigt die entsprechende Sprache an. Legen Sie diesen Parameter fest, um die automatische Spracherkennung außer Kraft zu setzen. (en, fr, nl, de, es, zh-TW, zh-CN) |
|
|
expiry
|
expiry | integer |
Die Anzahl der Sekunden, bevor die DocuPass-Sitzung abläuft. Nach Ablauf kann der Benutzer nicht mit der aktuellen Sitzung fortfahren, ein fehlgeschlagener Rückruf wird ebenfalls gesendet. |
|
|
qr_color
|
qr_color | string |
Farbe des QR-Code-Vordergrunds |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Farbe des QR-Code-Hintergrunds |
|
|
qr_size
|
qr_size | integer |
Größe des QR-Codes |
|
|
qr_margin
|
qr_margin | integer |
Rahmenstärke des QR-Codes |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
reference
|
reference | string |
Ein eindeutiger Referenzcode für die DocuPass-Sitzung. |
|
customid
|
customid | string |
Benutzerdefinierte ID, die beim Erstellen der DocuPass-Sitzung verwendet wird. |
|
URL
|
url | string |
Eindeutige URL zur DocuPass-Web-App. Senden Sie diesen Link an Ihren Benutzer, oder betten Sie ihn in Ihre Website oder mobile App ein, um das Dokument zu überprüfen und zu signieren. |
|
qrcode
|
qrcode | string |
QR-Codebild-URL für den Benutzer zum Scannen |
|
base_url
|
base_url | string |
Sie können diesen Link an Ihren Benutzer senden und ihn bitten, referenzierten Code einzugeben, um Dokumente zu signieren. |
|
html_qrcode
|
html_qrcode | string |
Beispiel-HTML zum Anzeigen von QR-Code auf Ihrer Webseite. |
|
html_iframe
|
html_iframe | string |
Beispiel-HTML zum Einfügen von iframe in Ihre Webseite. |
|
smssent
|
smssent | string |
Enthält die Telefonnummer als Bestätigung, wenn SMS erfolgreich über sms_contract_link Parameter gesendet wurde. |
|
expiry
|
expiry | integer |
UTC UNIX-Zeitstempel, der angibt, wann diese Sitzung abläuft, nach Ablauf kann der Benutzer den Link nicht mehr verwenden, und ein fehlgeschlagener Rückruf wird gesendet. |
Erstellen einer DocuPass-Sitzung
Sie können eine Überprüfungssitzung für jeden Benutzer erstellen, der eine Identitätsüberprüfung erfordert.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
type
|
type | integer |
0: Iframe Module ,1: Mobiles Modul, 2: Redirection Module, 3: Live Mobile Module |
|
|
Firmenname
|
companyname | True | string |
Ihr Unternehmen oder Produktname. |
|
callbackurl
|
callbackurl | string |
Webhook/Rückruf-URL zum Empfangen des Überprüfungsergebnisses. |
|
|
biometrisch
|
biometric | integer |
Bitten Sie den Benutzer, ein Selfie-Foto oder Selfie-Video zur Gesichtsüberprüfung aufzunehmen. |
|
|
biometric_threshold
|
biometric_threshold | float |
Geben Sie die Mindestbewertung an, um die biometrische Gesichtsüberprüfung zu bestehen. |
|
|
authenticate_minscore
|
authenticate_minscore | float |
Das Dokument muss die Mindestauthentifizierungsbewertung erfüllen, um die Überprüfung zu bestehen. Legen Sie "0" fest, um die Gültigkeits-/Echtheitsprüfung zu deaktivieren. |
|
|
authenticate_module
|
authenticate_module | integer |
Geben Sie das Modul an, das zum Überprüfen des Dokuments verwendet wird. |
|
|
maxattempt
|
maxattempt | integer |
Die Anzahl der maximalen Fehlerversuche für jede Überprüfungsanforderung. |
|
|
successredir
|
successredir | string |
Der Browser wird an diese URL umgeleitet, wenn die Identitätsüberprüfung erfolgreich ist. |
|
|
failredir
|
failredir | string |
Der Browser wird an diese URL umgeleitet, wenn die Identitätsüberprüfung fehlgeschlagen ist. |
|
|
customid
|
customid | string |
Es ist nützlich, den Benutzer in Ihrer Datenbank zu identifizieren. Dieser Wert wird unter docupass_customid unter Vault gespeichert. |
|
|
mehrweg
|
reusable | boolean |
Wenn Sie diesen Parameter aktivieren, können mehrere Benutzer ihre Identität über dieselbe URL überprüfen. Für jeden Benutzer wird automatisch ein neuer DocuPass-Referenzcode generiert. |
|
|
phoneverification
|
phoneverification | boolean |
Ob Der Benutzer zur Überprüfung aufgefordert werden soll, eine Telefonnummer einzugeben, unterstützt DocuPass sowohl die Überprüfung mobiler als auch die Festnetznummer. (Nur Abonnent) |
|
|
Dokumenttyp
|
documenttype | string |
Der Benutzer muss einen bestimmten Dokumenttyp hochladen. Beispielsweise würde "PD" sowohl Passport- als auch Treiberlizenz akzeptieren. |
|
|
documentcountry
|
documentcountry | string |
ISO ALPHA-2 Ländercode. |
|
|
documentregion
|
documentregion | string |
Vollständiger Name oder Abkürzung für Bundesland/Region. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Überprüfen Sie, ob die Namen, die Dokumentnummer und der Dokumenttyp bei der Dualseitigen Überprüfung zwischen der Vorderseite und der Rückseite des Dokuments übereinstimmen. Wenn informationen nicht übereinstimmen, wird Fehler 14 ausgelöst. |
|
|
verify_expiry
|
verify_expiry | boolean |
Nur Dokument akzeptieren, das nicht abgelaufen ist |
|
|
verify_documentno
|
verify_documentno | string |
Dokumentnummer, die eine Überprüfung erfordert. |
|
|
verify_name
|
verify_name | string |
Vollständiger Name einschließlich Vorname und Nachname, der eine Überprüfung erfordert. |
|
|
verify_dob
|
verify_dob | string |
Geburtsdatum, das eine Überprüfung erfordert, im Format JJJJ/MM/TT. |
|
|
verify_age
|
verify_age | string |
Altersbereich, Beispiel: 18-40 |
|
|
verify_address
|
verify_address | string |
Vollständige Adresse, die eine Überprüfung erfordert. |
|
|
verify_postcode
|
verify_postcode | string |
Vollständige Postleitzahl, die eine Überprüfung erfordert. |
|
|
verify_phone
|
verify_phone | string |
Vollständige Telefonnummer, die eine Überprüfung erfordert. |
|
|
vault_save
|
vault_save | boolean |
Speichern Sie Benutzerdokumente und analysierte Informationen im Tresor. |
|
|
return_documentimage
|
return_documentimage | boolean |
Gibt das Dokumentbild zurück, das vom Benutzer in der Rückrufanforderung hochgeladen wurde. |
|
|
return_faceimage
|
return_faceimage | boolean |
Das Von Einem Benutzer in der Rückrufanforderung hochgeladene Gesichtsbild wird zurückgegeben. |
|
|
return_type
|
return_type | integer |
Geben Sie den Typ des zurückgegebenen Bilds an, entweder base64-codierte Bildinhalte oder eine URL zum Bild. (DIE URL zum Bild wird nur 7 Tage lang aufbewahrt) |
|
|
welcomemessage
|
welcomemessage | string |
Ersetzen Sie die generische Begrüßungsnachricht auf der ersten Seite durch Ihren angepassten Text (max. 1.000 Zeichen) |
|
|
nobranding
|
nobranding | boolean |
Brandinglogo auf allen DocuPass-Seiten ausblenden. (Nur Abonnent) |
|
|
logo
|
logo | string |
Benutzerdefiniertes Brandinglogo. (Nur Abonnent) |
|
|
customhtmlurl
|
customhtmlurl | string |
Verwenden Sie Ihre eigene HTML-Seite und CSS für DocuPass. (Nur Abonnent) |
|
|
language
|
language | string |
DocuPass erkennt automatisch die Sprache des Benutzergeräts und zeigt die entsprechende Sprache an. |
|
|
expiry
|
expiry | integer |
Die Anzahl der Sekunden, bevor die DocuPass-Sitzung abläuft. Nach Ablauf kann der Benutzer nicht mit der aktuellen Sitzung fortfahren, ein fehlgeschlagener Rückruf wird ebenfalls gesendet. |
|
|
qr_color
|
qr_color | string |
Farbe des QR-Code-Vordergrunds. (Nur für Live Mobile und Standard Mobile) |
|
|
qr_bgcolor
|
qr_bgcolor | string |
Farbe des QR-Codehintergrunds. (Nur für Live Mobile und Standard Mobile) |
|
|
qr_size
|
qr_size | integer |
Größe des QR-Codes(1-50). (Nur für Live Mobile und Standard Mobile) |
|
|
qr_margin
|
qr_margin | integer |
Rahmenstärke des QR-Codes(1-50). (Nur für Live Mobile und Standard Mobile) |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
reference
|
reference | string |
Ein eindeutiger Referenzcode für die DocuPass-Sitzung. |
|
type
|
type | integer |
DocuPass-Modultyp erstellt. |
|
customid
|
customid | string |
Benutzerdefinierte ID, die beim Erstellen der DocuPass-Sitzung verwendet wird. |
|
URL
|
url | string |
Eindeutige URL zur DocuPass-Web-App. Senden Sie diesen Link an Ihren Benutzer, oder betten Sie ihn in Ihre Website oder mobile App ein, um die Identitätsüberprüfung zu starten. |
|
qrcode
|
qrcode | string |
QR-Codebild-URL für den Benutzer zum Scannen |
|
base_url
|
base_url | string |
Sie können diesen Link an Ihren Benutzer senden und ihn bitten, den Referenzcode einzugeben, um die Überprüfung zu starten. |
|
HTML
|
html | string |
Beispiel-HTML, die Sie in Ihre Webseite einfügen können. |
|
smssent
|
smssent | integer |
Enthält die Telefonnummer als Bestätigung, wenn SMS erfolgreich über sms_verification_link Parameter gesendet wurde. |
|
expiry
|
expiry | integer |
UTC UNIX-Zeitstempel, der angibt, wann diese Sitzung abläuft, nach Ablauf kann der Benutzer den Link nicht mehr verwenden, und ein fehlgeschlagener Rückruf wird gesendet. |
Gesichtssuche
Mithilfe der Gesichtssuche können Sie den gesamten Tresor mithilfe eines Bilds einer Person durchsuchen. Um die Gesichtssuche zu verwenden, müssen Sie die Indizierung der Gesichtssuche im Webportal aktivieren und Ihre Tresor-Datasets regelmäßig trainieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
image
|
image | string |
Base64-codierte Bilddaten. |
|
|
imageurl
|
imageurl | string |
Remotebild-URL. |
|
|
maxentry
|
maxentry | integer |
Anzahl der übereinstimmenden Einträge, die zurückgegeben werden sollen, zwischen 1 und 10. |
|
|
threshold
|
threshold | float |
Legen Sie im Bereich von 0 bis 1 die mindeste Ähnlichkeitsbewertung für Gesichtsähnlichkeiten fest. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
items
|
items | array of |
Wenn übereinstimmende Einträge gefunden werden, wird eine Liste von Dokumenten mit vollständigem Inhalt ähnlich wie der Listenbefehl zurückgegeben. |
Kern-API-Einstellung
Multi-Function ID verification API to verify remote physical document, its authenticity and face match the document with your user photo.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
file_base64
|
file_base64 | string |
Sie können ein base64-codiertes Bild als Zeichenfolge mithilfe von Application/x-www-form-urlencoded oder application/json hochladen. |
|
|
URL
|
url | string |
Die Core-API kann Remoteimages von Ihrem Server herunterladen. |
|
|
file_back_base64
|
file_back_base64 | string |
Base64-codiertes Bild der Rückseite des Dokuments, um einen dualen Scan durchzuführen. |
|
|
url_back
|
url_back | string |
Remotebild der Rückseite des Dokuments, um einen dualseitigen Scan durchzuführen. |
|
|
face_base64
|
face_base64 | string |
Base64-codiertes Bild des Gesichts einer Person, um eine biometrische Fotoüberprüfung durchzuführen. |
|
|
faceurl
|
faceurl | string |
Remotebild des Gesichts einer Person, um eine biometrische Fotoüberprüfung durchzuführen. |
|
|
video_base64
|
video_base64 | string |
Base64-codierte Selfie-Video zur Durchführung der biometrischen Videoüberprüfung. |
|
|
videourl
|
videourl | string |
Remote gehostetes Selfie-Video, um video biometrische Überprüfung durchzuführen. |
|
|
Kenncode
|
passcode | string |
4-stellige Zahl |
|
|
Genauigkeit
|
accuracy | integer |
Konfigurieren Sie die Geschwindigkeit und Genauigkeit der Dokumenterkennungs- und Ocr-Ergebnisse. Niedrige Genauigkeit reduziert die Reaktionszeit auf unter 1 Sekunde, während eine hohe Genauigkeit in der Regel 2~3 Sekunden dauert. |
|
|
authenticate
|
authenticate | boolean |
Überprüfen Sie das Dokument, um zu überprüfen, ob das Dokument authentifiziert ist und nicht manipuliert wurde. |
|
|
authenticate_module
|
authenticate_module | string |
Geben Sie das Modul an, das zum Überprüfen des Dokuments verwendet wird. |
|
|
biometric_threshold
|
biometric_threshold | float |
Geben Sie die Mindestbewertung an, um die biometrische Gesichtsüberprüfung zu bestehen. |
|
|
return_confidence
|
return_confidence | boolean |
Gibt konfidenzbewertung für jedes Datenfeld zurück. |
|
|
return_empty
|
return_empty | boolean |
Sie können die API abrufen, um NULL für leere Felder zurückzugeben, indem Sie diesen Parameter aktivieren. |
|
|
ocr_scaledown
|
ocr_scaledown | integer |
Zahl zwischen 500 und 4000 oder 0 |
|
|
outputimage
|
outputimage | boolean |
Erstellen Sie ein zugeschnittenes Bild des Dokuments. |
|
|
outputface
|
outputface | boolean |
Erstellen Sie ein zugeschnittenes Bild des Gesichtsbereichs im Dokument. |
|
|
outputmode
|
outputmode | string |
Geben Sie das zugeschnittene Dokument und das Gesicht entweder als URL oder base64-codierte Inhalte aus. |
|
|
dualsidecheck
|
dualsidecheck | boolean |
Überprüfen Sie, ob die Namen, die Dokumentnummer und der Dokumenttyp bei der Dualseitigen Überprüfung zwischen der Vorderseite und der Rückseite des Dokuments übereinstimmen. Wenn informationen nicht übereinstimmen, wird Fehler 14 ausgelöst. |
|
|
verify_expiry
|
verify_expiry | boolean |
Überprüfen Sie, ob das Dokument weiterhin gültig ist, basierend auf seinem Ablaufdatum. |
|
|
verify_documentno
|
verify_documentno | string |
Überprüfen Sie, ob die angegebene Dokumentnummer mit dem Dokument übereinstimmt. |
|
|
verify_dob
|
verify_dob | string |
Überprüfen Sie, ob das angegebene Geburtsdatum mit dem Dokument übereinstimmt. (JJJJ/MM/TT) |
|
|
verify_age
|
verify_age | string |
Überprüfen Sie, ob der Dokumenthalter zwischen dem angegebenen Bereich alt ist. (Bereich, Beispiel: 18-40) |
|
|
verify_address
|
verify_address | string |
Überprüfen Sie, ob die angegebene Adresse mit dem Dokument übereinstimmt. |
|
|
verify_postcode
|
verify_postcode | string |
Überprüfen Sie, ob die angegebenen Postleitzahlen mit dem Dokument übereinstimmen. |
|
|
country
|
country | string |
Überprüfen Sie, ob das Dokument von bestimmten Ländern ausgestellt wurde, wenn der Fehlercode 10 nicht ausgelöst wird. Trennen Sie mehrere Werte durch Komma. Beispielsweise würde "US,CA" Dokumente aus den USA und Kanada akzeptieren. |
|
|
region
|
region | string |
Überprüfen Sie, ob das Dokument vom angegebenen Zustand ausgegeben wurde, wenn kein Fehlercode 11 ausgelöst wird. Trennen Sie mehrere Werte durch Komma. Beispielsweise würde "CA,TX" Dokumente aus Kalifornien und Texas akzeptieren. |
|
|
type
|
type | string |
Überprüfen Sie, ob das Dokument eines der angegebenen Typen war, wenn kein Fehlercode 12 ausgelöst wird. Beispielsweise würde "PD" sowohl Passport- als auch Treiberlizenz akzeptieren. |
|
|
Checkblocklist
|
checkblocklist | boolean |
Überprüfen Sie die Dokumentdaten anhand blockierter Einträge in Ihrem Tresor. Wenn das Dokument mit einem der Fehler "Blockierter Eintrag" übereinstimmt, wird 15 ausgelöst. |
|
|
vault_save
|
vault_save | boolean |
Speichern Sie Das Dokumentbild und analysierte Informationen in Ihrem gesicherten Tresor. Sie können Dokumenteinträge in Ihrem Tresor über die Vault-API oder das Webportal auflisten, durchsuchen und aktualisieren. |
|
|
vault_saveunrecognized
|
vault_saveunrecognized | boolean |
Speichern Sie das Dokumentbild im Tresor, auch wenn das Dokument nicht erkannt werden kann. |
|
|
vault_noduplicate
|
vault_noduplicate | boolean |
Verhindern, dass duplizierte Bilder gespeichert werden. |
|
|
vault_automerge
|
vault_automerge | boolean |
Automatisches Zusammenführen von Bildern mit derselben Dokumentnummer in einen einzelnen Eintrag im Tresor. |
|
|
vault_customdata1
|
vault_customdata1 | string |
Fügen Sie bis zu 5 benutzerdefinierte Zeichenfolgen hinzu, die dem Tresoreintrag zugeordnet werden, dies kann zum Filtern und Durchsuchen von Einträgen hilfreich sein. |
|
|
vault_customdata2
|
vault_customdata2 | string |
Fügen Sie bis zu 5 benutzerdefinierte Zeichenfolgen hinzu, die dem Tresoreintrag zugeordnet werden, dies kann zum Filtern und Durchsuchen von Einträgen hilfreich sein. |
|
|
vault_customdata3
|
vault_customdata3 | string |
Fügen Sie bis zu 5 benutzerdefinierte Zeichenfolgen hinzu, die dem Tresoreintrag zugeordnet werden, dies kann zum Filtern und Durchsuchen von Einträgen hilfreich sein. |
|
|
vault_customdata4
|
vault_customdata4 | string |
Fügen Sie bis zu 5 benutzerdefinierte Zeichenfolgen hinzu, die dem Tresoreintrag zugeordnet werden, dies kann zum Filtern und Durchsuchen von Einträgen hilfreich sein. |
|
|
vault_customdata5
|
vault_customdata5 | string |
Fügen Sie bis zu 5 benutzerdefinierte Zeichenfolgen hinzu, die dem Tresoreintrag zugeordnet werden, dies kann zum Filtern und Durchsuchen von Einträgen hilfreich sein. |
|
|
aml_check
|
aml_check | boolean |
Überprüfen Sie den Namen und die Dokumentnummer des Dokumentinhabers anhand der AML-Datenbank des ID Analyzers. |
|
|
aml_database
|
aml_database | string |
Trennen Sie jeden Datenbankcode durch Komma, z. B. un_sc,us_ofac. |
|
|
aml_strict_match
|
aml_strict_match | boolean |
Aktivieren Sie diesen Parameter, um falsch positive Ergebnisse nur durch übereinstimmende Entitäten mit exakt der gleichen Nationalität und demselben Geburtstag zu reduzieren. |
|
|
contract_generate
|
contract_generate | string |
Vertragsvorlagen-ID zum automatischen Ausfüllen mit Benutzerdaten. |
|
|
contract_format
|
contract_format | string |
Ausgabedokumentformat. Optionals: PDF, DOCX, HTML. |
|
|
contract_prefill_data
|
contract_prefill_data | object |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
documentNumber
|
result.documentNumber | string |
Eindeutiger Bezeichner, der dem Dokument zugeordnet ist (z. B. Passport No./Driver License No./Card Number usw.) |
|
personalNumber
|
result.personalNumber | string |
Eindeutige persönliche ID, die der Person innerhalb eines Landes zugeordnet ist (z. B. Nationale ID-Nummer) |
|
Vorname
|
result.firstName | string |
Vorname/ Vorname |
|
lastName
|
result.lastName | string |
Nachname/ Familienname |
|
MiddleName
|
result.middleName | string |
Zweiter Vorname(n) |
|
fullName
|
result.fullName | string |
Wenn der Vorname und der Nachname nicht unterschieden werden können, wird stattdessen der vollständige Name zurückgegeben. |
|
firstName_local
|
result.firstName_local | string |
Vorname in lokaler Sprache, falls verfügbar |
|
lastName_local
|
result.lastName_local | string |
Nachname in lokaler Sprache, falls verfügbar |
|
middleName_local
|
result.middleName_local | string |
Zweiter Name in lokaler Sprache, falls verfügbar |
|
fullName_local
|
result.fullName_local | string |
Vollständiger Name in der lokalen Sprache, falls verfügbar |
|
Sex
|
result.sex | string |
Geschlecht M=Männlich F=Weibliche x=nicht spezifiziert |
|
height
|
result.height | string |
Höhe der Person |
|
weight
|
result.weight | string |
Gewicht der Person |
|
hairColor
|
result.hairColor | string |
Haarfarbe - ANSI D-20 Haarfarbcode (3 Buchstaben) |
|
eyeColor
|
result.eyeColor | string |
Augenfarbe - ANSI D-20 Eye Color Code (3 Buchstaben) |
|
Alter
|
result.age | integer |
Alter des Dokumentinhabers |
|
Rohdiamant
|
result.dob | string |
Geburtsdatum in JJJJ/MM/TT |
|
dob_day
|
result.dob_day | integer |
Geburtsdatum 1 bis 31 |
|
dob_month
|
result.dob_month | integer |
Geburtsdatum 1 bis 12 |
|
dob_year
|
result.dob_year | integer |
Geburtsdatum in JJJJ |
|
expiry
|
result.expiry | string |
Ablaufdatum des Dokuments in JJJJ/MM/TT |
|
expiry_day
|
result.expiry_day | integer |
Ablauftag 1 bis 31 |
|
expiry_month
|
result.expiry_month | integer |
Monat des Ablaufs von 1 bis 12 |
|
expiry_year
|
result.expiry_year | integer |
Ablaufjahr in JJJJ |
|
daysToExpiry
|
result.daysToExpiry | integer |
Anzahl der Tage vor Ablauf des Dokuments |
|
ausgestellt
|
result.issued | string |
Ausgabedatum in JJJJ/MM/TT |
|
issued_day
|
result.issued_day | integer |
Tag der Ausgabe 1 bis 31 |
|
issued_month
|
result.issued_month | integer |
Monat der Ausgabe 1 bis 12 |
|
issued_year
|
result.issued_year | integer |
Jahr der Ausgabe in JJJJ |
|
daysFromIssue
|
result.daysFromIssue | integer |
Anzahl der Tage seit der Ausstellung des Dokuments |
|
Adresse1
|
result.address1 | string |
Adresszeile 1 |
|
adresse2
|
result.address2 | string |
Adresszeile 2 |
|
Postleitzahl
|
result.postcode | string |
Adresspostcode |
|
placeOfBirth
|
result.placeOfBirth | string |
Geburtsort |
|
vehicleClass
|
result.vehicleClass | string |
Fahrzeugklasse Fahrerlizenz |
|
Einschränkungen
|
result.restrictions | string |
Einschränkungen für Treiberlizenzen |
|
Unterstützung
|
result.endorsement | string |
Unterstützung der Treiberlizenz |
|
optionalData
|
result.optionalData | string |
Zusätzliche nicht spezifische Daten, die im Dokument enthalten sind |
|
optionalData2
|
result.optionalData2 | string |
Zusätzliche nicht spezifische Daten, die im Dokument enthalten sind |
|
documentType
|
result.documentType | string |
Dokumenttyp: P=Passport, D=Führerschein, I=Identitätskarte, V=Visum, R=Aufenthaltskarte, O=Andere |
|
documentSide
|
result.documentSide | string |
Seite des Dokuments: FRONT, BACK oder BIODATA |
|
issuerOrg_region_full
|
result.issuerOrg_region_full | string |
Dokumentherausgeber-Unterregion/Status. (z. B. Kalifornien) |
|
issuerOrg_region_abbr
|
result.issuerOrg_region_abbr | string |
Abkürzung für Dokumentherausgeber-Unterregion/Bundesland. (z. B. CA) |
|
issuerOrg_full
|
result.issuerOrg_full | string |
Ausgestelltes Dokument. (z. B. Vereinigte Staaten) |
|
issuerOrg_iso2
|
result.issuerOrg_iso2 | string |
Dokument ausgestellter Ländercode in ISO2. (z. B. US) |
|
issuerOrg_iso3
|
result.issuerOrg_iso3 | string |
Dokument ausgestellter Ländercode in ISO3. (z.B. USA) |
|
nationality_full
|
result.nationality_full | string |
Staatsangehörigkeit des Dokumentinhabers. (z. B. Vereinigte Staaten) |
|
nationality_iso2
|
result.nationality_iso2 | string |
Staatsangehörigkeit des Dokumentinhabers in ISO2. (z. B. US) |
|
nationality_iso3
|
result.nationality_iso3 | string |
Staatsangehörigkeit des Dokumentinhabers in ISO3. (z.B. USA) |
|
internalId
|
result.internalId | string |
Wird verwendet, um die eindeutige Dokument-ID unter dem ID Analyzer-System zu identifizieren, sollte derselbe Dokumenttyp dieselbe ID aufweisen. |
|
documentNumber
|
confidence.documentNumber | float |
Konfidenzstufe von documentNumber |
|
Vorname
|
confidence.firstName | float |
Konfidenzniveau von FirstName |
|
lastName
|
confidence.lastName | float |
Konfidenzstufe des Nachnamens /Familienname |
|
MiddleName
|
confidence.middleName | float |
Konfidenzniveau der Zweiten Namen(n) |
|
dob_month
|
confidence.dob_month | float |
Konfidenzniveau der dob_month |
|
dob_day
|
confidence.dob_day | float |
Konfidenzniveau der dob_day |
|
dob_year
|
confidence.dob_year | float |
Konfidenzniveau der dob_year |
|
issued_month
|
confidence.issued_month | float |
Konfidenzniveau der issued_month |
|
issued_day
|
confidence.issued_day | float |
Konfidenzniveau der issued_day |
|
issued_year
|
confidence.issued_year | float |
Konfidenzniveau der issued_year |
|
expiry_month
|
confidence.expiry_month | float |
Konfidenzniveau der expiry_month |
|
expiry_day
|
confidence.expiry_day | float |
Konfidenzniveau der expiry_day |
|
expiry_year
|
confidence.expiry_year | float |
Konfidenzniveau der expiry_year |
|
Sex
|
confidence.sex | float |
Konfidenzniveau des Geschlechts |
|
height
|
confidence.height | float |
Konfidenzniveau der Höhe |
|
weight
|
confidence.weight | float |
Konfidenzniveau der Gewichtung |
|
Adresse1
|
confidence.address1 | float |
Konfidenzniveau der Adresse1 |
|
adresse2
|
confidence.address2 | float |
Konfidenzniveau der Adresse2 |
|
Postleitzahl
|
confidence.postcode | float |
Konfidenzniveau der Postleitzahl |
|
vehicleClass
|
confidence.vehicleClass | float |
Konfidenzniveau der vehicleClass |
|
Einschränkungen
|
confidence.restrictions | float |
Konfidenzniveau von Einschränkungen |
|
Unterstützung
|
confidence.endorsement | float |
Konfidenzniveau der Bestätigung |
|
eyeColor
|
confidence.eyeColor | float |
Konfidenzniveau von eyeColor |
|
Alter
|
confidence.age | float |
Konfidenzniveau des Alters |
|
Rohdiamant
|
confidence.dob | float |
Konfidenzniveau der Dob |
|
daysToExpiry
|
confidence.daysToExpiry | float |
Konfidenzniveau von daysToExpiry |
|
expiry
|
confidence.expiry | float |
Konfidenzniveau des Ablaufs |
|
ausgestellt
|
confidence.issued | float |
Konfidenzniveau der ausgestellten |
|
daysFromIssue
|
confidence.daysFromIssue | float |
Konfidenzniveau von daysFromIssue |
|
fullName
|
confidence.fullName | float |
Konfidenzniveau von fullName |
|
isIdentical
|
face.isIdentical | boolean |
Biometrische Überprüfung bestanden oder fehlgeschlagen |
|
Vertrauen
|
face.confidence | string |
Wert zwischen 0 und 1, wie ähnlich die beiden Gesichter sind, 1 ist identisch. |
|
Fehler
|
face.error | integer |
Fehlercode |
|
error_message
|
face.error_message | string |
Fehlermeldung. Beispiel: Gesichtsdaten im Gesichtsbild konnten nicht gefunden werden. |
|
verabschiedet
|
verification.passed | boolean |
Wenn das Dokument alle Überprüfungen bestanden hat, wird "true" zurückgegeben. Wenn das Dokument mindestens einen Überprüfungstyp fehlgeschlagen ist, wird "false" zurückgegeben. |
|
Gesicht
|
verification.result.face | boolean |
Wenn die biometrische Überprüfung aktiviert ist, ob die Ähnlichkeitsvertrauensbewertung über dem festgelegten Schwellenwert liegt. |
|
nicht abgelaufen
|
verification.result.notexpired | boolean |
Gibt an, ob das Dokument noch nicht abgelaufen ist. |
|
name
|
verification.result.name | boolean |
Gibt an, ob der angegebene Name mit dem aus der ID analysierten Namen übereinstimmt. |
|
Rohdiamant
|
verification.result.dob | boolean |
Gibt an, ob der Geburtstag mit der aus der ID analysierten Geburtstag übereinstimmt. |
|
documentNumber
|
verification.result.documentNumber | boolean |
Gibt an, ob die angegebene Dokumentnummer mit der anhand der ID analysierten Dokumentnummer übereinstimmt. |
|
Postleitzahl
|
verification.result.postcode | boolean |
Gibt an, ob die angegebene Postleitzahl mit der von der ID analysierten Postleitzahl übereinstimmt. |
|
address
|
verification.result.address | boolean |
Gibt an, ob die angegebene Adresse mit der von der ID analysierten Adresse übereinstimmt. |
|
checkdigit
|
verification.result.checkdigit | boolean |
Wenn der Dokumenttyp über einen Prüfziffern-/Soundex-Algorithmus verfügt, ob die Prüfziffern gültig sind. |
|
Alter
|
verification.result.age | boolean |
Gibt an, ob sich der Dokumenthalter innerhalb des festgelegten Altersbereichs befindet. |
|
cccode
|
verification.result.cccode | boolean |
Wenn der Typ des Dokuments eine Implementierung des chinesischen Handelscodes (CC-Code) aufweist, ob die CC-Codes gültig sind. |
|
score
|
authentication.score | float |
Die Bewertung ist ein Gleitkomma zwischen 0 und 1. Gültige Dokumente haben eine Bewertung näher an 1, während gefälschte oder bearbeitete Dokumente eine Bewertung näher an 0 haben. Es ist Ihr Ermessen, die Grenze zu entscheiden, ein guter Ausgangspunkt wäre, die Bewertung unter 0,5 abzulehnen. |
|
verabschiedet
|
authentication.breakdown.data_visibility.passed | boolean | |
|
verabschiedet
|
authentication.breakdown.image_quality.passed | boolean | |
|
verabschiedet
|
authentication.breakdown.feature_referencing.passed | boolean | |
|
verabschiedet
|
authentication.breakdown.exif_check.passed | boolean | |
|
Code
|
authentication.breakdown.exif_check.code | integer | |
|
Grund
|
authentication.breakdown.exif_check.reason | string | |
|
severity
|
authentication.breakdown.exif_check.severity | string | |
|
verabschiedet
|
authentication.breakdown.publicity_check.passed | boolean | |
|
Code
|
authentication.breakdown.publicity_check.code | integer | |
|
Grund
|
authentication.breakdown.publicity_check.reason | string | |
|
severity
|
authentication.breakdown.publicity_check.severity | string | |
|
verabschiedet
|
authentication.breakdown.text_analysis.passed | boolean | |
|
verabschiedet
|
authentication.breakdown.biometric_analysis.passed | boolean | |
|
verabschiedet
|
authentication.breakdown.security_feature_check.passed | boolean | |
|
Code
|
authentication.breakdown.security_feature_check.code | integer | |
|
Grund
|
authentication.breakdown.security_feature_check.reason | string | |
|
severity
|
authentication.breakdown.security_feature_check.severity | string | |
|
verabschiedet
|
authentication.breakdown.recapture_check.passed | boolean | |
|
Code
|
authentication.breakdown.recapture_check.code | integer | |
|
Grund
|
authentication.breakdown.recapture_check.reason | string | |
|
severity
|
authentication.breakdown.recapture_check.severity | string | |
|
warning
|
authentication.warning | array of string |
Array von Zeichenfolgen, die Warnmeldungen zur Gültigkeit des Dokuments enthalten. |
|
aml
|
aml | array of object |
Array, das eine Liste von AML-Übereinstimmungen enthält, gibt ein leeres Array zurück, wenn keine Übereinstimmung gefunden wurde. Spezifische Details finden Sie in der AML-API-Referenz. |
|
Entität
|
aml.entity | string |
Person oder Rechtmäßigkeit |
|
Vollständiger Name
|
aml.fullname | array of string |
Name der Person oder juristischen Person(n) |
|
Vorname
|
aml.firstname | array of string |
Vorname(n) der Person |
|
Nachname
|
aml.lastname | array of string |
Nachname(n) der Person |
|
Vorname
|
aml.middlename | array of string |
Vorname(n) der Person |
|
alias
|
aml.alias | array of string |
Alternative oder fremder Name(en) der Entität |
|
Rohdiamant
|
aml.dob | array of string |
Perons Geburtstag könnte in den Formaten JJJJ, JJJJ-MM oder JJJJ-MM-DD kommen. |
|
address
|
aml.address | array of string |
Adresse oder Wohnsitzland der Entität |
|
Nationalität
|
aml.nationality | array of string |
Land oder Staatsangehörigkeit der Entität |
|
Geburtsort
|
aml.birthplace | array of string |
Perons Geburtsstätte |
|
gender
|
aml.gender | array of string |
Perons Geschlecht: M oder F |
|
Dokumentnummer
|
aml.documentnumber | array of object |
Eine Liste der Dokumente, die der Entität zugeordnet sind. |
|
id
|
aml.documentnumber.id | string |
Dokumentnummer |
|
id_formatted
|
aml.documentnumber.id_formatted | string |
Alphanumerische Dokumentnummer |
|
country
|
aml.documentnumber.country | string |
ISO2-Ländercode |
|
type
|
aml.documentnumber.type | string |
P = Reisepassnummer, I = ID-Nummer, D = Führerscheinnummer, O = Anderer/unbekannter Dokumenttyp |
|
Programm
|
aml.program | array of string |
Sanktionsprogramm(n) |
|
Anmerkung
|
aml.note | array of string |
Zusätzliche Notiz für die Entität |
|
time
|
aml.time | string |
UTC-TZ-Zeitstempel beim Hinzufügen der Entität zur Quellliste oder letzten Aktualisierung |
|
status
|
aml.status | string |
Position/Titel der Entität oder des aktuellen Status der Sanktion |
|
source
|
aml.source | array of string |
Eine Liste der offiziellen Quell-URL(n) |
|
Datenbank
|
aml.database | string |
ID Analyzer AML-Datenbankcode |
|
schema
|
aml.schema | string | |
|
document_url
|
contract.document_url | string |
URL zum generierten Dokument |
|
Fehler
|
contract.error | string |
Falls der Vertrag nicht generiert werden konnte, enthält dieses Feld einen Grund wie "Ungültige Vertragsvorlagen-ID". |
|
vaultid
|
vaultid | string |
Eindeutiger Bezeichner für den Tresoreintrag, wenn vault_save aktiviert ist. |
|
Übereinstimmungrate
|
matchrate | float |
Das Verhältnis von Feldern, die von der API erfolgreich erkannt wurden, würde ein niedriges Verhältnis darauf hindeuten, dass das Dokumentbild zu verschwommen ist. |
|
output
|
output | string |
Wenn "outputimage" auf "true" festgelegt ist und "outputmode" die URL ist, enthält dieses Feld eine URL (oder ein Array von URLs für den Dualside-Scan), der auf das zugeschnittene Dokumentbild zeigt. Der Link ist nur für 600 Sekunden garantiert und wird jederzeit entfernt. |
|
outputface
|
outputface | string |
Wenn "outputface" auf "true" festgelegt ist und "outputmode" die URL ist, enthält dieses Feld eine URL, die auf das zugeschnittene Gesichtsbild zeigt. Der Link ist nur für 600 Sekunden garantiert und wird jederzeit entfernt. |
|
abgeschnitten
|
cropped | string |
Wenn "outputimage" auf "true" festgelegt ist und "outputmode" base64 ist, enthält dieses Feld ein base64-codiertes Bild (oder ein Array von base64-codierten Bildern für den Dualside-Scan) des zugeschnittenen Dokuments im JPEG-Format. |
|
zugeschnittene Oberfläche
|
croppedface | string |
Wenn "outputface" auf "true" festgelegt ist und "outputmode" base64 ist, enthält dieses Feld ein base64-codiertes Bild des Bereichs zugeschnittener Gesichtsbereiche des Dokuments im JPEG-Format. |
|
Ausführungszeit
|
executionTime | float |
Zeitaufwand für den API-Vorgang in Sekunden. |
|
responseID
|
responseID | string |
Ein eindeutiger Bezeichner, um die Anforderung/Antwort zu identifizieren. |
|
quota
|
quota | integer |
Verbleibendes API-Kontingent, setzt zu Beginn jedes Monats für einen kostenlosen oder jährlichen Abonnent oder zu Beginn jedes Abrechnungszyklus für monatlichen Abonnenten zurück. Wenn Sie über einen Abonnementplan verfügen, wird Ihr monatliches Kontingent vor Ihrer Gutschrift verwendet. |
|
Danksagung
|
credit | integer |
Resttestguthaben für Ihr Konto. Wenn Sie über einen Abonnementplan verfügen, wird Ihr monatliches Kontingent vor Ihrer Gutschrift verwendet. |
Schulung zur Gesichtssuche
Bevor Sie die Gesichtssuche ausführen, müssen Sie einen Zugbefehl ausgeben, um die Dokumentdatensätze in Ihrem Tresor zu trainieren. Sie können Ihre Tresordaten auch über das Webportal trainieren. Die Schulungsaufgabe ist asynchron, die Schulungszeit hängt von der Anzahl der Tresoreinträge und -bilder ab. Es kann von mehreren Sekunden bis zu einer Stunde dauern.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Erfolgreich
|
success | integer |
Schulungsstatus
Überprüfen Sie, ob die Tresorschulung noch läuft oder abgeschlossen ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
status
|
status | string |
nottrained: Never trained, notstarted: Training is not running, running: Training is currently running, succeeded: Training succeeded, failed: Training failed |
|
startTime
|
startTime | string |
Zeitpunkt, zu dem die letzte Schulung in UTC gestartet wurde. |
|
statusChangeTime
|
statusChangeTime | string |
Uhrzeit für die letzte Statusänderung in UTC. |
|
lastSuccessTime
|
lastSuccessTime | string |
Zeit für die letzte erfolgreiche Schulung in UTC. |
|
Fehler
|
error | string |
Fehlermeldung, die mit dem Status "Fehlgeschlagener Schulung" verknüpft ist. |
Überprüfen des Rückrufs
Um sicherzustellen, dass die Daten von unserem Server gesendet wurden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
apikey
|
apikey | True | string |
Ihr privater API-Schlüssel ist im Webportal verfügbar. |
|
reference
|
reference | True | string |
Referenzcode, der in POST BODY empfangen wurde. |
|
hash
|
hash | True | string |
In POST BODY empfangener Hash. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Erfolgreich
|
success | boolean | |
|
reference
|
reference | string |
Referenzcode für die DocuPass-Sitzung |