DOCSEARCHbyAlgolia
Submit Docs

Neuron Platform Documentation

website·Indexed 31 days ago

https://neuro-documentation.com

A unified trust and transaction layer for digital identity, payments, smart contracts, and tokenized assets. Includes documentation for the Agent API, which provides programmatic access to Neuro-Access (identities), Neuro-Pay (payments), and smart contract management, as well as the Neuro-Pay Checkout API for managing customer profiles and payment sessions.

Tokens
10.7K
Snippets
65
Records
92
Agent score
54%

What's inside Neuron

  1. Overview of the Neuron Platform

    Neuron is a decentralized trust and transaction layer designed for digital identity, payments, smart contracts, and tokenized assets. It serves as an infrastructure layer that ensures actions between applications, users, and devices are authenticated, verified, and recorded with cryptographic integrity. The platform is built on the IEEE P1451.99 IoT Harmonization standard to enable secure, interoperable communication across people, organizations, and connected devices.

  2. Overview of the Neuron Agent API

    The Agent API is a server-to-server REST API providing programmatic access to all Neuron services, including Neuro-Access (identities), Neuro-Pay (payments), and Neuro-Assets (assets). It allows developers to create digital identities, manage wallets, process payments, handle assets, request signatures, and execute smart contracts. It is specifically intended for cases where complete control over user flows is required, for IoT device integration, or when features are needed that are not available in the Neuro-Access App.

  3. Understand the Smart Contract lifecycle

    Smart Contracts in the Neuron Agent API follow a specific five-step lifecycle: 1. Design the structure and logic; 2. Propose the contract for review; 3. Wait for operator approval (automatic or manual); 4. Generate the final contract from the approved template; 5. Finalize the contract via signing.

  4. Manage identities and transactions with the Agent API

    The Agent API provides security features designed for safe identity management, contract signing, and the execution of transactions.

  5. Integrate Neuron Agent API into a web application

    The JavaScript Agent API allows web applications to manage user accounts, sessions, email/phone verification, cryptographic keys, KYC legal identities, wallets, and digital signatures. It runs entirely in the browser without requiring a backend or API keys. The library exposes a global AgentAPI object that mirrors Neuron REST API resources using asynchronous JavaScript syntax.

  6. Create and manage decentralized agreements via Smart Contracts

    Use automated smart contracts to create and manage decentralized agreements, which simplifies the handling of complex interactions.

  7. Track digital assets using Token Management

    Token Management allows for the effortless handling of digital assets through tokenized transactions, verification processes, and ownership tracking.

  8. Neuro-Pay Checkout API endpoints overview

    The following endpoints are available for managing checkouts. All endpoints require the POST method and Bearer Token authentication.
    /checkout/create   - Create a new checkout
/checkout/retrieve - Get checkout details
/checkout/capture  - Capture a checkout transaction
/checkout/refund   - Refund a checkout transaction
/checkout/update   - Modify metaData of an existing checkout
/checkout/delete   - Remove a checkout record

  9. Choose between Agent API and Neuro-Access App for Neuron integration

    Neuron services can be integrated using two complementary methods: the Agent API and the Neuro-Access App.

    • Agent API: A server-to-server REST API providing direct programmatic access. It is best for custom onboarding/KYC flows, digital signatures, smart contracts, IoT device identity management, and automated bots.
    • Neuro-Access App: A ready-made mobile application for end-users. It allows users to complete KYC once and authenticate across services via QR codes. It is best for B2C apps, simple secure authentication, and services that prefer not to build their own KYC infrastructure.

    Developers often combine both: using the Neuro-Access App for user-facing onboarding and login (UX), while utilizing the Agent API for advanced operations like digital signatures or smart contracts.

  10. Connect to the Neuro-Pay Checkout API

    The Neuro-Pay Checkout API is used to create, retrieve, capture, and manage checkouts. All API requests must be sent to the base URL using the POST method with JSON for both request and response formats.
    Base URL: https://api.neuro-admin.com

  11. Understand the Checkout Customer API response object

    The standard response object for 'Create Customer' and 'Retrieve Customer' endpoints provides details about a customer's stored information. It includes basic profile details, a metadata object for custom attributes, and an optional list of saved payment cards.

    Customer Profile Fields:

    • customer_id (String): Unique identifier of the customer.
    • first_name (String): First name of the customer.
    • last_name (String): Last name of the customer.
    • email (String): Email address of the customer.
    • client_page (String): URL where the customer can manage payment cards.
    • metaData (Object): Key-value parameters for custom attributes. New keys are added, existing keys are updated, and empty values are deleted.
    {
  "customer_id": "cust_5678",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "client_page": "https://merchant.com/manage-cards",
  "metaData": {
    "vip_status": "gold_member",
    "referral_code": "XYZ123"
  }
}

  12. Implement Neuron services via Agent.js JavaScript library

    The Agent.js library allows the Agent API to be used directly within a web browser via the global AgentAPI object. This method is suitable for prototypes, client-only applications, and fast integrations that do not require a backend server. It mirrors the REST API but automatically manages session tokens and nonces.
    <script src="https://YOUR-NEURON/Agent.js"></script>