logo

Users

Users

A   user   is the end user of your app who wants to connect their accounts through Quovo. Creating, modifying, and retrieving information for your user(s) all happens at the https://api.quovo.com/v3/users endpoint.
Our user-based data model enables holistic insights at the level of the person—such as total net worth or total income across multiple accounts—instead of being limited to only disparate account-level information. 

User Attributes

Quovo users have a few key fields associated with them. The most important fields are the Quovo   id  ,   username  , and  email  . We’ll automatically generate an   id   for every user created on Quovo. Pass through this   user_id   in any request to retrieve data associated with a user, such as getting all of their accounts or transactions. A username is required when creating a user on Quovo in order to help associate user details with a user   id  .  For a full list of user fields returned in the /users endpoint, please see our reference docs

Creating a User

All connections and accounts on Quovo must be associated with a user. Creating a new user is easy—make a POST call to https://api.quovo.com/v3/users. Remember, we’ll create a user   id    but you’ll have to give us a   username   (as well as any of the other fields that are important to you).  
curl -X POST \
    -H "Authorization: Bearer a724809d37d0a21b7e9257f45cee416f5aec61993ab4b09e" \
    -H "Content-Type: application/json" \
    -d '{"username": "quovo_myfirstuser"}' \
    "https://api.quovo.com/v3/users"

Retrieving and Modifying Users

If you want to view or alter the record for a user that you’ve created, use the https://api.quovo.com/v3/users/{user_id} endpoint, and pass the user’s   id  
  • Sending a GET request will return the attributes for this user
  • Make a PUT request to modify certain user fields, such as changing their   email  address or   name  . (See our reference docs for which fields can be modified)
  • A DELETE request will delete the user entirely
If you’d like to see all of your users, instead of just a single user, send a GET request to https://api.quovo.com/v3/users.
curl -X GET \
    -H "Authorization: Bearer a724809d37d0a21b7e9257f45cee416f5aec61993ab4b09e" \
    "https://api.quovo.com/v3/users"
Remember, the user_id must be passed through your requests for anything that is user-centered, such as connecting accounts, authenticating through our Connect widget, or viewing all holdings for a user.

Terms of Use (TOU)

Because Quovo connects your users with sensitive financial data, it is required that every user accepts our terms of use and privacy policies in order to connect their accounts. For this reason, Quovo will automatically accept the terms of use for a user every time they add a connection, unless otherwise specified. Terms of Use acceptance can be checked at our /terms_of_use endpoint by seeing if the   has_accepted   field yields a “true” value.
  • A PUT call will allow you to update the   has_accepted   field to “true” or “false”
  • A GET request will let you see the status of the   has_accepted   field for a particular Quovo user
curl -X PUT \
    -H "Authorization: Bearer a724809d37d0a21b7e9257f45cee416f5aec61993ab4b09e" \
    -H "Content-Type: application/json" \
    -d '{"has_accepted": true}' \
    "https://api.quovo.com/v3/users/12345/terms_of_use"
Note: As a platform that works with the largest financial institutions in the world, Quovo takes security and compliance extremely seriously. You can see our terms of use here and learn more about our overall security policies here.