Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.neuro-tech.io/llms.txt

Use this file to discover all available pages before exploring further.

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

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

​
Typical onboarding flow

  1. Call DomainInfo to display the domain name and description to the user (optional).
  2. Call Create with HMAC-signed credentials to create the account and receive an initial JWT.
  3. Prompt the user to enter the verification code sent to their email address.
  4. Call VerifyEMail to activate the account.
  5. 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.