API Reference

interface IndividualOnboardingSDK¶

The interface IndividualOnboardingSDK type defines the configuration for the IndividualOnboarding component.

interface IndividualOnboardingSDK {
  customTheme?: Theme;
  sdkOverride?: IndividualOnboardingOverride;
}

interface Theme {
  color: {
    primary: string;
    background: string;
    text: string;
    border: string;
    error: string;
    success: string;
    warning: string;
    info: string;
    muted: string;
    shadow: string;
    link: string;
  };
  typography: {
    fontFamily: string;
    fontSize: string;
    fontWeight: number;
    lineHeight: string;
    h2: {
      fontSize: string;
      fontWeight: number;
      lineHeight: string;
    };
    link: {
      color: string;
      textDecoration: string;
      hover: {
        textDecoration: string;
      };
    };
  };
  customStyles?: {
    [key: string]: {
      [property: string]: string | number;
    };
  };
}

type SdkStatusCardOverride = {
  icon?: ReactNode;
  heading?: string;
  message?: string;
};

type IndividualOnboardingOverride = {
  welcome?: {
    termsAndConditionsLinks?: TermsAndConditionLinks[];
    logo?: ReactNode;
    heading?: string;
    description?: ReactNode | string;
    btnText?: string;
  };
  loader?: React.JSX.Element;
  errorIcon?: React.JSX.Element;
  successIcon?: React.JSX.Element;
  signRequest?: SdkStatusCardOverride;
  rejectSignRequest?: SdkStatusCardOverride & {
    btnText?: string;
  };
  commonErrorScreen?: SdkStatusCardOverride;
  verificationPending?: SdkStatusCardOverride;
  verificationFailed?: SdkStatusCardOverride & {
    btnText?: string;
  };
  verificationSuccess?: {
    icon?: ReactNode;
    heading?: string;
    enableBtnText?: string;
    retryBtnText?: string;
  };
  transactionRequest?: SdkStatusCardOverride;
  rejectTransactionRequest?: SdkStatusCardOverride & {
    btnText?: string;
  };
  accountActivated?: SdkStatusCardOverride;
  successScreen?: ReactNode;
};

You can pass any combination of overrides and theme values to customize the experience and match your brand.