SDK Explorer

When the users don’t receive the OTP email, you can call this API to resend OTP email. The prior OTP email would expire after the new one is sent out.

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

otp_token
string
Required

The OTP is bound on a user and purpose, and uses this value to identify the request.

email
string
Required

Sends OTP email to the destination address.

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