AgentOnboard Docs
Partner Guide

Getting Started

Create a partner account, generate a partner key, and add AgentOnboard verify to your own API

Getting Started

Go from zero to a working verification in about ten minutes: create a partner account, generate a partner key, install the SDK, and wire verify() into your API's auth path.

Sign up with the email your users use

AgentOnboard matches identities by email — the email on your partner account is how /api/verify responses line up with the accounts in your own system. Sign up with the same email your users have on AgentOnboard. See Email & identity in the User Guide for the full policy.

1. Create a partner account

Sign up at partners.ao.aawej.in/register with your email, name, and a password (at least 8 characters). You'll receive a verification email — click the link to activate the account and sign in.

2. Generate a partner key

From the partner dashboard, open API Keys and click Create Key:

  • Give the key a descriptive label (for example Production server).
  • The raw key is shown exactly once in a dialog — copy it and store it somewhere safe, like the API key it is.
  • The dashboard lists your keys with a visible prefix, created date, and status, so you can recognise them later.

You can revoke a key from the same table at any time. Revoked keys immediately stop working: any verify call made with them returns 403.

Treat the partner key like a password

The partner key proves to AgentOnboard that you are the partner. Anyone holding it can verify tokens on your behalf. If it leaks, revoke it from the dashboard and generate a new one.

3. Install the SDK

The official client is @agentonboard/sdk — a single verify() function that wraps the POST /api/verify endpoint.

npm install @agentonboard/sdk

4. Add verify to your API

The integration point is wherever your API authenticates an agent request. The shape of the check is always the same:

import { verify } from "@agentonboard/sdk";

// Reads the session token the agent sent, verifies it, and returns
// the user account in *your* system — or null.
export async function authenticateRequest(request: Request) {
  const sessionToken = request.headers.get("x-session-token");
  if (!sessionToken) return null;

  const result = await verify(
    process.env.AGENTONBOARD_PARTNER_KEY!,
    sessionToken,
  );

  if (!result.ok) return null;

  // Email is the join key: look the user up in your own database.
  return db.users.findByEmail(result.email!);
}

A few notes on the sketch:

  • The partner key comes from an environment variable (AGENTONBOARD_PARTNER_KEY), never from client code.
  • verify() returns a result, it does not throw — check result.ok and branch on result.error if you want to send specific messages.
  • What you do with the returned email is up to you. The notes app (see the Example app) looks the user up in its own database and rejects requests whose email has no local account.

If you can't use the SDK, a plain HTTP call is equivalent — see SDK & verify for the raw contract.

5. Test end to end

With the SDK installed and the verify call in place, test the whole loop from the agent's side:

Get a session token

aon token get

If you don't have a saved key yet, save one first with aon save. The token is valid for 5 minutes.

Call your endpoint with the token

curl -H "x-session-token: <the-token>" https://your-api.example.com/your-endpoint

Your API should respond as an authenticated user — and with no token, or a garbage one, it should reject with 401.

Watch it in the dashboard

Every verify call appears in the partner dashboard's analytics and logs — you should see this request land as a successful verification.

Next steps

  • SDK & verify — the complete request/response contract, every HTTP status, and error messages
  • Example app — a complete reference implementation to copy from
  • Optionally list your service in the partner directory so agents can find it

On this page