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

Register Address

POST
https://sandbox.norsh.org/{network}/v1/ucp
Last modified:2025-10-30 03:54:10
This API registers a unique cryptographic address derived from a provided public key, calculated using the SHA3-384 hashing algorithm. The address serves as a unique identifier within the Norsh ecosystem.
Request:
This endpoint uses the UCP standard request format. In addition to the standard fields, specify the following fields for this operation:
command (string, required): The command to execute. Use address.register.
parameters (object, optional):
commonName (string, required): Human-readable name for the address. Only alphanumeric characters and spaces are allowed ([a-zA-Z0-9 ]).
Response:
Returns a unique address (SHA3-384 hash of the public key) along with the registered metadata.

Official Key Generation Libraries#

For secure, Norsh-compliant key generation and signature creation, you can use the official open-source libraries provided by the Norsh project. These libraries generate keys and signatures locally (offline), following the same cryptographic standards as the platform.
Node.js: @norsh/norsh-keygen (GitHub)
Java: norsh-keygen-java
Python: norsh-keygen-python
C#: norsh-keygen-csharp
All libraries are open source and available at github.com/norsh-org.
These libraries implement the same logic as the “Generate Public and Private Key Pair” API, but operate locally and offline.

Request

Path Params

Body Params application/vnd.ucp+json

Examples

Responses

🟢200Success
application/vnd.ucp+json
Body

🟠422Parameter Error
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.register",
        "version": 1,
        "parameters": {
          "commonName": "DTL"
        },
        "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.register",
        "version": 1,
        "status": 200,
        "timestamp": "2025-09-21T04:15:00.000Z",
        "success": true,
        "result": {
            "address": "04c90d5b23fff8c222aca048835fbb25d299471105715585e1328604f820bd98712cca6a84d715e2025ee2eee9bbeb78",
            "owner": "Common Name",
            "status": "ENABLED",
            "certificates": {
                "2025": "http://pki.norsh.com/issued/04c/90d/04c90d5b23fff8c222aca048835fbb25d299471105715585e1328604f820bd98712cca6a84d715e2025ee2eee9bbeb78-2025.pem"
            }
        },
        "tail": {
            "ledger": "bigledger",
            "statement": "05036377bb6a76648683e37a563cf829fb0c77fd807f8e0b93102ba23769e023",
            "envelope": "e0e8a311b980c564614552ec559daa1b0b19d52eeca4e454e46a097fb7ca4fb5",
            "duration": 55
        }
    }
]
Modified at 2025-10-30 03:54:10
Previous
Address
Next
Get Address
Built with