Access Tokens

Get an access token for requested scopes

Get an access token to use with the API with specified scopes.

You should always scope your access tokens. You get one for read-access and separate ones for updating, creating or deleting resources.

post/auth/token

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/auth/token
  • Auth: none declared. Required headers: upvest-client-id, signature, signature-input

Request body application/x-www-form-urlencoded

client_idstring uuid required

Client ID given during onboarding.

client_secretstring required

Client Secret given during onboarding.

grant_typestring required

This must always be client_credentials.

scopestring required

List of space delimited scopes to request for this access token.

Response

Access token successfully generated.

access_tokenstring required

The generated access token.

expires_ininteger required

How many seconds the access token is valid for.

token_typestring required

This is always 'bearer'.

scopestring required

List of space delimited scopes requested for this access token.

Changes

No recorded changes to this operation across all 25 revisions of this API.