ShareRing Documentation

website·Indexed 32 days ago

https://docs.shareri.ng

Technical documentation for the ShareRing ecosystem, including ShareRing LINK for enterprise identity verification, ShareRing Me Modules for mobile app web applications, ShareRing Vault for local-first identity storage, and ShareLedger blockchain infrastructure. Includes specifications for ZkVCT (Zero-Knowledge Verifiable Credential Token), SHR DID methods, and the CW1056 Lightweight Blockchain Identity Registry standard.

Tokens
38.2K
Snippets
126
Records
298
Agent score
53%

What's inside ShareRing

  1. Overview of ShareRing LINK identity verification

    ShareRing LINK allows developers to configure and deploy identity verification workflows. The platform supports Know Your Customer (KYC) processes, age verification checks, document validation, and utilizes webhook-based delivery for verification results.
  2. Overview of ShareRing LINK identity verification

    ShareRing LINK allows developers to configure and deploy identity verification workflows. The platform supports several verification types, including Know Your Customer (KYC) processes, age verification checks, and document validation. Results and status updates are delivered via webhooks.
  3. Overview of ShareRing Workflows

    Workflows are sequences of verification steps (such as identity, age checks, and document validation) that process user data to produce a structured output for integration into a system. Workflows must be explicitly created and published to appear in the Workflows list and become active.
  4. Overview of ShareLedger blockchain architecture

    ShareLedger is the foundational blockchain layer of the ShareRing ecosystem. It is a permissioned public network built within the Cosmos ecosystem. It utilizes Tendermint BFT consensus for fast finality and Byzantine fault tolerance, and employs IBC (Inter-Blockchain Communication) to enable interoperability and communication with other compatible blockchains.
  5. Overview of ShareRing LINK identity workflows

    ShareRing LINK is an enterprise-grade platform for securely collecting, verifying, and processing customer identity data. It replaces rigid, hard-coded verification processes with a flexible framework of configurable, multi-step workflows. These workflows can be managed via a visual dashboard or integrated programmatically through APIs, allowing organizations to define how identity data is collected, validated, and shared based on operational and compliance requirements.
  6. Overview of ZkVCT Architecture and Flow

    ZkVCT (Zero-Knowledge Verifiable Credential Token) enables users to prove identity claims (e.g., "I am over 18") without revealing the underlying PII. The process involves three entities:

    1. Issuer: Verifies identity, hashes attributes into a Sparse Merkle Tree (SMT) using the Poseidon hash function, signs the Merkle Root, and anchors it to the user's DID on ShareLedger. The raw attributes and Merkle Branch are sent to the Holder.
    2. Holder (Prover): Selects private inputs and public inputs (Merkle Root), executes a Circom circuit locally via snarkjs on a mobile device, and generates a Proof and PublicSignals.
    3. Verifier: A smart contract on ShareLedger or EVM chains that validates the proof against the signed Merkle Root and checks for nullifier reuse to prevent double-spending.
  7. Overview of ShareRing Me Modules

    A Me Module is a static web application (built with any framework like React, Vue, Svelte, or Vanilla JS) that runs inside the ShareRing Me mobile app's embedded WebView. Communication between the module and the app occurs exclusively via a message bridge using postMessage and addEventListener.
  8. Overview of ZkVCT (Zero-Knowledge Verifiable Credential Token)

    ZkVCT is a privacy-preserving layer built on the ShareLedger identity stack that uses zk-SNARKs to enable Selective Disclosure of identity attributes. Instead of presenting a signed JSON object containing plaintext PII (Personally Identifiable Information), the holder computes a cryptographic proof locally and submits it to a Verifier Smart Contract. The contract validates the proof against a known Merkle Root or Credential Hash without accessing the underlying data.
  9. Overview of ShareLedger blockchain architecture

    ShareLedger is the foundational blockchain layer of the ShareRing ecosystem. It is a permissioned public network built within the Cosmos ecosystem. It utilizes Tendermint BFT consensus for fast finality and Byzantine fault tolerance, and employs IBC (Inter-Blockchain Communication) to enable interoperability with other compatible blockchains. It serves as the infrastructure for decentralized identity management, on-chain reputation, and trustless verification.
  10. Overview of the CW1056 Identity Registry Standard

    CW1056 is a standard for a lightweight blockchain identity registry on the ShareRing Network. It allows for the management of keys and attributes without the need for expensive smart contract wallet deployments for every user. Key characteristics include:

    • Identifier: Uses the public key as the Identity ID (rather than a chain-specific address) to ensure cross-chain interoperability.
    • DID Compliance: The standard is fully DID-compliant.
    • Cost Efficiency: Identity creation is essentially free as any standard Shareledger key pair is inherently a valid identity.
    • Key Rotation: Supports account recovery by allowing the 'Controller' key to be swapped without changing the Identity ID.
  11. Overview of ShareRing Foundation technology

    The ShareRing Foundation encompasses the core technology, architecture, and technical standards that underpin the platform. This includes identity protocols, cryptographic primitives, compliance frameworks, and system design principles shared across all ShareRing products.
  12. Overview of ShareRing LINK Webhook Delivery

    Webhook Delivery provides real-time notifications about workflow and task execution events, allowing systems to react to changes without polling the API. Webhooks are used for operational visibility and event tracking. Supported events include: Workflow started, Workflow completed, Workflow failed, Task started, Task completed, and Task cancelled.