The purpose of this document is to set up Plaid Credentials via script. This script will be run from the Developer Console.
Initial Steps
-
Login to Salesforce using your credentials
-
Click on the Gear Icon ⚙️ and Select Developer Console.
-
In the Developer Console, go to Debug → Open Execute Anonymous Window.
-
Copy one of the desired scripts from the options provided below into the window.
-
Highlight the script and click Execute Highlighted.
Setting up Plaid Credentials and enabling Products
bankconnect.AdminServices.updatePlaidCredentials(environment, clientId, clientSecret, siteURL, encryptionKey, assets, assetPDF, auth, balance, income, transactions, insights, invest, liabilities);
|
Parameter |
Description |
|---|---|
|
environment |
Sandbox or Production |
|
clientId |
Enter Client Id (You can get this info on your Plaid Dashboard. In case you don't have the membership with Plaid please request these information from Cloud Maven) |
|
clientSecret |
Enter Client Secret (You can get this info on your Plaid Dashboard. In case you don't have the membership with Plaid please request these information from Cloud Maven) |
|
siteURL |
Enter the site URL |
|
encryptionKey |
Enter Encryption Key (Any 16 digit code, Example - 1234567890123456) |
|
assets |
true , If you want assets to be enabled |
|
assetPDF |
true , If you want asset PDF to be enabled |
|
auth |
true , If you want auth to be enabled |
|
balance |
true , If you want balance to be enabled |
|
identity |
true , If you want Identity to be enabled |
|
transactions |
true , If you want transactions to be enabled |
|
insights |
true , If you want insights to be enabled ( Include insights is enabled if you want transaction details with the asset) |
|
invest |
true , If you want investments to be enabled |
|
liabilities |
true , If you want liabilities to be enabled |
Enable Processor Token Feature
bankconnect.AdminServices.enableProcessorTokenFeature(environment, bEnable);
This feature allows Salesforce (via the Plaid integration) to generate a processor_token, which is a secure, single-use token used by Plaid partners to initiate API calls on your behalf.
The processor_token is primarily used in conjunction with Plaid’s Auth product and is generated after a customer has successfully authenticated their bank account through Plaid Link. Once authentication is complete, Plaid retrieves the account’s routing number and account number (along with other necessary metadata), then uses these details to securely create the processor token.
Why It’s Important
-
Enables seamless payment initiation, fund transfers, or direct debit setup through payment processors that integrate with Plaid (e.g., Stripe, Dwolla).
-
Avoids storing sensitive banking details directly in Salesforce by exchanging them for a secure token.
-
Ensures compliance and security when handling bank account information.
Typical Flow
-
Customer links their bank account via Plaid Link in Salesforce.
-
The Auth product retrieves the bank account’s routing and account numbers.
-
This feature generates a
processor_tokenfor the authenticated account. -
The
processor_tokenis passed to your chosen payment processor to complete the transaction or setup process.
Enable Income Verification
bankconnect.AdminServices.enableIncomeVerification(environment, bEnable);
Income Verification in Plaid is a feature that allows businesses to securely confirm a user’s income, employment status, and income sources directly from their bank account data. Instead of relying on manual document uploads like pay stubs or tax forms, Plaid connects to the user’s financial institution (with consent) and analyzes transaction history to identify payroll deposits, amounts, and frequency.
Key Points
-
Data Source: Pulls real-time data from linked bank accounts.
-
Use Cases: Loan approvals, tenant screening, gig worker verification, benefits eligibility.
-
Benefits: Faster, more accurate, and less prone to fraud compared to manual income verification.
-
Integration: Works through Plaid Link and the
/income/API endpoints, with results viewable in reports or your integrated system.
It’s essentially a way to replace paperwork with instant, trusted bank data for income checks.
Enable Identity Verification
bankconnect.AdminServices.enableIdentityVerification(environment, bEnable);
Identity Verification in Plaid is a feature that allows businesses to confirm a user’s identity in real time using a secure, automated process. It combines document checks, biometric verification (selfie match), and database lookups to ensure the person is who they claim to be.
Key Points
-
Process: The user uploads an ID document (e.g., driver’s license, passport) and may take a selfie for facial match verification.
-
Additional Checks: Validates personal details such as name, date of birth, and address against trusted data sources.
-
Use Cases: KYC compliance, fraud prevention, account opening, and onboarding in regulated industries.
-
Integration: Configured through an Identity Verification Template in the Plaid Dashboard and launched via Plaid Link.
It’s essentially Plaid’s digital ID check that helps businesses meet compliance requirements while giving users a quick and secure onboarding experience.
Enable Statement Product
bankconnect.AdminServices.enableStatements(environment, bEnable);
Statements in Plaid allow businesses to retrieve a user’s official bank account statements directly from their financial institution, with the user’s consent. Instead of asking customers to manually download and upload PDFs, Plaid automates the process by securely fetching these statements through its API.
Key Points
-
Data Source: Official PDF statements provided by the bank.
-
Use Cases: Loan processing, income verification, financial audits, and account history validation.
-
Benefits: Saves time for users, ensures authenticity of documents, and reduces the risk of tampering or fraud.
-
Integration: Accessed through Plaid’s
/statements/endpoints after the user links their account via Plaid Link.
It’s essentially a fast, secure way to collect bank-issued statements without the back-and-forth of manual file sharing.
Enable Custom Plaid Analytics & Statement Summary
bankconnect.AdminServices.enableCustomPlaidAnalytics(environment, plaidAnalytics, plaidStatementSummary);
plaidAnalytics - This setting enables the Cloud Maven Statistics component to display detailed insights such as transaction history and account balances after the Asset Report has been successfully retrieved.
plaidStatementSummary - This feature enables the automatic creation of Statement Summaries under the Bank Verification record after the Asset Report is retrieved from Plaid.
Once the Asset Report is pulled from Plaid, this component processes the data and presents key financial statistics, giving users a comprehensive view of their account activity and current balances in an easy-to-understand format.
Benefits:
-
Provides real-time visibility into transactions and balances.
-
Helps users and administrators quickly assess financial health based on up-to-date data.
-
Enhances the overall user experience by integrating detailed financial insights directly within Salesforce.
Enable Multiple Bank Authentication Feature
bankconnect.AdminServices.enableMultipleBankFeature(environment, bEnable);
This feature allows the end user to connect and authenticate multiple bank accounts within a single verification request.
Instead of initiating separate requests for each bank, the user can link more than one financial institution during the same Plaid session. This is particularly useful when a customer’s financial data is spread across multiple banks and you want to gather a complete view in one go.
Benefits:
-
Reduces the number of verification requests needed.
-
Saves time for both the user and the business.
-
Ensures a more holistic financial profile by including data from multiple sources.
Example: A user can connect their checking account from Bank A and their savings account from Bank B during the same Plaid verification flow.