Fetch Digital Passport Data

Fetch Data using Product ID

As a brand you wish to retrieve the content, metadata, and information related to a specific digital passport using the productId.

URL

To fetch the details of a specific digital product passport, use /productManagement/product/:productId.

GET - https://{{nmpUrl}}/productManagement/product/:productId

Return Payload

FieldTypeDescription
productGroupIdStringIdentifier of the product group associated.
productIdStringIdentifier for the product.
contentObjectContent details (schema added by API).
aggregatedContentObjectContent of product and content of productGroup.
tagsArrayTags associated with this product only.
publicContentBooleanVisibility on platforms like OpenSea.
protocolStringProtocol to be used. ex: 99-breitling-0.
mintedBooleanWhether the digital passport is minted or not.
tokenIdStringtokenId of the digital passport on the network.
passphraseStringView key of the NFT.
{
    "data": {
        "productGroupId": "group1",
        "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/953022145,a4dsvuh0aty0"
                }
            ],
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json"
        },
        "passphrase": "dxpfd3ayykcg",
        "productId": "productId2",
        "minted": false,
        "tags": [
            "testProduct",
            "public_v2"
        ]
    }
}

Errors

Status CodeSuccessCodeError Message
404falsenmp.productManagement.PRODUCT_ID_NOT_EXISTSProduct group ID does not exist.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.
{
    "message": "This productId doesnt exists",
    "code": "nmp.productManagement.PRODUCT_ID_NOT_EXISTS"
}

Fetch Data using Token ID

As a brand you wish to retrieve the content, metadata, and information related to a specific digital passport using the tokenId.

URL

To fetch the details of a specific digital product passport, use /productManagement/product/byTokenId/:tokenId.

GET - https://{{nmpUrl}}/productManagement/product/byTokenId/:tokenId

Return Payload

Status CodeSuccessError Message
200trueThe digital passport details of the target token ID are returned.
{
    "data": {
        "content": {
            "language": "fr-FR",
            "name": "test-98",
            "model": "X-wing T-65 starfighter",
            "description": "Le X-wing, chasseur conรงu par le constructeur Incom Corporation, รฉtait initialement destinรฉ ร  lโ€™Empire. Cependant, lโ€™intรฉgralitรฉ des ingรฉnieurs ayant rejoint lโ€™Alliance rebelle, ils y ont amenรฉ tous les prototypes.\n\nLe T-65 descend directement du vieux Z-95 Headhunter (ยซ chasseur de tรชtes ยป), et partage des caractรฉristiques de conception avec le chasseur ARC-170 datant de lโ€™รฉpoque de la Guerre des clones (tous deux รฉtant conรงus par Incom et Subpro).\n\nLe X-wing a connu plusieurs versions, continuellement amรฉliorรฉes. Le T-65AC1 original mis en service par lโ€™Alliance rebelle, est un appareil dโ€™attaque polyvalent correct pour son temps mais vite supplantรฉ par le T-65AC2, vantant une meilleure accรฉlรฉration. Le T-65AC3 amรฉliore lโ€™รฉlectronique embarquรฉe, les boucliers et les sondes. Le T-65AC4 est principalement une mise ร  niveau des moteurs, ce qui en fait un engin presque รฉgal ร  lโ€™A-wing en termes de manล“uvrabilitรฉ. On notera une nouveautรฉ de conception pour le T-65D-A1, qui remplace le droรฏde astromรฉcanicien par un ordinateur interne pour les calculs de saut en hyperespace, mais il est considรฉrรฉ comme un รฉchec, partiellement dรป ร  la facilitรฉ de sabotage.",
            "externalContents": [
                {
                    "type": "transparency",
                    "title": "transparency",
                    "url": "https://api.bdh-arianee-showroom.arianee.com/pub/856020ce-aa0e-4a5e-9de9-d7674094ef1a"
                },
                {
                    "type": "website",
                    "title": "regular link",
                    "url": "https://arianee.org"
                },
                {
                    "type": "arianeeAccessTokenAuthLink",
                    "title": "link with aat",
                    "url": "https://services.arianee.com/customer-care/home"
                },
                {
                    "type": "proofLinkAction",
                    "title": "https://services.arianee.com/customer-care/home",
                    "url": "link with proof of ownership"
                }
            ],
            "medias": [
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://api.bdh-maxime.arianee.com/pub/5fecd9cd-2095-49ab-b16b-ff6df18e21a8"
                },
                {
                    "mediaType": "youtube",
                    "type": "product",
                    "url": "https://www.youtube.com/watch?v=fr-H8Pffa0A",
                    "ytId": "fr-H8Pffa0A",
                    "thumbnail": "https://img.youtube.com/vi/fr-H8Pffa0A/0.jpg",
                    "embedURL": "https://www.youtube.com/embed/fr-H8Pffa0A"
                }
            ],
            "parentCertificates": [
                {
                    "type": "Full",
                    "arianeeLink": "https://test.arian.ee/74697077,bgvqvgg1ntb7"
                }
            ],
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json"
        },
        "passphrase": "1amrnueypxvp",
        "tokenId": "442302508",
        "minted": true,
        "tags": []
    }
}

Errors

Status CodeSuccessError Message
404falseToken ID does not exist.
500falseAn unknown error has occurred.
{
    "success": false,
    "message": "Product not found"
}

Fetch On-Chain Data using Product ID

As a brand, you wish to fetch all on-chain data associated such as events for a specific digital passport using the productId.

URL

To fetch the data on-chain of a specific digital passport, use /productManagement/product/:productId/onChain.

GET - https://{{url}}/productManagement/product/:productId/onChain

Return Payload

Status CodeSuccessDescription
200trueThe digital passport data are returned.
{
    "arianeeEvents": [],
    "data": {
        "certificateId": "60706460",
        "content": {
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
            "serialnumber": [
                {
                    "type": "serialnumber",
                    "value": "SN1"
                }
            ],
            "category": "apparel",
            "language": "fr-FR",
            "name": "audemars piguet",
            "model": "Royal Oak",
            "description": "description",
            "parentCertificates": [
                {
                    "type": "Full",
                    "arianeeLink": "https://test.arian.ee/76594276,2aqsoivsrz73"
                }
            ]
        },
        "rawContent": {
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
            "parentCertificates": [
                {
                    "type": "Full",
                    "arianeeLink": "https://test.arian.ee/76594276,2aqsoivsrz73"
                }
            ],
            "serialnumber": [
                {
                    "type": "serialnumber",
                    "value": "SN1"
                }
            ]
        },
        "blockchainEvents": [
            {
                "isSentToWebhook": true,
                "_id": "65a682f37202095e2c796b43",
                "blockNumber": 34306248,
                "eventName": "Transfer",
                "eventData": {
                    "address": "0x512C1FCF401133680f373a386F3f752b98070BC5",
                    "blockHash": "0x47475c5c8519752062a5ccba4ff1b26e93784e34a8ae3c514d27f6a69d445242",
                    "blockNumber": 34306248,
                    "logIndex": 1,
                    "removed": false,
                    "transactionHash": "0x4e46128508b02d545c2382f6c41f1068444fd1a806c1d25bafc25790a12e4b87",
                    "transactionIndex": 0,
                    "transactionLogIndex": "0x1",
                    "id": "log_f07d9f37",
                    "returnValues": {
                        "0": "0x0000000000000000000000000000000000000000",
                        "1": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                        "2": "60706460",
                        "_from": "0x0000000000000000000000000000000000000000",
                        "_to": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                        "_tokenId": "60706460"
                    },
                    "event": "Transfer",
                    "signature": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                    "raw": {
                        "data": "0x",
                        "topics": [
                            "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                            "0x0000000000000000000000000000000000000000000000000000000000000000",
                            "0x000000000000000000000000305051e9a023fe881ee21ca43fd90c460b427caa",
                            "0x00000000000000000000000000000000000000000000000000000000039e4e9c"
                        ]
                    }
                },
                "returnValues": {
                    "0": "0x0000000000000000000000000000000000000000",
                    "1": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                    "2": "60706460",
                    "_from": "0x0000000000000000000000000000000000000000",
                    "_to": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                    "_tokenId": "60706460"
                },
                "logBloom": "0x000000000000000c0000000000100000000000000000000000000004000004000000000010000000000000001004400000000000000000000000000010000000000000000000001000000048000000000010000000000000000000000000000000000000020000400000000000000800000000000000000004000010200020000000000000000000000000000000000004000020000000000000000001000000800000000200000000000000000000002000000000000000000000000000000000000002000000000000000800000000801000100040000000000000000020000000000000000000000000000000000800004004020010000000000000000000",
                "timestamp": 1705411315,
                "blockDate": "2024-01-16T13:21:55.000Z",
                "logIndex": 1,
                "transactionHash": "0x4e46128508b02d545c2382f6c41f1068444fd1a806c1d25bafc25790a12e4b87",
                "eventHash": "fa52526d96c4d051f640985e03f324e289143064",
                "smartContractName": "smartAssetContract",
                "contractAddress": "0x512c1fcf401133680f373a386f3f752b98070bc5",
                "chainId": 77,
                "network": "testnet",
                "createdAt": "2024-01-16T13:21:55.780Z",
                "updatedAt": "2024-01-16T13:21:56.376Z",
                "__v": 0
            },
            {
                "isSentToWebhook": true,
                "_id": "65a688e87202094ded796edd",
                "blockNumber": 34306553,
                "eventName": "Transfer",
                "eventData": {
                    "address": "0x512C1FCF401133680f373a386F3f752b98070BC5",
                    "blockHash": "0x2aff9d3e2fb0f8899670ecf7ea265331f05981c5b1dba02ff1326efc4b0b6383",
                    "blockNumber": 34306553,
                    "logIndex": 0,
                    "removed": false,
                    "transactionHash": "0x5524829b492069aa1918354f441484592aaea3230ba322a907005cd473d5aee0",
                    "transactionIndex": 0,
                    "transactionLogIndex": "0x0",
                    "id": "log_ed88cab0",
                    "returnValues": {
                        "0": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                        "1": "0x38e22E8d61022ce2b08B9c1Cb437939afeF3C128",
                        "2": "60706460",
                        "_from": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                        "_to": "0x38e22E8d61022ce2b08B9c1Cb437939afeF3C128",
                        "_tokenId": "60706460"
                    },
                    "event": "Transfer",
                    "signature": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                    "raw": {
                        "data": "0x",
                        "topics": [
                            "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                            "0x000000000000000000000000305051e9a023fe881ee21ca43fd90c460b427caa",
                            "0x00000000000000000000000038e22e8d61022ce2b08b9c1cb437939afef3c128",
                            "0x00000000000000000000000000000000000000000000000000000000039e4e9c"
                        ]
                    }
                },
                "returnValues": {
                    "0": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                    "1": "0x38e22E8d61022ce2b08B9c1Cb437939afeF3C128",
                    "2": "60706460",
                    "_from": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                    "_to": "0x38e22E8d61022ce2b08B9c1Cb437939afeF3C128",
                    "_tokenId": "60706460"
                },
                "logBloom": "0x00200000000000080000000000000000000000100000100000000004000000000000000010020000000000001000400000040000000000010000000010000000000000000010001000002048000000000000000000000000000100820010000010000000000000400000000000004000000000000000000004000010000020000000000000000000000000000000000000000020000000000008000000000000000120000201000000000000000000002000000000000000000000800000010000000002000000000000000000000000001000120040000040000001000000000000000002008000000000000000000000004404020014000000000000000000",
                "timestamp": 1705412840,
                "blockDate": "2024-01-16T13:47:20.000Z",
                "logIndex": 0,
                "transactionHash": "0x5524829b492069aa1918354f441484592aaea3230ba322a907005cd473d5aee0",
                "eventHash": "985f8dc88567cde3c4b2c7f5114a61de603dac37",
                "smartContractName": "smartAssetContract",
                "contractAddress": "0x512c1fcf401133680f373a386f3f752b98070bc5",
                "chainId": 77,
                "network": "testnet",
                "createdAt": "2024-01-16T13:47:20.526Z",
                "updatedAt": "2024-01-16T13:47:21.026Z",
                "__v": 0
            }
        ],
        "imprint": "0x736e355b356cb1af3978ed7eaddfe680e9233c4edba90e756621900ad40c9448",
        "isRequestable": false,
        "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
        "owner": "0x38e22e8d61022ce2b08b9c1cb437939afef3c128",
        "protocol": {
            "name": "testnet",
            "chainId": 77
        },
        "recover": {
            "isRecoverable": true,
            "timestamp": 1863091283000
        }
    }
}

Error

Status CodeSuccessCodeError Message
404falsenmp.productManagement.PRODUCT_ID_NOT_EXISTSProduct group ID does not exist.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.
{
    "message": "This productId doesnt exists",
    "code": "nmp.productManagement.PRODUCT_ID_NOT_EXISTS"
}

Fetch Owner Profile using Product ID

As a brand, you wish to fetch the owner's wallet address and the associated wallet profile of a specific digital passport issued from your NFT Management Platform using the productId.

URL

To fetch the owner of a specific digital passport, use /productManagement/product/:productId/ownerOf.

GET - https://{{url}}/productManagement/product/:productId/ownerOf

Return Payload

Status CodeSuccessDescription
200trueThe wallet owner data are returned.
{
    "owner": "0x38e22E8d61022ce2b08B9c1Cb437939afeF3C128",
    "walletProfile": {
        "issuers": [
            {
                "issuer": "0x305051e9a023fe881EE21cA43fd90c460B427Caa",
                "chainId": 77
            }
        ],
        "lastSeenCountry": "France",
        "lastSeenCountryEventTime": 1707302265880,
        "mostConnectedCountry": "France",
        "lastBlockchainInteraction": 1707916955000,
        "updatedat": 1707918242596,
        "publicKey": "0x38e22E8d61022ce2b08B9c1Cb437939afeF3C128",
        "hashedWallet": "651cab7e65a479ec43cc3ddb74c17906c3c72ea084751826f58136254c9c8f2b",
        "isCustodial": false,
        "walletApps": [
            {
                "appId": 15493,
                "appName": "Wallet_Android",
                "language": "French",
                "lastConnection": 1707302265880,
                "isReachable": true,
                "isOptin": true,
                "lastPushSentDate": 1707916989000,
                "lastPushOpenDate": 1706518274000,
                "lastReachabilityTime": 1693399374000
            }
        ],
        "lastPushSentDate": 1695123568000,
        "lastPushOpenDate": null,
        "eventName": "nmp.walletProfile"
    }
}

Error

Status CodeSuccessCodeError Message
404falsenmp.productManagement.PRODUCT_ID_NOT_EXISTSProduct group ID does not exist.
500falsenpm.productManagement.UnknownErrorAn unknown error has occurred.
{
    "message": "This productId doesnt exists",
    "code": "nmp.productManagement.PRODUCT_ID_NOT_EXISTS"
}