Function ConnectAccountOnboarding

  • ConnectAccountOnboarding(
        __namedParameters: {
            title?: string;
            onExit: () => void;
            onStepChange?: (stepChange: StepChange) => void;
            recipientTermsOfServiceUrl?: string;
            fullTermsOfServiceUrl?: string;
            privacyPolicyUrl?: string;
            collectionOptions?: CollectionOptions;
        } & Omit<CommonComponentProps, "style">,
    ): Element

    A full-screen modal component for Connect account onboarding. Guides connected accounts through the process of providing required information.

    Platform differences:

    • iOS: Uses native modal with UIKit navigation bar
    • Android: Uses React Native Modal with custom navigation bar

    Parameters

    • __namedParameters: {
          title?: string;
          onExit: () => void;
          onStepChange?: (stepChange: StepChange) => void;
          recipientTermsOfServiceUrl?: string;
          fullTermsOfServiceUrl?: string;
          privacyPolicyUrl?: string;
          collectionOptions?: CollectionOptions;
      } & Omit<CommonComponentProps, "style">

    Returns Element

    Example

    <ConnectAccountOnboarding
      title="Complete your account setup"
      onExit={() => navigation.goBack()}
      onStepChange={({ step }) => console.log('Current step:', step)}
      collectionOptions={{
        fields: 'currently_due',
        futureRequirements: 'include'
      }}
    />

Settings

Member Visibility