Skip to content
NeptliumDocumentation

Developer & operator reference

Neptlium Documentation

Find the right system boundary, understand the state model, and complete technical work without assuming that a visible route or configured provider is a live financial capability.

Documentation search is not shown until a functional searchable index exists.

Start here

Overview

Available

Understand Neptlium’s public, application, admin and API boundaries.

Getting started

Available

Learn the concepts that must be clear before integrating with privileged financial workflows.

Authentication

Available

Understand identity, session and principal resolution during the current authentication transition.

Platform contracts

Authorization

Available

Separate authenticated identity from resource ownership, policy and financial authority.

Idempotency

Available

Design mutation commands so retries do not silently create duplicate financial consequences.

Errors

Available

Treat unavailable capability, missing durable state and failed verification as explicit failure states.

Audit & evidence

Available

Keep activity, audit records, provider evidence, ledger state and reconciliation conceptually distinct.

Financial systems

Payments

Available

Provider evidence and payment-related routes do not establish a live payment product without end-to-end posting and reconciliation.

Treasury

Available

Treasury concepts cover liquidity, reserves, policy and approvals; the target treasury API is read-only and does not execute transfers.

Reconciliation

Available

Understand why settlement evidence and canonical reconciled financial state are separate.

Webhooks

Available

Verified provider events require replay protection, durable ingestion and reviewed provider-specific verification.

Current API surface

Document routes that exist. Do not infer live capability from route presence.

The repository’s current API architecture explicitly distinguishes route presence from production readiness. The sample below is intentionally limited to contracts documented as present in the runtime.

HTTPCurrent route examples
GET /health · GET /v1/health
GET /v1/status · GET /v1/version
POST /v1/account/provision · POST /v1/account/onboarding
GET /v1/capital-account/deposit-address · GET /v1/capital-account/balances

Financial authority

Keep the layers separate.

AuthenticationWho is present?
AuthorizationMay this principal act on this resource now?
ExecutionWas an external or internal action actually submitted?
SettlementDid the financial movement reach a settled state?
ReconciliationDoes canonical state agree with independent evidence?
AuditCan the important action and decision path be attributed and reviewed?

Need the user-facing security model?

Read Security

Neptlium

Build a clearer view of your capital.

Create an account to enter the Neptlium capital environment, or explore the platform before you begin.