# Flinks Documentation

## Docs

- [Welcome to Flinks API Reference](https://docs.flinks.com/api-home.md): Flinks uses a RESTful API that allows developers to seamlessly integrate with our products. It provides a secure connection to our endpoints so that you can receive account information, data enrichment, confirm a customer's identity, initiate a payment, and more.
- [Endpoints](https://docs.flinks.com/api/authorize/endpoints.md): Refer to the following table for a list of endpoints related to Authorization.
- [/Authorize](https://docs.flinks.com/api/authorize/endpoints/authorize.md)
- [/GenerateAuthorizeToken](https://docs.flinks.com/api/authorize/endpoints/generate-authorize-token.md): Use the /GenerateAuthorizeToken endpoint to get an Authorize Token.
- [Error Codes](https://docs.flinks.com/api/authorize/error-codes.md)
- [Authorize Token](https://docs.flinks.com/api/authorize/getting-started.md)
- [REST API](https://docs.flinks.com/api/authorize/rest-api.md)
- [Authentication Troubleshooting](https://docs.flinks.com/api/authorize/troubleshooting.md)
- [Endpoints](https://docs.flinks.com/api/connect/endpoints.md)
- [/AnswerMFAQuestions](https://docs.flinks.com/api/connect/endpoints/account-linking/answer-mfa-questions.md): The `AnswerMFAQuestions` endpoint allows you to submit responses to multi-factor authentication questions in order to complete the authentication process and refresh the associated financial card.
- [/DeleteCard](https://docs.flinks.com/api/connect/endpoints/account-linking/delete-card.md): Delete all data that's associated with a specific user account.
- [/GetAccountsDetail](https://docs.flinks.com/api/connect/endpoints/account-linking/get-accounts-detail.md): To retrieve full account details, including transactions, the holder's name, address, email and phone number, use the /GetAccountsDetail endpoint.
- [/GetAccountsDetailAsync](https://docs.flinks.com/api/connect/endpoints/account-linking/get-accounts-detail-async.md): Get pending requests from GetAccountsDetail.
- [/GetAccountsSummary](https://docs.flinks.com/api/connect/endpoints/account-linking/get-accounts-summary.md): To access general account details such as the cardholder's name (when available), account balance, account category and EFT eligibility, use the /GetAccountsSummary endpoint.
- [/GetAccountsSummaryAsync](https://docs.flinks.com/api/connect/endpoints/account-linking/get-accounts-summary-async.md): Get pending requests from GetAccountsSummary.
- [/GetMFAQuestions](https://docs.flinks.com/api/connect/endpoints/account-linking/get-mfa-questions.md): Retrieve the multi-factor authentication (MFA) questions associated with a user's account.
- [/GetNightlyRefreshStatus](https://docs.flinks.com/api/connect/endpoints/account-linking/get-nightly-refresh-status.md): Troubleshoot nightly refreshes and see ineligible accounts.
- [/GetStatements](https://docs.flinks.com/api/connect/endpoints/account-linking/get-statements.md): To retrieve PDF statements from a customer's financial institution, use the /GetStatements endpoint.
- [Banking Account Linking](https://docs.flinks.com/api/connect/endpoints/account-linking/index.md)
- [/Institutions](https://docs.flinks.com/api/connect/endpoints/account-linking/institutions.md): Retrieve all available institutions and their details.
- [/Institutions/RoutingNumber](https://docs.flinks.com/api/connect/endpoints/account-linking/institutions-routing-number.md): Returns the details of the institution corresponding to the routing number.
- [/SetScheduledRefresh](https://docs.flinks.com/api/connect/endpoints/account-linking/set-scheduled-refresh.md): Enable or disable nightly refreshes for a specific account.
- [Accounts Aggregation](https://docs.flinks.com/api/connect/getting-started.md)
- [Webhooks](https://docs.flinks.com/api/connect/webhooks.md)
- [Endpoints](https://docs.flinks.com/api/enrich/endpoints.md): Refer to the following table for a list of endpoints related to Enrich products at Flinks.
- [/Categories](https://docs.flinks.com/api/enrich/endpoints/attributes-libraries/categories.md): The /Categories endpoint returns an up-to-date list of all categories that can be applied to your customers' transactional data in either Canada or the US.
- [/Library (Consumer)](https://docs.flinks.com/api/enrich/endpoints/attributes-libraries/consumer.md): This endpoint will return a list of all currently available Attributes in our Attributes Library for Consumers.
- [/GetAllBusinessAttributes](https://docs.flinks.com/api/enrich/endpoints/business-attributes/get-all-business-attributes.md): This endpoint will provide you with all the currently available Business Attributes.
- [/GetBusinessAnalysisAttributes](https://docs.flinks.com/api/enrich/endpoints/business-attributes/get-business-analysis-attributes.md): This endpoint will provide you with all Business Analysis Use-Case Attributes.
- [Business Attributes](https://docs.flinks.com/api/enrich/endpoints/business-attributes/index.md)
- [/Attributes](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/attributes.md): Use the /Attributes endpoint to tell us the data points in your attributes package you want to retrieve.
- [/GetAllAttributes](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/get-all-attributes.md): Use the /GetAllAttributes endpoint to return a list of all customer attributes (only available to Flinks clients who take a Tier 2 or above package).
- [/GetCategorization](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/get-categorization.md): Returns categorized transactional data. This data is aggregated by Flinks through the /GetAccountsDetail endpoint.
- [/GetCreditRiskAttributes](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/get-credit-risk-attributes.md): This endpoint will provide you with all Credit Risk Use-Case Attributes.
- [/GetIncomeAttributes](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/get-income-attributes.md): This endpoint will provide you with all Income use-case Attributes.
- [/GetLendingAttributes](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/get-lending-attributes.md): This endpoint will provide you with all Lending Use-Case Attributes.
- [/GetUserAnalysisAttributes](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/get-user-analysis-attributes.md): This endpoint will provide you with all Credit Risk use-case attributes. Please refer to our Quickstart guide for further information on the use-cases / when to use this specific endpoint.
- [Consumer Attributes](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/index.md)
- [Response Parameters](https://docs.flinks.com/api/enrich/endpoints/consumer-attributes/response-parameters.md): Details of the response parameters for Consumer Attributes endpoints.
- [/Library (Business)](https://docs.flinks.com/api/enrich/endpoints/libraries/business-attributes-library.md): This endpoint will return a list of all currently available Attributes in our Attributes Library for Business.
- [Payments Optimization](https://docs.flinks.com/api/enrich/endpoints/payment-attributes/index.md): A dedicated endpoint to return all insights and information necessary to perform and optimize your user payments.
- [/Prepayment](https://docs.flinks.com/api/enrich/endpoints/payment-attributes/pre-payment.md): Use this endpoint to submit additional information on a given end-user and retrieve Payment Optimization insights.
- [ATTRIBUTES SPECIFIC ERROR CODES](https://docs.flinks.com/api/enrich/error-codes.md)
- [Attributes](https://docs.flinks.com/api/enrich/getting-started.md)
- [Webhooks](https://docs.flinks.com/api/enrich/webhooks.md)
- [Endpoints](https://docs.flinks.com/api/outbound/endpoints.md)
- [Authorize With a Data Provider](https://docs.flinks.com/api/outbound/endpoints/authorize/authorize-with-a-data-provider.md): Use this endpoint to initiate the authorization process with a particular Data Provider.
- [List of Authorization Errors](https://docs.flinks.com/api/outbound/endpoints/authorize/errors.md)
- [Authorize](https://docs.flinks.com/api/outbound/endpoints/authorize/index.md)
- [List Active Data Providers](https://docs.flinks.com/api/outbound/endpoints/authorize/list-active-data-providers.md): Use the /api/v1/providers endpoint to list active Data Providers.
- [List Active Data Providers (v2)](https://docs.flinks.com/api/outbound/endpoints/authorize/list-active-data-providers-v2.md): Use the /api/v2/providers endpoint to list which Data Providers a particular Data Recipient is registered with.
- [Revoke Connection](https://docs.flinks.com/api/outbound/endpoints/authorize/revoke-connection.md): Use the /api/v1/revoke endpoint to revoke access to the Open Banking API for an individual connection.
- [Token](https://docs.flinks.com/api/outbound/endpoints/authorize/token.md): Use the /api/v1/token endpoint to receive an access token.
- [Create a Data Recipient](https://docs.flinks.com/api/outbound/endpoints/data-receipts/create-a-data-recipient.md): Use the /api/v1/recipients endpoint to add a new Data Recipient to the Open Banking API.
- [Data Recipient Management](https://docs.flinks.com/api/outbound/endpoints/data-receipts/index.md)
- [Regenerate a Data Recipient Secret](https://docs.flinks.com/api/outbound/endpoints/data-receipts/regenerate-a-data-recipient-secret.md): Use the /api/v1/recipients/{client_id}/secret endpoint to regenerate a new client secret for a particular Data Recipient.
- [Update a Data Recipient](https://docs.flinks.com/api/outbound/endpoints/data-receipts/update-a-data-recipient.md): Use the /api/v1/recipients/{client_id} endpoint to update the redirect URLs for a particular Data Recipient.
- [List of Data Access Errors](https://docs.flinks.com/api/outbound/endpoints/fdx/fdx-errors.md)
- [Get Account Details](https://docs.flinks.com/api/outbound/endpoints/fdx/get-account-details.md): Use the /api/fdx/5/accounts/{accountId} endpoint to get information about a particular customer account in FDX format.
- [Get Accounts](https://docs.flinks.com/api/outbound/endpoints/fdx/get-accounts.md): Use the /api/fdx/5/accounts endpoint to get a list of customer accounts in FDX format.
- [Get Customers](https://docs.flinks.com/api/outbound/endpoints/fdx/get-customers.md): Use the /api/fdx/5/customers/current endpoint to get information about a particular customer in FDX format.
- [Get Payment Networks](https://docs.flinks.com/api/outbound/endpoints/fdx/get-payment-networks.md): Use the /api/fdx/5/accounts/{accountId}/payment-networks endpoint to return a list of payment networks for a particular account.
- [Get Transactions](https://docs.flinks.com/api/outbound/endpoints/fdx/get-transactions.md): Use the /api/fdx/5/accounts/{accountId}/transactions endpoint to get the transaction history for a particular account.
- [FDX](https://docs.flinks.com/api/outbound/endpoints/fdx/index.md)
- [Get All Data Recipients](https://docs.flinks.com/api/outbound/endpoints/institutions/get-all-data-recipients.md): Use the /api/v1/recipients endpoint to get a list of all registered Data Recipients.
- [Get Data Provider Details](https://docs.flinks.com/api/outbound/endpoints/institutions/get-data-provider-details.md): Use the /api/v1/providers endpoint to retrieve information about a particular Data Provider such as their country, their data scopes, the FDX fields they support, and more.
- [Get Data Recipient Details](https://docs.flinks.com/api/outbound/endpoints/institutions/get-data-recipient-details.md): Use the /api/v1/recipients/{client_id} endpoint to get additional details for a particular Data Recipient, including the scopes and redirect URLs.
- [Get Supported Data Providers](https://docs.flinks.com/api/outbound/endpoints/institutions/get-supported-data-providers.md): Use the /api/v1/providers endpoint to retrieve a list of all supported Data Providers in the Outbound ecosystem.
- [Institutions Coverage](https://docs.flinks.com/api/outbound/endpoints/institutions/index.md)
- [Get the Registration Status for a Data Recipient](https://docs.flinks.com/api/outbound/endpoints/registration/a-data-recipient.md): Use the /api/v1/recipients/{client_id}/providers/requests endpoint to check the registrations status of a Data Recipient.
- [Get the Registration Status for All Data Recipients](https://docs.flinks.com/api/outbound/endpoints/registration/all-data-recipients.md): Use the /api/v1/recipients/providers/requests endpoint to check the registrations status of all Data Recipients.
- [ Registration Status](https://docs.flinks.com/api/outbound/endpoints/registration/index.md)
- [Request Data Provider Registrations](https://docs.flinks.com/api/outbound/endpoints/registration/request-data-provider-registrations.md): Use the POST /api/v1/recipients/providers/requests/{recipient_ids}/{provider_ids} endpoint to submit a request to Flinks to connect Data Recipients with Data Providers. Flinks will evaluate the request and approve the registrations.
- [Getting Started](https://docs.flinks.com/api/outbound/getting-started.md): This page will help you get started with the Open Banking API.
- [Endpoints](https://docs.flinks.com/api/pay/endpoints.md)
- [/Authorize](https://docs.flinks.com/api/pay/endpoints/authorize/authorize.md): Authorize and generate an access token.
- [Authorize](https://docs.flinks.com/api/pay/endpoints/authorize/index.md)
- [E-Transfer API Overview](https://docs.flinks.com/api/pay/endpoints/e-transfer/index.md): Complete API reference for Interac e-Transfer (Request For Money) payments
- [Cancel Active Session](https://docs.flinks.com/api/pay/endpoints/e-transfer/sessions-cancel.md)
- [Session Details](https://docs.flinks.com/api/pay/endpoints/e-transfer/sessions-details.md)
- [Initiate Session](https://docs.flinks.com/api/pay/endpoints/e-transfer/sessions-initiate.md)
- [Cancel Schedule](https://docs.flinks.com/api/pay/endpoints/eft/cancel-schedule.md): Cancel an active recurring payment schedule. This stops all future payments that have not yet been submitted.
- [Create Transaction](https://docs.flinks.com/api/pay/endpoints/eft/create-transaction.md): Create a new EFT transaction with optional recurring schedule. Supports both debit (collect from customer) and credit (send to customer) directions.
- [Contact](https://docs.flinks.com/api/pay/endpoints/eft/get-contact.md): Retrieve a stored contact by its ID.
- [PAD Agreement](https://docs.flinks.com/api/pay/endpoints/eft/get-pad.md): Retrieve a Pre-Authorized Debit (PAD) agreement by its ID. The response includes a `padLink` URL that can be presented to the end user for PAD signing.
- [Schedule Information](https://docs.flinks.com/api/pay/endpoints/eft/get-schedule.md): Retrieve the details of a payment schedule by its ID, including the associated PAD agreement identifier once it has been generated.
- [EFT API Overview](https://docs.flinks.com/api/pay/endpoints/eft/index.md): API reference for EFT (Electronic Funds Transfer) payments — V1 endpoints
- [Transaction Codes](https://docs.flinks.com/api/pay/endpoints/eft/transaction-codes.md): EFT transaction codes as defined by Payments Canada Standard 007
- [Confirm Guarantee](https://docs.flinks.com/api/pay/endpoints/geft/guarantee-confirm.md): Accept or reject a guarantee for a GEFT session. Used in conjunction with the webhook system to explicitly confirm or decline a guarantee before completing a session.
- [GEFT API Overview](https://docs.flinks.com/api/pay/endpoints/geft/index.md): Complete API reference for GEFT (Guaranteed Electronic Funds Transfer) payments
- [Cancel Active Session](https://docs.flinks.com/api/pay/endpoints/geft/sessions-cancel.md)
- [Session Details](https://docs.flinks.com/api/pay/endpoints/geft/sessions-details.md)
- [Initiate Session](https://docs.flinks.com/api/pay/endpoints/geft/sessions-initiate.md)
- [Session Status](https://docs.flinks.com/api/pay/endpoints/geft/sessions-status.md): Retrieve the current status of a GEFT session at any point in the flow.
- [FlinksPay](https://docs.flinks.com/api/pay/getting-started.md)
- [Common Error Codes](https://docs.flinks.com/api/upload/common-error-codes.md)
- [Endpoints](https://docs.flinks.com/api/upload/endpoints.md)
- [Document Processing](https://docs.flinks.com/api/upload/endpoints/document-processing/index.md)
- [Optional Parameters](https://docs.flinks.com/api/upload/endpoints/document-processing/optional-parameters.md)
- [Transforming external transactions](https://docs.flinks.com/api/upload/endpoints/document-processing/transforming-external-transactions.md)
- [/Upload (All Attributes Example)](https://docs.flinks.com/api/upload/endpoints/document-processing/upload-all-attributes-example.md): This endpoint returns all available attributes for the given set of transactions.
- [/Upload (Base Example)](https://docs.flinks.com/api/upload/endpoints/document-processing/upload-base-example.md): Use the standard /Upload endpoint to upload transaction data and receive calculated attributes.
- [/Upload/Categorization](https://docs.flinks.com/api/upload/endpoints/document-processing/upload-categorization.md): This endpoint will allow your teams to generate Broad Categorization Responses from External Data.
- [/FraudAnalysis](https://docs.flinks.com/api/upload/endpoints/fraud/fraud-analysis.md): Use the /FraudAnalysis endpoint if you are using Flinks Upload and want to check if our fraud signals were triggered by documents that were uploaded.
- [Fraud Verification](https://docs.flinks.com/api/upload/endpoints/fraud/index.md)
- [External Data (Upload)](https://docs.flinks.com/api/upload/getting-started.md): Start using external transactional data using Flinks Enrichment.
- [/AuthSecret](https://docs.flinks.com/api/utilities/data-sharing/auth-secret.md): Use the /AuthSecret endpoint if you are a client of Flinks and want to grant access for a partner to retrieve data that is processed by Flinks. This endpoint generates a unique authorization token that your partner can use to securely access Flinks APIs.
- [/AuthSecret/Disable](https://docs.flinks.com/api/utilities/data-sharing/auth-secret-disable.md): Use the /AuthSecret/Disable endpoint if you are a client of Flinks and want to revoke access from a partner that you have previously granted access to.
- [/AuthSecret/Enable](https://docs.flinks.com/api/utilities/data-sharing/auth-secret-enable.md): Use the /AuthSecret/Enable endpoint if you are a client of Flinks and want to re-enable a partner's Auth Secret to provide access to data that is processed through Flinks.
- [Data Sharing](https://docs.flinks.com/api/utilities/data-sharing/index.md): A collection of APIs that allow you to share specific and limited end-user data with your partners.
- [/PartnerAccess](https://docs.flinks.com/api/utilities/data-sharing/partner-access.md): Retrieve shared user data through Flinks APIs using a partner access token.
- [/PartnerData](https://docs.flinks.com/api/utilities/data-sharing/partner-data.md): Use the /PartnerData endpoint if you are a client of Flinks and want to grant access for a partner to retrieve data that is processed by Flinks. This endpoint generates a unique Access Token that's associated with a specific user.
- [Endpoints](https://docs.flinks.com/api/utilities/endpoints.md): Refer to the following table for a list of utility endpoints.
- [/FieldMatch](https://docs.flinks.com/api/utilities/identity/field-match.md): Verify customer identity and validate information against account data.
- [Identity](https://docs.flinks.com/api/utilities/identity/index.md)
- [Investment Account Linking](https://docs.flinks.com/api/wealth/endpoints.md)
- [/GetWealthNightlyRefreshStatus](https://docs.flinks.com/api/wealth/endpoints/account-linking/get-nightly-refresh-status.md)
- [/Investments](https://docs.flinks.com/api/wealth/endpoints/account-linking/investments.md)
- [/Investments/Delete](https://docs.flinks.com/api/wealth/endpoints/account-linking/investments-delete.md): Specific endpoint to delete both Investments and Banking Data.
- [Response Fields](https://docs.flinks.com/api/wealth/endpoints/account-linking/response-fields.md)
- [Start to Retrieve Investments Data](https://docs.flinks.com/api/wealth/getting-started.md): How to make initial API calls to retrieve data.
- [Changelog](https://docs.flinks.com/changelog.md): Product updates and announcements
- [MCP Server Setup](https://docs.flinks.com/guides/ai/mcp-server-setup.md): Learn how to connect AI coding assistants to Flinks documentation using our MCP server
- [AI Skill](https://docs.flinks.com/guides/ai/skill.md): Give AI coding assistants complete Flinks integration context in a single file
- [Account Types & Data Categorization](https://docs.flinks.com/guides/connect/account-types.md): Understand the account types and data categorization returned by Flinks Connect.
- [Authentication Reference](https://docs.flinks.com/guides/connect/authentication-reference.md): Credentials, headers, and authentication flow for all Flinks API endpoints.
- [Bank Statements](https://docs.flinks.com/guides/connect/bank-statements.md): Retrieve original bank-issued PDF statements from Canadian financial institutions using Flinks.
- [Choose a Back-End solution](https://docs.flinks.com/guides/connect/choose-a-backend-solution.md): Compare API requests and webhooks to choose the right back-end solution for receiving customer data.
- [Choose a Front-End Solution](https://docs.flinks.com/guides/connect/choose-a-frontend-solution.md): The first step to connecting your customer accounts is choosing a front-end solution. The front-end solution is the interface that your customers use to link their banking data.
- [Confirm Your Customer's Identity](https://docs.flinks.com/guides/connect/confirm-your-customers-identity.md): Use our Field Matching service if you need to confirm your customers’ identity, confirm account ownership, or verify the accuracy of the information before connecting a customer’s bank account to your financial service.
- [Connect Customer Bank Accounts](https://docs.flinks.com/guides/connect/connect-bank-accounts.md): Allow your customers to safely access their financial data within your app or website by connecting their bank accounts through Flinks.
- [Field Match API — Guide & Testing Reference](https://docs.flinks.com/guides/connect/field-match-guide.md): Detailed guide for using and testing the /FieldMatch API, including match score ranges for all fields, test users, and test scenarios.
- [Add the Flinks Connect iframe to Your Page](https://docs.flinks.com/guides/connect/flinks-connect/add-flinks-connect-iframe.md): Embed the Flinks Connect iframe into your web page, app, or React Native project.
- [Flinks Connect Overview](https://docs.flinks.com/guides/connect/flinks-connect/flinks-connect.md): Learn how Flinks Connect works, what your customers see, and how to get started with the iframe integration.
- [Handled Errors](https://docs.flinks.com/guides/connect/flinks-connect/handled-errors.md): Reference for the 10 error types that Flinks Connect handles automatically, with their corresponding JavaScript events.
- [Test Users](https://docs.flinks.com/guides/connect/flinks-connect/test-users.md): Use test credentials and the Flinks Capital dummy institution to test your Flinks Connect integration.
- [Use a Custom Tag](https://docs.flinks.com/guides/connect/flinks-connect/use-custom-tag.md): You can use custom tags to mark requests or groups of requests. This section will cover what a custom tag is and how to handle tag information.
- [Use an Event Listener](https://docs.flinks.com/guides/connect/flinks-connect/use-event-listener.md): Add an event listener to track user progress and API events in your Flinks Connect integration.
- [Flinks Connect Widget Parameters](https://docs.flinks.com/guides/connect/flinks-connect/widget.md): Configure and customize your Flinks Connect widget using iframe URL parameters.
- [Flinks Express](https://docs.flinks.com/guides/connect/flinks-express.md): Flinks Express is the fastest way to integrate with us to connect end-user accounts. It's a hosted solution that we manage on your behalf, but design it to look like your website.
- [Getting Started with Connect](https://docs.flinks.com/guides/connect/getting-started.md): On this page, you will find instructions on how to set up Flinks Connect and Flinks Express.
- [Legacy API Integrations](https://docs.flinks.com/guides/connect/legacy-api-integrations.md): Reference guide for legacy API integrations using /Authorize, replaced by Flinks Connect.
- [Mobile & Native App Integration](https://docs.flinks.com/guides/connect/mobile-integration.md): Integrate Flinks Connect into iOS, Android, and React Native apps using WebView.
- [Nightly Refreshes](https://docs.flinks.com/guides/connect/nightly-refresh.md): If you would like automatic account refreshes, read the following sections to enable Nightly Refreshes.
- [OAuth Integration](https://docs.flinks.com/guides/connect/oauth-integration.md): Set up Flinks Connect with OAuth for web and mobile platforms, including deep linking and WebView configuration.
- [Reconnect](https://docs.flinks.com/guides/connect/resume-and-reconnect.md): Bring an end user back into Flinks Connect to answer MFA — whether their session was just interrupted or an existing connection needs a live refresh.
- [Retrieve Account Data](https://docs.flinks.com/guides/connect/retrieve-account-data.md): Call /GetAccountsDetail to retrieve account data, then handle the 202 polling flow or use webhooks.
- [Set Up Authorization](https://docs.flinks.com/guides/connect/setup-authorization.md): Generate and pass an authorize token to securely access Flinks account data.
- [Supported Financial Institutions](https://docs.flinks.com/guides/connect/supported-institutions.md): Search and browse the financial institutions supported by Flinks in Canada and the United States.
- [Testing Flinks Express](https://docs.flinks.com/guides/connect/testing-flinks-express.md): Test your Flinks Express hosted solution using demo mode and test credentials.
- [Connect Customer Investment Accounts](https://docs.flinks.com/guides/connect/wealth/connect-customers.md): Allow your customers to safely access their investments within your app or website by connecting their investment accounts through Flinks.
- [Scheduled Refresh](https://docs.flinks.com/guides/connect/wealth/scheduled-refresh.md): Set up scheduled (nightly) refreshes for Wealth investment accounts.
- [Wealth Reconnect Flow](https://docs.flinks.com/guides/connect/wealth/wealth-reconnect-flow.md): Preserve the original loginId across reconnections to track customer investments over time.
- [Getting Started with the Dashboard](https://docs.flinks.com/guides/dashboard/getting-started.md): Learn how to access the Flinks Dashboard, find your API credentials, and switch between environments.
- [Request Feed](https://docs.flinks.com/guides/dashboard/request-feed.md): Monitor and manage connection requests in the Flinks Dashboard Request Feed.
- [Team Management](https://docs.flinks.com/guides/dashboard/team-management.md): Invite team members, assign roles, and configure security settings in the Flinks Dashboard.
- [Dashboard Tools](https://docs.flinks.com/guides/dashboard/tools.md): Use Dashboard tools to download statements, refresh data, view Attributes reports, and send Bank Verification Invitations.
- [Attributes](https://docs.flinks.com/guides/enrich/attributes.md): Transform raw transactional data into actionable financial insights using Flinks Attributes.
- [List of Attributes packages](https://docs.flinks.com/guides/enrich/attributes-packages.md): Browse available Attributes packages including Income, Lending, Credit Risk, and Business Analysis.
- [Categorization Guide](https://docs.flinks.com/guides/enrich/categorization-guide.md): Understand the difference between Broad Categorization and Transaction Categorization, income detection, and merchant normalization.
- [Connect to Upload APIs](https://docs.flinks.com/guides/enrich/connect-to-api.md): Explore the available Upload endpoints for requesting Attributes using external data.
- [Enrich Your Data](https://docs.flinks.com/guides/enrich/enrich-your-data.md): Enrichment is a Flinks solution that allows you to automatically transform raw transactional data into real-time, actionable insights using `Attributes`. Each data attribute reveals information about your customer's financial profile and consumer behaviour.
- [Getting Started with Enrich](https://docs.flinks.com/guides/enrich/getting-started.md): This page will walk you through the general steps to set up Enrich in your integration.
- [Receive Your Attributes Data](https://docs.flinks.com/guides/enrich/receive-your-data.md): Set up the API call flow to retrieve enriched Attributes data using a loginId and requestId.
- [Set Up Attributes](https://docs.flinks.com/guides/enrich/setup-attributes.md): This page will walk you through the steps required to set up Attributes in your integration.
- [Transaction Categorization](https://docs.flinks.com/guides/enrich/transaction-categorization.md): Understand how Flinks categorizes transactions into primary and sub-categories for financial analysis.
- [About Flinks](https://docs.flinks.com/guides/getting-started/about-flinks.md): Learn what Flinks is, how it securely transfers financial data, and who our customers are.
- [Flinks Products](https://docs.flinks.com/guides/getting-started/flinks-products.md): Explore the full suite of Flinks products including Connect, Attributes, Pay, Outbound, and Upload.
- [Instances and Data Residency](https://docs.flinks.com/guides/getting-started/instances.md): How Flinks instances are provisioned per country to keep end-user data within its country of origin.
- [Key Concepts](https://docs.flinks.com/guides/getting-started/key-concepts.md): Understand the core concepts of the Flinks API: LoginId, RequestId, caching, and transaction types.
- [Testing Environments](https://docs.flinks.com/guides/getting-started/testing-environments.md): Understand the three levels of testing available at Flinks: Sandbox, Toolbox, and Production.
- [Walkthrough Videos](https://docs.flinks.com/guides/getting-started/walkthrough-videos.md): A complete video guide to integrating with Flinks and making the most of our products
- [Outbound (Open Banking)](https://docs.flinks.com/guides/outbound-overview.md): Learn about Flinks Outbound, the Open Banking solution for secure, consent-based financial data sharing.
- [Getting Started with E-Transfer](https://docs.flinks.com/guides/pay/e-transfer/e-transfer.md): Learn how Flinks Pay processes one-time payments using Interac E-Transfer Request for Money.
- [Set Up Flinks Pay Using E-Transfer as Your Payment Method](https://docs.flinks.com/guides/pay/e-transfer/setup-flinks-pay.md): Configure Flinks Pay with Interac e-Transfer from onboarding to production transactions.
- [Getting Started with EFT](https://docs.flinks.com/guides/pay/eft/eft-debit.md): Learn how Flinks Pay uses EFT to collect or send funds via Pre-Authorized Debit transactions.
- [Generate a PAD Link from a Contact](https://docs.flinks.com/guides/pay/eft/generate-pad-link.md): Walk through the API flow to generate a Pre-Authorized Debit signing link from a contact ID.
- [Guaranteed EFT](https://docs.flinks.com/guides/pay/eft/guaranteed-eft.md): Set up and use Flinks Guaranteed EFT (G-EFT) for secure, real-time account funding.
- [Set Up Flinks Pay Using EFT](https://docs.flinks.com/guides/pay/eft/setup-flinks-pay.md): Set up Flinks Pay with EFT as the payment method, from sandbox testing to production.
- [Use an Event Listener](https://docs.flinks.com/guides/pay/geft/event-handling.md): Add an event listener to track user progress and payment events in the GEFT widget.
- [Getting Started with Guaranteed EFT](https://docs.flinks.com/guides/pay/geft/overview.md): Learn how GEFT provides guaranteed EFT payments with real-time risk evaluation by Flinks.
- [GEFT Production Readiness](https://docs.flinks.com/guides/pay/geft/production-readiness.md): Verify critical testing requirements and identity validation before going live with GEFT.
- [GEFT Sandbox Overview](https://docs.flinks.com/guides/pay/geft/sandbox-overview.md): Use the GEFT sandbox to test session creation, user scenarios, and front-end design before go-live.
- [Set Up Flinks Pay Using GEFT as the Payment Method](https://docs.flinks.com/guides/pay/geft/setup-flinks-pay.md): Configure Flinks Pay with GEFT from onboarding and authentication through to production.
- [GEFT Test Scenarios](https://docs.flinks.com/guides/pay/geft/test-scenarios.md): Review all available sandbox test scenarios for GEFT including happy paths and error cases.
- [GEFT Testing Best Practices](https://docs.flinks.com/guides/pay/geft/testing-best-practices.md): Code examples and automation strategies for comprehensive GEFT integration testing.
- [GEFT Widget](https://docs.flinks.com/guides/pay/geft/widget.md): Embed the GEFT widget iframe to guide users through the guaranteed payment flow.
- [Getting Started with Flinks Pay](https://docs.flinks.com/guides/pay/getting-started.md)
- [Send and Receive Money](https://docs.flinks.com/guides/pay/send-and-receive-money.md): FlinksPay is a payment processing service that allows your customers to transfer funds to you using Interac e-Transfer Request Money.
- [Set Up Pay](https://docs.flinks.com/guides/pay/set-up-pay.md): This page will provide the general steps towards setting up Pay in your integration.
- [Troubleshooting Payments](https://docs.flinks.com/guides/pay/troubleshooting.md): Troubleshoot payment status issues and understand CPA005 error codes in Flinks Pay.
- [Security & Privacy](https://docs.flinks.com/guides/security.md): Learn about Flinks security practices, compliance certifications, and how we protect your data.
- [Contact Flinks](https://docs.flinks.com/guides/support/contact-flinks.md): Find help in the documentation or create a support ticket through the Flinks Support Portal.
- [Upload Capabilities & Limits](https://docs.flinks.com/guides/upload/capabilities.md): Processing times, accuracy, file limits, and supported formats for Flinks Upload.
- [Document Processing](https://docs.flinks.com/guides/upload/document-processing.md): Process, authenticate, and extract data from uploaded bank statements with built-in fraud detection.
- [Flinks Upload](https://docs.flinks.com/guides/upload/flinks-upload.md): Enable bank statement uploads in Flinks Connect with data extraction and fraud detection.
- [Fraud Signals & False Positives](https://docs.flinks.com/guides/upload/fraud-signals.md): Understand the fraud signals detected by Flinks Upload and how to handle false positives.
- [Check for Fraud](https://docs.flinks.com/guides/upload/fraud-verification.md): Review fraud verification results for uploaded bank statements in the Flinks Dashboard or via API.
- [Getting Started with Flinks Upload](https://docs.flinks.com/guides/upload/getting-started.md): Enable Flinks Upload in Flinks Connect to process and extract data from bank statements.
- [Upload Integration Tips](https://docs.flinks.com/guides/upload/integration-tips.md): Integration modes, fallback triggers, and best practices for Flinks Upload.
- [Manage Files](https://docs.flinks.com/guides/upload/manage-files.md): Replace, organize, and delete previously uploaded files in Flinks Connect and Dashboard.
- [Receive Your Data](https://docs.flinks.com/guides/upload/receive-your-data.md): Access processed bank statement data through the Flinks Dashboard or API endpoints.
- [Upload a file](https://docs.flinks.com/guides/upload/upload-a-file.md)
- [HMAC Signature Validation](https://docs.flinks.com/guides/webhooks/hmac-validation.md): Validate webhook authenticity using HMAC-SHA256 signature verification.
- [Webhooks](https://docs.flinks.com/guides/webhooks/introduction.md): Set up webhooks to receive customer data automatically from Flinks without polling the API.
- [Flinks Documentation](https://docs.flinks.com/index.md)

## OpenAPI Specs

- [openapi-wealth](https://docs.flinks.com/openapi-wealth.yaml)
- [pay-interac](https://docs.flinks.com/pay-interac.yaml)
- [openapi](https://docs.flinks.com/openapi.yaml)
- [openapi-pay-geft](https://docs.flinks.com/openapi-pay-geft.yaml)
- [openapi-pay-eft](https://docs.flinks.com/openapi-pay-eft.yaml)
- [openapi-pay](https://docs.flinks.com/openapi-pay.yaml)
- [openapi-outbound](https://docs.flinks.com/openapi-outbound.yaml)
- [openapi-outbound-auth](https://docs.flinks.com/openapi-outbound-auth.yaml)
- [openapi-upload](https://docs.flinks.com/openapi-upload.yaml)

## Optional

- [About](https://www.flinks.com/about-us)
- [Blog](https://www.flinks.com/blog)