Agent Sign Up

curl --request POST \
  --url https://api.openfunnel.dev/api/v1/agent/sign-up \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "founder@example.com"
}
'

{
  "email": "founder@example.com",
  "message": "Verification code sent to your email"
}

Agent Auth

Agent Sign Up

Step 1 of 2 in the Agent Auth flow. Sign up as a new user or sign back in to retrieve your API key.

Sends a 6-digit verification code to the provided email address. After receiving the code, call POST /api/v1/agent/verify to complete authentication and receive your API key.

New users: creates your account. API key is issued after verification.
Existing users: use this to recover your API key if lost. Verify with the OTP to get your existing key back.

Once verified, the returned api_key and email are your X-API-Key and X-User-ID headers for every other OpenFunnel API request.

POST

api

agent

sign-up

Agent Sign Up

curl --request POST \
  --url https://api.openfunnel.dev/api/v1/agent/sign-up \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "founder@example.com"
}
'

{
  "email": "founder@example.com",
  "message": "Verification code sent to your email"
}

Body

application/json

string<email>

required

Email address to send the verification code to

Response

Successful Response

string<email>

required

message

string

required

Agent Verify

⌘I

Agent Auth

Documentation Index

Body

Response