Get a new userToken with the refreshToken
posthttps://api.circle.com/v1/w3s/users/token/refresh
- Reference
- Playground
Get a new userToken with the refreshToken passed over from sdk/performLogin which matches to the current userToken
Header parameters
X-User-Token
string
Required
Unique system generated JWT session token for specific user.
Body parameters
deviceId
string
Required
Get the device id from SDK, and the deviceToken is bound with this device id.
refreshToken
string
Required
Use the refresh token passed from sdk/performLogin to get a new userToken. Each refreshToken has a corresponding userToken for verification purposes.
idempotencyKey
string
Required
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.
Response
RequestChoose a language
ResponseChoose an example
1{
2 "data": {
3 "userToken": "eyJhbGciOiJS...-F8EFYDYjAxIUw",
4 "encryptionKey": "7LcOsm4lUAK2Mg...+6fPjr58=",
5 "userID": "ext_user_id",
6 "refreshToken": "eyJhbGciOiJSUz...kmqSVLDhiI-F8EFYDYjAxIUw"
7 }
8}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
