LearnCard Documentation
GithubStatusSupportLaunch App
  • ๐Ÿš€Introduction
    • What is LearnCard?
    • Use Cases & Possibilities
    • Ecosystem Architecture
  • โšกQuick Start
    • Setup & Prerequisites
    • Your First Integration
  • ๐Ÿ“šTutorials
    • Create a Credential
    • Create a Boost
    • Create a ConsentFlow
    • Create a Connected Website
    • Send xAPI Statements
    • Listen to Webhooks
  • โœ…How-To Guides
    • Verify My Issuer
    • Connect Systems
      • Connect a Website
      • Connect a Game
    • Implement Flows
      • Claim Data after Guardian Consent
      • Connect via CHAPI
        • โญCHAPI Wallet Setup Guide
        • โ†”๏ธTranslating to CHAPI documentation
        • ๐Ÿ–ฅ๏ธDemo Application
        • ๐Ÿ”ฐUsing LearnCard to Interact with a CHAPI Wallet
        • ๐Ÿ“Cheat Sheets
          • Issuers
          • Wallets
    • Deploy Infrastructure
      • Remote Key Management
      • Generate API Tokens
      • Signing Authority
      • Connect to Independent Network
      • Build a Plugin
  • ๐Ÿ› ๏ธSDKs & API Reference
    • LearnCard Wallet SDK
      • Authentication
      • Usage Examples
      • SDK Reference
      • Plugin API Reference
      • Integration Strategies
      • Deployment
      • Troubleshooting
      • Changelog
    • LearnCloud Network API
      • Authentication
      • Usage Examples
      • Architecture
      • Notifications & Webhooks
      • Profiles
      • Profile Managers
      • Credentials
      • Boosts
      • Presentations
      • Storage
      • Contracts
      • DID Metadata
      • Claim Hooks
      • Auth Grants
      • Utilities
      • Models
      • OpenAPI
    • LearnCloud Storage API
      • Authentication
      • Usage Examples
      • Architecture
      • Storage
      • Index
      • User
      • Custom Storage
      • Utilities
      • Models
      • xAPI Reference
    • Plugins
      • Crypto
      • DIDKit
      • DID Key
      • Dynamic Loader
      • VC
        • Expiration Sub-Plugin
      • VC-Templates
      • VC-API
      • Ceramic
      • IDX
      • VPQR
      • Ethereum
      • CHAPI
      • LearnCard Network
      • LearnCloud
      • LearnCard
      • Simple Signing
      • Claimable Boosts
    • LearnCard CLI
  • ๐Ÿง Core Concepts
    • Identities & Keys
      • Decentralized Identifiers (DIDs)
      • Seed Phrases
      • Network Profiles
      • Signing Authorities
      • Trust Registries
    • Credentials & Data
      • Verifiable Credentials (VCs)
      • Credential Lifecycle
      • Schemas, Types, & Categories
      • Building Verifiable Credentials
      • Boost Credentials
      • Getting Started with Boosts
      • Credential URIs
      • xAPI Data
      • General Best Practices & Troubleshooting
    • Consent & Permissions
      • ConsentFlow Overview
      • Consent Contracts
      • User Consent & Terms
      • Consent Transactions
      • Auto-Boosts
      • Writing Consented Data
      • Accessing Consented Data
      • GameFlow Overview
    • Network & Interactions
      • Network Vision & Principles
      • Key Network Procedures
      • Core Interaction Workflows
    • Architecture & Principles
      • Control Planes
      • Plugin System
      • Auth Grants and API Tokens
  • ๐Ÿ”—Development
    • Contributing
Powered by GitBook
On this page

Was this helpful?

  1. SDKs & API Reference
  2. LearnCloud Network API

DID Metadata

PreviousContractsNextClaim Hooks

Was this helpful?

๐Ÿ› ๏ธ

Delete DID Metadata

delete

Delete DID Metadata

Authorizations
Path parameters
idstringRequired
Responses
200
Successful response
application/json
Responseboolean
default
Error response
application/json
delete
DELETE /api/did-metadata/{id} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true

Get My DID Metadata

post

Get My DID Metadata

Authorizations
Responses
200
Successful response
application/json
default
Error response
application/json
post
POST /api/profile/did-metadata HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "@context": [
      "text"
    ],
    "id": "text",
    "alsoKnownAs": "text",
    "controller": "text",
    "verificationMethod": [
      "text"
    ],
    "authentication": [
      "text"
    ],
    "assertionMethod": [
      "text"
    ],
    "keyAgreement": [
      "text"
    ],
    "capabilityInvocation": [
      "text"
    ],
    "capabilityDelegation": [
      "text"
    ],
    "publicKey": [
      "text"
    ],
    "service": [
      {
        "id": "text",
        "type": "text",
        "serviceEndpoint": null,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "proof": {
      "type": "text",
      "created": "text",
      "challenge": "text",
      "domain": "text",
      "nonce": "text",
      "proofPurpose": "text",
      "verificationMethod": "text",
      "jws": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
]
  • POSTAdd Metadata to your did web
  • GETGet DID Metadata
  • DELETEDelete DID Metadata
  • POSTGet My DID Metadata
  • POSTUpdate DID Metadata

Get DID Metadata

get

Get DID Metadata

Authorizations
Path parameters
idstringRequired
Responses
200
Successful response
application/json
Responseany of
notOptional
or
default
Error response
application/json
get
GET /api/did-metadata/{id} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add Metadata to your did web

post

Add Metadata to your did web

Authorizations
Body
idstringOptional
alsoKnownAsstringOptional
controllerany ofOptional
stringOptional
or
string[] ยท min: 1Optional
proofany ofOptional
or
Other propertiesanyOptional
Responses
200
Successful response
application/json
Responseboolean
default
Error response
application/json
post
POST /api/did-metadata/create HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 594

{
  "@context": [
    "text"
  ],
  "id": "text",
  "alsoKnownAs": "text",
  "controller": "text",
  "verificationMethod": [
    "text"
  ],
  "authentication": [
    "text"
  ],
  "assertionMethod": [
    "text"
  ],
  "keyAgreement": [
    "text"
  ],
  "capabilityInvocation": [
    "text"
  ],
  "capabilityDelegation": [
    "text"
  ],
  "publicKey": [
    "text"
  ],
  "service": [
    {
      "id": "text",
      "type": "text",
      "serviceEndpoint": null,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "proof": {
    "type": "text",
    "created": "text",
    "challenge": "text",
    "domain": "text",
    "nonce": "text",
    "proofPurpose": "text",
    "verificationMethod": "text",
    "jws": "text",
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "ANY_ADDITIONAL_PROPERTY": "anything"
}
true

Update DID Metadata

post

Update DID Metadata

Authorizations
Path parameters
idstringRequired
Body
Responses
200
Successful response
application/json
Responseboolean
default
Error response
application/json
post
POST /api/did-metadata/update/{id} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 606

{
  "updates": {
    "@context": [
      "text"
    ],
    "id": "text",
    "alsoKnownAs": "text",
    "controller": "text",
    "verificationMethod": [
      "text"
    ],
    "authentication": [
      "text"
    ],
    "assertionMethod": [
      "text"
    ],
    "keyAgreement": [
      "text"
    ],
    "capabilityInvocation": [
      "text"
    ],
    "capabilityDelegation": [
      "text"
    ],
    "publicKey": [
      "text"
    ],
    "service": [
      {
        "id": "text",
        "type": "text",
        "serviceEndpoint": null,
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ],
    "proof": {
      "type": "text",
      "created": "text",
      "challenge": "text",
      "domain": "text",
      "nonce": "text",
      "proofPurpose": "text",
      "verificationMethod": "text",
      "jws": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
true