OAuth 2.0
Overview of OAuth 2.0 within the Upvest Investment API
The Investment API uses opaque access tokens obtained using the OAuth 2.0 Client Credentials flow.
During the onboarding process, each client receives a client ID and a client secret that can be used to request access tokens via our OAuth2 endpoints.
Authentication scopes
The Upvest Investment API supports granular authentication scopes, thus improving security. You can restrict the permissions and data that is requested during authentication by specifying the scopes.
The following table lists available scopes:
Request a users:read
access token to read user data but not be able to change user data. Then request a users:admin
access token to be able to onboard new users.
More on available permissions see here.
Once the access token is returned, the token can be used in all requests for the specific required scopes using the standard authorization header as shown below:
Example header
Authorization: Bearer <access_token>
The use of client_credentials
alone allows us to identify you and authorise your request. However, it does not protect against a man-in-the-middle attack, where the request can be maliciously modified. To mitigate this risk, there is an additional layer of public key infrastructure in the form of HTTP Message signatures.
Was this page helpful?