Skip to main content
POST
/
v1
/
w3s
/
users
/
email
/
token
Get a deviceToken to log in with email OTP
curl --request POST \
  --url https://api.circle.com/v1/w3s/users/email/token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "deviceId": "018d7c79-6b79-71ec-8ad8-ebc2b57a4650",
  "email": "john@domain.com"
}
'
{
  "data": {
    "deviceToken": "eyJhbGciOiJS...-F8EFYDYjAxIUw",
    "deviceEncryptionKey": "7LcOsm4lUAK2...7+kMGvqD1T6E=",
    "otpToken": "eyJhbGciOiJS...-F8EFYDYjAxIUw"
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support. A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Body

application/json

Request body

​
idempotencyKey
string<uuid>
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.

Example:

"a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"

​
deviceId
string
required

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

Example:

"018d7c79-6b79-71ec-8ad8-ebc2b57a4650"

​
email
string
required

Sends OTP email to the destination address.

Example:

"john@domain.com"

Response

Successfully obtained the deviceToken for the email login.

​
data
object
required