Link React Native SDK

This guide covers the latest major version of the Link React Native SDK, which is version 12.x.x. For information on migrating from older versions, see Migration guides.

Overview

To get started with Plaid Link for React Native youʼll want to sign up for free API keys through the Plaid Dashboard.

Requirements

• React Native Version 0.66.0 or higher

SDK versions are supported for two years; with each major SDK release, Plaid will stop officially supporting any previous SDK versions that are more than two years old. While these older versions are expected to continue to work without disruption, Plaid will not provide assistance with unsupported SDK versions.

Getting Started

In your react-native project directory, run:

npm install --save react-native-plaid-link-sdk

Add Plaid to your project's Podfile as follows (likely located at ios/Podfile).

pod 'Plaid', '~> <insert latest version>'

Autolinking should install the CocoaPods dependencies for iOS project. If it fails you can run

cd ios && bundle install && bundle exec pod install

Requirements:

• Android 5.0 (API level 21) and above.
• Your compileSdkVersion must be 35.
• Android gradle plugin 4.x and above.

Autolinking should handle all of the Android setup.

• Register your Android package name in the Dashboard. This is required in order to connect to OAuth institutions (which includes most major banks).

Sample app

For a sample app that demonstrates a minimal integration with the React Native Plaid Link SDK, see the Tiny Quickstart (React Native).

Before you can open Link, you need to first create a link_token. A link_token can be configured for different Link flows and is used to control much of Link's behavior. To see how to create a new link_token, see the API Reference entry for /link/token/create. If your React Native application will be used on Android, the link/token/create call should include the android_package_name parameter. Each time you open Link, you will need to get a new link_token from your server.

Next, open Link via the create and open methods. These functions require version 11.6 or later of the Plaid React Native SDK.

If using a version earlier than 11.6, you must open Link with the legacy PlaidLink component, which configures Link and registers a callback in a single component. This approach has higher user-facing latency than using the create and open methods.

<TouchableOpacity
  style={styles.button}
  onPress={() => {
      create({token: linkToken});
      setDisabled(false);
    }
  }>
  <Text style={styles.button}>Create Link</Text>
</TouchableOpacity>

<TouchableOpacity
  disabled={disabled}
  style={disabled ? styles.disabledButton : styles.button}
  onPress={() => {
    const openProps = {
      onSuccess: (success: LinkSuccess) => {
      console.log(success);
      },
      onExit: (linkExit: LinkExit) => {
        console.log(exit);
      };
    open(openProps);
    setDisabled(true);
  }}>
  <Text style={styles.button}>Open Link</Text>
</TouchableOpacity>

<PlaidLink
  tokenConfig={{
    token: '#GENERATED_LINK_TOKEN#',
  }}
  onSuccess={(success: LinkSuccess) => {
    console.log(success);
  }}
  onExit={(exit: LinkExit) => {
    console.log(exit);
  }}
>
  <Text>Add Account</Text>
</PlaidLink>

const onSuccess = (success: LinkSuccess) => {
  // If using Item-based products, exchange public_token
  // for access_token
  fetch('https://yourserver.com/exchange_public_token', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json",
    },
    body: JSON.Stringify({
      publicToken: linkSuccess.publicToken,
      accounts: linkSuccess.metadata.accounts,
      institution: linkSuccess.metadata.institution,
      linkSessionId: linkSuccess.metadata.linkSessionId,
    }),
  });
};

const onExit = (linkExit: LinkExit) => {
  supportHandler.report({
    error: linkExit.error,
    institution: linkExit.metadata.institution,
    linkSessionId: linkExit.metadata.linkSessionId,
    requestId: linkExitlinkExit.metadata.requestId,
    status: linkExit.metadata.status,
  });
};

The React Native Plaid module emits onEvent events throughout the account linking process. To receive these events use the usePlaidEmitter hook.

usePlaidEmitter((event) => {
  console.log(event);
});

submit({
  "phone_number": "+14155550123"
})

create(tokenConfiguration1)
async () => {
  try {
    await destroy(); // Clear previous session state
    create(tokenConfiguration2);
    submit(phoneNumber);
  } catch (e) {
    console.error('Error during flow:', e);
  }
}

Using Plaid Link with an OAuth flow requires some additional setup instructions. For details, see the OAuth guide.

The latest version of the SDK is available from GitHub. New versions of the SDK are released frequently. Major releases occur annually. The Link SDK uses Semantic Versioning, ensuring that all non-major releases are non-breaking, backwards-compatible updates. We recommend you update regularly (at least once a quarter, and ideally once a month) to ensure the best Plaid Link experience in your application.

SDK versions are supported for two years; with each major SDK release, Plaid will stop officially supporting any previous SDK versions that are more than two years old. While these older versions are expected to continue to work without disruption, Plaid will not provide assistance with unsupported SDK versions.

• Version 12.x removes the PlaidLink component and openLink function, which were deprecated in version 11.6.0. If you are using this method of opening Link, replace it with the new process that uses create and then open. For details, see Opening Link or the README. Version 12.x also removes the PROFILE_ELIGIBILITY_CHECK_ERROR.
• Version 12.x updates the Android target SDK version and compile version from 33 to 35 and requires use of an Xcode 16 toolchain.
• Version 11.x contains several breaking changes from previous major versions. For details, see the migration guide on GitHub.
• When upgrading from 9.x to 10.x or later, you should remove any invocation of useDeepLinkRedirector on iOS, as it has been removed from the SDK, since it is no longer required for handling Universal Links. You must make sure you are using a compatible version of React Native (0.66.0 or higher) and the Plaid iOS SDK (see the version compatibility chart on GitHub).
• No code changes are required to upgrade from 8.x to 9.x, although you must make sure you are using a compatible version of the Plaid iOS SDK (4.1.0 or higher).
• The only difference between version 7.x and 8.x is that 8.x adds support for Xcode 14. No code changes are required to upgrade from 7.x to 8.x, although you must convert to an Xcode 14 toolchain.