Create Digital Passport

Before your begin

Use case examples:

Create a digital product passport that enhances authentication and services through proof of ownership, proof of engagement, traceability, and transparency.
Create digital assets as a reward for your community to superpower engagement.
Create digital passports to distribute to your audience as membership proof.

As a brand, say you wish to create a digital product passport for your physical product because this digital passport establishes a link between your brand and your customers.

Once claimed by the owner, the digital product passport is useful as proof of ownership. Digital passports are great for showing what the brands stand for, and the proof of ownership is great when used as a gate to access exclusive experiences.

⚠️
Each created digital passport spends one credit.

Let's start 🚀

Step 1. Optional - Upload the assets you need to design your digital passport.

Step 2. Gather the product content within your digital passport respecting the Json Schema and define advanced parameters, then use api/createCertificateWithMetadata.

📌

NMP user rights required to call this API → certCreate

If you wish to create a digital passport without including metadata, use /api/createAndStoreCertificate.

Input	Mandatory	Type	Description
`hydrateTokenParameters`	✅	Object	Digital passport content.
`hydrateTokenParameters` → `tokenRecoveryTimeStamp`	❌	Number	The period during which the digital passport can be recovered by the issuer. Default value if empty: 5 years.
`hydrateTokenParameters` → `content`	✅	Object	Content of the digital passport.
`$schema` → `parentCertificates`	❌	Object	Use a parent digital passport as a template, and integrate this digital passport into your JSON body.
`$schema` → `i18n`	❌	Object	Add extra languages for your digital passport content.
`metadata` → `tags`	✅	String	Tag(s) of your digital passport.

Json body example:

{
    "hydrateTokenParameters":{
    "tokenRecoveryTimestamp": 12345678912345,
    "content":{
          "$schema":"https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
          "parentCertificates":[{"type":"Full","arianeeLink":"https://test.arian.ee/577746159,3o9ymkscvwf0"}],  
      	  "medias":[{
  				  "mediaType":"picture",
  				  "type":"product",
 					  "url":"https://documentation.arianee.com/pub/1670419418865-1632234657561-ROSE_BLEU_EMERAUDE_PURPLE.jpeg"}],
   					 "externalContents":[{
    				    "type":"youtube",
				        "title":"From the street to metaverse",
   					    "url":"https://www.youtube.com/watch?v=7wPUW5HHR-I&t=29s",
       				  "order":1}],
"i18n":[{
    "language":"fr-FR",
    "name":"Sweat Kitten ",
    "model":"Modèle violet électrique",
    "description":"<i>À propos de ce sweat</i>\nCe n'est pas juste un sweat à capuche de plus dans votre garde-robe. Ce sweat à capuche soutenu par NFT a été développé par Arianee - un groupe de pionniers qui veulent redéfinir la perception de la propriété dans les industries de la mode et du luxe.\nEn collaboration avec les meilleures maisons de production de France - Neyret, ISRA et WILTEE Paris, Kitten & Arianee a créé un sweat à capuche au design unique, durable dans la production et immersif dans l'expérience numérique.\n<i>Pourquoi est-ce spécial ?</i> ... ",
    "subDescription":[],
    "medias":[{
        "mediaType":"picture",
        "type":"product",
        "url":"https://documentation.arianee.com/pub/1670419418865-1632234657561-ROSE_BLEU_EMERAUDE_PURPLE.jpeg"}],
        "externalContents":[{
            "type":"youtube",
            "title":"De la rue au métaverse",
            "url":"https://www.youtube.com/watch?v=7wPUW5HHR-I&t=29s"}],
            "customAttributes":[],"transparencyItems":[]}],
            "category":"accessory",
            "language":"en-US",
            "model":"Electric Purple Model",
            "description":"<i>About this hoodie</i>\nThis is not just another hoodie in your wardrobe. This NFT-backed hoodie was developed by Arianee - a group of trailblazers who want to redefine the perception of ownership in the fashion & luxury industries. \nIn collaboration with the finest production houses in France - Neyret, ISRA and WILTEE Paris, Kitten & Arianee created a hoodie that is unique in design, sustainable in production, and immersive in digital experience. \n<i>Why is it special?</i>\nOn scanning the NFC chip on the left sleeve of the hoodie with your phone, you can claim its digital ownership and unleash a wide range of possibilities on the Arianee app:\n<ul>\n<li>Gain visibility into the product's transparency </li>\n<li>See the hoodie in Augmented Reality</li>\n<li>Stay in direct contact with our team while remaining anonymous</li>\n<li>Prove your ownership & authenticity in 1 click</li>\n</ul>\n<i>About the creative direction</i>\n“We are living in an exciting era with big changes. Through an assortment of neon tones, we want to embody contemporary optimism, passion and energy. “Why use cats?” - you might ask. Because they are fearless, resilient, and cute!” - Kitten Production.\n<i>Comfy in style</i>\nTailored from 100% organic cotton and printed with ultra-vibrant colors, this hoodie will make you a street style royalty. With a relaxed fit, the hoodie gives you a com-fur-table look in all circumstances. Most importantly, it was designed to keep kitties close. \nCurious about the hidden story of your hoodie? There you go: We’ve known all along cats have a secret plan to take over the world but their kung-fu abilities were completely under the radar... until now! Here's the proof: two cats were spotted practicing their ninja skills. \n<i>Did you know</i>\nA digital hoodie & three 3D cat illustrations in our collection are up for sale on OpenSea. All money will be donated to the Girls Club association to support young women and gender minorities. Beyond a fashion initiative, we want to inspire and empower people to be a force for good in the world.\nReady for experience? Click on, we'll guide you through!"
           },
      
"metadata": {
    "tags":["kittenhoodie","purple"]}
        }
}

{
    "hydrateTokenParameters":{
    "tokenRecoveryTimestamp": 10,
    "content":{
            "$schema":"https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
            "parentCertificates":[{"type":"Full","arianeeLink":"https://test.arian.ee/577746159,3o9ymkscvwf0"}],  
            "name":"Kitten Hoodie",
            "medias":
        [{  " mediaType":"picture",
            "type":"product",
            "url":"https://bdh-stef.api.staging.arianee.com/pub/1670419418865-1632234657561-ROSE_BLEU_EMERAUDE_PURPLE.jpeg"
        }],
        "externalContents":
         [{"type":"youtube",
         "title":"From the street to metaverse",
           "url":"https://www.youtube.com/watch?v=7wPUW5HHR-I&t=29s",
           "order":1
        }],
         "category":"accessory",
          "language":"en-US",
         "model":"Electric Purple Model",
          "description":"<i>About this hoodie</i>\nThis is not just another hoodie in your wardrobe. This NFT-backed hoodie was developed by Arianee - a group of trailblazers who want to redefine the perception of ownership in the fashion & luxury industries. \nIn collaboration with the finest production houses in France - Neyret, ISRA and WILTEE Paris, Kitten & Arianee created a hoodie that is unique in design, sustainable in production, and immersive in digital experience. \n<i>Why is it special?</i>\nOn scanning the NFC chip on the left sleeve of the hoodie with your phone, you can claim its digital ownership and unleash a wide range of possibilities on the Arianee app:\n<ul>\n<li>Gain visibility into the product's transparency </li>\n<li>See the hoodie in Augmented Reality</li>\n<li>Stay in direct contact with our team while remaining anonymous</li>\n<li>Prove your ownership & authenticity in 1 click</li>\n</ul>\n<i>About the creative direction</i>\n“We are living in an exciting era with big changes. Through an assortment of neon tones, we want to embody contemporary optimism, passion and energy. “Why use cats?” - you might ask. Because they are fearless, resilient, and cute!” - Kitten Production.\n<i>Comfy in style</i>\nTailored from 100% organic cotton and printed with ultra-vibrant colors, this hoodie will make you a street style royalty. With a relaxed fit, the hoodie gives you a com-fur-table look in all circumstances. Most importantly, it was designed to keep kitties close. \nCurious about the hidden story of your hoodie? There you go: We’ve known all along cats have a secret plan to take over the world but their kung-fu abilities were completely under the radar... until now! Here's the proof: two cats were spotted practicing their ninja skills. \n<i>Did you know</i>\nA digital hoodie & three 3D cat illustrations in our collection are up for sale on OpenSea. All money will be donated to the Girls Club association to support young women and gender minorities. Beyond a fashion initiative, we want to inspire and empower people to be a force for good in the world.\nReady for experience? Click on, we'll guide you through!"
        }
    },
"metadata": {
    "tags":["kittenhoodie","purple"]
}
}

📌
To avoid display issues in your customers' wallet, keep English content as the main language.

Result:

`httpCode`	Description
`200`	Your digital passport has been created and will be minted on the blockchain in a few minutes. You are the first owner. The `certificateId` and the `deeplink` are returned.
`400`	The body properties are not respected.
`500`	`{}` returned. `metadata` may be missing because mandatory.

{
    "certificateId": 440105186,
    "passphrase": "v6lsj4vhg5dx",
    "deepLink": {
        "certificateId": 440105186,
        "passphrase": "v6lsj4vhg5dx",
        "link": "https://test.arianee.net/440105186,v6lsj4vhg5dx"
    }
}

{
    "errors": [
        {
            "value": [],
            "msg": "nftCreationCampaignId must be an array or null",
            "param": "metadata.tags",
            "location": "body"
        }
    ]
}

{}

🚀
Our team tips
For smooth experience when minting and distributing your digital passports, we recommend to be mindful of:

On-chain transaction latency.

The design and content of your digital passport to avoid update that leads to extra cost in credits and potentially confusing digital passport history for the owners.

For more information on updates, check out Update your Digital Passport.

Before your begin

⚠️

Let's start 🚀

📌

📌

🚀Our team tips

🚀
Our team tips