SDK Explorer

Get a new userToken with the refreshToken passed over from sdk/performLogin which matches to the current userToken

Parameters
RefreshUserTokenRequest
object
Required
idempotency_key
string

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.

refresh_token
string
Required

Use the refresh token passed from sdk/performLogin to get a new userToken. Each refreshToken has a corresponding userToken for verification purposes.

device_id
string
Required

Get the device id from SDK, and the deviceToken is bound with this device id.

x_user_token
string
Required

Unique system generated JWT session token for specific user.

x_request_id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Responses
Example
1from circle.web3 import user_controlled_wallets
2from circle.web3 import utils
3
4client = utils.init_user_controlled_wallets_client(api_key=key)
5
6api_instance = user_controlled_wallets.SocialEmailAuthenticationApi(client)
7request = user_controlled_wallets.RefreshUserTokenRequest.from_dict({
8    "idempotencyKey": "a1b66f87-2320-5834-bcd3-175a36a4d331",
9    "deviceId": "a2b66f87-3131-2832-bcd3-175a36a4d442",
10    "refreshToken": "refresh-token-from-sdk"
11})
12response = api_instance.refresh_user_token(x_user_token=user_token, refresh_user_token_request=request)
13print(response.json())
14
ResponseChoose an example
1{
2  "data": {
3    "user_token": "eyJhbGciOiJS...-F8EFYDYjAxIUw",
4    "encryption_key": "7LcOsm4lUAK2Mg...+6fPjr58=",
5    "user_id": "ext_user_id",
6    "refresh_token": "eyJhbGciOiJSUz...kmqSVLDhiI-F8EFYDYjAxIUw"
7  }
8}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.