SDK Explorer

Get a deviceToken to login with email OTP in SDK

Parameters
DeviceTokenEmailRequest
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.

device_id
string
Required

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

email
string
Required

Sends OTP email to the destination address.

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.DeviceTokenEmailRequest.from_dict({
8    "idempotencyKey": "a1b66f87-2320-5834-bcd3-175a36a4d331",
9    "deviceId": "a2b66f87-3131-2832-bcd3-175a36a4d442",
10    "email": "[email protected]"
11})
12response = api_instance.create_device_token_email_login(device_token_email_request=request)
13print(response.json())
14
ResponseChoose an example
1{
2  "data": {
3    "device_token": "eyJhbGciOiJS...-F8EFYDYjAxIUw",
4    "device_encryption_key": "7LcOsm4lUAK2...7+kMGvqD1T6E=",
5    "otp_token": "eyJhbGciOiJS...-F8EFYDYjAxIUw"
6  }
7}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.