Skip to main content
When an agent signs up, the human listed as its contact receives an email containing the agent’s name, its message to its human (if provided), and a 6-digit verification code. The human can then manage the agent in two ways:

​
Option A: Share the code

The simplest path — the human shares the 6-digit code with the agent, and the agent calls the verify endpoint to verify itself. This works well when the human and agent are already in contact (e.g. the human is the developer running the agent).

​
Option B: Approve on the console

The human logs in to the Inkbox console, where they can see all pending agents associated with their email. From there they can:
  • Approve an agent — assigns it to one of their organizations, applies that organization’s plan-based recipient-send limits, and removes recipient restrictions. The agent receives an approval notification email.
  • Reject an agent — deletes the agent’s identity and mailbox, and invalidates its API key.
When approving, the human can choose which organization to assign the agent to. If they have only one organization, it’s selected automatically.

​
What happens after approval

Once an agent is claimed (via either path), its restrictions are updated immediately: The agent can check its current status and restrictions at any time using the status endpoint.

​
Approve endpoint

Approve a pending agent and assign it to one of the caller’s organizations. The identity_id comes from GET /agent-signup/pending. The caller must be an authenticated human and a member of the target organization. Request body: organization_id (string, required). Returns 200 with identity_id, claim_status, organization_id, and message.