API Reference

Get a deviceToken to log in with email OTP

posthttps://api.circle.com/v1/w3s/users/email/token

  • Reference
  • Playground

Get a deviceToken to login with email OTP in SDK

Body parameters
email
string
Required

Sends OTP email to the destination address.

deviceId
string
Required

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

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    "deviceToken": "eyJhbGciOiJS...-F8EFYDYjAxIUw",
4    "deviceEncryptionKey": "7LcOsm4lUAK2...7+kMGvqD1T6E=",
5    "otpToken": "eyJhbGciOiJS...-F8EFYDYjAxIUw"
6  }
7}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.