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
  • Entity types
  • Endpoints
  1. General API Resources

Entities

At Vumi we have decided to name financial institutions (brokers, banks or crypto exchanges) as the shorter name entities 🏦

Last updated 10 months ago

An entity refers to any financial institution that Vumi integrates with to obtain data. At Vumi, we have different levels of development for an entity:

  • TEST: the entity is fully integrated and working in the use case we have available. However, it is an entity that has been developed recently and there might some edge cases that give problems.

  • PROD: the entity has been developed and almost fully tested with a wide range of use cases from our side. We guarantee that most of the connections will work without any problem.

You can decide which entities you include in your app depending on your needs.

Can't find an entity you need? Contact our team to see what we can do in order to prioritize it.

Entity types

Our system currently classifies entities into two types, BROKER and BANK. You can see specific details about these types in the table below. It is important to mention that this is an internal classification and it does not match the actual financial entity type, but it exists to give you information on how to handle the information that comes from an entity. More types are to come in the future when we integrate crypto exchanges or other type of financial entities. Our current types are:

Type
Description

BROKER

An entity whose main purpose revolves around investing. It has accounts that are linked to a specific portfolio, without cards associated to it. For that reason, we are able to return information about those accounts like deposits, removals, etc.

BANK

An entity that supports cash accounts with payments associated to them and does not separate their investment portfolios into different specific accounts. We are unable to provide information for current accounts at the moment, so in these type of entities we stick to providing the investment transactions.

Endpoints

Here is a table showing all available endpoints in the entities resource:

Endpoint
Method
Description

GET

Get all enabled entities for your current app

List