Create Digital Passport

Overview

Use cases

  • Create a digital product passport that enhances authentication and services through proof of ownership, proof of engagement, traceability, and transparency.
  • 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.

Workflow

Let's start 🚀

Create a digital passport

💡

  • To create your digital passports, save your productGroupId to link these to it. To create n digital passports, call n times the request.
  • You can either decide to create a digital passport draft, and do not mint the passport on the network, or you can mint it directly.

⚠️

  • Each digital passport minted spends 1 credit.
  • Digital passport recovery time is automatically 5 years.
  • To associate a digital passport with a group, the group must be minted on the network.
  • You must not set two identical productId in the same productGroup. However, you can have two identical productId in two different groups.
  • If you define a digital passport schema property, the property defined in the digital passport group is erased.

URL

To create a product digital passport, use /productManagement/productGroup/:productGroupId/product/create.

POST - https://{{nmpUrl}}/productManagement/productGroup/:productGroupId/product/create

Body

FieldTypeRequiredDefault ValueDescription
productIdStringN/AID of the product defined by the user.
contentObjectN/AContent details (schema added by API). Only customized content.
tagsArrayN/ATags associated with the product. Product Group tags are not applied to the product.
publicContentBooleanProductGroup default valueVisibility on platforms such as OpenSea.
mintBooleanfalseWhether to create the digital passport directly on the blockchain.
If you do not mint the digital passport, use the mint request.
⚠️ Reminder: The group must be minted to create its digital passports.
{
    "productId": "navyclock", //required
    "tags": ["testProduct"], // optional
    "mint": false, // optional
    "publicContent": true, // optional
    "content": { // optional
        "language": "en-US",
        "name": "The Navyclock",
        "sku": "NAC-BB-LS20-06",
        "gtin": "0 00 12345 60001 2",
        "brandInternalId": "NYC12345",
        "category": "apparel",
        "subCategory": "watch",
        "intended": "womens",
        "serialnumber": [
        {
            "type": "serialnumber",
            "value": "DEMO#001"
        },
        {
            "type": "casenumber",
            "value": "Cas pratique - Clara"
        },
        {
            "type": "movementnumber",
            "value": "85QR18 [demo]"
        }
        ],
        "subBrand": "Arianee watches",
        "model": "Limited serie 2020",
        "description": "<b>Description</b>\nThe Navyclock by Arianee watch, small model, quartz movement. Case in 18k pink gold, beaded crown in 18k pink gold set with a synthetic cabochon-shaped spinel, strap in leather. \n\n<b>Case dimensions</b>\ndiameter: 29.5 mm, thickness: 6.35 mm, water-resistant to 3 bar (approx. 30 meters/100 feet).",
        "subDescription": [
        {
            "type": "other",
            "title": "The Navyclock watchmaking process",
            "content": "The Navyclock preserves the perfectly pitched classical elegance and signature Arianee features. The brand has been producing its own in-house movements since 2017. The movements boast a host of features but are designed to be thin by incorporating various complications into the mainplate."
        },
        {
            "type": "service",
            "title": "Customer service information",
            "content": "The Navyclock is rarely down. When it happens you can be sure our network will be here for you. "
        }
        ],
        "externalContents": [
        {
            "type": "website",
            "title": "Website",
            "url": "https://www.arianee.org/"
        },
        {
            "type": "website",
            "title": "About Arianee",
            "url": "https://www.arianee.org/about-arianee"
        },
        {
            "type": "website",
            "title": "History of Watches",
            "url": "https://en.wikipedia.org/wiki/History_of_watches"
        },
        {
            "type": "proofLinkAction",
            "title": "Link with a proof of ownership",
            "url": "https://test.arian.ee/proofLinkAction.html"
        }
        ],
        "msrp": [
        {
            "msrp": "35000",
            "currency": "EUR",
            "msrpCountry": "Europe"
        },
        {
            "msrp": "32000",
            "currency": "GBP",
            "msrpCountry": "United Kingdom"
        },
        {
            "msrp": "40000",
            "currency": "USD",
            "msrpCountry": "USA"
        }
        ],
        "medias": [
        {
            "mediaType": "picture",
            "type": "product",
            "url": "https://bdharianeetest.firebaseapp.com/pub/-Lzfbb6qGXMN3LVhPRWG_arianeeResized"
        },
        {
            "mediaType": "picture",
            "type": "product",
            "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbcJwhZPNES_2NK1h_arianeeResized"
        },
        {
            "mediaType": "picture",
            "type": "product",
            "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbdNMkhOxvu5n_cPv_arianeeResized"
        },
        {
            "mediaType": "picture",
            "type": "brandItemBackgroundPicture",
            "url": "https://bdharianeetest.firebaseapp.com/pub/-LtzQIIK-FD65qAFCBEm"
        },
        {
            "mediaType": "youtube",
            "type": "product",
            "url": "https://www.youtube.com/watch?v=Z7v41l4I-Gc",
            "ytId": "Z7v41l4I-Gc",
            "thumbnail": "https://img.youtube.com/vi/Z7v41l4I-Gc/0.jpg",
            "embedURL": "https://www.youtube.com/embed/Z7v41l4I-Gc"
        },
        {
            "mediaType": "picture",
            "type": "itemBackgroundPicture",
            "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI78FCrDVaPk8tQkl9"
        },
        {
            "mediaType": "picture",
            "type": "certificateBackgroundPicture",
            "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI7CrFW31aP_hyx1ZE"
        }
        ],
        "attributes": [
        {
            "type": "color",
            "value": "Gold"
        }
        ],
        "materials": [
        {
            "material": "gold",
            "pourcentage": "50%"
        }
        ],
        "size": [
        {
            "type": "depth",
            "value": "6",
            "unit": "in"
        },
        {
            "type": "depth",
            "value": "3,6",
            "unit": "cm"
        }
        ],
        "manufacturingCountry": "Switzerland",
        "facilityId": "12345",
        "productCertification": [
        {
            "name": "fairtrade"
        }
        ],
        "i18n": [
        {
            "language": "fr-FR",
            "description": "<b>Description</b>\nLa montre The Navyclock d'Arianee est un petit modèle utilisant le mouvement à quartz. Boitier en or rose 18 carats, Couronne perlée en or rose 18 carats sertie d'un spinelle synthétique en forme de cabochon, bracelet en cuir.\n\n<b>Dimensions</b>\ndiamètre: 29.5 mm, épaisseur: 6.35 mm, étanche à 3 bar (environ 30 mètres/100 pieds).",
            "externalContents": [
            {
                "type": "website",
                "title": "Site",
                "url": "https://www.arianee.org/"
            },
            {
                "type": "website",
                "title": "Arianee",
                "url": "https://www.arianee.org/about-arianee"
            },
            {
                "type": "website",
                "title": "L'Histoires des montres ",
                "url": "https://fr.wikipedia.org/wiki/Montre_(horlogerie)"
            },
            {
                "type": "proofLinkAction",
                "title": "Link with a proof of ownership",
                "url": "https://test.arian.ee/proofLinkAction.html"
            }
            ]
        },
        {
            "language": "zh-CN",
            "description": "<b>描述</b>\nThe Navyclock by Arianee 手表,小型款,石英机芯. 18k玫瑰金表壳,18k玫瑰金串珠状表冠,镶有凸圆形人造合成尖晶石,皮革表带.\n\n<b>外壳尺寸</b>\n直径:29.5毫米,厚度:6.35毫米,防水深度达3巴(约30米/ 100英尺\n",
            "externalContents": [
            {
                "type": "website",
                "title": " 网站",
                "url": "https://www.arianee.org/"
            },
            {
                "type": "website",
                "title": " 关于 Arianee",
                "url": "https://www.arianee.org/about-arianee"
            },
            {
                "type": "website",
                "title": " 手表的历史",
                "url": "https://zh.wikipedia.org/wiki/%E6%89%8B%E8%A1%A8"
            }
            ]
        }
        ]
    }
}

Return Payload

FieldTypeDescription
successBooleanIndicates whether the request was successful.
dataObjectContains the full payload and blockchain information.
{
    "success": true,
    "data": {
        "productGroupId": "productGroupID",
        "content": {
            "language": "en-US",
            "name": "product",
            "sku": "NAC-BB-LS20-06",
            "gtin": "0 00 12345 60001 2",
            "brandInternalId": "NYC12345",
            "category": "apparel",
            "subCategory": "watch",
            "intended": "womens",
            "serialnumber": [
                {
                    "type": "serialnumber",
                    "value": "DEMO#001"
                },
                {
                    "type": "casenumber",
                    "value": "Cas pratique - Clara"
                },
                {
                    "type": "movementnumber",
                    "value": "85QR18 [demo]"
                }
            ],
            "subBrand": "Arianee watches",
            "model": "Limited serie 2020",
            "description": "<b>Description</b>\nThe Navyclock by Arianee watch, small model, quartz movement. Case in 18k pink gold, beaded crown in 18k pink gold set with a synthetic cabochon-shaped spinel, strap in leather. \n\n<b>Case dimensions</b>\ndiameter: 29.5 mm, thickness: 6.35 mm, water-resistant to 3 bar (approx. 30 meters/100 feet).",
            "subDescription": [
                {
                    "type": "other",
                    "title": "The Navyclock watchmaking process",
                    "content": "The Navyclock preserves the perfectly pitched classical elegance and signature Arianee features. The brand has been producing its own in-house movements since 2017. The movements boast a host of features but are designed to be thin by incorporating various complications into the mainplate."
                },
                {
                    "type": "service",
                    "title": "Customer service information",
                    "content": "The Navyclock is rarely down. When it happens you can be sure our network will be here for you. "
                }
            ],
            "externalContents": [
                {
                    "type": "website",
                    "title": "Website",
                    "url": "https://www.arianee.org/"
                },
                {
                    "type": "website",
                    "title": "About Arianee",
                    "url": "https://www.arianee.org/about-arianee"
                },
                {
                    "type": "website",
                    "title": "History of Watches",
                    "url": "https://en.wikipedia.org/wiki/History_of_watches"
                },
                {
                    "type": "proofLinkAction",
                    "title": "Link with a proof of ownership",
                    "url": "https://test.arian.ee/proofLinkAction.html"
                }
            ],
            "msrp": [
                {
                    "msrp": "35000",
                    "currency": "EUR",
                    "msrpCountry": "Europe"
                },
                {
                    "msrp": "32000",
                    "currency": "GBP",
                    "msrpCountry": "United Kingdom"
                },
                {
                    "msrp": "40000",
                    "currency": "USD",
                    "msrpCountry": "USA"
                }
            ],
            "medias": [
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-Lzfbb6qGXMN3LVhPRWG_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbcJwhZPNES_2NK1h_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbdNMkhOxvu5n_cPv_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "brandItemBackgroundPicture",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LtzQIIK-FD65qAFCBEm"
                },
                {
                    "mediaType": "youtube",
                    "type": "product",
                    "url": "https://www.youtube.com/watch?v=Z7v41l4I-Gc",
                    "ytId": "Z7v41l4I-Gc",
                    "thumbnail": "https://img.youtube.com/vi/Z7v41l4I-Gc/0.jpg",
                    "embedURL": "https://www.youtube.com/embed/Z7v41l4I-Gc"
                },
                {
                    "mediaType": "picture",
                    "type": "itemBackgroundPicture",
                    "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI78FCrDVaPk8tQkl9"
                },
                {
                    "mediaType": "picture",
                    "type": "certificateBackgroundPicture",
                    "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI7CrFW31aP_hyx1ZE"
                }
            ],
            "attributes": [
                {
                    "type": "color",
                    "value": "Gold"
                }
            ],
            "materials": [
                {
                    "material": "gold",
                    "pourcentage": "50%"
                }
            ],
            "size": [
                {
                    "type": "depth",
                    "value": "6",
                    "unit": "in"
                },
                {
                    "type": "depth",
                    "value": "3,6",
                    "unit": "cm"
                }
            ],
            "manufacturingCountry": "Switzerland",
            "facilityId": "12345",
            "productCertification": [
                {
                    "name": "fairtrade"
                }
            ],
            "i18n": [
                {
                    "language": "fr-FR",
                    "description": "<b>Description</b>\nLa montre The Navyclock d'Arianee est un petit modèle utilisant le mouvement à quartz. Boitier en or rose 18 carats, Couronne perlée en or rose 18 carats sertie d'un spinelle synthétique en forme de cabochon, bracelet en cuir.\n\n<b>Dimensions</b>\ndiamètre: 29.5 mm, épaisseur: 6.35 mm, étanche à 3 bar (environ 30 mètres/100 pieds).",
                    "externalContents": [
                        {
                            "type": "website",
                            "title": "Site",
                            "url": "https://www.arianee.org/"
                        },
                        {
                            "type": "website",
                            "title": "Arianee",
                            "url": "https://www.arianee.org/about-arianee"
                        },
                        {
                            "type": "website",
                            "title": "L'Histoires des montres ",
                            "url": "https://fr.wikipedia.org/wiki/Montre_(horlogerie)"
                        },
                        {
                            "type": "proofLinkAction",
                            "title": "Link with a proof of ownership",
                            "url": "https://test.arian.ee/proofLinkAction.html"
                        }
                    ]
                },
                {
                    "language": "zh-CN",
                    "description": "<b>描述</b>\nThe Navyclock by Arianee 手表,小型款,石英机芯. 18k玫瑰金表壳,18k玫瑰金串珠状表冠,镶有凸圆形人造合成尖晶石,皮革表带.\n\n<b>外壳尺寸</b>\n直径:29.5毫米,厚度:6.35毫米,防水深度达3巴(约30米/ 100英尺\n",
                    "externalContents": [
                        {
                            "type": "website",
                            "title": " 网站",
                            "url": "https://www.arianee.org/"
                        },
                        {
                            "type": "website",
                            "title": " 关于 Arianee",
                            "url": "https://www.arianee.org/about-arianee"
                        },
                        {
                            "type": "website",
                            "title": " 手表的历史",
                            "url": "https://zh.wikipedia.org/wiki/%E6%89%8B%E8%A1%A8"
                        }
                    ]
                }
            ],
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json"
        },
        "tags": [
            "testProduct",
            "public_v2"
        ],
        "minted": false,
        "passphrase": "6d8j0envby6d",
        "productId": "productId"
    }
}

Errors

Status CodeSuccessCodeError Message
400falsenpm.productManager.incorrectPayloadSome parameters of your payload are incorrect. See details.
409falsenpm.productManagement.productIdAlreadyExistForThisProductGroupproductId already exists associated to this productGroup.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.

Mint digital passport

URL

To create a product digital passport, use /productGroup/:productGroupId/product/:productId/mint.

POST - https://{{nmpUrl}}/productGroup/:productGroupId/product/:productId/mint

Return Payload

FieldTypeDescription
successBooleanIndicates whether the request was successful.
dataObjectContains the full payload and blockchain information.
{
    "success": true,
    "data": {
        "productGroupId": "productGroupID",
        "content": {
            "language": "en-US",
            "name": "product",
            "sku": "NAC-BB-LS20-06",
            "gtin": "0 00 12345 60001 2",
            "brandInternalId": "NYC12345",
            "category": "apparel",
            "subCategory": "watch",
            "intended": "womens",
            "serialnumber": [
                {
                    "type": "serialnumber",
                    "value": "DEMO#001"
                },
                {
                    "type": "casenumber",
                    "value": "Cas pratique - Clara"
                },
                {
                    "type": "movementnumber",
                    "value": "85QR18 [demo]"
                }
            ],
            "subBrand": "Arianee watches",
            "model": "Limited serie 2020",
            "description": "<b>Description</b>\nThe Navyclock by Arianee watch, small model, quartz movement. Case in 18k pink gold, beaded crown in 18k pink gold set with a synthetic cabochon-shaped spinel, strap in leather. \n\n<b>Case dimensions</b>\ndiameter: 29.5 mm, thickness: 6.35 mm, water-resistant to 3 bar (approx. 30 meters/100 feet).",
            "subDescription": [
                {
                    "type": "other",
                    "title": "The Navyclock watchmaking process",
                    "content": "The Navyclock preserves the perfectly pitched classical elegance and signature Arianee features. The brand has been producing its own in-house movements since 2017. The movements boast a host of features but are designed to be thin by incorporating various complications into the mainplate."
                },
                {
                    "type": "service",
                    "title": "Customer service information",
                    "content": "The Navyclock is rarely down. When it happens you can be sure our network will be here for you. "
                }
            ],
            "externalContents": [
                {
                    "type": "website",
                    "title": "Website",
                    "url": "https://www.arianee.org/"
                },
                {
                    "type": "website",
                    "title": "About Arianee",
                    "url": "https://www.arianee.org/about-arianee"
                },
                {
                    "type": "website",
                    "title": "History of Watches",
                    "url": "https://en.wikipedia.org/wiki/History_of_watches"
                },
                {
                    "type": "proofLinkAction",
                    "title": "Link with a proof of ownership",
                    "url": "https://test.arian.ee/proofLinkAction.html"
                }
            ],
            "msrp": [
                {
                    "msrp": "35000",
                    "currency": "EUR",
                    "msrpCountry": "Europe"
                },
                {
                    "msrp": "32000",
                    "currency": "GBP",
                    "msrpCountry": "United Kingdom"
                },
                {
                    "msrp": "40000",
                    "currency": "USD",
                    "msrpCountry": "USA"
                }
            ],
            "medias": [
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-Lzfbb6qGXMN3LVhPRWG_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbcJwhZPNES_2NK1h_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LzfbdNMkhOxvu5n_cPv_arianeeResized"
                },
                {
                    "mediaType": "picture",
                    "type": "brandItemBackgroundPicture",
                    "url": "https://bdharianeetest.firebaseapp.com/pub/-LtzQIIK-FD65qAFCBEm"
                },
                {
                    "mediaType": "youtube",
                    "type": "product",
                    "url": "https://www.youtube.com/watch?v=Z7v41l4I-Gc",
                    "ytId": "Z7v41l4I-Gc",
                    "thumbnail": "https://img.youtube.com/vi/Z7v41l4I-Gc/0.jpg",
                    "embedURL": "https://www.youtube.com/embed/Z7v41l4I-Gc"
                },
                {
                    "mediaType": "picture",
                    "type": "itemBackgroundPicture",
                    "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI78FCrDVaPk8tQkl9"
                },
                {
                    "mediaType": "picture",
                    "type": "certificateBackgroundPicture",
                    "url": "https://bdharianeemaxime.firebaseapp.com/pub/-LzI7CrFW31aP_hyx1ZE"
                }
            ],
            "attributes": [
                {
                    "type": "color",
                    "value": "Gold"
                }
            ],
            "materials": [
                {
                    "material": "gold",
                    "pourcentage": "50%"
                }
            ],
            "size": [
                {
                    "type": "depth",
                    "value": "6",
                    "unit": "in"
                },
                {
                    "type": "depth",
                    "value": "3,6",
                    "unit": "cm"
                }
            ],
            "manufacturingCountry": "Switzerland",
            "facilityId": "12345",
            "productCertification": [
                {
                    "name": "fairtrade"
                }
            ],
            "i18n": [
                {
                    "language": "fr-FR",
                    "description": "<b>Description</b>\nLa montre The Navyclock d'Arianee est un petit modèle utilisant le mouvement à quartz. Boitier en or rose 18 carats, Couronne perlée en or rose 18 carats sertie d'un spinelle synthétique en forme de cabochon, bracelet en cuir.\n\n<b>Dimensions</b>\ndiamètre: 29.5 mm, épaisseur: 6.35 mm, étanche à 3 bar (environ 30 mètres/100 pieds).",
                    "externalContents": [
                        {
                            "type": "website",
                            "title": "Site",
                            "url": "https://www.arianee.org/"
                        },
                        {
                            "type": "website",
                            "title": "Arianee",
                            "url": "https://www.arianee.org/about-arianee"
                        },
                        {
                            "type": "website",
                            "title": "L'Histoires des montres ",
                            "url": "https://fr.wikipedia.org/wiki/Montre_(horlogerie)"
                        },
                        {
                            "type": "proofLinkAction",
                            "title": "Link with a proof of ownership",
                            "url": "https://test.arian.ee/proofLinkAction.html"
                        }
                    ]
                },
                {
                    "language": "zh-CN",
                    "description": "<b>描述</b>\nThe Navyclock by Arianee 手表,小型款,石英机芯. 18k玫瑰金表壳,18k玫瑰金串珠状表冠,镶有凸圆形人造合成尖晶石,皮革表带.\n\n<b>外壳尺寸</b>\n直径:29.5毫米,厚度:6.35毫米,防水深度达3巴(约30米/ 100英尺\n",
                    "externalContents": [
                        {
                            "type": "website",
                            "title": " 网站",
                            "url": "https://www.arianee.org/"
                        },
                        {
                            "type": "website",
                            "title": " 关于 Arianee",
                            "url": "https://www.arianee.org/about-arianee"
                        },
                        {
                            "type": "website",
                            "title": " 手表的历史",
                            "url": "https://zh.wikipedia.org/wiki/%E6%89%8B%E8%A1%A8"
                        }
                    ]
                }
            ],
            "parentCertificates": [
                {
                    "type": "Full",
                    "arianeeLink": "https://test.arian.ee/964007972,hgvskeayqlfy"
                }
            ],
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json"
        },
        "tags": [
            "testProduct",
            "public_v2"
        ],
        "minted": false,
        "passphrase": "da1i2whtq7zd",
        "productId": "grd1"
    }
}

Errors

Status CodeSuccessCodeMessage
404falsenmp.productManagement.PRODUCT_ID_NOT_EXISTSThe productId does not exist.
409falsenmp.productManagement.PRODUCT_GROUP_ALREADY_MINTEDThe productId already minted.
{
    "message": "productId STRING does not exists",
    "code": "nmp.productManagement.PRODUCT_ID_NOT_EXISTS"
}
{
    "message": "STRING already minted",
    "code": "nmp.productManagement.PRODUCT_GROUP_ALREADY_MINTED"
}

🗂️

To retrieve the legacy NFT Management API, see the V1.9 documentation.