---
title: "Redeem an email sign-in code."
method: POST
path: "/v1/auth/key/redeem"
---

# Redeem an email sign-in code.

`POST /v1/auth/key/redeem`

## Request

- Base URL: `https://api.cortexplus.io`
- URL: `https://api.cortexplus.io/v1/auth/key/redeem`
- Auth: none required

Redeem the 6-digit code received by email (with the same email) and issue a device token for this app install.

## Request body

- object
  - `email` string, email, required: Email the code was sent to.
  - `key` string, required: 6-digit code received by email.
  - `deviceName` string
  - `platform` string

## Response `200`

Successful response.

- object
  - `deviceToken` string, required: Device credential (cxd_…); use it as the bearer token.
  - `user` object, required

## Other responses

- `default`: Request failed.

---

[API](https://skmtc.dev/cortexplus/apis/cortexplus-rest-api.md) · [All operations](https://skmtc.dev/cortexplus/apis/cortexplus-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cortexplus/apis/cortexplus-rest-api/revisions/2d04f1593663?raw)
