Norsh
Home
NTPNCLAPI
Home
NTPNCLAPI
  1. Address
  • Norsh
    • Usage Guide
      • Identity in the Norsh Ecosystem
      • UCP Message Structure (Standard Request Format)
    • API
      • UCP Error Codes
      • Keys Identity
        • Generates a public and private key pair
      • Address
        • Register Address
          POST
        • Get Address
          POST
        • Enable TOTP
          POST
        • Disable TOTP
          POST
        • Enable Secret-Based Authentication
          POST
        • Disable Secret-Based Authentication
          POST
        • Revoke Address
          POST
      • Modules
        • Get Module
        • Create Notary
      • Statements
        • Get Statement
        • Create Notary Statement
      • BigLedger
        • Get BigLedger Statement
      • Tartarus
        • Get Tartarus Statement
      • Envelopes
        • Get Envelope
  • NTP - Norsh Technical Paper
    • NTP-1: Norsh Technical Paper Specification
    • NTP-2: Standards for Encoding, Time and Localization
    • NTP-3: Cryptography and Hash Specification
    • NTP-4: Interchangeable Data Standard
    • NTP-5: Temporal Time-Step Model
    • NTP-6: Modular Prime Fragmentation
    • NTP-7: The End of Mining - PoW
    • NTP-8: The Fallacy of Stake - PoS
    • NTP-9: The Myth of Absolute Non-Censorship
    • NTP-10: Structural Failures of Decentralization
    • NTP-11: Universal Blockchain Protocol (UBP)
    • NTP-12: Sharded Certificate Storage for the Norsh Ecosystem
  • NCL - Norsh Commons License
    • NCL-0: Norsh Commons License
    • NCL-1: Attribution Requirement
    • NCL-2: Restricted Commercialization
    • NCL-4: Commercialization with Agreement or Royalties
    • NCL-8: Educational Use Permission
    • NCL-16: Complementary Use and Integration Permission
    • NCL-32: Pre-Approval for Application Publication
    • NCL-64: Restricted or Authorized Derivatives
    • NCL-128: Contribution Terms
  • Compliance
    • Terms of Use
    • Privacy Policy
    • Norsh Brand and Trademark Usage Guidelines
    • AI Content Notice
    • Credits
    • Partners
    • Legal Templates
      • Policy on Public Disclosure of Legal Templates
      • NDA - Template
      • Service Agreement - Template
  • Resources
    • Norsh Brand Guidelines
    • Academy
      • Exam Program
  • Service Operations
    • Service Level Agreement (SLA)
    • Scheduled Maintenance Notice
    • Incident Reports
  • Schemas
    • Key & Address
      • Key.Generate
      • Address.Register
      • Address.Revoke
      • Address.TOTP.Enable
      • Address.TOTP.Disable
      • Address.Secret.Enable
      • Address.Secret.Disable
    • Modules
      • Module.Notary.Create
      • Module.Meter.Create
    • Ucp Response
    • Ucp PublicKey
    • Ucp Parameters
    • Ucp Header
    • Ucp Ghost
Home
NTPNCLAPI
Home
NTPNCLAPI
  1. Address

Enable TOTP

POST
https://sandbox.norsh.org/{network}/v1/ucp
Last modified:2025-10-30 03:54:28
This API enables Time-based One-Time Password (TOTP) authentication for a cryptographic address in the Norsh ecosystem.
A new shared secret is generated and returned, along with a compliant otpauth:// URL for client integration (compatible with Google Authenticator and similar apps).
The cryptographic address is always derived from the provided publicKey.
Once TOTP is enabled, subsequent operations will require the client to provide a valid TOTP code in the ghost.totp field of the UCP request.
Batch submission is supported; each message is processed independently.
Request:
This endpoint uses the UCP standard request format. In addition to the standard fields, specify the following fields for this operation:
command: Set to keys.totp.enable.
ghost (object, optional):
secret (string, required if the address already has an active secret): The current secret value for request verification.
Response:
otpauth: Standard otpauth:// URL for use with TOTP applications.
Notes:
The cryptographic address is always derived from the provided publicKey.
If the address already has an active secret configured, the current secret must be provided in the ghost object to authorize TOTP activation (triple factor).
After enabling TOTP, all protected operations require the client to supply a valid TOTP code in the ghost.totp field.
The client must implement a standard 30-second TOTP generator based on the returned secret, using SHA1 and 6 digits.
Loss of the TOTP secret may prevent access to TOTP-protected operations.
The TOTP secret must be securely stored and never shared.

Request

Path Params

Body Params application/vnd.ucp+json

Examples

Responses

🟢200Success
application/vnd.ucp+json
Body

🟠422Parameter Error
🟢207Multi-Status
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://sandbox.norsh.org/main/v1/ucp' \
--header 'Content-Type: application/vnd.ucp+json' \
--data-raw '[
    {
        "command": "address.totp.enable",
        "version": 1,
        "parameters": {},
        "publicKey": "MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEoVOBV/Ji7NfdOA8RAqpvqLQ7qnzuUHESOL/6Oosdg4/un0+YU+7QVX5L3sjXbbxYLQeYa4XPI7n5pKKOxNn2Qu7rsvY+CkHXW+lxzGKen9JA4EfnlWteM5KI3JYvH/Pj",
        "signature": "MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEoVOBV/Ji7NfdOA8RAqpvqLQ7qnzuUHESOL/6Oosdg4/un0+YU+7QVX5L3sjXbbxYLQeYa4XPI7n5pKKOxNn2Qu7rsvY+CkHXW+lxzGKen9JA4EfnlWteM5KI3JYvH/Pj"
    }
]'
Response Response Example
200 - Success
[
    {
        "command": "address.totp.enable",
        "version": 1,
        "status": 200,
        "timestamp": "2025-10-13T15:36:26.314Z",
        "success": true,
        "result": {
            "otpauth": "otpauth://totp/04c90d5b23fff8c2?secret=WALXBL35L2SXSCCR7UNJA27YZGWFFX33&issuer=Norsh&algorithm=SHA1&digits=6&period=30"
        },
        "tail": {
            "ledger": "bigledger",
            "statement": "2fff5060f0c29a4444da95481cd35f85ce9cb045ed61546df341e61991c3f0f151402e8903dbb986c64aa48918f15696",
            "envelope": "f5060f0c29a4444da95481cd35f85ce9cb045ed61546df341e",
            "durationMs": 116
        }
    }
]
Modified at 2025-10-30 03:54:28
Previous
Get Address
Next
Disable TOTP
Built with