Plaid logo
Docs
ALL DOCS

Link

  • Overview
Platforms
  • Web
  • iOS
  • Android
  • React Native
  • Hosted Link
Core Link functionality
  • OAuth guide
  • Update mode
  • Preventing duplicate Items
  • Data Transparency Messaging migration
  • Returning user experience
Additional Link modes
  • Embedded Link
  • Multi-Item Link
  • Link Recovery (beta)
  • Modular Link (UK/EU only)
Optimizing Link
  • Optimizing Link conversion
  • Link analytics and tracking
  • Pre-Link messaging
  • Customizing Link
  • Choosing when to initialize products
Errors and troubleshooting
  • Troubleshooting
  • Handling an invalid Link Token
  • Institution status in Link
Legacy flows
  • Legacy public key integrations
  • Link Token migration guide
  • Webview integrations
Plaid logo
Docs
Close search modal
Ask Bill!
Ask Bill!
Hi! I'm Bill! You can ask me all about the Plaid API. Try asking questions like:
  • Can you show code for getting a credit card APR in Ruby?
  • Why is /transactions/sync/ better than /get?
  • How do I enable IDV selfie checks?
Note: Bill isn't perfect. He's just a robot platypus that reads our docs for fun. You should treat his answers with the same healthy skepticism you might treat any other answer on the internet. This chat may be logged for quality and training purposes. Please don't send Bill any PII -- he's scared of intimacy. All chats with Bill are subject to Plaid's Privacy Policy.
Plaid.com
Log in
Get API Keys
Open nav

Link React Native SDK

Reference for integrating with the 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

Prefer to learn with code examples? A GitHub repo showing a working example Link implementation is available for this topic.

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

Examples of Plaid Link for React Native

Requirements

  • React Native Version 0.66.0 or higher

New versions of the React Native 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 Compatibility
React Native SDKAndroid SDKiOS SDKStatus
12.x.x5.0+>=6.0.0Active, supports Xcode 16
11.x.x4.1.1+>=5.1.0Active, supports Xcode 15
10.x.x3.10.1+>=4.1.0Active, supports Xcode 14
9.x.x3.10.1+>=4.1.0Deprecated, supports Xcode 14

Getting Started

Installing the SDK

In your react-native project directory, run:

1npm install --save react-native-plaid-link-sdk
iOS Setup

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

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

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

1cd ios && bundle install && bundle exec pod install
Android Setup

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).

Opening Link

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.

create

You can initiate the Link preloading process by invoking the create function. After calling create, call open to open Link. This function requires SDK version 11.6 or later.

create
linkTokenConfiguration
LinkTokenConfigurationLinkTokenConfiguration
A configuration used to open Link with a Link Token.
token
stringstring
The link_token to be used to authenticate your app with Link. The link_token is created by calling /link/token/create and is a short lived, one-time use token that should be unique for each Link session. In addition to the primary flow, a link_token can be configured to launch Link in update mode. See the /link/token/create endpoint for a full list of configurations.
noLoadingState
booleanboolean
Hides native activity indicator if true.
logLevel
LinkLogLevelLinkLogLevel
Set the level at which to log statements

Possible values: DEBUG, INFO, WARN, ERROR
1<TouchableOpacity
2 style={styles.button}
3 onPress={() => {
4 create({token: linkToken});
5 setDisabled(false);
6 }
7 }>
8 <Text style={styles.button}>Create Link</Text>
9</TouchableOpacity>
open

After calling create, you can subsequently invoke the open function. Note that maximizing the delay between these two calls will reduce latency for your users by allowing Link more time to load. This function requires SDK version 11.6 or later.

open
onSuccess
LinkSuccessListenerLinkSuccessListener
A function that is called when a user successfully links an Item. The function should expect one argument. See onSuccess.
onExit
LinkExitListenerLinkExitListener
A function that is called when a user exits Link without successfully linking an Item, or when an error occurs during Link initialization. The function should expect one argument. See onExit.
iosPresentationStyle
LinkIOSPresentationStyleLinkIOSPresentationStyle
The presentation style to use on iOS. Defaults to MODAL.

Possible values: MODAL, FULL_SCREEN
logLevel
LinkLogLevelLinkLogLevel
Set the level at which to log statements

Possible values: DEBUG, INFO, WARN, ERROR
1<TouchableOpacity
2 disabled={disabled}
3 style={disabled ? styles.disabledButton : styles.button}
4 onPress={() => {
5 const openProps = {
6 onSuccess: (success: LinkSuccess) => {
7 console.log(success);
8 },
9 onExit: (linkExit: LinkExit) => {
10 console.log(exit);
11 };
12 open(openProps);
13 setDisabled(true);
14 }}>
15 <Text style={styles.button}>Open Link</Text>
16</TouchableOpacity>
PlaidLink

PlaidLink is a React component used to open Link from a React Native application. PlaidLink renders a Pressable component, which wraps the component you provide and intercepts onPress events to open Link. PlaidLink is an older alternative to the create and open methods, which offer reduced Link latency and improved performance.

plaidLink
onSuccess
LinkSuccessListenerLinkSuccessListener
A function that is called when a user successfully links an Item. The function should expect one argument. See onSuccess.
tokenConfig
LinkTokenConfigurationLinkTokenConfiguration
A configuration used to open Link with a Link Token.
token
stringstring
The link_token to be used to authenticate your app with Link. The link_token is created by calling /link/token/create and is a short lived, one-time use token that should be unique for each Link session. In addition to the primary flow, a link_token can be configured to launch Link in update mode. See the /link/token/create endpoint for a full list of configurations.
logLevel
LinkLogLevelLinkLogLevel
Set the level at which to log statements

Possible values: DEBUG, INFO, WARN, ERROR
extraParams
Record<string, any>Record<string, any>
You do not need to use this field unless specifically instructed to by Plaid.
onExit
LinkExitListenerLinkExitListener
A function that is called when a user exits Link without successfully linking an Item, or when an error occurs during Link initialization. The function should expect one argument. See onExit.
children
React.ReactNodeReact.ReactNode
The underlying component to render
1<PlaidLink
2 tokenConfig={{
3 token: '#GENERATED_LINK_TOKEN#',
4 }}
5 onSuccess={(success: LinkSuccess) => {
6 console.log(success);
7 }}
8 onExit={(exit: LinkExit) => {
9 console.log(exit);
10 }}
11>
12 <Text>Add Account</Text>
13</PlaidLink>

onSuccess

The method is called when a user successfully links an Item. The onSuccess handler returns a LinkConnection class that includes the public_token, and additional Link metadata in the form of a LinkConnectionMetadata class.

onSuccess
publicToken
StringString
Displayed once a user has successfully completed Link. If using Identity Verification or Beacon, this field will be null. If using Document Income or Payroll Income, the public_token will be returned, but is not used.
metadata
LinkSuccessMetadataLinkSuccessMetadata
Displayed once a user has successfully completed Link.
accounts
Array<LinkAccount>Array<LinkAccount>
A list of accounts attached to the connected Item. If Account Select is enabled via the developer dashboard, accounts will only include selected accounts.
id
stringstring
The Plaid account_id
name
nullablestringnullable, string
The official account name
mask
nullablestringnullable, string
The last 2-4 alphanumeric characters of an account's official account number. Note that the mask may be non-unique between an Item's accounts, it may also not match the mask that the bank displays to the user.
type
LinkAccountTypeLinkAccountType
The account type. See the Account schema for a full list of possible values
subtype
LinkAccountSubtypeLinkAccountSubtype
The account subtype. See the Account schema for a full list of possible values
verification_status
nullableLinkAccountVerificationStatusnullable, LinkAccountVerificationStatus
Indicates an Item's micro-deposit-based verification or database verification status.
pending_automatic_verification
The Item is pending automatic verification
pending_manual_verification
The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the deposit.
automatically_verified
The Item has successfully been automatically verified
manually_verified
The Item has successfully been manually verified
verification_expired
Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.
verification_failed
The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.
database_matched
The Item has successfully been verified using Plaid's data sources.
database_insights_pending
The Database Insights result is pending and will be available upon Auth request.
null
Neither micro-deposit-based verification nor database verification are being used for the Item.
institution
nullableobjectnullable, object
An institution object. If the Item was created via Same-Day micro-deposit verification, will be null.
name
stringstring
The full institution name, such as 'Wells Fargo'
id
stringstring
The Plaid institution identifier
linkSessionId
nullableStringnullable, String
A unique identifier associated with a user's actions and events through the Link flow. Include this identifier when opening a support ticket for faster turnaround.
metadataJson
nullableMapnullable, Map
The data directly returned from the server with no client side changes.
1const onSuccess = (success: LinkSuccess) => {
2 // If using Item-based products, exchange public_token
3 // for access_token
4 fetch('https://yourserver.com/exchange_public_token', {
5 method: 'POST',
6 headers: {
7 "Content-Type": "application/json",
8 },
9 body: JSON.Stringify({
10 publicToken: linkSuccess.publicToken,
11 accounts: linkSuccess.metadata.accounts,
12 institution: linkSuccess.metadata.institution,
13 linkSessionId: linkSuccess.metadata.linkSessionId,
14 }),
15 });
16};

onExit

The onExit handler is called when a user exits Link without successfully linking an Item, or when an error occurs during Link initialization. The PlaidError returned from the onExit handler is meant to help you guide your users after they have exited Link. We recommend storing the error and metadata information server-side in a way that can be associated with the user. You’ll also need to include this and any other relevant info in Plaid Support requests for the user.

onExit
error
LinkErrorLinkError
An object that contains the error type, error code, and error message of the error that was last encountered by the user. If no error was encountered, error will be null.
displayMessage
nullableStringnullable, String
A user-friendly representation of the error code. null if the error is not related to user action. This may change over time and is not safe for programmatic use.
errorCode
LinkErrorCodeLinkErrorCode
The particular error code. Each errorType has a specific set of errorCodes. A code of 499 indicates a client-side exception.
errorType
LinkErrorTypeLinkErrorType
A broad categorization of the error.
errorMessage
StringString
A developer-friendly representation of the error code.
errorJson
nullableStringnullable, String
The data directly returned from the server with no client side changes.
metadata
Map<String, Object>Map<String, Object>
An object containing information about the exit event
linkSessionId
nullableStringnullable, String
A unique identifier associated with a user's actions and events through the Link flow. Include this identifier when opening a support ticket for faster turnaround.
institution
nullableLinkInstitutionnullable, LinkInstitution
An institution object. If the Item was created via Same-Day micro-deposit verification, will be null.
name
stringstring
The full institution name, such as 'Wells Fargo'
id
stringstring
The Plaid institution identifier
status
nullableLinkExitMetadataStatusnullable, LinkExitMetadataStatus
The point at which the user exited the Link flow. One of the following values
requires_questions
User prompted to answer security questions
requires_selections
User prompted to answer multiple choice question(s)
requires_recaptcha
User prompted to solve a reCAPTCHA challenge
requires_code
User prompted to provide a one-time passcode
choose_device
User prompted to select a device on which to receive a one-time passcode
requires_credentials
User prompted to provide credentials for the selected financial institution or has not yet selected a financial institution
requires_account_selection
User prompted to select one or more financial accounts to share
requires_oauth
User prompted to enter an OAuth flow
institution_not_found
User exited the Link flow on the institution selection pane, typically after unsuccessfully (no results returned) searching for a financial institution.
institution_not_supported
User exited the Link flow after discovering their selected institution is no longer supported by Plaid
unknown
An exit status that is not handled by the current version of the SDK
requestId
nullableStringnullable, String
The request ID for the last request made by Link. This can be shared with Plaid Support to expedite investigation
metadataJson
nullableMapnullable, Map
The data directly returned from the server with no client side changes.
1const onExit = (linkExit: LinkExit) => {
2 supportHandler.report({
3 error: linkExit.error,
4 institution: linkExit.metadata.institution,
5 linkSessionId: linkExit.metadata.linkSessionId,
6 requestId: linkExitlinkExit.metadata.requestId,
7 status: linkExit.metadata.status,
8 });
9};

onEvent

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

The onEvent callback is called at certain points in the Link flow. Unlike the handlers for onSuccess and onExit, the onEvent handler is initialized as a global lambda passed to the Plaid class. OPEN, LAYER_READY, and LAYER_NOT_AVAILABLE events will be sent immediately in real-time, and remaining events will be sent when the Link session is finished and onSuccess or onExit is called. Callback ordering is not guaranteed; onEvent callbacks may fire before, after, or surrounding the onSuccess or onExit callback, and event callbacks are not guaranteed to fire in the order in which they occurred. If you need the exact time when an event happened, use the timestamp property.
The following onEvent callbacks are stable, which means that they are suitable for programmatic use in your application's logic: OPEN, EXIT, HANDOFF, SELECT_INSTITUTION, ERROR, BANK_INCOME_INSIGHTS_COMPLETED, IDENTITY_VERIFICATION_PASS_SESSION, IDENTITY_VERIFICATION_FAIL_SESSION, LAYER_READY, LAYER_NOT_AVAILABLE. The remaining callback events are informational and subject to change, and should be used for analytics and troubleshooting purposes only.

onEvent
eventName
LinkEventNameLinkEventName
A string representing the event that has just occurred in the Link flow.
AUTO_SUBMIT_PHONE
The user was automatically sent an OTP code without a UI prompt. This event can only occur if the user's phone phone number was provided to Link via the /link/token/create call and the user has previously consented to receive OTP codes from Plaid.
BANK_INCOME_INSIGHTS_COMPLETED
The user has completed the Assets and Bank Income Insights flow.
CLOSE_OAUTH
The user closed the third-party website or mobile app without completing the OAuth flow.
CONNECT_NEW_INSTITUTION
The user has chosen to link a new institution instead of linking a saved institution. This event is only emitted in the Link Remember Me flow.
ERROR
A recoverable error occurred in the Link flow, see the error_code metadata.
EXIT
The user has exited without completing the Link flow and the onExit callback is fired.
FAIL_OAUTH
The user encountered an error while completing the third-party's OAuth login flow.
HANDOFF
The user has exited Link after successfully linking an Item.
IDENTITY_VERIFICATION_START_STEP
The user has started a step of the Identity Verification flow. The step is indicated by view_name.
IDENTITY_VERIFICATION_PASS_STEP
The user has passed a step of the Identity Verification flow. The step is indicated by view_name.
IDENTITY_VERIFICATION_FAIL_STEP
The user has failed a step of the Identity Verification flow. The step is indicated by view_name.
IDENTITY_VERIFICATION_PENDING_REVIEW_STEP
The user has reached the pending review state.
IDENTITY_VERIFICATION_CREATE_SESSION
The user has started a new Identity Verification session.
IDENTITY_VERIFICATION_RESUME_SESSION
The user has resumed an existing Identity Verification session.
IDENTITY_VERIFICATION_PASS_SESSION
The user has passed their Identity Verification session.
IDENTITY_VERIFICATION_PENDING_REVIEW_SESSION
The user has completed their Identity Verification session, which is now in a pending review state.
IDENTITY_VERIFICATION_FAIL_SESSION
The user has failed their Identity Verification session.
IDENTITY_VERIFICATION_OPEN_UI
The user has opened the UI of their Identity Verification session.
IDENTITY_VERIFICATION_RESUME_UI
The user has resumed the UI of their Identity Verification session.
IDENTITY_VERIFICATION_CLOSE_UI
The user has closed the UI of their Identity Verification session.
LAYER_NOT_AVAILABLE
The user phone number passed to Link is not eligible for Layer.
LAYER_READY
The user phone number passed to Link is eligible for Layer and open() may now be called.
MATCHED_SELECT_INSTITUTION
The user selected an institution that was presented as a matched institution. This event can be emitted if Embedded Institution Search is being used, if the institution was surfaced as a matched institution likely to have been linked to Plaid by a returning user, or if the institution's routing_number was provided when calling /link/token/create. For details on which scenario is triggering the event, see metadata.matchReason.
MATCHED_SELECT_VERIFY_METHOD
deprecateddeprecated,
The user selected a verification method for a matched institution. This event is emitted only during the legacy version of the Returning User Experience flow.
OPEN
The user has opened Link.
OPEN_MY_PLAID
The user has opened my.plaid.com. This event is only sent when Link is initialized with Assets as a product.
OPEN_OAUTH
The user has navigated to a third-party website or mobile app in order to complete the OAuth login flow.
SEARCH_INSTITUTION
The user has searched for an institution.
SELECT_BRAND
The user selected a brand, e.g. Bank of America. The SELECT_BRAND event is only emitted for large financial institutions with multiple online banking portals.
SELECT_DEGRADED_INSTITUTION
The user selected an institution with a DEGRADED health status and was shown a corresponding message.
SELECT_DOWN_INSTITUTION
The user selected an institution with a DOWN health status and was shown a corresponding message.
SELECT_FILTERED_INSTITUTION
The user selected an institution Plaid does not support all requested products for and was shown a corresponding message.
SELECT_INSTITUTION
The user selected an institution.
SKIP_SUBMIT_PHONE
The user has opted to not provide their phone number to Plaid. This event is only emitted in the Link Remember Me flow.
SUBMIT_ACCOUNT_NUMBER
The user has submitted an account number. This event emits the account_number_mask metadata to indicate the mask of the account number the user provided.
SUBMIT_CREDENTIALS
The user has submitted credentials.
SUBMIT_MFA
The user has submitted MFA.
SUBMIT_OTP
The user has submitted an OTP code during the phone number verification flow. This event is only emitted in the Link Returning User Experience flow.
SUBMIT_PHONE
The user has submitted their phone number. This event is only emitted in the Link Remember Me flow.
SUBMIT_ROUTING_NUMBER
The user has submitted a routing number. This event emits the routing_number metadata to indicate user's routing number.
TRANSITION_VIEW
The TRANSITION_VIEW event indicates that the user has moved from one view to the next.
VERIFY_PHONE
The user has successfully verified their phone number using OTP. This event is only emitted in the Link Remember Me flow.
VIEW_DATA_TYPES
The user has viewed data types on the data transparency consent pane.
UNKNOWN
The UNKNOWN event indicates that the event is not handled by the current version of the SDK.
metadata
LinkEventMetadataLinkEventMetadata
An object containing information about the event.
submitAccountNumber
StringString
The account number mask extracted from the user-provided account number. If the user-inputted account number is four digits long, account_number_mask is empty. Emitted by SUBMIT_ACCOUNT_NUMBER.
errorCode
StringString
The error code that the user encountered. Emitted by: ERROR, EXIT.
errorMessage
StringString
The error message that the user encountered. Emitted by: ERROR, EXIT.
errorType
StringString
The error type that the user encountered. Emitted by: ERROR, EXIT.
exitStatus
StringString
The status key indicates the point at which the user exited the Link flow. Emitted by: EXIT.
institutionId
StringString
The ID of the selected institution. Emitted by: all events.
institutionName
StringString
The name of the selected institution. Emitted by: all events.
institutionSearchQuery
StringString
The query used to search for institutions. Emitted by: SEARCH_INSTITUTION.
isUpdateMode
StringString
Indicates if the current Link session is an update mode session. Emitted by: OPEN.
matchReason
nullablestringnullable, string
The reason this institution was matched. This will be either returning_user or routing_number if emitted by: MATCHED_SELECT_INSTITUTION. Otherwise, this will be SAVED_INSTITUTION or AUTO_SELECT_SAVED_INSTITUTION if emitted by: SELECT_INSTITUTION.
routingNumber
Optional<String>Optional<String>
The routing number submitted by user at the micro-deposits routing number pane. Emitted by SUBMIT_ROUTING_NUMBER.
linkSessionId
StringString
The linkSessionId is a unique identifier for a single session of Link. It's always available and will stay constant throughout the flow. Emitted by: all events.
mfaType
StringString
If set, the user has encountered one of the following MFA types: code device questions selections. Emitted by: SUBMIT_MFA and TRANSITION_VIEW when view_name is MFA.
requestId
StringString
The request ID for the last request made by Link. This can be shared with Plaid Support to expedite investigation. Emitted by: all events.
selection
StringString
Either the verification method for a matched institution selected by the user or the Auth Type Select flow type selected by the user. If selection is used to describe selected verification method, then possible values are phoneotp or password; if selection is used to describe the selected Auth Type Select flow, then possible values are flow_type_manual or flow_type_instant. Emitted by: MATCHED_SELECT_VERIFY_METHOD and SELECT_AUTH_TYPE.
timestamp
StringString
An ISO 8601 representation of when the event occurred. For example, 2017-09-14T14:42:19.350Z. Emitted by: all events.
viewName
LinkEventViewNameLinkEventViewName
The name of the view that is being transitioned to. Emitted by: TRANSITION_VIEW.
ACCEPT_TOS
The view showing Terms of Service in the identity verification flow.
CONNECTED
The user has connected their account.
CONSENT
We ask the user to consent to the privacy policy.
CREDENTIAL
Asking the user for their account credentials.
DATA_TRANSPARENCY
We disclose the data types being shared.
DATA_TRANSPARENCY_CONSENT
We ask the user to consent to the privacy policy and disclose data types being shared.
DOCUMENTARY_VERIFICATION
The view requesting document verification in the identity verification flow (configured via "Fallback Settings" in the "Rulesets" section of the template editor).
ERROR
An error has occurred.
EXIT
Confirming if the user wishes to close Link.
INSTANT_MICRODEPOSIT_AUTHORIZED
The user has authorized an instant micro-deposit to be sent to their account over the RTP or FedNow network with a 3-letter code to verify their account.
KYC_CHECK
The view representing the "know your customer" step in the identity verification flow.
LOADING
Link is making a request to our servers.
MATCHED_CONSENT
deprecateddeprecated,
We ask the matched user to consent to the privacy policy and SMS terms. Used only in the legacy version of the Returning User Experience flow.
MATCHED_CREDENTIAL
deprecateddeprecated,
We ask the matched user for their account credentials to a matched institution. Used only in the legacy version of the Returning User Experience flow.
MATCHED_MFA
deprecateddeprecated,
We ask the matched user for MFA authentication to verify their identity. Used only in the legacy version of the Returning User Experience flow.
MFA
The user is asked by the institution for additional MFA authentication.
NUMBERS
The user is asked to insert their account and routing numbers.
NUMBERS_SELECT_INSTITUTION
The user goes through the Same Day micro-deposits flow with Reroute to Credentials.
OAUTH
The user is informed they will authenticate with the financial institution via OAuth.
RECAPTCHA
The user was presented with a Google reCAPTCHA to verify they are human.
RISK_CHECK
The risk check step in the identity verification flow (configured via "Risk Rules" in the "Rulesets" section of the template editor).
SAME_DAY_MICRODEPOSIT_AUTHORIZED
The user has authorized a same day micro-deposit to be sent to their account over the ACH network with a 3-letter code to verify their account.
SCREENING
The watchlist screening step in the identity verification flow.
SELECT_ACCOUNT
We ask the user to choose an account.
SELECT_AUTH_TYPE
The user is asked to choose whether to Link instantly or manually (i.e., with micro-deposits).
SELECT_BRAND
The user is asked to select a brand, e.g. Bank of America. The brand selection interface occurs before the institution select pane and is only provided for large financial institutions with multiple online banking portals.
SELECT_INSTITUTION
We ask the user to choose their institution.
SELECT_SAVED_ACCOUNT
The user is asked to select their saved accounts and/or new accounts for linking in the Link Remember Me flow.
SELECT_SAVED_INSTITUTION
The user is asked to pick a saved institution or link a new one in the Link Remember Me flow.
SELFIE_CHECK
The view in the identity verification flow which uses the camera to confirm there is real user that matches their ID documents.
SUBMIT_PHONE
The user is asked for their phone number in the Link Remember Me flow.
UPLOAD_DOCUMENTS
The user is asked to upload documents (for Income verification).
VERIFY_PHONE
The user is asked to verify their phone OTP in the Link Remember Me flow.
VERIFY_SMS
The SMS verification step in the identity verification flow.
1usePlaidEmitter((event) => {
2 console.log(event);
3});

submit

The submit function is currently only used in the Layer product. It allows the client application to submit additional user-collected data to the Link flow (e.g. a user phone number).

submit
submissionData
objectobject
Data to submit during a Link session.
phoneNumber
StringString
The end user's phone number.
1submit({
2 "phone_number": "+14155550123"
3})

destroy

The destroy function clears state and resources from a previously opened session. The destroy function is only available on Android, as this state clearing behavior occurs automatically on iOS. destroy is intended for use with the Layer product and should be used if you are making multiple calls to create before calling submit. By calling destroy between the create calls, you can avoid unexpected behavior on the submit call.

1create(tokenConfiguration1)
2async () => {
3 try {
4 await destroy(); // Clear previous session state
5 create(tokenConfiguration2);
6 submit(phoneNumber);
7 } catch (e) {
8 console.error('Error during flow:', e);
9 }
10}

OAuth

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

Upgrading

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.

Migration guides
  • 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 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.
Was this helpful?
Developer community
GitHub
GitHub
Stack Overflow
Stack Overflow
YouTube
YouTube
Discord
Discord