Flinks is a Canadian financial data platform (owned by National Bank of Canada) that lets businesses connect to consumer and business bank accounts to aggregate account, transaction, and statement data, verify identity, and derive income, credit-risk, and fraud analytics. Access begins with a Flinks Connect authentication session and a multi-step /Authorize (MFA) call, after which banking, enrichment, and analytics endpoints are invoked with the returned RequestId.
APIs.json: https://raw.githubusercontent.com/api-evangelist/flinks/refs/heads/main/apis.yml
- Financial Data
- Open Banking
- Bank Aggregation
- Fintech
- Canada
- Created: 2026-07-01
- Modified: 2026-07-01
Opens a banking session for a Flinks Connect LoginId. Handles the multi-step MFA flow - an initial /Authorize returns HTTP 203 with SecurityChallenges when a challenge is required, and a resubmission with RequestId and SecurityResponses returns HTTP 200 with the RequestId and Links used for subsequent data calls.
- Human URL: https://docs.flinks.com/api/authorize/endpoints/authorize
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Authorize
- Connect
- MFA
- Session
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Returns full detail for each account linked to the session, including account identity (transit / institution / account numbers), balances, up to 90 or 365 days of transactions, and holder KYC information. Long-running requests return HTTP 202 and are polled via the /GetAccountsDetailAsync variant with the same RequestId.
- Human URL: https://docs.flinks.com/reference/getaccountsdetail
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Accounts
- Transactions
- Banking Data
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Retrieves general account information - cardholder name (when available), account balance, category, and EFT eligibility - without full transaction history, using the RequestId from /Authorize. A /GetAccountsSummaryAsync variant supports polling of long-running requests.
- Human URL: https://docs.flinks.com/reference/getaccountssummary
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Accounts
- Balance
- Summary
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Signs up one or more of the connected customer accounts to retrieve PDF bank statements issued by their financial institution, referenced by the session RequestId.
- Human URL: https://docs.flinks.com/reference/getstatements-1
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Statements
- Documents
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Surfaces account-holder identity captured during aggregation - name, civic address, email, and phone - and supports /FieldMatch verification that compares supplied applicant fields against the identity on the connected bank account.
- Human URL: https://docs.flinks.com/reference/choose-the-correct-endpoint
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Identity
- Verification
- KYC
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Enrich product returns pre-computed attribute packages derived from aggregated transaction data via /GetAttributes, plus /GetCategorization for categorized transactions and /Categories to list available transaction categories.
- Human URL: https://docs.flinks.com/guides/set-up-the-attributes-api-call
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Attributes
- Enrich
- Categorization
- Analytics
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Analytics endpoints that summarize a connected account into decisioning signals - /GetIncomeAttributes for total, employment, and government income verification, and /GetCreditRiskAttributes for income sources, loan and bill payments, and additional risk measures.
- Human URL: https://docs.flinks.com/docs/getincomeattributes-1
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Score
- Income
- Credit Risk
- Documentation
- API Reference
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
The Upload product ingests external bank statement / transaction data via /Upload and runs /FraudAnalysis to surface tampering and fraud signals, complementing the live-aggregation KYC data returned on connected accounts.
- Human URL: https://docs.flinks.com/docs/legacy-api-integrations
- Base URL:
https://{instance}-api.private.fin.ag/v3/{customerId}/BankingServices
- Fraud
- KYC
- Upload
- Risk
- Documentation
- OpenAPI — OpenAPI Specification
- Postman Collection — Postman Collection 2.1
- Open Collection — Open Collection 1.0
Flinks was acquired by National Bank of Canada in 2021 and operates as a wholly owned subsidiary, retaining the Flinks brand and its public HTTP REST API platform documented at docs.flinks.com.
FN: Kin Lane Email: kin@apievangelist.com