Start authentication

POST

connect

start

curl -X POST https://api.useknot.xyz/connect/start \
  -H "Content-Type: application/json" \
  -d '{"email": "agent@example.com"}'

{
  "status": true,
  "statusCode": 200,
  "message": "OTP sent successfully.",
  "data": {
    "otpId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

This is the first step of the two-step authentication flow. Send the agent’s email address to receive a one-time password (OTP) code by email.

This endpoint does not require authentication. No Authorization header is needed.

Request body

string

required

Email address for the agent. The OTP code is sent to this address.

boolean

true when the request succeeds.

number

HTTP status code.

string

Human-readable result message.

object

Show properties

string

Unique identifier for this OTP request. Pass this value to the complete authentication endpoint along with the OTP code.

Status	Description
`400`	Invalid or missing email address
`429`	Rate limit exceeded

curl -X POST https://api.useknot.xyz/connect/start \
  -H "Content-Type: application/json" \
  -d '{"email": "agent@example.com"}'

{
  "status": true,
  "statusCode": 200,
  "message": "OTP sent successfully.",
  "data": {
    "otpId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

curl -X POST https://api.useknot.xyz/connect/start \
  -H "Content-Type: application/json" \
  -d '{"email": "agent@example.com"}'

{
  "status": true,
  "statusCode": 200,
  "message": "OTP sent successfully.",
  "data": {
    "otpId": "550e8400-e29b-41d4-a716-446655440000"
  }
}