Zum Hauptinhalt springen
Verwenden Sie diese config-Felder innerhalb jedes Elements des features-Arrays für POST /v3/workflows/ und PATCH /v3/workflows/{settings_uuid}/.
Die v3-Workflow-API erstellt einen linearen, knotenbasierten Workflow aus dem geordneten features-Array. Senden Sie Funktionen in der exakten Ausführungsreihenfolge.
Welche Engine eine Funktion ausführt – Didits eigene oder die eines Drittanbieters – ist keines der unten aufgeführten Konfigurationsfelder. Dies wird über den Marketplace der Konsole verwaltet, der provider_key und fallback_to_native im config-Objekt der Funktion für Sie festlegt.

Validierungsregeln

  • OCR verwendet standardmäßig alle unterstützten Länder und Dokumenttypen, wenn config.documents_allowed weggelassen wird, null oder {} ist. Wenn Sie ein benutzerdefiniertes documents_allowed-Objekt senden, muss es mindestens ein gültiges Land und einen aktivierten Dokumenttyp enthalten. Jede Dokumentkonfiguration kann sides auf 1 für die Erfassung nur der Vorderseite oder auf 2 für die Erfassung von Vorder- und Rückseite setzen.
  • QUESTIONNAIRE erfordert config.questionnaire_uuid.
  • KYB_DOCUMENTS erfordert config.kyb_required_document_groups.
  • SIGNATURE lehnt signature_level: "qes" mit qes_not_available ab, bis qualifizierte Signaturen verfügbar sind, und einen neuen Schritt mit signature_level: "aes" mit aes_not_available, solange signature_availability.aes im Workflow false ist. Seine Dokumente müssen vorhanden sein, wenn eine Sitzung erstellt wird: Wenn signature_documents_source auf workflow gesetzt ist, benötigt der Schritt in der Konsole hochgeladene Dokumente, und ein Schritt ohne Dokumente kann als Entwurf verbleiben, aber nicht live geschaltet werden; bei session muss jede Erstellungsanfrage sign.documents enthalten.
  • FACE_MATCH muss in einfachen Workflow-Anfragen nach OCR folgen.
  • NFC und DATABASE_VALIDATION erfordern OCR, wenn sie im selben Workflow vorkommen. AML benötigt eines von OCR, KYB_REGISTRY oder DOCUMENT_AI vor sich; wenn nur DOCUMENT_AI davor steht, muss der zu prüfende full_name befüllbar sein – entweder über ein vorgelagertes Document AI-Feld, das bereits den Schlüssel full_name trägt und automatisch zugeordnet wird, oder über einen expliziten Eintrag in config.aml_field_sources (siehe AML).
  • KYB-Unterfunktionen wie KYB_DOCUMENTS und KYB_KEY_PEOPLE erfordern KYB_REGISTRY an einer früheren Stelle im Workflow.
  • Ein Workflow ist entweder ein Personen-Workflow (KYC) oder ein Unternehmens-Workflow (KYB), niemals beides. Ein Workflow, der eine beliebige KYB-Funktion (KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE) verwendet, darf diese nur mit AML, DOCUMENT_AI, QUESTIONNAIRE, PHONE_VERIFICATION, EMAIL_VERIFICATION, IP_ANALYSIS und SIGNATURE kombinieren. Er darf keine reinen Personenfunktionen wie OCR, LIVENESS, FACE_MATCH, NFC, PROOF_OF_ADDRESS, DATABASE_VALIDATION oder AGE_ESTIMATION enthalten, und ein Personen-Workflow darf keine KYB-Funktionen enthalten. In einem Unternehmens-Workflow gleicht DOCUMENT_AI jedes als is_full_name gekennzeichnete Feld mit dem verifizierten Unternehmen statt mit einer Person ab. Um die Personen hinter einem Unternehmen zu verifizieren, erstellen Sie einen separaten KYC-Workflow und verweisen Sie im KYB_KEY_PEOPLE-Knoten mithilfe von kyb_ubo_verification_workflow, kyb_officer_verification_workflow oder kyb_shareholder_verification_workflow darauf.
  • Aktionsfelder verwenden DECLINE, REVIEW oder NO_ACTION, sofern das jeweilige Feld unten nicht als eingeschränkt angegeben ist.
  • Score- und Schwellenwert-Felder sind Zahlen von 0 bis 100, sofern kein engerer Bereich angegeben ist.

Allgemeine Statusregeln

Jede Funktion unterstützt ein optionales status_rules-Array. Verwenden Sie es, um den Funktionsstatus zu überschreiben, wenn eine Feldbedingung zutrifft.
Lesen Sie das obige Beispiel wie folgt: kyc.extra_fields.profession stimmt mittels Fuzzy-Matching mit Soft. Engineer überein, wobei der Mindestwert 80 beträgt → setzen Sie den Funktionsstatus auf Declined. Zielen Sie bei der Ausweisverifizierung auf extrahierte extra_fields-Werte wie kyc.extra_fields.profession, Gültigkeitsdaten von Führerscheinklassen wie kyc.extra_fields.dl_class_code_b_from und kyc.extra_fields.dl_class_code_b_to oder klassenspezifische Einschränkungs-/Informationscodes wie kyc.extra_fields.dl_class_code_b_notes (Spalte 12 bei Führerscheinen aus dem Vereinigten Königreich) ab. Diese Werte stammen aus dem extra_fields-Objekt des OCR-Ergebnisses; sie sind nicht Teil von expected_details.
dl_class_code_*_from und dl_class_code_*_to sind immer entweder ein gültiges ISO-Datum oder in extra_fields nicht vorhanden – Didit gibt in einem Datumsfeld niemals unlesbaren OCR-Text zurück. Wenn die Zelle der Klassentabelle nicht gelesen werden kann, wird das Feld weggelassen, anstatt als Roh-String gesendet zu werden. Verwenden Sie daher den Operator is_empty, um unlesbare Gültigkeitsdaten von Führerscheinklassen weiterzuleiten, anstatt davon auszugehen, dass das Feld immer vorhanden ist.
Verwenden Sie für Datumsfelder value_type: "relative_date" mit einem Wertobjekt im Format { "direction": "past" | "future", "amount": number, "unit": "days" | "months" | "years" }. Beispielsweise findet operator: "less_than" mit { "direction": "past", "amount": 3, "unit": "years" } Datumswerte, die mehr als drei Jahre vor dem heutigen Datum liegen.

Mit einem bestimmten Schritt vergleichen

Ein Graph-Workflow kann dieselbe Funktion mehr als einmal ausführen, beispielsweise drei Schritte zur Ausweisverifizierung. Hängen Sie bei value_type: "field" das Suffix @<node_id> an den Wert an, um ihn aus einem bestimmten Schritt auszulesen. Der referenzierte Knoten muss ein Funktionsschritt sein, der auf jedem Pfad, der den eigenen Schritt der Regel erreicht, immer vor diesem ausgeführt wird, oder der eigene Schritt der Regel selbst. Ein Wert ohne das Suffix wird aus dem eigenen Schritt der Regel ausgelesen.
Lesen Sie diese Regel, die auf dem dritten Schritt zur Ausweisverifizierung konfiguriert ist, wie folgt: Wenn kyc.full_name dieses Schritts mittels Fuzzy-Matching mit dem durch Schritt ocr_1 gelesenen vollständigen Namen mit einem Mindestwert von 80 übereinstimmt → setzen Sie den Funktionsstatus auf Declined. In der Konsole listet die Variablenauswahl jeden berechtigten Schritt anhand seiner Nummer auf dem Canvas auf und speichert das Suffix automatisch für Sie.

OCR / Ausweisverifizierung

Funktionswert: OCR.
Die Dokumenten-Liveness wird mit den sechs obigen document_liveness_*-Schwellenwerten konfiguriert, nicht mit Aktionsfeldern pro Signal. portrait_replacement_action, printed_copy_action und screen_capture_action sind Einstellungen auf Kontoebene und werden in einer Workflow-Funktionskonfiguration nicht akzeptiert: Die API entfernt unbekannte Konfigurationsschlüssel beim Speichern, sodass das Senden dort keine Auswirkung hat. Jedes Signal hat einen Ablehnungsschwellenwert und einen Prüfungsschwellenwert auf einer Skala von 0 bis 100, wobei ein höherer Score bedeutet, dass das Dokument mit höherer Wahrscheinlichkeit echt ist.
Beispiel:

Methoden pro Land

methods verwendet den Ländercode nach ISO 3166-1 alpha-3 als Schlüssel. Jedes Land enthält bis zu drei Methodenobjekte; alles, was Sie weglassen, nimmt seinen Standardwert an.
wallet.on_failure ist fallback_to_document, decline oder retry. retry (nur Wallet, Dokumentenerfassung für das Land deaktiviert) hält einen Benutzer, dessen Anmeldung nicht abgeschlossen wurde, im Wallet-Schritt, um es erneut zu versuchen; die Sitzung wird dafür niemals abgelehnt und bleibt geöffnet, bis er fertig ist oder sie abläuft. Die id_lookup-Schalter akzeptieren nur fallback_to_document oder decline. Um Dokumente vom ersten Bildschirm fernzuhalten und sie nur anzubieten, wenn ein Wallet oder Lookup nicht erfolgreich ist, setzen Sie document.fallback_only. Das Beispiel verwendet Finnland, wo das Finnish Trust Network an erster Stelle steht und die Dokumentenerfassung das Fallback ist. Finnland muss außerdem seine Dokumenttypen in documents_allowed aktiviert haben (zum Beispiel Reisepass und Personalausweis), damit im Fallback Dokumente angeboten werden können.
Beide obigen Lookups sind im heutigen Katalog als available gekennzeichnet, sodass diese Konfiguration wie angegeben gespeichert wird. Der Wallet-Block wurde in diesem Beispiel absichtlich weggelassen: Eine Wallet lässt sich nur in einem Land speichern, in dem der Katalog sie als available kennzeichnet; wallet.enabled: true an jedem anderen Ort wird abgelehnt und bricht den gesamten Speichervorgang ab, einschließlich der Lookup-Konfiguration. Wo der Katalog eine Wallet als available kennzeichnet, fügen Sie sie in diesem Land hinzu:
Validierung, die die API beim Speichern anwendet:
  • Ein unbekannter Ländercode, ein unbekannter Schlüssel innerhalb eines Landes oder ein unbekannter Schlüssel innerhalb einer Methode wird abgelehnt – nichts wird stillschweigend verworfen.
  • Ein Land, in dem keine Methode aktiviert ist, wird abgelehnt: dort könnte sich niemand verifizieren.
  • Eine Wallet oder ein Lookup kann nur dann auf die Dokumentenerfassung zurückgreifen, wenn die Dokumentenerfassung für dieses Land aktiviert ist. fallback_to_document in einem Land, in dem document.enabled auf false gesetzt ist, führt zur Laufzeit zu einer Ablehnung, da kein Fallback-Ziel existiert.
  • document.fallback_only: true wird mit HTTP 400 abgelehnt, es sei denn, document.enabled ist true und mindestens eine Wallet oder ein ID-Lookup in diesem Land greift auf die Dokumentenerfassung zurück.
Die aktuelle Staging-Implementierung wendet id_lookup.response_fields auf die Vergleichsausgabe, das optionale Geschlecht und aufbewahrte Register-Porträtfotos an. Erforderliche Identitätsfelder bleiben Teil des Verifizierungsdatensatzes. Dies ist keine Garantie dafür, dass jede Zwischen-Payload des Anbieters von der Verarbeitung ausgeschlossen ist. Das Produktions-Rollout wurde für diese Änderung noch nicht verifiziert; prüfen Sie das Verhalten in Ihrer Zielumgebung, bevor Sie sich bei Aufbewahrungsanforderungen auf die Feldauswahl verlassen.
Lesen Sie den Funktionskatalog, bevor Sie methods schreiben – über den Tab Länder der Konsole oder mit dem MCP-Tool didit_workflow_get_id_verification_methods_catalog. Verhalten, Abdeckung und Abrechnung finden Sie unter Methoden der Ausweisverifizierung.

NFC / ePassport

Funktionswert: NFC.

Liveness

Funktionswert: LIVENESS.

Gesichtsabgleich

Funktionswert: FACE_MATCH.

Altersschätzung

Funktionswert: AGE_ESTIMATION.

Telefonverifizierung

Funktionswert: PHONE_VERIFICATION. Die Telefonverifizierung ist deaktiviert, bis die Organisation ihre erste Aufladung abgeschlossen hat.
Die Anreicherung mit Telefoninformationen ist ein optionales Add-on. Wenn phone_enrichment_enabled auf true gesetzt ist, wird jede abgeschlossene Telefonverifizierung mit Telefoninformationen angereichert und mit $0.05 pro Anfrage abgerechnet, zusätzlich zu den regulären Kosten der Telefonverifizierung. Die Score-basierten Aktionen greifen erst, sobald der Anreicherungs-Score verfügbar ist; die Aktionen für Vertrauensindex, Telefontyp und Portierung werden angewendet, sobald die Anreicherung ausgeführt wird.Die Prüfung des Social Footprints ist ein zweites, separates Add-on. Wenn phone_social_enabled auf true gesetzt ist, meldet jede abgeschlossene Telefonverifizierung außerdem, auf welchen Online-Plattformen die Nummer registriert ist – Messaging, soziale Medien, E-Commerce und professionelle Dienste – und wird mit $0.05 pro Anfrage abgerechnet. Es kann mit oder ohne phone_enrichment_enabled aktiviert werden: Beide Add-ons werden unabhängig voneinander bepreist und abgerechnet. Eine Abfrage, die die Nummer auf keiner der abgedeckten Plattformen findet, ist ein gültiges, abrechenbares Ergebnis und löst phone_no_social_presence_action aus. Verwenden Sie phone.social_profiles_registered (die Anzahl der Plattformen, auf denen die Nummer registriert ist), um in einem Workflow-Graphen basierend auf dem Ergebnis eine Verzweigung vorzunehmen.

E-Mail-Verifizierung

Feature-Wert: EMAIL_VERIFICATION.
Die E-Mail-Intelligence-Anreicherung ist ein optionales Add-on. Wenn email_enrichment_enabled auf true gesetzt ist, wird jede abgeschlossene E-Mail-Verifizierung mit E-Mail-Intelligence angereichert und mit $0.05 pro Anfrage abgerechnet, zusätzlich zu den regulären Kosten der E-Mail-Verifizierung. Die Score-basierte Aktion tritt in Kraft, sobald der Anreicherungs-Score verfügbar ist; die Datenleck-Aktionen greifen, sobald die Anreicherung ausgeführt wird.Die Social-Footprint-Prüfung ist ein zweites, separates Add-on. Wenn email_social_enabled auf true gesetzt ist, gibt jede abgeschlossene E-Mail-Verifizierung zusätzlich an, auf welchen Online-Plattformen die Adresse registriert ist – E-Mail-Anbieter, soziale Medien, berufliche Plattformen, E-Commerce- und Entertainment-Dienste – und wird mit $0.05 pro Anfrage abgerechnet. Es kann mit oder ohne email_enrichment_enabled aktiviert werden: Die beiden Add-ons werden unabhängig voneinander bepreist und abgerechnet. Eine Abfrage, die die Adresse auf keiner der abgedeckten Plattformen findet, ist eine gültige, kostenpflichtige Antwort und löst email_no_social_presence_action aus. Verwenden Sie email.social_profiles_registered (die Anzahl der Plattformen, auf denen die Adresse registriert ist), um im Workflow-Graphen basierend auf dem Ergebnis zu verzweigen.

Datenbankvalidierung

Funktionswert: DATABASE_VALIDATION. Beispiel:
database_validation_countries sorgt dafür, dass dieser Schritt überhaupt ausgeführt wird. Eine DATABASE_VALIDATION-Funktion, die ohne dieses Feld gespeichert wird, wird zwar akzeptiert, führt dann jedoch keinerlei Prüfung durch. Übergeben Sie daher immer mindestens ein Land mit mindestens einer Service-ID.
Eine Service-ID für einen Dienst, den dieser Schritt nicht ausführen kann, wird mit einem 400-Fehler abgewiesen, der die ID benennt und die Ursache erklärt; es wird nichts gespeichert. Dies betrifft eine ID, die nicht im Katalog enthalten ist, eine ID, die zu einem anderen Land gehört, einen Dienst, der noch nicht verfügbar ist, und einen Dienst, der nur über das eigenständige POST /v3/database-validation/ angeboten wird. Ein Dienst, dessen Eingaben von keinem früheren Schritt bereitgestellt werden, wird auf dieselbe Weise abgewiesen, wobei die fehlenden Eingaben aufgelistet werden. Ein Dienst, der im gespeicherten Workflow bereits vorhanden ist, aber nicht mehr ausgeführt werden kann, wird entfernt, sobald Sie ihn erneut speichern. Dieser Workflow für Argentinien liest beispielsweise die DNI-Nummer und das Geschlecht aus der Ausweisverifizierung und gleicht sie ohne Selfie mit RENAPER ab:
Verwenden Sie stattdessen arg_renaper nach einem LIVENESS-Schritt, um auch das Selfie mit dem bei RENAPER hinterlegten Foto abzugleichen. Informationen zum Übereinstimmungswert und Schwellenwert für den Gesichtsabgleich finden Sie unter RENAPER.

Bank-Verifizierung

Feature-Wert: BANK_VERIFICATION. Der Benutzer verifiziert ein Bankkonto, und der von der Bank gemeldete Kontoinhaber wird mit der Identität verglichen, die ein vorheriger Schritt im Workflow festgestellt hat. Der Benutzer führt dies über eine von zwei Methoden durch: Bank-Login (open_banking), bei dem er sich bei seiner Bank anmeldet, oder die Kontoprüfung (account_lookup), bei der er die Kontodaten eingibt und die Bank den darauf eingetragenen Namen bestätigt. bank_method_order und die methods jedes Landes bestimmen, welche Methoden ein Land anbietet und welche an erster Stelle steht; siehe Bank-Verifizierungsmethoden. Der Schritt erzeugt Nachweise – einen Inhabernamen-Score, den Vergleich, der ihn hervorgebracht hat, Ursachencodes – und die bank_*_action-Schlüssel wandeln diese Nachweise in einen Status um. Zwei Faktoren entscheiden darüber, ob der Knoten überhaupt etwas ausführt. bank_countries ist eine Zulassungsliste (Whitelist), daher bietet eine leere Map keine Bank an und führt keine Prüfung durch. Zudem benötigt der Inhaber eine Referenz, mit der er verglichen werden kann: Platzieren Sie einen OCR-, DATABASE_VALIDATION- oder QUESTIONNAIRE-Schritt davor, übergeben Sie expected_details bei der Sitzungserstellung oder mappen Sie die Felder selbst mit bank_field_sources. Ohne eines dieser Elemente kann die Eigentümerstruktur nur unknown sein, worüber bank_reference_identity_missing_action entscheidet.
Die Bank-Verifizierung befindet sich noch im Rollout, daher wird ein BANK_VERIFICATION-Knoten nur für Konten akzeptiert, für die sie aktiviert wurde. Überall sonst wird das Speichern abgelehnt und entsprechend ausgewiesen. Welche Route den Schritt ausführt, wird hier ebenfalls nicht konfiguriert: Es handelt sich um das Paar aus provider_key und fallback_to_native, das der Marketplace der Konsole für Sie festlegt.

Konto verknüpfen

Wenn der Benutzer sich nicht verifizieren kann

Der Benutzer kann jederzeit ohne Bank fortfahren, und der Schritt lässt ihn niemals festhängen. Siehe Wenn die Person ihre Bank nicht verifizieren kann. Was das Fortfahren für die Sitzung bedeutet, wird durch bank_unsupported_action, bank_attempts_exhausted_action oder bank_skipped_action festgelegt, je nachdem, warum der Benutzer fortgefahren ist, es sei denn, ein zuvor ausgewerteter Versuch hat den Schritt bereits entschieden: siehe Entscheidungsaktionen.

Inhaber abgleichen

Kontoprüfung

Diese Schlüssel gelten nur für die Kontoprüfung. Bei der Bank-Anmeldung gelten weiterhin die Regeln für enge Übereinstimmungen sowie das eigene bank_max_attempts.

Finanzdaten

bank_expected_currencies funktioniert allein mit der Standard-Einwilligung ownership. Die anderen drei Schlüssel lesen echte Finanzdaten, daher benötigt jeder den passenden Einwilligungsumfang in bank_scopes, und das Speichern wird ohne diesen verweigert.

Was gespeichert wird

Entscheidungsaktionen

Jeder Schlüssel hier akzeptiert DECLINE, REVIEW oder NO_ACTION, sofern er nicht als eingeschränkt gekennzeichnet ist, und greift auf den unten stehenden Standardwert zurück, wenn Sie ihn weglassen oder null übergeben. Alles, was kein positiver Eigentumsnachweis ist, wird standardmäßig nicht genehmigt, und nur nachweisbare Belege gegen den Benutzer führen standardmäßig zu einer Ablehnung.

Weitere Steuerelemente

Diese Schlüssel sind optional. Jeder Aktionsschlüssel akzeptiert DECLINE, REVIEW oder NO_ACTION. Beispiel für ein config-Objekt für ein Konto, bei dem die Bankverifizierung aktiviert ist und die ausgewählte Route das angegebene Land abdeckt:
bank_countries sorgt dafür, dass dieser Schritt überhaupt ausgeführt wird, und wird anhand der Route geprüft, auf der der Knoten ausgeführt wird, nicht anhand einer globalen Liste. Ein Land, in dem diese Route keine Kontoinhaberschaft feststellen kann, wird beim Speichern abgelehnt und im Fehler benannt; lesen Sie daher die Fehlermeldung, anstatt davon auszugehen, dass das Land akzeptiert wurde und zur Laufzeit übersprungen wird.

AML

Funktionswert: AML. Für das KYC-Personen-Screening verwenden Sie diese Felder: Für das KYB-Unternehmens-Screening verwenden Sie diese Felder:

Screening einer durch einen Document-AI-Schritt extrahierten Entität

Ein AML-Schritt liest normalerweise aus dem OCR-Schritt (eine Person) oder dem KYB_REGISTRY-Schritt (ein Unternehmen), wer überprüft werden soll. Ein Workflow, dessen einziger Extraktionsschritt DOCUMENT_AI ist – nicht standardisierte Dokumente wie eine Steuerbescheinigung oder eine Gründungsurkunde –, hat keines von beiden und muss daher angeben, woher die jeweiligen Screening-Eingabedaten stammen. Beispiel – Screening des in einer mexikanischen acta constitutiva genannten Unternehmens, ohne Ausweisdokument an irgendeiner Stelle im Workflow:
Ohne einen vorherigen OCR- oder KYB_REGISTRY-Schritt muss ein AML-Schritt in der Lage sein, full_name auszufüllen – ohne Namen gibt es keine Anbietersuche. Ein Workflow, der nichts zuweist oder einen Document-AI-Schlüssel zuweist, den kein vorgelagerter Schritt extrahiert, wird beim Speichern abgelehnt, anstatt gespeichert zu werden und anschließend nichts zu screenen. Die AML-Präzision hängt direkt davon ab, wie viele Identifikatoren Sie bereitstellen: Ein reines Namens-Screening führt zu einem hohen Aufkommen an falsch positiven Ergebnissen.

Geräte- und IP-Analyse

Feature-Wert: IP_ANALYSIS. Beispiel:
Verwenden Sie recovered_device_action separat von duplicated_device_action, wenn Sie wiederhergestellte Geräte mit hoher Konfidenz überwachen möchten, bevor Sie sie automatisch ablehnen. Dies ist während des Rollouts nützlich, da Übereinstimmungen wiederhergestellter Geräte für die Erkennung von Betrugsringen konzipiert sind, jedoch dennoch anhand Ihres eigenen Datenverkehrs kalibriert werden sollten.

Standortverifizierung

Funktionswert: GEOLOCATION. Prüft, wo sich die Person während der Verifizierung befindet, anhand der Geräteposition oder des IP-Standorts der Verbindung, und gleicht dies mit zulässigen und blockierten Gebieten, dem IP-Standort und der Dokumentadresse ab. Siehe Standortverifizierung zum Verhalten des Schritts und dessen Bericht für die Entscheidungsfelder. Platzieren Sie diesen Schritt nach Ausweisverifizierung oder Adressnachweis, wenn Sie die Entfernung zu einer Dokumentadresse benötigen, da die Entfernung nur gemessen wird, wenn eine Adresse hinterlegt ist. Wenn geolocation_position_source nicht gesetzt ist, erfordert die Entfernung zum IP-Standort einen Schritt zur Geräte- und IP-Analyse im selben Workflow. Jeder Schlüssel ist optional: Ein Schritt mit einer leeren config fragt beim Gerät eine auf 250 m genaue Position ab, die nicht älter als 120 Sekunden ist, gewährt der Person 3 Versuche und wendet keine Gebietsregel an. Jedes Ergebnis hat seinen eigenen Aktionsschlüssel. Ein nicht gesetzter Aktionsschlüssel übernimmt den Standardwert des gewählten geolocation_preset oder den unten aufgeführten Standardwert pro Schlüssel, falls keines gewählt wurde. Bei einem ungenauen oder verweigerten Standort wird standardmäßig REVIEW verwendet, niemals DECLINE, da eine verweigerte Berechtigung oder ein großer Radius kein Betrugsnachweis ist. Eine explizit festgelegte Aktion hat immer Vorrang vor dem Preset. Eine wieder abgespielte Challenge (LOCATION_REPLAY_DETECTED) und eine fehlgeschlagene Geräte-Attestierung (LOCATION_INTEGRITY_FAILED) führen immer zu einer Ablehnung und haben keinen Aktionsschlüssel.

Gebietsformen

Jedes Element von geolocation_areas besitzt eine id (1 bis 64 Zeichen aus A-Z a-z 0-9 _ -, eindeutig in der Liste), ein optionales label (bis zu 80 Zeichen), ein type-Feld mit dem Wert allowed oder blocked und ein kind-Feld, das die Form bestimmt. Eine Liste umfasst maximal 50 Gebiete und erfordert mindestens ein allowed-Gebiet, wenn is_geolocation_geofencing_enabled den Wert true hat. geolocation_areas und geolocation_geofencing_by_country können nicht zusammen übermittelt werden, und geolocation_refusal_path: "end_session" erfordert, dass geolocation_permission_denied_action auf REVIEW oder DECLINE gesetzt ist. Die API lehnt ein Gebiet ab, das niemals übereinstimmen könnte, wie etwa eine Region eines Landes ohne veröffentlichte Grenzen, anstatt es zu speichern. Beispiel:

Adressnachweis

Feature-Wert: PROOF_OF_ADDRESS.

Fragebögen

Feature-Wert: QUESTIONNAIRE.

KYB-Register

Feature-Wert: KYB_REGISTRY. kyb_registry_fields_config ordnet jeden konfigurierbaren Feldschlüssel {"enabled": bool, "required": bool} zu. enabled: false blendet das Feld aus, enabled: true, required: false zeigt es als optional an und enabled: true, required: true macht es beim Absenden zum Pflichtfeld. company_name, country_code und region werden immer angezeigt, sind Pflichtfelder und können nicht konfiguriert werden. Wenn das Objekt weggelassen wird, null oder {} ist, gilt der Standard: Nur incorporation_date ist erforderlich und jedes andere Feld ist optional.
Konfigurierbare Feldschlüssel: registration_number, incorporation_date, legal_address, vat_number, alternative_names, tax_number, company_type, legal_entity_identifier, location_of_registration, nature_of_business, registered_capital_amount, registered_capital_currency, website, email, phone, control_scheme. Siehe konfigurierbare Registerformularfelder für das Verhalten für Endbenutzer und Validierung von USt-IdNr. und Steuernummer dafür, wie vat_number und tax_number geprüft werden.

KYB-Dokumente

Funktionswert: KYB_DOCUMENTS.

KYB-Schlüsselpersonen

Funktionswert: KYB_KEY_PEOPLE.

Document AI

Funktionswert: DOCUMENT_AI. Fordert ein oder mehrere Dokumente vom Benutzer an und extrahiert die von Ihnen definierten Felder mithilfe eines Vision-Modells. Jedes konfigurierte Feld wird zu einem verzweigbaren Wert document_ai.<key>, und das Ergebnis des Schritts ist document_ai.status. Jeder Eintrag in document_ai_documents ist ein Dokument: Jeder Eintrag in den fields eines Dokuments ist ein Feld: Beispiel:

E-Signatur

Funktionswert: SIGNATURE. Ermöglicht der verifizierten Person oder den Schlüsselpersonen eines Unternehmens, Dokumente zu unterzeichnen, auf einfacher Stufe (Standard) oder fortgeschrittener Stufe (AES). Platzieren Sie diesen Schritt nach den Schritten, die den Unterzeichner verifizieren: Ausweisverifizierung sowie E-Mail- oder Telefonverifizierung für den Code. Siehe E-Signatur. Felder in einem Workflow-Dokument werden im Vorlagen-Editor der Konsole platziert. Bei Sitzungsdokumenten übergeben Sie diese in sign.documents[].fields und übergeben die Werte der api.<key>-Felder in sign.field_values. Siehe Sitzung erstellen. Beispiel für Dokumente, die mit jeder Sitzung übergeben werden:
Zuletzt geändert am 7. November 2026