Skip to content

remoteObject

AttributeTypeDescriptionRequired
namestringDescribing name✅
displayNamelanguage value objectDescriptive name of the file used for human readability in applications.
descriptionlanguage value objectFile description
fileTypestringMIME Filetype of the remote object. E.g.: application/pdf✅
sha256stringsha256 hash of the rremote object✅
mirrorsArray of remoteSourceCan include source type url and ipfs. Array must not be empty.✅
additionalInformationObjectStores additional information, this is customizable by publisher

remoteSource

type url

AttributeTypeDescriptionRequired
typestringvalue url✅
urlstringRemote object URL✅
methodstringThe HTTP method (e.g.: GET, POST)✅
headersstringadditional http headers
Example: 
{
    "type": "url",
    "url": "https://your-files.com/file1.json",
    "method": "GET",
    "headers": {
      "Custom-Header": "custom-value-if-needed"
    }
}

type ipfs

AttributeTypeDescriptionRequired
typestringvalue ipfs✅
ipfsCIDstringA content identifier, or CID, is a label used to point to material in IPFS.✅

Example:

{
  "type": "ipfs",
  "ipfsCID": "QmRA3NWM82ZGynMbYzAgYTSXCVM14Wx1RZ8fKP42G6gjgj"
}