# Redeem Magic Link

`POST /gate/magic-link/redeem` · Identity & Access · Sign-in & Sessions

Completes magic-link sign-in by verifying the token from the emailed link and issuing a Gate JWT and refresh token on success. The token is single-use and expires after 15 minutes; an expired or reused token returns `K9O_MAGIC_LINK_EXPIRED` (410).

## Parameters

| Name | In | Required | Description |
|---|---|---|---|
| `projectSlug` | path | yes | The project's slug: the path segment after `@`. It is unique within the org. Example: `"storefront"`. |

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `token` | string | yes | The `token` query parameter from the sign-in link. It works once and expires 15 minutes after it was sent. |

```json
{
  "token": "EXAMPLE-magic-link-token-not-a-real-secret0"
}
```

## Responses

- **200**: Success

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes | Either `session` or `mfa`, never both. |
| _one of_ | | |  |
| `data.redeemed` | enum (true) | yes | Always `true`: the link was valid and is now used up. |
| `data.session` | object | yes | The tokens for the new session. Keep the refresh token for `POST /@{projectSlug}/gate/refresh` and send the access token on API calls. |
| `data.session.accessToken` | string | yes | A signed JWT that authenticates the end user to this project's API. Send it as `Authorization: Bearer <accessToken>`. Its subject (`sub`) is the end user's id (`eu_...`), its audience (`aud`) is the project id (`proj_...`), and its issuer is the API origin of the region that holds the end user. It lives for the project's end-user access token lifetime: 30 minutes by default, settable from 5 to 60 minutes. `expiresAt` is when it expires. It cannot be revoked early: signing out or revoking sessions stops the next refresh, but a token already issued stays valid until `expiresAt`. |
| `data.session.refreshToken` | string | yes | An opaque secret (43 base64url characters) that gets a new access token from `POST /@{projectSlug}/gate/refresh`. Store it securely and never send it anywhere else. It is single use: every refresh returns a new refresh token, and sending the one it replaced a second time ends the whole session. It stops working when the session ends: on sign-out, a password reset, a revoke-all, or when the project's session limits are reached (by default 30 days without a refresh, or 90 days after sign-in, whichever comes first). |
| `data.session.expiresAt` | string (date-time) | yes | When `accessToken` expires. Refresh before this time to keep the end user signed in. |
| `data.endUserId` | string | yes | The end user the link signed in (`eu_...`). |
| _or_ | | |  |
| `data.redeemed` | enum (true) | yes | Always `true`: the link was valid and is now used up. |
| `data.mfa` | object | yes | Present instead of `session` when the end user has a confirmed authenticator app: the sign-in needs a code first. |
| `data.mfa.required` | enum (true) | yes | Always `true`: the end user has a confirmed authenticator app, so this sign-in needs a code before it gets a session. |
| `data.mfa.challengeId` | string | yes | An opaque, single-use id for this sign-in (43 base64url characters). Send it with a current code from the end user's authenticator app to `POST /@{projectSlug}/gate/mfa/challenge`, on the origin in `resident.origin`, to get the session. A new sign-in by the same door replaces it, and it dies after 5 wrong codes. |
| `data.mfa.expiresAt` | string (date-time) | yes | When the challenge expires, 5 minutes after it was issued. After that the end user signs in again. |
| `data.mfa.methodsAvailable` | array of enum ("totp") | yes | The second factors that can answer this challenge. Always `["totp"]`: a time-based code from an authenticator app. |
| `data.mfa.resident` | object | yes | Where the challenge lives. |
| `data.mfa.resident.region` | string | yes | The region that holds the end user and this challenge. |
| `data.mfa.resident.origin` | string | yes | That region's API origin. Send the challenge answer here: no other region has the challenge. |
| `data.endUserId` | string | yes | The end user the link signed in (`eu_...`). |
| `meta` | object | yes | Request metadata: cost, timing and the request and trace ids. |


## Errors

| HTTP | Code | When |
|---|---|---|
| 401 | `K9O_MFA_REQUIRED` | The magic-link credential was accepted but the end-user has an enrolled MFA factor that must be verified before a session is issued. |
| 404 | `K9O_END_USER_NOT_FOUND` | No end-user record matches the identity associated with the supplied magic-link token. |
| 401 | `K9O_INVALID_CREDENTIALS` | The magic-link token is invalid, has expired, or has already been used. |

## Code samples

### cURL

```bash
curl -X POST 'https://<org>.api-<region>.k9o.io/@storefront/gate/magic-link/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "EXAMPLE-magic-link-token-not-a-real-secret0"
}'
```

### fetch

```javascript
const res = await fetch('https://<org>.api-<region>.k9o.io/@storefront/gate/magic-link/redeem', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "token": "EXAMPLE-magic-link-token-not-a-real-secret0"
}),
});
const { data, meta } = await res.json();
```

### @k9o/core

```typescript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.gate.passwordless.verifyMagicLink({
  token: 'EXAMPLE-magic-link-token-not-a-real-secret0'
})
```

### k9o

```python
# k9o = create_client(org_slug="playground", project_slug="storefront", api_key="k9o_…")
response = k9o.gate.passwordless.verify_magic_link({
    "token": "EXAMPLE-magic-link-token-not-a-real-secret0"
})
```

### sdk-go

```go
// ctx := context.Background()
// client, _ := k9o.NewClient(k9o.ClientOpts{OrgSlug: "playground", ProjectSlug: "storefront", APIKey: "k9o_…"})
data, _, kerr := client.Gate.Passwordless.VerifyMagicLink(ctx, map[string]any{"token": "EXAMPLE-magic-link-token-not-a-real-secret0"})
```

### k9o

```rust
// let k9o = Client::new(ClientOpts { org_slug: "playground".into(), project_slug: "storefront".into(), api_key: "k9o_…".into() })?;
let resp = k9o.gate.passwordless.verify_magic_link(json!({"token": "EXAMPLE-magic-link-token-not-a-real-secret0"})).await?
```

### dev.k9o:core

```java
// K9o k9o = K9o.createClient(K9o.Opts.builder().orgSlug("playground").projectSlug("storefront").apiKey("k9o_…").build());
var response = k9o.gate().passwordless().verifyMagicLink(Map.of("token", "EXAMPLE-magic-link-token-not-a-real-secret0"))
```

### K9o.Core

```c#
// var k9o = K9oClient.Create(new K9oOptions { OrgSlug = "playground", ProjectSlug = "storefront", ApiKey = "k9o_…" });
var response = await k9o.Gate.Passwordless.VerifyMagicLinkAsync(new Dictionary<string, object> { ["token"] = "EXAMPLE-magic-link-token-not-a-real-secret0" })
```

### k9o

```ruby
# k9o = K9o.create_client(org_slug: "playground", project_slug: "storefront", api_key: "k9o_…")
response = k9o.gate.passwordless.verify_magic_link({ token: "EXAMPLE-magic-link-token-not-a-real-secret0" })
```

### k9o/sdk

```php
// $k9o = K9oClient::create(['org_slug' => 'playground', 'project_slug' => 'storefront', 'api_key' => 'k9o_…']);
$response = $k9o->gate->passwordless->verify_magic_link(['token' => 'EXAMPLE-magic-link-token-not-a-real-secret0'])
```

### K9o

```swift
// let k9o = try K9o.createClient(orgSlug: "playground", projectSlug: "storefront", apiKey: "k9o_…")
let result = try await k9o.gate.passwordless.verifyMagicLink({
  token: "EXAMPLE-magic-link-token-not-a-real-secret0"
})
```

### core-kotlin

```kotlin
// val k9o = createClient { orgSlug = "playground"; projectSlug = "storefront"; apiKey = "k9o_…" }
val result = k9o.gate.passwordless.verifyMagicLink({
  token: "EXAMPLE-magic-link-token-not-a-real-secret0"
})
```

### k9o (Flutter)

```dart
// final k9o = K9o.createClient(orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…');
final result = await k9o.gate.passwordless.verifyMagicLink({
  token: 'EXAMPLE-magic-link-token-not-a-real-secret0'
})
```

### @k9o/react-native

```javascript
// const k9o = createClient({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })  // RN, secure storage
const { data } = await k9o.gate.passwordless.verifyMagicLink({
  token: 'EXAMPLE-magic-link-token-not-a-real-secret0'
})
```


Canonical page: https://docs.kilimanjaro.dev/api-playground/identity-access/redeem-magic-link
