Weiter zum Inhalt
Konto erstellen
 oder
anmelden
Das Logo der Stripe-Dokumentation
/
Konto erstellen
Anmelden

Eingebettetes Onboarding

Stellen Sie Ihren verbundenen Konten ein lokalisiertes Onboarding-Formular zur Verfügung, mit dem die Daten validiert werden können.

Die eingebettete Onboarding-Nutzeroberfläche weist nur wenig Stripe-Branding auf und kann an Ihre Marke angepasst werden. Sie betten die Konto-Onboarding-Komponente in Ihre Plattformanwendung ein und Ihre verbundenen Konten interagieren mit der eingebetteten Komponente, ohne Ihre Anwendung verlassen zu müssen.

Die Komponente unterstützt vernetztes Onboarding, wodurch Inhaber/innen mehrerer Stripe-Konten Unternehmensinformationen untereinander austauschen können. Beim Onboarding eines Kontos können diese Informationen aus einem bestehenden Konto wiederverwendet werden, anstatt sie erneut einzureichen.

Das eingebettete Onboarding verwendet die Accounts API, um Anforderungen zu lesen und ein Onboarding-Formular mit zuverlässiger Datenvalidierung zu generieren, das für alle von Stripe unterstützten Länder lokalisiert ist. Darüber hinaus übernimmt das eingebettete Onboarding Folgendes:

  • Unternehmenstypen
  • Konfigurationen der Unternehmensvertreter/innen
  • Verifizierungsdokument wird hochgeladen
  • Identitätverifizierung und verschiedene Status
  • Internationale Bankkonten
  • Fehlerstatus

In dieser Demo können Sie die Nutzeroberfläche der eingebetteten Onboarding-Komponente erkunden:

Konten erstellen und Informationen vorab angeben
Serverseitig

Erstellen Sie ein verbundenes Konto mit den standardmäßigen Controllereigenschaften. Weitere Informationen zu Controllereigenschaften finden Sie unter Konzipieren einer Integration. Alternativ können Sie ein verbundenes Konto durch Angabe eines Kontotyps erstellen.

Wenn Sie das Land des Kontos angeben oder Funktionen dafür anfordern, kann der/die Kontoinhaber/in das Land nicht ändern. Andernfalls hängt es vom Dashboard-Zugriff des Kontos ab:

  • Vollständiges Stripe-Dashboard: Während der Registrierung kann der/die Kontoinhaber/in ein beliebiges Akquisitionsland auswählen, genau wie bei der Anmeldung für ein normales Stripe-Konto. Stripe fordert je nach ausgewähltem Land automatisch eine Reihe von Funktionen für das Konto an.
  • Express-Dashboard: Beim Onboarding kann der/die Kontoinhaber/in aus einer Liste von Ländern wählen, die Sie in den Onboarding-Optionen Ihres Plattform-Dashboards konfigurieren. Sie können diese Optionen auch konfigurieren, um die Standardfunktionen anzugeben, die für Konten in jedem Land angefordert werden sollen.
  • Kein Stripe-Dashboard: Wenn Stripe für die Erfassung der Anforderungen verantwortlich ist, kann der Kontoinhaber im Onboarding-Prozess ein beliebiges Akquisitionsland auswählen. Andernfalls müssen in Ihrem nutzerdefinierten Onboarding-Ablauf das Land festgelegt und Funktionen angefordert werden.
Command Line
curl -X POST https://api.stripe.com/v1/accounts \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

Die Antwort enthält die ID, die Sie verwenden, um in Ihrer gesamten Integration auf das Account zu verweisen.

Funktionen anfordern

Sie können Funktionen beim Erstellen eines Kontos anfordern, indem Sie die Eigenschaft requested der gewünschten Funktionen auf „true“ festlegen. Bei Konten mit Zugriff auf das Express-Dashboard können Sie Ihre Onboarding-Optionen auch so konfigurieren, dass bestimmte Funktionen beim Erstellen eines Kontos automatisch angefordert werden.

Die Onboarding-Nutzeroberflächen von Stripe erfassen automatisch die Anforderungen für angeforderte Funktionen. Fordern Sie nur Funktionen an, die Sie benötigen, um den Onboarding-Aufwand zu reduzieren.

Informationen vorab angeben

Wenn Sie Informationen über den/die Kontoinhaber/in haben (wie Name, Adresse oder andere Details), können Sie das Onboarding vereinfachen, indem Sie diese bei der Erstellung oder Aktualisierung des Kontos angeben. Die Onboarding-Schnittstelle fordert den/die Kontoinhaber/in auf, die vorausgefüllten Informationen zu bestätigen, bevor er/sie den Connect-Rahmenvertrag akzeptiert. Der/die Kontoinhaber/in kann alle vorausgefüllten Informationen bearbeiten, bevor er/sie den Rahmenvertrag akzeptiert, selbst wenn Sie die Informationen über die Accounts API bereitgestellt haben.

Wenn Sie das Onboarding eines Kontos durchlaufen haben und Ihre Plattform eine URL dafür bereitstellt, füllen Sie die business_profile.url des Kontos vorab aus. Wenn das Unternehmen keine URL hat, können Sie stattdessen seine business_profile.product_description vorab ausfüllen.

Verwenden Sie beim Testen Ihrer Integration Testdaten, um verschiedene Ergebnisse zu simulieren, zum Beispiel Identitätsprüfung, Verifizierung der Unternehmensinformationen, Auszahlungsfehler und mehr.

Die zu erfassenden Informationen bestimmen

Sie als Plattform müssen entscheiden, ob die erforderlichen Informationen von den verbundenen Konten vorab oder inkrementell erfasst werden sollen. Beim Onboarding im Voraus werden die eventually_due-Anforderungen für das Konto erfasst, während beim inkrementellen Onboarding nur die currently_due-Anforderungen erfasst werden.

Onboarding-TypVorteile
Im Voraus
  • Normalerweise ist nur eine Abfrage für alle Informationen erforderlich
  • Vermeidet die Möglichkeit von Auszahlungs- und Bearbeitungsproblemen aufgrund verpasster Fristen
  • Stellt frühzeitig ein potenzielles Risiko dar, wenn Konten Informationen verweigern
Inkrementell
  • Das Onboarding von Konten kann schnell abgeschlossen werden, da sie nicht so viele Informationen bereitstellen müssen

Um zu bestimmen, ob Sie das Onboarding im Voraus oder inkrementelles Onboarding nutzen möchten, überprüfen Sie die Anforderungen für die Standorte und Funktionen Ihrer verbundenen Konten. Auch wenn Stripe versucht, etwaige Auswirkungen auf verbundene Konten zu minimieren, können sich Anforderungen im Laufe der Zeit ändern.

Bei verbundenen Konten, bei denen Sie für die Anforderungserfassung verantwortlich sind, können Sie das Verhalten zukünftiger Anforderungen mithilfe des Parameters collection_options anpassen. Um die zukünftigen Anforderungen des Kontos zu erfassen, setzen Sie collection_options.future_requirements auf include.

Richtlinien anpassen, die Ihren Nutzern/Nutzerinnen angezeigt werden

Der Rahmenvertrag und die Datenschutzerklärung von Stripe werden verbundenen Konten im eingebetteten Onboarding angezeigt. Nutzer/innen verbundener Konten, die den Rahmenvertrag von Stripe nicht akzeptiert haben, müssen dies im letzten Bildschirm des Onboardings nachholen. Das eingebettete Onboarding verfügt außerdem über eine Fußzeile mit Links zum Rahmenvertrag und zur Datenschutzerklärung von Stripe.

Für verbundene Konten, bei denen die Plattform für die Erfassung der Anforderungen zuständig ist, haben Sie zusätzliche Optionen zur Anpassung des Onboarding-Ablaufs, die im Folgenden beschrieben werden.

Kümmern Sie sich selbst um die Zustimmung zum Rahmenvertrag

Wenn Sie eine Plattform sind, die das Onboarding von verbundenen Konten durchführt und dabei für die Erfassung der Anforderungen verantwortlich sind, können Sie die Zustimmung zu den Allgemeinen Geschäftsbedingungen über Ihre eigene Methode statt über die integrierte Konto-Onboarding-Komponente einholen. In diesem Fall werden Ihre verbundenen Konten im letzten Onboarding-Bildschirm nur aufgefordert, die von ihnen eingegebenen Informationen zu bestätigen, und Sie müssen ihre Zustimmung zum Rahmenvertrag von Stripe einholen.

Das eingebettete Onboarding enthält weiterhin Links zu den allgemeinen Geschäftsbedingungen (zum Beispiel in der Fußzeile), die Sie durch Verknüpfung mit Ihren eigenen Vereinbarungen und Ihrer Datenschutzerklärung ersetzen können.

Link zu Ihren Vereinbarungen und Ihrer Datenschutzerklärung

Verbundene Konten können den Stripe-Rahmenvertrag und die Datenschutzerklärung während des eingebetteten Onboardings einsehen. Für Ihre verbundenen Konten, bei denen Sie für die Erfassung der Anforderungen verantwortlich sind, können Sie diese Links durch Ihre eigenen Vereinbarungen und Richtlinien ersetzen. Befolgen Sie diese Anweisungen, um den Stripe-Rahmenvertrag aufzunehmen und stellen Sie einen Link zur Datenschutzerklärung von Stripe zur Verfügung.

Komponente für Konto-Onboarding integrieren
Serverseitig
Clientseitig

Erstellen Sie eine Kontositzung, indem Sie die ID des verbundenen Kontos und account_onboarding als zu aktivierende Komponente angeben.

Kontositzung erstellen

Aktivieren Sie beim Erstellen einer Kontositzung das Konto-Onboarding, indem Sie account_onboarding im Parameter components angeben.

Command Line
curl https://api.stripe.com/v1/account_sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
{{CONNECTED_ACCOUNT_ID}}
 \
  -d "components[account_onboarding][enabled]"=true

Nachdem die Kontositzung erstellt und ConnectJS initialisiert wurde, können Sie die Komponente für Konto-Onboarding im Frontend darstellen:

account-onboarding.js
// Include this element in your HTML
const accountOnboarding = stripeConnectInstance.create('account-onboarding');
accountOnboarding.setOnExit(() => {
  console.log('User exited the onboarding flow');
});
container.appendChild(accountOnboarding);

// Optional: make sure to follow our policy instructions above
// accountOnboarding.setFullTermsOfServiceUrl('{{URL}}')
// accountOnboarding.setRecipientTermsOfServiceUrl('{{URL}}')
// accountOnboarding.setPrivacyPolicyUrl('{{URL}}')
// accountOnboarding.setSkipTermsOfServiceCollection(false)
// accountOnboarding.setCollectionOptions({
//   fields: 'eventually_due',
//   futureRequirements: 'include',
// })
// accountOnboarding.setOnStepChange((stepChange) => {
//   console.log(`User entered: ${stepChange.step}`);
// });
MethodeTypBeschreibungStandard
setFullTermsOfServiceUrlstringAbsolute URL zu Ihren vollständigen Allgemeinen Geschäftsbedingungen.Vollständiger Rahmenvertrag von Stripe
setRecipientTermsOfServiceUrlstringAbsolute URL zu Ihren Allgemeinen Geschäftsbedingungen für Empfänger/innen.Rahmenvertrag für Empfänger/innen von Stripe
setPrivacyPolicyUrlstringAbsolute URL zu Ihrer Datenschutzerklärung.Datenschutzerklärung von Stripe
setSkipTermsOfServiceCollectionstringFalls „true“, wird beim eingebetteten Onboarding die Erfassung der allgemeinen Geschäftsbedingungen übersprungen, und Sie müssen die Zustimmung zu den Bedingungen selbst einholenfalse
setCollectionOptions{ fields: 'currently_due' | 'eventually_due', future_requirements: 'omit' | 'include' }Passt die Erfassung der Anforderungen currently_due oder eventually_due an und steuert, ob zukünftige Anforderungen einbezogen werden sollen. Durch die Angabe von eventually_due werden die beiden Anforderungen eventually_due und currently_due erfasst.{fields: 'currently_due', futureRequirements: 'omit'}
setOnExit() => voidDas verbundene Konto hat den Onboarding-Vorgang beendet
setOnStepChange({step}: StepChange) => voidDas verbundene Konto ist innerhalb des Onboarding-Vorgangs von einem Schritt zum nächsten navigiert. Verwenden Sie StepChange, um den aktuellen Schritt zu identifizieren (wie unten beschrieben).

So richten Sie mit dieser Komponente neue Konten ein:

  1. Erstellen Sie ein verbundenes Konto. Sie können Informationen für das Account-Objekt in diesem API-Aufruf vorab ausfüllen.
  2. Initialisieren Sie die in Connect eingebetteten Komponenten mithilfe der ID des verbundenen Kontos.
  3. Beziehen Sie das Element account-onboarding ein, um dem verbundenen Konto den Onboarding-Ablauf zu zeigen.
  4. Überwachen Sie das von dieser Komponente ausgegebene exit-Ereignis. Stripe sendet dieses Ereignis, wenn das verbundene Konto den Onboarding-Vorgang beendet.
  5. Wenn exit ausgelöst wird, rufen Sie die Account-Details ab, um den Status von Folgendem zu prüfen:Wenn alle erforderlichen Funktionen aktiviert sind, können Sie das verbundene Konto zum nächsten Schritt Ihres Ablaufs führen.

Das StepChange-Objekt

Der Typ StepChange ist in connect.js definiert. Jedes Mal, wenn das verbundene Konto im Onboarding-Prozess von einem Schritt zum anderen navigiert, empfängt der Schrittänderungs-Handler ein StepChange-Objekt mit der folgenden Eigenschaft:

Name
Typ
Beispielwert
step
string (muss ein gültiger Schrittname sein)
business_type
Der eindeutige Verweis auf einen Onboarding-Schritt.
Einschränkungen für einzelne Schritte
  • Das StepChange-Objekt dient nur für Analysen.
  • Schritte können in beliebiger Reihenfolge angezeigt und wiederholt werden.
  • Die Liste der gültigen step-Namen kann jederzeit ohne Vorankündigung geändert werden.

Schrittnamen

Jede Seite in einem Onboarding-Ablauf hat einen der folgenden Schrittnamen.

SchrittnameBeschreibung
stripe_user_authenticationNutzerauthentifizierung enthält ein Pop-up-Fenster zu einem Stripe-eigenen Fenster. Das verbundene Konto muss sich authentifizieren, bevor es seinen Workflow fortsetzen kann.
risk_interventionUnterstützt das verbundene Konto bei der Erfüllung risikobezogener Anforderungen.
legal_entity_sharingVerbundene Konten können optional Unternehmensinformationen aus bestehenden Konten mit demselben/derselben Eigentümer/in wiederverwenden.
business_typeLegt den Unternehmenstyp des verbundenen Kontos fest. In bestimmten Fällen kann das verbundene Konto auch sein Land festlegen.
business_detailsSammelt Informationen zum Unternehmen des verbundenen Kontos.
business_verificationErfasst einen Rechtsnachweis, aus dem die ID-Nummer der juristischen Person des Unternehmens hervorgeht, zum Beispiel die Satzung des Unternehmens. Oder ermöglicht es Nutzer/innen, falsch eingegebene Informationen in Bezug auf die juristische Person zu korrigieren.
business_bank_account_ownership_verificationSammelt Dokumente, die erforderlich sind, um zu überprüfen, ob die Bankkontoinformationen, z. B. der Name der juristischen Person und die Kontonummer, mit den Informationen des Stripe-Kontos des Nutzers/der Nutzerin übereinstimmen.
business_documentsSammelt andere Dokumente und Verifizierungsanforderungen in Bezug auf das Unternehmen.
representative_detailsSammelt Informationen über den/die Kontovertreter/in.
representative_documentErfasst einen behördlich ausgestellten Ausweis, der die Existenz des Kontovertreters/der Kontovertreterin bestätigt.
representative_additional_documentErfasst ein zusätzliches Dokument, um die Angaben des Kontovertreters/der Kontovertreterin zu verifizieren.
legal_guardian_detailsHolt die Zustimmung der erziehungsberechtigten Person für Konten ein, die von Minderjährigen eröffnet wurden.
ownersSammelt Informationen zu den wirtschaftlichen Eigentümern/Eigentümerinnen eines Unternehmens.
directorsSammelt Informationen über die Vorstandsmitglieder eines Unternehmens.
executivesSammelt Informationen über die Führungskräfte eines Unternehmens.
proof_of_ownership_documentSammelt Unterlagen, die die wirtschaftlichen Eigentümer/innen eines Unternehmens verifizieren.
proof_of_authorizationSammelt Unterlagen, um zu überprüfen, ob der/die Kontovertreter/in innerhalb eines Unternehmens eine Position mit ausreichender Autorität innehat.
confirm_ownersSo können verbundene Konten bestätigen, dass die an Stripe übermittelten Informationen zum/zur wirtschaftlichen Eigentümer/in aktuell und korrekt sind.
risa_compliance_survey(Gilt nur für Unternehmen in Japan.) Beantwortet Fragen zum geänderten Ratenverkaufsgesetz.
treasury_and_card_issuing_terms_of_serviceErfasst die allgemeinen Geschäftsbedingungen von Treasury und Kartenausstellung, wenn diese Funktionen angefordert werden.
external_accountErfasst das externe Konto des verbundenen Kontos.
support_detailsSammelt Informationen, anhand derer Kundinnen und Kunden das Unternehmen der verbundenen Konten erkennen können. Diese Support-Informationen können in Zahlungsaufstellungen, Rechnungen und Belegen sichtbar sein.
climateErmöglicht es einem verbundenen Konto, sich für Stripe Climate anzumelden.
taxErmöglicht es einem verbundenen Konto, sich für Stripe Tax zu entscheiden.
summaryLetzter Schritt der Überprüfung des Onboardings. Das verbundene Konto kann die eingegebenen Informationen aus diesem Schritt aktualisieren. Die URL für die Allgemeinen Geschäftsbedingungen und den Datenschutz wird auf diesem Bildschirm angezeigt.
summary_riskIm Übersichtsschritt kann ein verbundenes Konto Informationen im Zusammenhang mit den Risikoanforderungen aktualisieren.
summary_business_typeIm Übersichtsschritt kann ein verbundenes Konto Informationen aktualisieren, die sich auf seinen Unternehmenstyp beziehen.
summary_businessIm Übersichtsschritt kann ein verbundenes Konto Informationen aktualisieren, die sich auf sein Unternehmen beziehen.
summary_supportIm Übersichtsschritt kann ein verbundenes Konto öffentlich zugängliche Informationen aktualisieren, die sich auf sein Unternehmen beziehen.
summary_personsIm Übersichtsschritt kann ein verbundenes Konto Informationen über jede Person in seinem Konto aktualisieren.
summary_external_accountIm Übersichtsschritt kann ein verbundenes Konto Informationen zu seinem externen Konto aktualisieren.
summary_taxIm Übersichtsschritt kann ein verbundenes Konto Informationen im Zusammenhang mit seiner Stripe Tax-Integration aktualisieren.
summary_tax_identification_formIm Übersichtsschritt kann ein verbundenes Konto Informationen aktualisieren, die sich auf seine zertifizierten W8/W9-Steuerinformationen beziehen. Dies wird angezeigt, wenn Stripe W8/W9-Informationen erfassen muss.
summary_climateIm Übersichtsschritt kann ein verbundenes Konto Informationen im Zusammenhang mit seiner Stripe Climate-Integration aktualisieren.

Identifizieren und reagieren Sie auf Aktualisierungen der Anforderungen
Serverseitig

Richten Sie Ihre Integration so ein, dass Änderungen der Kontoanforderungen überwacht werden. Sie können den Umgang mit neuen Anforderungen (und wie diese möglicherweise Zahlungen und Auszahlungen deaktivieren) mit den Test-Auslöserkarten testen.

Senden Sie ein verbundenes Konto über das Onboarding zurück, wenn es currently_due- oder eventually_due-Anforderungen erfüllt. Sie müssen die spezifischen Anforderungen nicht identifizieren, da die Onboarding-Schnittstelle weiß, welche Informationen sie erfassen muss. Wenn beispielsweise ein Tippfehler die Verifizierung der Identität des Kontoinhabers/der Kontoinhaberin verhindert, fordert das Onboarding ihn/sie auf, ein Identitätsdokument hochzuladen.

Stripe benachrichtigt Sie über alle bevorstehenden Aktualisierungen der Anforderungen, die Ihre verbundenen Konten betreffen. Sie können diese Informationen proaktiv erfassen, indem Sie die zukünftigen Anforderungen für Ihre Konten überprüfen.

Erhalten Sie für verbundene Konten, bei denen controller.requirement_collection stripe ist, nach dem Erstellen einer Konto-Link oder einer Kontositzung keine Updates mehr für Identitätsinformationen.

Konten speichern Identitätsinformationen in den Hashes company und individual.

Verifizierungsfehler handhaben

Überwachen Sie das Ereignis account.updated. Wenn das Konto zum Zeitpunkt der current_deadline Felder mit der Bezeichnung currently_due enthält, wird die entsprechende Funktion deaktiviert und diese Felder werden zu past_due hinzugefügt.

Lassen Sie Ihre Konten die Verifizierungsanforderungen regeln, indem Sie sie an die Komponente für Konto-Onboarding leiten.

Stripe-Nutzerauthentifizierung deaktivieren

Bei Verwendung des eingebetteten Onboarding ist die Nutzerauthentifizierung durch Stripe standardmäßig aktiviert. Dieses Verhalten können Sie mithilfe von disable_stripe_user_authentication aufheben.

Wir empfehlen den Einsatz der Zwei-Faktor-Authentifizierung oder gleichwertiger Sicherheitsmaßnahmen als Best Practice. Bei Kontokonfigurationen, die diese Funktion unterstützen, wie z. B. Custom, übernehmen Sie die Haftung für verbundene Konten, wenn diese Negativsalden nicht zurückzahlen können.

Siehe auch

War diese Seite hilfreich?
JaNein