Error

A valid request URL is required to generate request examples

{
  "challenge_token": "uk_ec_…",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Customer plane

Request an email sign-in code

Mails six digits and hands back the challenge that spends them. The magic link’s flow with a different presentation — a code is typed back into the page that asked for it, so it survives a mail client that opens links in its own browser, and it works when the inbox is on a different device from the sign-in.

The challenge comes back for every address, known or not: it is minted before anything is looked up, so this endpoint never becomes the place somebody learns which addresses have accounts.

Requesting a code spends whatever code that contact had outstanding. Valid for 10 minutes.

Works in both auth modes. Rate limited to 5 requests per hour per IP.

POST

contact-auth

email-code

Error

A valid request URL is required to generate request examples

{
  "challenge_token": "uk_ec_…",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Corpo

application/json

publishable_key

string

obrigatório

string<email>

obrigatório

Resposta

Accepted, unconditionally.

challenge_token

string

uk_ec_…. Hold it in the page and send it back with the code. It is not a session and can never be used as one.

Exemplo:

"uk_ec_…"

expires_at

string<date-time>

Join the waitlist Sign in with an email code

⌘I

Visão geral

Endpoints

Request an email sign-in code

Corpo

Resposta