From Safe Creative API
Jump to navigation Jump to search

Registers an external NFT associated to a work.

A NFT info page will be generated in IPFS.

This call requires a nonce key


  • Component name: nft.register
  • Signature: Requires signature using the authkey's private key
  • Timestamp: Requires ztime parameter
  • Nonce key: Requires a nonce key
  • Authorization level: ADD
  • API trust level: Partner


  • authkey*: Authorization key
  • ztime*: Z-Timestamp
  • noncekey*: nonce key
  • workcode*: Code of the work associated to the NFT. The work must be in REGISTERED state.
  • tokentype*: NFT type (ERC720 or ERC1155)
  • network*: Blockchain network (ETHEREUM, POLYGON,...)
  • smartcontract*: Address of smart contract (0x...)
  • tokenid*: NFT token ID
  • wallet*: Minter wallet address (0x...)
  • language*: Language for info page
    • en: English
    • es: Spanish
  • supply: NFT issues supply (for ERC1155) defaults to 1
  • exclusive: 1 to mark this NFT as exclusive (no other NFT exists for the work)
  • licensetype: Type of license granted by the NFT
    • PRIVATE: Non-commercial end user
    • PROFESSIONAL: Professional end user
    • DISTRIBUTION: Distributor
    • CUSTOM: Custom license, must be accompanied by the customlicense parameter
  • customlicense: Full license text explaining the rights granted by the NFT over the work (for CUSTOM licensetype)
  • licenserights: Text explaining the rights or kind of usage granted by the NFT over the work
  • licenselimitations: Text explaining any limitations on the usage described by licenserights
    • Eg. geographic limits, kind of allowed projects,...
  • numberofuses: Number of uses or copies of the work allowed by this NFT
    • For licenserights allowing to create physical copies of the work, this field will specify how many copies are allowed
  • validuntil: Date limit for the rights granted by this NFT
    • Date format: yyyy-mm-ddThh:mm:ssZ
  • allowresale: 1 if this NFT can be resold by its owner, 0 otherwise (defaults to 1)
  • royaltywalletN: (multivalue) wallet address that receives royalties on sales of the NFT
  • royaltypercentN: (multivalue, integer) % of the sale price received as royalties by the corresponding wallet
    • There must be the same number of royaltywallet and royaltypercent parameters
  • imageurl*: HTTP or IPFS url of the NFT image
  • audiourl: HTTP or IPFS url of the NFT audio file
  • videourl: HTTP or IPFS url of the NFT video file


  • nftregistry
    • id: NFT registration internal ID
    • workCode: Code of the registered work
    • licenseIpfsUrl: IPFS url of the generated NFT info page




<?xml version="1.0" encoding="UTF-8"?>