Overview - Neuron Agent API

The Accounts & onboarding endpoints cover the full lifecycle of a Neuron account — from initial creation through contact verification, account recovery, and transferring an account to another application. These endpoints are typically the starting point for any integration. Most other API groups require an active, verified account with a valid JWT before they can be used.

Endpoints

Endpoint	Description
Domain info	Retrieve human-readable information about the server domain. Call this first to let users choose a service provider.
Create account	Create a new Neuron account and receive an initial JWT. Requires an API key and HMAC signature.
Create web form	Create an agent account via a browser-based web form — suitable when you cannot protect API secrets client-side.
Verify email	Submit the email verification code to enable the account.
Verify phone number	Submit the phone verification code if a phone number was provided during account creation.
Resend verification codes	Resend email or phone verification codes if the originals were not received.
Recover	Recover access to an account using a recovery code or alternative credential.
Info	Retrieve basic information about the current account.
Transfer	Transfer the account to another application, such as a mobile wallet, using a QR-code-based onboarding URI.

Typical onboarding flow

Call DomainInfo to display the domain name and description to the user (optional).
Call Create with HMAC-signed credentials to create the account and receive an initial JWT.
Prompt the user to enter the verification code sent to their email address.
Call VerifyEMail to activate the account.
Call Login to get a fresh JWT for ongoing API use.

Authentication notes

DomainInfo requires no authentication.
Create and CreateWebForm require an HMAC-signed API key — see the Authentication guide.
All other endpoints in this group require a JWT bearer token obtained from Create or Login.
New accounts are disabled until email verification is complete. Disabled accounts cannot use most other endpoints.

Authentication & sessions — log in, refresh, and manage tokens after account creation.
User onboarding guide — step-by-step walkthrough of the full onboarding flow.
Authentication guide — how HMAC signing and JWT tokens work.

​Endpoints

​Typical onboarding flow

​Authentication notes

​Related

Endpoints

Typical onboarding flow

Authentication notes

Related