AgentOnboard Docs
Partner Guide

Overview

What the AgentOnboard partner programme is and how to evaluate whether to integrate your API

Partner Guide

AgentOnboard is an identity layer for AI agents. By becoming a partner, you open your API to every agent that uses AgentOnboard — the agent authenticates with a short-lived session token, and your API verifies it with a single call and gets back the user's email.

What partnering means

Your API keeps its own users, its own database, and its own rules. AgentOnboard never stores your users' accounts, and you never see your users' AgentOnboard API keys. The only thing the two systems share is the email address — it is the join key between an AgentOnboard identity and an account in your system.

When an agent wants to use your service on behalf of a person, the flow looks like this:

The user saves a key

Your user saves their AgentOnboard API key once, with aon save. The key stays on their machine.

The agent mints a session token

Whenever the agent needs to call your API, it exchanges that key for a session token with aon token get. Session tokens are valid for 5 minutes.

The agent calls your API

The agent sends the session token to your API — for example in the x-session-token header, or in the request body. The exact transport is up to you.

You verify the token

Your API sends the token to POST /api/verify together with your partner key. AgentOnboard answers with the user's AgentOnboard login email.

You serve the user

You look up the user by email in your own database and serve their data — or reject the request with a 401.

Why integrate

  • One integration, every agent. You implement a single verify call, and any agent that uses AgentOnboard can authenticate with your API — no per-agent onboarding, no OAuth dance, no session management.
  • You never handle user credentials. You only ever see short-lived session tokens. The user's long-lived API key never leaves their machine.
  • Your data model stays yours. The email you get back from verify is all you need to map the request to your own user records.
  • Directory visibility. List your service in the partner directory so agents and users can discover it.

What you need

  • A partner account at partners.ao.aawej.in
  • A partner key, generated from the partner dashboard (the dashboard also lets you revoke keys at any time)
  • One small integration: call POST /api/verify from your API — with the @agentonboard/sdk or plain HTTP

Email is the join key

The partner signs up with the same email the user has on AgentOnboard, and /api/verify returns the user's AgentOnboard login email. Both sides key accounts on email — see Email & identity in the User Guide for the full policy and what happens when emails mismatch.

What's in this guide

  • Getting Started — create an account, get a partner key, add verify to your own API
  • SDK & verify — the full POST /api/verify contract: request shape, every HTTP status, response and error shapes
  • Example app — a complete reference implementation: the notes app, its REST API integration, and a create-and-read-notes walkthrough

Next steps

On this page