SoulFire LogoSoulFire

Start login flow

Initiates a login flow for the specified email address. If the email is registered, a six-digit verification code is sent to that address. The response always indicates that an email code step is next, regardless of whether the email exists, to prevent email enumeration attacks.

POST
/v1/login

Initiates a login flow for the specified email address.

If the email is registered, a six-digit verification code is sent to that address. The response always indicates that an email code step is next, regardless of whether the email exists, to prevent email enumeration attacks.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/login" \  -H "Content-Type: application/json" \  -d '{    "email": ""  }'
{
  "auth_flow_token": "001c8d33-f179-47fb-9db8-4caa31962e87",
  "email_code": {},
  "success": {
    "token": "string"
  },
  "failure": {
    "reason": "INVALID_CODE"
  }
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

How is this page?