Self-signup for a free account + first inbox

POST

/v1/agent/sign-up

• Production
• Local

When the operational gate is enabled, provisions (or idempotently re-provisions) a free account and a first inbox on free.extrovertmail.com, returns a limited-permission agent key that expires with the emailed verification code, and sends that code to human_email. Call POST /v1/agent/verify to activate the account and atomically exchange the bootstrap key for a full-permission key. Before verification, that key may call verification only and the account cannot send. The OTP is never returned in the body. Free signup is currently disabled in production.

Request Body ^required

object

human_email

required

Where the verification code is sent.

string format: email

username

Desired local part for the first free inbox. It is normalized to lowercase, must contain at least five characters, and cannot be postmaster, admin, webadmin, legal, fraudmark, fraudmarc, keith, melissa, richard, sydney, syd, john, or johnny. Omit it for a generated local part.

string

Responses

201

Account created; verification code emailed.

The verification-only signup:verify bootstrap key (shown once) plus the pending inbox on free.extrovertmail.com. The account is not active until OTP verification. Before then the key may call signup verification only; it cannot create or read inboxes, export credentials, or send customer-authored mail. The key expires at otp_expires_at; the OTP is sent only to human_email.

object

customer_id

string

agent_id

string

agent_key

Limited-scope bootstrap key

string

key_prefix

string

scopes

Array<string>

address

The pending inbox on free.extrovertmail.com.

string format: email

verified

boolean

otp_sent_to

string

otp_expires_at

string format: date-time

message

string

400

Invalid request.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

403

Free signup is temporarily paused (signup_disabled).

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

502

Upstream delivery failed. The request can be retried.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

503

Self-signup is not configured or the signup gate is unavailable.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope