@moneytree/mt-link-javascript-sdk
    Preparing search index...

    Interface StoredOptions

    interface StoredOptions {
        affiliateCode?: string;
        authAction?: "login" | "signup";
        authnMethod?: "passwordless" | "sso" | "credentials" | "otp";
        backTo?: string;
        clientId?: string;
        cobrandClientId?: string;
        email?: string;
        emailToken?: string;
        isNewTab?: boolean;
        locale?: string;
        mode: Mode;
        redirectUri?: string;
        samlSubjectId?: string;
        scopes?: Scopes;
        sdkPlatform?: "ios" | "android" | "js";
        sdkVersion?: string;
        showAuthToggle?: boolean;
        showRememberMe?: boolean;
        state?: string;
    }

    Hierarchy (View Summary)

    Index
    affiliateCode? authAction? authnMethod? backTo? clientId? cobrandClientId? email? emailToken? isNewTab? locale? mode redirectUri? samlSubjectId? scopes? sdkPlatform? sdkVersion? showAuthToggle? showRememberMe? state?
    affiliateCode?: string

    An optional affiliate code for attributing user referrals.

    If not provided, no affiliate attribution will be applied.

    authAction?: "login" | "signup"

    Show the login or sign up screen when a session does not exist during an MtLinkSdk.authorize call.

    Set default value via MtLinkSdk.init

    'login'
    authnMethod?: "passwordless" | "sso" | "credentials" | "otp"

    Use different authentication methods.

    backTo?: string

    A redirection URL for redirecting a user back to in one of the following conditions:

    • User clicks on Back to [App Name] button in any Moneytree screen.
    • User refuses to give consent to access permission in the consent screen.
    • User logs out from Moneytree via an app with this client ID
    • User revokes consent from settings screen opened via an app with this client ID

    ⚠️ No Back to [App Name] button will be shown if this value is not set, and any of the actions mentioned above will redirect the user back to the login screen by default.

    Set the default value via MtLinkSdk.init

    clientId?: string
    cobrandClientId?: string

    Brand Moneytree apps with client's branding. E.g: logo or theme.

    This is an internal attribute. Please do not use it unless instructed by your integration representative.

    email?: string

    Email address to pre-fill the email field in login or sign up or form.

    Set the default value via MtLinkSdk.init

    emailToken?: string
    isNewTab?: boolean

    Call method and open/render in a new browser tab. By default all views open in the same tab.

    Set default value via MtLinkSdk.init

    false
    locale?: string

    Force Moneytree to load content in this specific locale.

    A default value will be auto detected based on the user's language configuration and location if available. Check this spec for more information.

    Currently supported values are:'en', 'en-AU', 'ja'.

    mode: Mode

    Environment for the SDK to connect to, the SDK will connect to the Moneytree production server by default.

    • Moneytree clients should use staging for development as develop may contain unstable features.
    • local is only for SDK development by Moneytree engineers.
    redirectUri?: string

    OAuth redirection URI, see here for more details.

    Set the default value via MtLinkSdk.init

    samlSubjectId?: string

    Sets the subject ID for SAML AuthnRequest.

    scopes?: Scopes

    Access scopes you're requesting. This can be a single scope, or an array of scopes.

    Currently supported scopes are:

    • guest_read
    • accounts_read
    • points_read
    • point_transactions_read
    • transactions_read
    • transactions_write
    • expense_claims_read
    • categories_read
    • investment_accounts_read
    • investment_transactions_read
    • notifications_read
    • request_refresh
    • life_insurance_read

    See the LINK Platform documentation for more details

    'guest_read', or set via MtLinkSdk.init

    sdkPlatform?: "ios" | "android" | "js"
    sdkVersion?: string
    showAuthToggle?: boolean

    If you wish to disable the Login to Sign up form toggle button and vice-versa in the auth screen, set this to false.

    Set default value via MtLinkSdk.init

    true
    showRememberMe?: boolean

    If you wish to disable the Stay logged in for 30 days checkbox in the login screen, set this to false.

    Set default value via MtLinkSdk.init

    true
    state?: string

    The state parameter for OAuth flows, see here for more details.

    If you generate an identifier for the OAuth authorization on your server make sure to set this value explicitly so that you can use it to acquire the access token after the OAuth redirect occurs.

    The default value is a randomly generated uuid, or set via MtLinkSdk.init

    Settings
    Member Visibility

    On This Page
    Properties