> For the complete documentation index, see [llms.txt](https://timechain.gitbook.io/neucron/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://timechain.gitbook.io/neucron/overview.md).

# Overview

## Overview

Neucron is a **blockchain-as-a-service (BaaS)** platform. It gives developers and businesses one API surface for wallets, digital assets, payments, invoicing, security tokens, and business tooling on Blockchain.

With Neucron you can:

* Authenticate users (password, OTP, OAuth, passkeys)
* Create and manage **multi-asset wallets** (MPC or Encrypted custody)
* Send, receive, and swap digital assets
* Run **Get Paid** flows (customers, invoices, payment collections)
* Run **Pay** flows (vendors, bills, payouts)
* Build and publish **Apps** to the Neucron Appstore
* Govern businesses with members, RBAC, policies, and MFA intents
* Issue assets, certificates, and Asset21 security-token operations
* Inscribe documents and text on-chain for data integrity

***

### Ways to integrate

Neucron is documented across three companion surfaces. Use the one that matches how you build:

| Surface                                | Best for                                  | Documentation                                                                 |
| -------------------------------------- | ----------------------------------------- | ----------------------------------------------------------------------------- |
| **REST API** (this space)              | Direct HTTP, OpenAPI, custom clients      | This GitBook — Overview, Installation, Features                               |
| **TypeScript SDK** (`@neucron/ts-sdk`) | Typed Node / web / React Native apps      | [Neucron TypeScript SDK](https://timechain.gitbook.io/neucron-javascript-sdk) |
| **MCP Server**                         | AI agents & LLM tools (`neucron_*` tools) | [Neucron MCP](https://timechain.gitbook.io/neucron-mcp)                       |

All three talk to the same Neucron backend. Auth tokens and business context work the same way across them.

***

### Neucron TypeScript SDK

Official package: **`@neucron/ts-sdk`** — a type-safe TypeScript client so you can call Neucron without wiring low-level HTTP yourself.

```bash
npm install @neucron/ts-sdk
```

```typescript
import NeucronSDK from "@neucron/ts-sdk";

const sdk = new NeucronSDK();

await sdk.auth.login({
  email: "user@example.com",
  password: "your-password",
});

const wallets = await sdk.wallet.getAccountWallets();
```

#### SDK surface

| Module                                                   | Capabilities                                  |
| -------------------------------------------------------- | --------------------------------------------- |
| `sdk.auth`                                               | Sign up, login, profile, password recovery    |
| `sdk.wallet` / `sdk.pay` / `sdk.paymail`                 | Wallets, balances, history, payments, paymail |
| `sdk.assets` / `sdk.asset21` / `sdk.utility`             | Digital assets & security tokens              |
| `sdk.assetSwap`                                          | Asset swaps                                   |
| `sdk.business` / `sdk.team` / `sdk.members` / `sdk.rbac` | Business, teams, members, roles               |
| `sdk.apps` / `sdk.blob`                                  | Developer apps & uploads                      |
| `sdk.customer` / `sdk.invoice`                           | Customers, invoices, payment collections      |
| `sdk.vendor` / `sdk.bill` / `sdk.payout`                 | Vendors, bills, payouts                       |
| `sdk.billing`                                            | Platform plans & credits                      |
| `sdk.dataIntegrity`                                      | On-chain inscriptions                         |

**Full SDK docs:** [timechain.gitbook.io/neucron-javascript-sdk](https://timechain.gitbook.io/neucron-javascript-sdk)\
Start with [Quick Start](https://timechain.gitbook.io/neucron-javascript-sdk/quick-start) → [Core](https://timechain.gitbook.io/neucron-javascript-sdk/core) → Features.

{% hint style="info" %}
SDK docs describe **typed methods** such as `sdk.wallet.createWallet(...)`. This API space documents the underlying **HTTP endpoints** (method, path, headers, body, responses).
{% endhint %}

***

### Neucron MCP

The **Neucron MCP server** exposes Neucron as tools for AI agents and LLM clients. Tool names follow `neucron_<action>` (for example `neucron_login`, `neucron_list_wallets`, `neucron_create_invoice`).

#### Domains

| Domain              | Tools | Description                                            |
| ------------------- | ----: | ------------------------------------------------------ |
| Auth & Setup        |     3 | Login, entity selection, business registration         |
| Holdings & Wallets  |     8 | Wallets, balances, transactions, assets, notifications |
| Develop & App Store |     3 | Developer apps and the Appstore                        |
| Get Paid            |     5 | Invoices, customers, collection links, revenue         |
| Pay & Expenses      |     7 | Vendors, bills, payouts, scheduled payments, expenses  |
| Data Integrity      |     4 | On-chain proofs, signing, encryption                   |
| Asset Issuance      |     3 | Security token registration, customers, operations     |

#### Auth for MCP tools

| Requirement   | Details                                                                                                                                   |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Session token | Required for all tools except `neucron_login`. Set `NEUCRON_AUTH_TOKEN` or call `neucron_login`.                                          |
| Business ID   | Required for most business-scoped tools. Set `NEUCRON_BUSINESS_ID`, call `neucron_choose_entity`, or pass `businessId` in the tool input. |

**Full MCP docs:** [timechain.gitbook.io/neucron-mcp](https://timechain.gitbook.io/neucron-mcp)

***

### Base URL (REST API)

```
https://dev.neucron.io
```

Production host is typically `https://api.neucron.io`. Paths in this documentation are relative to the selected server (some deployments may prefix `/v1`).

***

### Authentication model (REST)

| Header                                       | Required               | Description                                     |
| -------------------------------------------- | ---------------------- | ----------------------------------------------- |
| `Authorization`                              | Yes (protected routes) | Access token from login/signup                  |
| `X-Identifier`                               | Yes                    | Always `NEUCRON`                                |
| `X-Neucron-Business-ID`                      | Contextual             | Business entity context                         |
| `X-Neucron-Team-ID`                          | Contextual             | Team context for some member/wallet-access APIs |
| `X-Neucron-App-ID` / `Key-ID` / `Key-Secret` | Contextual             | App credential headers for certain integrations |

***

### Standard response codes

| Code  | Meaning                                               |
| ----- | ----------------------------------------------------- |
| `200` | **OK** — Request completed successfully.              |
| `400` | **Bad Request** — Invalid or missing parameters.      |
| `401` | **Unauthorized** — Missing or invalid authentication. |
| `403` | **Forbidden** — Insufficient permissions.             |
| `404` | **Not Found** — Resource does not exist.              |
| `409` | **Conflict** — Resource conflict (e.g. duplicate).    |
| `500` | **Internal Server Error** — Server-side failure.      |

#### Error body

```json
{ "error": "string" }
```

or

```json
{ "message": "string" }
```

#### Pagination

```json
{
  "page": 1,
  "limit": 20,
  "total": 100,
  "next_page": 2,
  "total_pages": 5
}
```

***

### Documentation map

| Section                                                               | What it covers                            |
| --------------------------------------------------------------------- | ----------------------------------------- |
| Overview                                                              | Platform intro, SDK, MCP, auth, responses |
| Features                                                              | All REST APIs by domain                   |
| [TypeScript SDK](https://timechain.gitbook.io/neucron-javascript-sdk) | Typed `@neucron/ts-sdk` reference         |
| [MCP](https://timechain.gitbook.io/neucron-mcp)                       | AI agent tools (`neucron_*`)              |