Skip to main content
GET
Refresh a user access token
The x-api-key header value to be used on this API is your partner API key, which can be generated through the dashboard.
string
required
The refresh token received from the exchange token API flow or previously received from refreshing an access token from this API
string
required
The current access token you are refreshing

Return values

integer
required
The Benji Platform ID associated with the user.
integer
required
Your system ID as specified on the Benji Platform.
object
required
An object representing the access_token, refresh_token to use when using the Benji Platform APIs as well as the access token expiry date. Once an access token expires, you can use the refresh token to obtain a new access token silently without requiring the user to authenticate again.
Access tokens are typically valid for 90 days. You can refresh an access token either before it expires proactively, or after calling an API and getting an expired_token 401 status code.