VUMI Documentation
  • Introduction
    • 🎉Welcome!
    • ➡️Quick Start
  • Platform
    • App Overview
      • API Products
      • Connections Overview
      • API Configuration
    • Link Overview
      • Link redirects
      • Link parameters
      • Customization
  • General API Resources
    • Authentication
      • API Login
    • Entities
      • List entities for app
    • Connections
      • Exchange public token
      • Get Connection status
      • List all connections
      • List public tokens
      • Delete Connection
    • Investments
      • List investments
    • Webhook
      • Get verification key
  • Aggregation
    • Accounts
      • List accounts
      • List account transactions
    • Portfolios
      • List portfolios
      • List portfolio transactions
      • List portfolio positions
  • Assets Transfer
    • Assets transfer
  • Developer Resources
    • API and Widget Errors
    • Webhooks and security
      • Webhook verification
    • Pagination
    • Tracing requests
Powered by GitBook
On this page
  1. General API Resources

Connections

The most important concept in Vumi Finlink API: connections 🔗

Last updated 11 months ago


Whenever a user connects an entity to your app through the , a new connection is created. Connections are identified through a unique identifier called connectionToken.

Connections in Vumi Finlink are always recurrent. This means that if the data can be updated daily (because the user does not have MFA, the credentials are being stored and the account is not temporarily unaccessible), it will be updated.

In Vumi Finlink, users can decide if they want us to store credentials for long-term access or if they want to perform updates manually whenever it's convenient for them.

We recommend configuring to update connection data whenever new data is available, instead of using less efficient approaches like polling.

These are the endpoints available for the connections resource:

Endpoint
Method
Description

POST

Exchanges a publicToken for its connectionToken

GET

Retrieves the status for the given connection

GET

Lists all connections for the current app

GET

Lists all publicTokens that have not been exchanged

DELETE

Deletes the given connection

Link
webhooks
Exchange public token
Connection status
List
List public tokens
Delete connection