# NMP APIs Documentation Documentation > Welcome to the NFT Management Platform documentation. Find comprehensive guides and documentation to help you start working on Digital Product Passports (DPP) management as quickly as possible, but also our other services such as the Client Account (Custodial Wallet) for end-users. Let's jump right in! ## Guides - [Introduction](https://docs.nmp.arianee.com/docs/introduction.md): Welcome to the developers space to learn about our NFT Management Platform! - [Integration Quickstart](https://docs.nmp.arianee.com/docs/quickstart.md) - [About Integration](https://docs.nmp.arianee.com/docs/about-integration.md): A short list of key information to enable you to start building as fast as possible - [Features Overview](https://docs.nmp.arianee.com/docs/mains-features.md): Welcome to the developers space to learn about our NFT Management Platform! - [Create Digital Passports](https://docs.nmp.arianee.com/docs/create-digital-passports-process.md) - [Create Digital Passports Group](https://docs.nmp.arianee.com/docs/create-digital-passports-group.md): Create a group of digital product passports working as a template for the multiple passports you wish to mint. - [Create Digital Passport](https://docs.nmp.arianee.com/docs/create-digital-passport.md) - [Create Digital Passport Batch using CSV](https://docs.nmp.arianee.com/docs/create-digital-passport-using-csv.md): Introducing the Bulk Upload API, a powerful feature designed to streamline the creation of multiple digital product passports. By simply uploading a CSV file containing the necessary data, you can efficiently mint numerous digital passports in one go. The bulk upload process is straightforward and consists of three steps: 1. Prepare a CSV file in the required format. 2. Upload the CSV file to trigger the creation of digital product passports. 3. Regularly check the status of the lines in your uploaded file by fetching the file. This feature significantly enhances efficiency and simplifies the creation of digital product passports. - [Update Digital Passport Group](https://docs.nmp.arianee.com/docs/update-digital-passport-group.md) - [Update Digital Passport](https://docs.nmp.arianee.com/docs/update-digital-passport.md) - [Manage Digital Passport](https://docs.nmp.arianee.com/docs/digital-passport-management.md) - [Transfer Digital Passport](https://docs.nmp.arianee.com/docs/transfer-digital-passport.md) - [Recover Digital Passport](https://docs.nmp.arianee.com/docs/recover-digital-product-passport.md) - [Delete Digital Passport](https://docs.nmp.arianee.com/docs/delete-digital-product-passport.md): As a brand, you wish to destroy a digital passport. - [Fetch Digital Passport Data](https://docs.nmp.arianee.com/docs/fetch-data.md) - [Fetch Digital Passport Group Data](https://docs.nmp.arianee.com/docs/digital-passport-group-data.md) - [Fetch Digital Passport Data](https://docs.nmp.arianee.com/docs/digital-passport-data.md) - [Keys Management](https://docs.nmp.arianee.com/docs/arianee-keys.md) - [Keys Overview](https://docs.nmp.arianee.com/docs/keys-management.md): Dig deeper into Arianee keys including the viewKey, requestKey, and proofKey. - [Manage Digital Passport Transferability](https://docs.nmp.arianee.com/docs/add-token-access.md) - [Client Account Wallet in NMP](https://docs.nmp.arianee.com/docs/client-accounts-in-nmp.md) - [Identity Management](https://docs.nmp.arianee.com/docs/identity-management.md): Create and manage identities through the NMP. - [Events Management](https://docs.nmp.arianee.com/docs/events-management.md): Create an event that will be linked to a digital passport through the NMP. - [Enriched Digital Passport](https://docs.nmp.arianee.com/docs/enriched-content.md) - [Enriched Digital Passports](https://docs.nmp.arianee.com/docs/enriched-nft.md) - [Digital Passport Schema](https://docs.nmp.arianee.com/docs/nft-schema-1.md) - [Product Transparency](https://docs.nmp.arianee.com/docs/transparency.md): The transparency is an option available for digital passport content content. This option displays general information about the physical origin of your products. - [Upload Assets](https://docs.nmp.arianee.com/docs/upload-assets.md): As a brand, the look and feel of your digital passports matter. Say you want to upload a media that will be integrated into your digital passports. Because a digital passport has a long life, you must attach long-lived content. Arianee offers a hosting solution for static assets that will last forever. - [Events](https://docs.nmp.arianee.com/docs/arianee-events.md): An Arianee event is a blockchain-based interaction or update linked to a digital passport, providing information or experiences such as ownership transfers, product authentication, or exclusive content for the asset's holder. - [Event Schema](https://docs.nmp.arianee.com/docs/event-schema.md) - [Link Event to a Digital Passport](https://docs.nmp.arianee.com/docs/link-event-to-target-digital-passport.md): Link an event to a target digital passport using the token ID. - [Auto-Event Campaign](https://docs.nmp.arianee.com/docs/create-event-campaign.md): As a brand, you want to enrich the digital passport history for a specific audience, to do so you'll create an auto-event campaign that will be automatically triggered and sent when respecting specific rules. - [Once-Off Event Campaign](https://docs.nmp.arianee.com/docs/create-once-off-event-campaign.md): As a brand, you want to enrich the digital passport history for a specific audience, to do so you'll create a once-off event campaign. - [TimestampDPP](https://docs.nmp.arianee.com/docs/timestampdpp-documentation.md) - [Messages](https://docs.nmp.arianee.com/docs/messages.md): A dMessage is a secure, blockchain-based messaging system that allows you to communicate directly with the holders of their digital passports, ensuring privacy and authenticity. - [Message Schema](https://docs.nmp.arianee.com/docs/message-schema.md) - [Send Message to a Digital Passport](https://docs.nmp.arianee.com/docs/send-message-to-a-digital-passport.md): Send a message to a target digital passport. - [Auto-Message Campaign](https://docs.nmp.arianee.com/docs/auto-message-campaign.md): Create an auto-message campaign to communicate by targeting your audience every time rules are triggered. - [Once-Off Message Campaign](https://docs.nmp.arianee.com/docs/once-off-message-campaign.md): Create and send a once-off message campaign to a defined audience. You can engage a specific group of holders of digital passports thanks to tags or digital passport ID(s). - [What's the Client Account Wallet?](https://docs.nmp.arianee.com/docs/wallet-as-a-service-introduction.md) - [About Integration](https://docs.nmp.arianee.com/docs/wallet-as-a-service-about-integration.md) - [Authentication](https://docs.nmp.arianee.com/docs/wallet-as-a-service-authentication.md) - [Create Wallet](https://docs.nmp.arianee.com/docs/custody-gateway-create-wallet-address.md): Create a wallet for your brand-new customers. - [Fetch Wallet Information](https://docs.nmp.arianee.com/docs/wallet-3.md) - [Display Digital Passports](https://docs.nmp.arianee.com/docs/display-digital-passports.md): Fetch digital passport information and content through the ID of the link. - [Claim Digital Passports](https://docs.nmp.arianee.com/docs/digital-passports-1.md) - [Transfer Digital Passport to Another Wallet](https://docs.nmp.arianee.com/docs/transfer-ownership.md) - [Manage Proof of Ownership](https://docs.nmp.arianee.com/docs/manage-proof-of-ownership.md) - [Fetch & Read Messages](https://docs.nmp.arianee.com/docs/messages-2.md) - [Accept Arianee Event](https://docs.nmp.arianee.com/docs/accept-arianee-event.md): Users can accept the Arianee Events they receive for a given digital passport. This event is enriched with content and is timestamped in the digital passport history. - [Fetch Identities](https://docs.nmp.arianee.com/docs/identities-1.md) - [Transfer Permit](https://docs.nmp.arianee.com/docs/sst.md) - [Generate SST](https://docs.nmp.arianee.com/docs/generate-sst.md): The token provider, also known as the digital passport owner, facilitates the creation of a Smart Asset Sharing Token (SST). This token allows the service provider to fetch and transfer the digital passport if the SST is valid. - [Check SST](https://docs.nmp.arianee.com/docs/check-sst.md) - [Fetch Digital Passport Details from SST](https://docs.nmp.arianee.com/docs/get-smart-asset-details-from-sst.md): If the <> is valid for a given digital passport, the user can fetch its associated content. - [Transfer Digital Passport using SST](https://docs.nmp.arianee.com/docs/transfer-digital-passport-using-sst.md): The digital passport transfer operates once the passport is fetched and the <> is valid. - [Arianee Access Token](https://docs.nmp.arianee.com/docs/arianee-access-token-2.md) - [Create Arianee Access Token](https://docs.nmp.arianee.com/docs/create-arianee-access-token.md) - [Check Arianee Access Token](https://docs.nmp.arianee.com/docs/check-arianee-access-token.md) - [What is the Arianee Webhook?](https://docs.nmp.arianee.com/docs/introduction-3.md) - [Events & Retries](https://docs.nmp.arianee.com/docs/events-retries-copy.md) - [Webhooks Data](https://docs.nmp.arianee.com/docs/webhooks-data.md) - [Manage Webhooks](https://docs.nmp.arianee.com/docs/manage-webhooks.md) - [Fetch Digital Passport On-Chain Data using Token ID](https://docs.nmp.arianee.com/docs/retrieve-nft-data.md) - [Search for Digital Passports using Data](https://docs.nmp.arianee.com/docs/search-for-digital-passports.md): Launch basic or advanced research to fetch target assets. - [Count Digital Passports using Data](https://docs.nmp.arianee.com/docs/count-dpp.md): Retrieve the count of digital passports on your NFT Management Platform. - [Report Distributed Digital Passports using Tags](https://docs.nmp.arianee.com/docs/get-nfts-list-by-tags.md): As a brand, say you wish to list digital passport IDs having one or several specific tags. - [Report Digital Passports Transfers](https://docs.nmp.arianee.com/docs/report-nft-transfers.md): As a brand, you wish to get a report about the ownership transfers of your distributed digital passports during a given period. - [Interface Dashboard](https://docs.nmp.arianee.com/docs/interface-dashboard.md): From the Statistics tab of your NFT Management Platform, you can access a dashboard giving you access to various data in order to get insight. - [Profile Management](https://docs.nmp.arianee.com/docs/profile-management.md) - [Rights Listing](https://docs.nmp.arianee.com/docs/rights-listing.md): When creating a new profile, you'll define one or several rights applied. - [Create Profile](https://docs.nmp.arianee.com/docs/create-profile.md): Create a new profile on your NFT Management Platform. - [Fetch Profiles](https://docs.nmp.arianee.com/docs/fetch-profiles.md): Profiles in the NFT management platform are used to define user rights rules. - [Update Profile](https://docs.nmp.arianee.com/docs/update-profile.md): Update an existing profile on your NFT Management Platform. - [Delete Profile](https://docs.nmp.arianee.com/docs/delete-profile.md): Profiles in the NFT management platform are used to define user rights rules. - [Users Management](https://docs.nmp.arianee.com/docs/users-management.md) - [Access Right Management](https://docs.nmp.arianee.com/docs/access-right-management.md) - [Create User](https://docs.nmp.arianee.com/docs/create-user.md): Add a new user on your NFT Management Platform and the rights you wish to associate with. - [Fetch Users](https://docs.nmp.arianee.com/docs/fetch-users.md): Retrieve all the users of your NFT Management Platform, their information and associated rights. - [Update User](https://docs.nmp.arianee.com/docs/update-user.md): Update the rights of a user registered in your NFT Management Platform. - [Generate/Update User's API Key](https://docs.nmp.arianee.com/docs/manage-users-api-key.md): Generate the first API key of a specific user or update it. - [Delete User](https://docs.nmp.arianee.com/docs/revoke-user.md): Delete a user from your NFT Management Platform. - [What's the Forge?](https://docs.nmp.arianee.com/docs/introduction-1.md) - [Digital Passport Templates](https://docs.nmp.arianee.com/docs/create-templates.md) - [Pair Digital Passport with Product Through Interface](https://docs.nmp.arianee.com/docs/pair-digital-passport-to-product-interface.md) - [Pair Digital Passport with Product](https://docs.nmp.arianee.com/docs/create-template-api.md) - [Update Template](https://docs.nmp.arianee.com/docs/update-template.md): Update an existing template using API. - [Fetch Templates](https://docs.nmp.arianee.com/docs/authentication-1.md): Link The Forge App to your NFT Management Platform to access your templates. - [Delete Template](https://docs.nmp.arianee.com/docs/delete-template-api.md) - [Event Templates](https://docs.nmp.arianee.com/docs/manage-event-templates.md) - [Create Event Template](https://docs.nmp.arianee.com/docs/create-event-template.md) - [Update Event Template](https://docs.nmp.arianee.com/docs/update-event-template.md) - [Fetch Event Templates](https://docs.nmp.arianee.com/docs/fetch-event-templates.md) - [Delete Event Template](https://docs.nmp.arianee.com/docs/delete-event-template.md) - [Glossary](https://docs.nmp.arianee.com/docs/glossary.md) ## API Reference - [Test API](https://docs.nmp.arianee.com/reference/testapi.md): Test our API with your environment: NFT Management Platform URL and API key. - URL: `GET - {{url}}/productManagement/hello` - Success: `World!` message is returned. - [Create Digital Passport](https://docs.nmp.arianee.com/reference/createdigitalpassport.md): This endpoint allows you to create a new digital product passport within a specific product group. - `URL: POST - {{url}}/productManagement/productGroup/:productGroupID/product/create` - Parameter: - `productId` - The unique identifier for the product. - Body: - `productId` - ID of the product you wish to associate with the digital passport. - `tags` - An array of tags associated with the product. - `mint` - A boolean value indicating whether the product is mint. - `content` - The detailed content of the product including language, name, sku, gtin, brand details, category, subcategory, intended use, serial numbers, sub brand, model, description, sub descriptions, external contents, msrp, medias, attributes, materials, size, manufacturing country, facility ID, product certification, and internationalization details. - Success: Depending on `mint` field, your draft is created or your digital passport is about to be minted. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/create-digital-passport) - [Mint Digital Passport](https://docs.nmp.arianee.com/reference/mintdigitalpassport.md): This endpoint allows you to mint a specific digital passport. - URL: `POST - {{url}}/productManagement/product/:productId/mint` - `productId` - The unique identifier for the product. - Body: - `tokenId` - ID of the token on the blockchain you wish to associate with your digital passport. - `passphrase` - Passphrase of the token on the blockchain associated with your digital passport. The value is empty but is returned after sending the request. - Success: Your digital is about to be minted. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/create-digital-passport) - [Create Digital Passport Batch using CSV](https://docs.nmp.arianee.com/reference/createdigitalpassportbatchusingcsv.md): This endpoint allows you to upload a batch of products to create multiple digital passports simultaneously. - URL: `POST - {{url}}/productManagement/product/batch/upload` - Body: `csvFile` to be uploaded. - Success: Your batch is created. [For more information on the CSV file format, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-digital-passport-using-csv) - [Create Digital Passport Group](https://docs.nmp.arianee.com/reference/createdigitalpassportgroup.md): This API endpoint is used to create a new digital product passport group. - URL: `POST - {{url}}/productManagement/productGroup/create` - Body: - `productGroupId` - The unique identifier for the product group. - `tags` - An array of tags to be associated with the product group. - `mint` - A boolean value indicating whether the product group is mint. Default: false - `content` - An object containing detailed information about the product group, including language, name, SKU, GTIN, brand internal ID, category, subcategory, etc. - Success: Depending on `mint` field, your digital passport group is created or about to be minted. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/create-digital-passports-group) - [Mint Digital Passport Group](https://docs.nmp.arianee.com/reference/mintdigitalpassportgroup.md): This API endpoint is used to mint a digital passport group. - URL: `POST - {{url}}/productManagement/productGroup/:productGroupId/mint` - Parameter: `productGroupId` - The unique identifier for the product group. - Success: The digital passport group is about to be minted. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-digital-passports-group) - [Fetch Owner Profile using Product ID](https://docs.nmp.arianee.com/reference/fetchownerprofileusingproductid.md): This endpoint retrieves the owner and the associated wallet profile of a specific digital passport. - URL: `GET - {{url}}/productManagement/product/:productId/ownerOf` - Parameter: `productId` - The unique identifier for the product group. - Success: The owner profile is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/digital-passport-data) - [Fetch On-Chain Data using Product ID](https://docs.nmp.arianee.com/reference/fetchon-chaindatausingproductid.md): This endpoint retrieves the on-chain details of a specific digital passport. - URL: `GET - {{url}}/productManagement/product/:productId/onChain` - Parameter: `productId` - The unique identifier for the product group. - Success: Data is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/digital-passport-data) - [Fetch Data using Product ID](https://docs.nmp.arianee.com/reference/fetchdatausingproductid.md): This endpoint retrieves a specific product within a product group using the product's ID. - URL: `GET - {{url}}/productManagement/product/:productId` - Parameter: `productId` - The unique identifier for the product group. - Success: The digital passport data is returned. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/digital-passport-data) - [Fetch Data using Token ID](https://docs.nmp.arianee.com/reference/fetchdatausingtokenid.md): This endpoint retrieves a specific product within a product group using the token ID. - URL: `GET - {{url}}/productManagement/product/byTokenId/:tokenId` - Parameter: `tokenId` - Blockchain identification number on the blockchain) of the digital passport. - Success: The digital passport data is returned. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/digital-passport-data) - [Fetch CSV File](https://docs.nmp.arianee.com/reference/fetchcsvfile.md): This endpoint allows you to retrieve a CSV file uploaded on your NFT Management Platform. - URL: `GET - {{url}}/productManagement/product/batch/:csvOriginalName` - Parameter: `csvOriginalName` - Name of the CSV name. - Success: The digital passport data is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-digital-passport-using-csv) - [Fetch Statistics using ProductGroup ID](https://docs.nmp.arianee.com/reference/fetchstatisticsusingproductgroupid.md): This endpoint allows you to retrieve statistics for a specific digital product passport group identified by the productGroupId parameter. - URL: `GET - {{url}}/productManagement/productGroup/:productGroupId/stats` - Parameter: `productGroupId` - The unique identifier for the product group. - Success: The group statistics are returned. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/digital-passport-group-data) - [Fetch Data using ProductGroup ID](https://docs.nmp.arianee.com/reference/fetchdatausingproductgroupid.md): This endpoint retrieves the details of a specific product group identified by the `productGroupId` parameter. - URL: `GET - {{url}}/productManagement/productGroup/:productGroupId` - Parameter: `productGroupId` - The unique identifier for the product group. - Success: The group data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/digital-passport-group-data) - [Fetch Digital Passport Missing Status](https://docs.nmp.arianee.com/reference/fetchdigitalpassportmissingstatus.md): This endpoint allows you to check if a certificate is missing. - URL: `POST - {{url}}/lostAndStolen/isMissing` - Body: `certificateId` - Token ID of the digital passport (blockchain identification number) to be checked for missing. - Success: The status is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/declare-product-as-lost-or-stolen) - [Fetch Digital Passport Stolen Status](https://docs.nmp.arianee.com/reference/fetchdigitalpassportstolenstatus.md): This endpoint allows you to check if a digital passport is stolen. - URL: `POST - {{url}}/lostAndStolen/isStolen` - Body: `certificateId` - Token ID of the digital passport (blockchain identification number) to be checked for stolen. - Success: The status is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/declare-product-as-lost-or-stolen) - [Set/Remove Digital Passport Missing Status](https://docs.nmp.arianee.com/reference/setremovedigitalpassportmissingstatus.md): This endpoint allows you to set or unset a digital passport status as missing. - URL: `POST - {{url}}/lostAndStolen/setMissing` - Body: - `certificateId` - The ID of the target digital passport. - `isMissing` - Set the digital passport as missing (`true`) or unset (`false`). - Success: The new status is set. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/declare-product-as-lost-or-stolen) - [Set/Remove Digital Passport Stolen Status](https://docs.nmp.arianee.com/reference/setremovedigitalpassportstolenstatus.md): This endpoint is used to set or unset a digital passport status as stolen. - URL: `POST - {{url}}/lostAndStolen/setStoen` - Body: - `certificateId` - The ID of the target digital passport. - `isStolen` - Set the digital passport as stolen (`true`) or unset (`false`). - Success: The new status is set. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/declare-product-as-lost-or-stolen) - [Transfer Digital Passport](https://docs.nmp.arianee.com/reference/transferdigitalpassport.md): This endpoint allows you to transfer a digital passport. - URL: `POST - {{url}}/productManagement/product/:productId/transfer` - Parameter: `productId` - The unique identifier for the product. - Body: - `viewKey` - Digital passport's passphrase. - `address` - Address of the target wallet that must receive the ownership of the NFT. - The digital passport has been transferred. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/transfer-digital-passport) - [Recover Digital Passport](https://docs.nmp.arianee.com/reference/recoverdigitalpassport.md): This endpoint allows you to recover a specific digital passport. - URL: `POST - {{url}}/productManagement/product/:productId/recover` - Parameter: `productId` - The unique identifier for the product. - Success: The digital passport has been recovered. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/recover-digital-product-passport) - [Destroy Digital Passport](https://docs.nmp.arianee.com/reference/destroydigitalpassport.md): ### Destroy Product This endpoint is used to destroy a specific digital passport. - URL: `POST - {{url}}/productManagement/product/:productId/destroy` - Parameter: `productId` - The unique identifier for the product. - Success: The digital passport has been destroyed. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/delete-digital-product-passport) - [Manage Digital Passport Transferability](https://docs.nmp.arianee.com/reference/managedigitalpassporttransferability.md): This endpoint allows users to add token access to a specific digital passport. The request should include a payload with the following parameters: This endpoint allows you to recover a specific digital passport. - URL: `POST - {{url}}/productManagement/product/:productId/addTokenAccess` - Parameter: `productId` - The unique identifier for the product. - Body: - `address` - Wallet address. - `activate` - To activate or disable the token access. - `tokenType` - The type of the token access. - Success: The type of key has been changed. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/add-token-access) - [Get Tags List](https://docs.nmp.arianee.com/reference/gettagslist.md): Get the list of tags that have been used for your digital passports on your NFT Management Platform. - [Update Complete JSON Schema](https://docs.nmp.arianee.com/reference/updatecompletejsonschema.md): This endpoint allows you to update a specific digital passport. This updates all the content and erases the former content body. - URL: `PUT - {{url}}/productManagement/product/:productId` - Parameter: `productId` - ID of the digital passport to update. - Body: - `tags` - Tag(s) of the digital passport. - `content` - Content of the digital passport. - Success: The digital passport has been updated. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport) - [Update JSON Schema Property & Metadata](https://docs.nmp.arianee.com/reference/updatejsonschemapropertymetadata.md): This endpoint allows you to update a specific digital passport. - URL: `PATCH - {{url}}/productManagement/product/:productId` - Parameter: `productId` - ID of the digital passport to update. - Body: - `tags` - Tag(s) of the digital passport. - `content` - Content of the digital passport. - Success: The digital passport has been updated. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport) - [Update One JSON Schema Property](https://docs.nmp.arianee.com/reference/updateonejsonschemaproperty.md): This endpoint allows you to update one property in a digital passport. - URL: `PUT - {{url}}/productManagement/product/:productId/:property` - Parameter: - `productId` - ID of the digital passport to update. - `property` - Property to update. - Body: - `data` - New value of the property. - Success: The digital passport has been updated. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport) - [Remove One Property in the JSON Schema](https://docs.nmp.arianee.com/reference/removeonepropertyinthejsonschema.md): This endpoint allows you to delete a specific property of a digital passport. - URL: `DELETE - {{url}}/productManagement/product/:productId/:property` - Parameter: - `productId` - ID of the digital passport to update. - `property` - Property to update. - Success: The property has been removed. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport) - [Update One Property in Extra-language JSON Schema](https://docs.nmp.arianee.com/reference/updateonepropertyinextra-languagejsonschema.md): This endpoint allows you to update one property in the extra-language schema of the digital passport. - URL: `PUT - {{url}}/productManagement/product/:productId/i18n/:language/:property` - Parameter: - `productId` - ID of the digital passport to update. - `language` - Target language. - `property` - Property to update. - Body: `data` - New value of the property. - Success: The property has been updated. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport) - [Remove One Property in Extra-languages JSON Schema](https://docs.nmp.arianee.com/reference/removeonepropertyinextra-languagesjsonschema.md): This endpoint allows you to delete an extra-language property of a specific digital passport. - URL: `DELETE - {{url}}/productManagement/product/:productId/i18n/:language/:property` - Parameter: - `productId` - ID of the digital passport to update. - `language` - Target language. - `property` - Property to delete. - Success: The property has been removed. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport) - [Update Complete JSON Schema](https://docs.nmp.arianee.com/reference/putupdatecompletejsonschema.md): This endpoint allows you to update a specific digital product passport group. - URL: `PUT - {{url}}/productManagement/productGroup/:productGroupId` - Parameter: `productGroupId` - ID of the digital passport group to update. - Body: - `tags` - Tag(s) of the digital passport group. - `content` - Content of the digital passport group. - Success: The digital passport group has been updated. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport-group) - [Update JSON Schema & Metadata](https://docs.nmp.arianee.com/reference/updatejsonschemametadata.md): This endpoint allows you to update a digital passport group. - URL: `PATCH - {{url}}/productManagement/productGroup/:productGroupId` - Parameter: `productGroupId` - ID of the digital passport group to update. - Body: - `tags` - Tag(s) of the digital passport group. - `content` - Content of the digital passport group. - Success: The digital passport group has been updated. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport-group) - [Update One JSON Schema Property](https://docs.nmp.arianee.com/reference/putupdateonejsonschemaproperty.md): This endpoint allows you to update one property in a digital passport group. - URL: `PUT - {{url}}/productManagement/productGroup/:productGroupId/:property` - Parameter: - `productGroupId` - ID of the digital passport group to update. - `property` - Property to update. - Body: - `data` - New value of the property. - Success: The digital passport group has been updated. [For more information and to see all supported properties, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport-group) - [Remove One Property in the JSON Schema](https://docs.nmp.arianee.com/reference/deleteremoveonepropertyinthejsonschema.md): This endpoint allows you to delete a specific property of a digital passport group. - URL: `DELETE - {{url}}/productManagement/productGroup/:productGroupId/:property` - Parameter: - `productId` - ID of the digital passport group to update. - `property` - Property to update. - Success: The property has been removed. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport-group) - [Update One Property in Extra-language JSON Schema](https://docs.nmp.arianee.com/reference/putupdateonepropertyinextra-languagejsonschema.md): This endpoint allows you to update one property in the extra-language schema of the digital passport group. - URL: `PUT - {{url}}/productManagement/productGroup/:productGroupId/i18n/:language/:property` - Parameter: - `productGroupId` - ID of the digital passport group to update. - `language` - Target language. - `property` - Property to update. - Body: `data` - New value of the property. - Success: The property has been updated. [For more information and to see all supported properties, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport-group) - [Remove One Property in Extra-languages JSON Schema](https://docs.nmp.arianee.com/reference/deleteremoveonepropertyinextra-languagesjsonschema.md): This endpoint allows you to delete an extra-language property of a specific digital passport group. - URL: `DELETE - {{url}}/productManagement/productGroup/:productGroupId/i18n/:language/:property` - Parameter: - `productId` - ID of the digital passport group to update. - `language` - Target language. - `property` - Property to delete. - Success: The property has been removed. [For more information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/update-digital-passport-group) - [Create Identity](https://docs.nmp.arianee.com/reference/createidentity.md) - [Fetch Identity](https://docs.nmp.arianee.com/reference/fetchidentity.md) - [Get client account address](https://docs.nmp.arianee.com/reference/getclientaccountaddress.md) - [Update Identity](https://docs.nmp.arianee.com/reference/updateidentity.md) - [Claim NFT](https://docs.nmp.arianee.com/reference/claimnft.md) - [Transfer NFT](https://docs.nmp.arianee.com/reference/transfernft.md) - [Create a delegated Event](https://docs.nmp.arianee.com/reference/createadelegatedevent.md) - [Upload Asset](https://docs.nmp.arianee.com/reference/uploadasset.md): This endpoint allows you to upload the media you wish to use to design your digital passports. - URL: `POST - {{url}}/asset/pub` - Body: - `image` - Media to upload - `fileId` - ID of the media - Success: The asset is uploaded. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/upload-assets) - [Fetch Asset](https://docs.nmp.arianee.com/reference/fetchasset.md): This endpoint allows you to fetch media uploaded on your NFT Management Platform by using its ID. - URL: `GET - {{url}}/pub/:id` - Parameter: `id` - ID of the asset. - Success: The asset is returned. - [Create Auto-Event Campaign](https://docs.nmp.arianee.com/reference/createauto-eventcampaign.md): This endpoint allows you to create an event campaign for a target audience. - URL: `POST - {{url}}/auto-event` - Body: - `name` - Name of the campaign. - `trigger` - `eachTransfer`, `genesis`, `walletToWallet` - `content` - Content of the Event. Check out [Event Schema](https://docs.nmp.arianee.com/docs/event-schema). - `audienceId` - ID of the target audience. - `autoAccept` - Set as `true` to auto-accept events. - `enable` - Set `true` to enable the campaign after the creation. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-event-campaign) - [Fetch All Auto-Event Campaigns](https://docs.nmp.arianee.com/reference/fetchallauto-eventcampaigns.md): This endpoint allows you to fetch all existing auto-event campaign and their associated information such as the content or the target audience. - URL: `GET - {{url}}/auto-event` - Success: All campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-event-campaign) - [Update Auto-Event Campaign](https://docs.nmp.arianee.com/reference/updateauto-eventcampaign.md): This endpoint allows you to update campaign parameters such as the name, the audience, or content. - URL: `PUT - {{url}}/auto-event/:id` - Parameter: `id` - ID of the campaign. - Body: - `name` - Name of the campaign. - `trigger` - `eachTransfer`, `genesis`, `walletToWallet` - `content` - Content of the Event. Check out [Event Schema](https://docs.nmp.arianee.com/docs/event-schema). - `audienceId` - ID of the target audience. - `autoAccept` - Set as `true` to auto-accept events. - `enable` - Set `true` to enable the campaign after the creation. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-event-campaign) - [Fetch an Auto-Event Campaign](https://docs.nmp.arianee.com/reference/fetchanauto-eventcampaign.md): This endpoint allows you to fetch an existing event campaign and its associated information such as the content or the target audience. - URL: `GET - {{url}}/auto-event/:id` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-event-campaign) - [Delete Auto-Event Campaign](https://docs.nmp.arianee.com/reference/deleteauto-eventcampaign.md): This endpoint allows you to delete an existing event campaign of your NFT Management Platform. - URL: `DELETE - {{url}}/auto-event/:id` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-event-campaign) - [Create Auto-Message Campaign](https://docs.nmp.arianee.com/reference/createauto-messagecampaign.md): This endpoint allows you to create an auto-message campaign, and define the distribution rules and its content. - URL: `POST - {{url}}/autoMessage` - Body: - `campaignName` - Name of the campaign. - `trigger` - `eachTransfer`, `genesis`, `walletToWallet` - `content` - Content of the message. Check out the [Message Schema](https://docs.nmp.arianee.com/docs/message-schema). - `audienceId` - ID of the target audience. - `autoAccept` - Set as `true` to auto-accept events. - `status` - `DRAFT` or `CREATED`. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/auto-message-campaign) - [Fetch All Auto-Message Campaigns](https://docs.nmp.arianee.com/reference/fetchallauto-messagecampaigns.md): This endpoint allows you all auto-message campaigns available on your NFT Management Platform. - URL: `GET - {{url}}/autoMessage` - Success: All the campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/auto-message-campaign#retrieve-auto-message-campaign) - [Update Auto-Message Campaign](https://docs.nmp.arianee.com/reference/updateauto-messagecampaign.md): This endpoint allows you to update a previously created auto-message campaign. - URL: `PUT - {{url}}/autoMessage/:id` - Parameter: `id` - ID of the campaign. - Body: - `campaignName` - Name of the campaign. - `productIds` - ID of the specific digital passport to target. - `content` - Content of the message. Check out the [Message Schema](https://docs.nmp.arianee.com/docs/message-schema). - `audienceId` - ID of the target audience. - `status` - `DRAFT` or `CREATED`. - Success: The campaign data are returned. [For more information, read our detailed API information.](https://docs.nmp.arianee.com/docs/auto-message-campaign) - [Fetch an Auto-Message Campaign](https://docs.nmp.arianee.com/reference/fetchanauto-messagecampaign.md): This endpoint allows you to get information on a specific created auto-message campaign available on your NFT Management Platform. - URL: `GET - {{url}}/autoMessage/:id` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/auto-message-campaign#retrieve-auto-message-campaign) - [Delete Auto-Message Campaign](https://docs.nmp.arianee.com/reference/deleteauto-messagecampaign.md): This endpoint allows you to delete an auto-message campaign for your NFT Management Platform. - URL: `DELETE - {{url}}/autoMessage/:id` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API information.](https://docs.nmp.arianee.com/docs/auto-message-campaign) - [Create Audience](https://docs.nmp.arianee.com/reference/createaudience.md): This endpoint allows you to create a new audience respecting criteria for a future campaign. - URL: `POST - {{url}}/audience/create` - Body: - `name` - The name of the audience. - `tagRule` - The tag rule for the audience. - `uniqueOwner` - Indicates whether the audience has a unique owner. - `custodialWallet` - Custodial or non-custodial wallet. `yes`: Send to custodial wallet only. `no`: Send to non-custodial wallet only. `all`: Both types of wallet. - `isWalletActiveSinceNumberOfDays` - A period in days during which activity was observed on the user's wallet. - `countries` - Define the target country. String with values separated by a pipe Example: `France`|`Spain`... - Success: The audience data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-audience) - [Update Audience](https://docs.nmp.arianee.com/reference/updateaudience.md): This endpoint allows you to update an audience branch. - URL: `PATCH - {{url}}/audience/:id` - Parameter: `id` - ID of the campaign. - Body: - `name` - The name of the audience. - `tagRule` - The tag rule for the audience. - `uniqueOwner` - Indicates whether the audience has a unique owner. - `custodialWallet` - Custodial or non-custodial wallet. `yes`: Send to custodial wallet only. `no`: Send to non-custodial wallet only. `all`: Both types of wallet. - `isWalletActiveSinceNumberOfDays` - A period in days during which activity was observed on the user's wallet. - `countries` - Define the target country. String with values separated by a pipe Example: `France`|`Spain`... - Success: The audience data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/update-audience) - [Fetch an Audience](https://docs.nmp.arianee.com/reference/fetchanaudience.md): This endpoint allows you to fetch the details of a specific audience member identified by their ID. - URL: `GET - {{url}}/audience/:id` - Parameter: `id` - ID of the audience. - Success: The audience data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/fetch-audience) - [Fetch All Audiences](https://docs.nmp.arianee.com/reference/fetchallaudiences.md): This endpoint allows you to retrieve a list of audience branches. - URL: `GET - {{url}}/audience/list` - Success: All the audiences are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/fetch-audience) - [Fetch Countries List](https://docs.nmp.arianee.com/reference/fetchcountrieslist.md): This endpoint allows you to get the list of countries to target your audience. - URL: `GET - {{url}}/walletProfile/countries` - Success: The country list is returned. [For more information, see our dedicated API documentation.](https://docs.nmp.arianee.com/docs/fetch-audience-countries) - [Create Once-Off Event Campaign](https://docs.nmp.arianee.com/reference/createonce-offeventcampaign.md): This endpoint allows you to create a once-off event campaign for a specific audience and its content. - URL: `POST - {{url}}/onceOfEvent` - Body: - `campaignName` - Name of the campaign. - `content` - Content of the Event. Check out [Event Schema](https://docs.nmp.arianee.com/docs/event-schema). - `audienceId` - ID of the target audience. - `autoAccept` - Set as `true` to auto-accept events. - status - `DRAFT` or `CREATED`. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-once-off-event-campaign) - [Fetch All Once-Off Event Campaigns](https://docs.nmp.arianee.com/reference/fetchallonce-offeventcampaigns.md): This endpoint allows you to retrieve all the once-off event campaigns created on your NFT Management Platform. - URL: `GET - {{url}}/onceOfEvent` - Success: All the campaigns are returned. For more information, read our detailed API documentation. - [Update Once-Off Event Campaign](https://docs.nmp.arianee.com/reference/updateonce-offeventcampaign.md): This endpoint allows you to update a once-off event campaign. - URL: `PUT - {{url}}/onceOfEvent/:id` - Parameter: `id` - ID of the campaign. - Body: - `campaignName` - Name of the campaign. - `content` - Content of the Event. Check out [Event Schema](https://docs.nmp.arianee.com/docs/event-schema). - `audienceId` - ID of the target audience. - `autoAccept` - Set as `true` to auto-accept events. - status - `DRAFT` or `CREATED`. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-once-off-event-campaign) - [Fetch an Once-Off Event Campaign](https://docs.nmp.arianee.com/reference/fetchanonce-offeventcampaign.md): This endpoint allows you to retrieve a specific once-off event campaign. - URL: `GET - {{url}}/onceOfEvent/:id` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. For more information, read our detailed API documentation. - [Delete Once-Off Event Campaign](https://docs.nmp.arianee.com/reference/deleteonce-offeventcampaign.md): This endpoint allows you to delete an existing campaign from your NFT Management Platform. - URL: `DELETE - {{url}}/onceOfEvent` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-once-off-event-campaign) - [Create Once-Message Campaign Draft](https://docs.nmp.arianee.com/reference/createonce-messagecampaigndraft.md): This endpoint allows you to create your once-off message campaign. - URL: `POST - {{url}}/onceOfMessage` - Body: - `campaignName` - Name of the campaign. - `productIds` - ID of the specific digital passport to include in the campaign. - `content` - Content of the message. Check out the [Message Schema](https://docs.nmp.arianee.com/docs/message-schema). - `audienceId` - ID of the target audience. - `status` - `DRAFT` or `CREATED`. If you create a draft, use the "Send Once-Off Message Campaign" API to trigger the campaign afterward. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/once-off-message-campaign) - [Fetch All Once-Off Message Campaigns](https://docs.nmp.arianee.com/reference/fetchallonce-offmessagecampaigns.md): This endpoint allows you to get information on all the once-off message campaigns created and available on your NFT Management Platform. - URL: `GET - {{url}}/onceOfMessage` - Success: The campaigns are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/once-off-message-campaign#retrieve-once-off-message-campaign) - [Send Once-Off Message Campaign](https://docs.nmp.arianee.com/reference/sendonce-offmessagecampaign.md): This endpoint allows you to send a once-off message campaign draft previously created. - URL: `POST - {{url}}/onceOfMessage/:id/createMessage` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/once-off-message-campaign) - [Update Once-Off Message Campaign](https://docs.nmp.arianee.com/reference/updateonce-offmessagecampaign.md): This endpoint allows you to update a once-off message campaign previously created. - URL: `PUT - {{url}}/onceOfMessage/:id` - Parameter: `id` - ID of the campaign. - Body: - `campaignName` - Name of the campaign. - `productIds` - ID of the specific digital passport to include in the campaign. - `content` - Content of the message. Check out the [Message Schema](https://docs.nmp.arianee.com/docs/message-schema). - `audienceId` - ID of the target audience. - `status` - `DRAFT` or `CREATED`. If you create a draft, use the "Send Once-Off Message Campaign" API to trigger the campaign afterward. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/once-off-message-campaign) - [Fetch an Once-Off Message Campaign](https://docs.nmp.arianee.com/reference/fetchanonce-offmessagecampaign.md): This endpoint allows you to get information on a once-off message campaign created and available on your NFT Management Platform. - URL: `GET - {{url}}/onceOfMessage/:id` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/once-off-message-campaign#retrieve-once-off-message-campaign) - [Delete Once-Off Message Campaign](https://docs.nmp.arianee.com/reference/deleteonce-offmessagecampaign.md): This message allows you to delete a once-off message campaign previously created from your NFT Management Platform. - URL: `DELETE - {{url}}/onceOfMessage/:id` - Parameter: `id` - ID of the campaign. - Success: The campaign data are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/once-off-message-campaign) - [Create Digital Passport's Arianee Access Token](https://docs.nmp.arianee.com/reference/createdigitalpassportsarianeeaccesstoken.md): This endpoint allows you to create a digital passport access token for a specific client and network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/createCertificateAccessToken` - Body: - `protocolName` - `testnet`, `mainnet`, `arianeetestnet`, `mumbai`, `polygon`, `arialabs`, `stadetoulousain`, `ysl`, `testnetSbt`, `arianeeSupernet`, `arianeesbt`, `tezostestnet`, `supernettestnet`, `etherlinktestnet` - `smartAsset` - Token ID on the blockchain of the digital passport involved. - Success: `aat` is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-arianee-access-token) - [Create Wallet's Arianee Access Token](https://docs.nmp.arianee.com/reference/createwalletsarianeeaccesstoken.md): This endpoint allows you to create the Arianee Access Token of your wallet. - URL: `GET - https://custody.arianee.com/{{client}}/{{chainType}}/nft/createWalletAccessToken` - Success: `aat` is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-arianee-access-token) - [Check Arianee Access Token](https://docs.nmp.arianee.com/reference/checkarianeeaccesstoken.md): This request is used to check the validity of an Arianee Access Token for a specific user and network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/checkCertificateAccessToken` - Body: - `aat` - Arianee Access Token to check. - Success: - `valid` - Indicates whether the Arianee Access Token is valid or not. - `message` - A message indicating the status of the Arianee Access Token. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/check-arianee-access-token) - [Claim Digital Passport](https://docs.nmp.arianee.com/reference/claimdigitalpassport.md): This endpoint allows a user to request to claim a digital passport for a specific user within a specific network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/claim` - Body: link - Link of the digital passport to claim. - Success: The digital has been claimed. Ownership is about to be transferred. `true` indicates a successful claim. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/digital-passports-1) - [Create Wallet](https://docs.nmp.arianee.com/reference/createwallet.md): This endpoint triggers the creation of a new wallet for a user within a given network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/wallet/create` - `provider` - The provider for the wallet. - Success: - `address` - The address of the newly created wallet. - `walletId` - The ID of the newly created wallet (DFNS only). [For more information on providers, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/custody-gateway-create-wallet-address) - [Fetch Owned Digital Passports](https://docs.nmp.arianee.com/reference/fetchowneddigitalpassports.md): This endpoint allows you to retrieve the digital passports owned by a specific user within a particular network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/getOwned` - Success: The response will include the details of the digital passports owned by the specified user in the specified network. [For miore information, read our dedicated API documentation.](https://docs.nmp.arianee.com/docs/display-digital-passports) - [Fetch Digital Passport using Token ID](https://docs.nmp.arianee.com/reference/fetchdigitalpassportusingtokenid.md): This endpoint allows you to retrieve digital passport information for a specific client and network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/get` - Body: - `protocolName` - `testnet`, `mainnet`, `arianeetestnet`, `mumbai`, `polygon`, `arialabs`, `stadetoulousain`, `ysl`, `testnetSbtal`, `arianeeSupernet`, `arianeesbt`, `supernettestnet` ``` - `smartAsset` - Token ID of the digital passport. ``` - Success: The response will contain the details of the requested digital passport. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/display-digital-passports) - [Fetch Digital Passport Information using Link](https://docs.nmp.arianee.com/reference/fetchdigitalpassportinformationusinglink.md): This endpoint allows you to retrieve digital passport data from a specific link within a given network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/getFromLink` - Body: `link` - Link of the digital passport to retrieve. - Success: The response will contain the details of the requested digital passport. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/display-digital-passports) - [Fetch Identity using Issuer Address](https://docs.nmp.arianee.com/reference/fetchidentityusingissueraddress.md): This endpoint allows you to retrieve identity information for an issuer and network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/identity/get` - Body: `issuer` - Issuer wallet address. - Success: The response will include the identity details. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/v2.1/docs/identities-1) - [Fetch Identities on Network](https://docs.nmp.arianee.com/reference/fetchidentitiesonnetwork.md): This endpoint allows you to retrieve the identities of the digital passport owned by a specific user and on a specific network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/identity/getOwnedSmartAssetsIdentities` - Success: The response to this request includes an array of objects containing identity details. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/identities-1) - [Fetch Received Messages](https://docs.nmp.arianee.com/reference/fetchreceivedmessages.md): This endpoint allows you to retrieve received messages. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/messages/getReceived` - Success: The response provides an array of message objects containing the message details. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/messages-2) - [Fetch Message using ID](https://docs.nmp.arianee.com/reference/fetchmessageusingid.md): This request allows you to retrieve a message. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/messages/get` - Body: - `id` - The ID of the message. - `protocolName` - The name of the protocol. - Success: The response will contain the message details. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/messages-2) - [Mark Message as Read](https://docs.nmp.arianee.com/reference/markmessageasread.md): This request allows you to mark a message as read. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/messages/markAsRead` - Body: - `id` - The ID of the message. - `protocolName` - The name of the protocol. - Success: The message is marked as read. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/messages-2) - [Fetch Wallet Owner Information](https://docs.nmp.arianee.com/reference/fetchwalletownerinformation.md): This endpoint allows you to retrieve wallet information. - URL: `GET - https://custody.arianee.com/{{client}}/{{chainType}}/wallet/infos` - Success: The response will include the following fields. - `userId`: The unique identifier for the user. - `mnemonic`: The mnemonic phrase for the wallet. - `signingClient`: The client used for signing. - `address`: The wallet address. - `provider`: The provider of the wallet. - `walletId`: The unique identifier for the wallet. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/wallet-3) - [Fetch Wallet Address](https://docs.nmp.arianee.com/reference/fetchwalletaddress.md): This endpoint allows you to fetch the wallet address. - URL: `GET - https://custody.arianee.com/{{client}}/{{chainType}}/address` - Success: The wallet address is returned. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/wallet-3) - [Generate a Proof of Ownership](https://docs.nmp.arianee.com/reference/generateaproofofownership.md): This endpoint allows you to create a proof link for a specific digital passport within a given network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/createProofLink` - Body: - `protocolName` - `testnet`, `mainnet`, `arianeetestnet`, `mumbai`, `polygon`, `arialabs`, `stadetoulousain`, `ysl`, `testnetSbt`, `arianeeSupernet`, `arianeesbt`, `supernettestnet` - `smartAsset` - ID of the digital passport. - Success: The proof link is returned. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/manage-proof-of-ownership) - [Check Proof of Ownership](https://docs.nmp.arianee.com/reference/checkproofofownership.md): This endpoint allows you to make a request to check the validity of a proof link within a network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/checkProofLink` - Body: `link` - The proof link to be checked. - Success: The response will include the following fields. - `valid` - Indicates whether the proof link is valid or not. - `message` - A message indicating the status of the proof link. - `link` - The original proof link. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/manage-proof-of-ownership) - [Transfer Digital Passport using Link](https://docs.nmp.arianee.com/reference/transferdigitalpassportusinglink.md): This endpoint allows you to create of a transfer link for a digital passport within the network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/createTransferLink` - Body: - `protocolName` - `testnet`, `mainnet`, `arianeetestnet`, `mumbai`, `polygon`, `arialabs`, `stadetoulousain`, `ysl`, `testnetSbt`, `arianeeSupernet`, `arianeesbt`, `supernettestnet` - `smartAsset` - ID of the digital passport. - Success: The transfer link is returned. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/transfer-ownership) - [Transfer Digital Passport to Target Wallet Address](https://docs.nmp.arianee.com/reference/transferdigitalpassporttotargetwalletaddress.md): This endpoint allows a user to transfer a digital passport from a specific wallet to another one within a given network. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/transfer` - Body: - `protocolName` - `testnet`, `mainnet`, `arianeetestnet`, `mumbai`, `polygon`, `arialabs`, `stadetoulousain`, `ysl`, `testnetSbt`, `arianeeSupernet`, `arianeesbt`, `tezostestnet`, `supernettestnet`, `etherlinktestnet` - `smartAssetId` - The ID of the digital passport being transferred. - `to` - Recipient wallet of the digital passport. - Success: `true` indicates a successful transfer. [For more information, read our dedicated documentation.](https://docs.nmp.arianee.com/docs/transfer-ownership) - [Generate SST](https://docs.nmp.arianee.com/reference/generatesst.md): This endpoint allows you to generate an SST. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/token-provider/generateSST` - Body : - `certificateId` - Digital passport identification number to be transferred. - `spender` - Address that will be able to transfer the smart asset using the SST. - Success: `sst` is returned. [For more details, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/generate-sst) - [Check SST](https://docs.nmp.arianee.com/reference/checksst.md): This endpoint allows you to check if the SST is valid. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/service-provider/isValidSST` - Body: `sst` - SST to check. - Success: `true` is returned when SST is valid. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/check-sst) - [Fetch Digital Passport Details from SST](https://docs.nmp.arianee.com/reference/fetchdigitalpassportdetailsfromsst.md): This endpoint allows you to fetch digital passport details with valid SST. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/service-provider/getSmartAssetFromSST` - Body: `sst` - SST to check. - Success: The digital passport details are returned. [For more information, read our detailed API documentation.
](https://docs.nmp.arianee.com/docs/get-smart-asset-details-from-sst) - [Transfer Digital Passport using SST](https://docs.nmp.arianee.com/reference/transferdigitalpassportusingsst.md): This endpoints triggers the transfer of a given digital passport towards a new wallet owner using SST. - URL: `POST - https://custody.arianee.com/{{client}}/{{chainType}}/service-provider/transferSmartAssetFromSST` - Body: - `sst` - SST. - `to` - Recipient wallet address. - Success: Transfer is triggerred. [For more information, read our detailed API information.](https://docs.nmp.arianee.com/v1.9/docs/transfer-digital-passport-using-sst) - [Fetch Digital Passport On-Chain Data using Token ID](https://docs.nmp.arianee.com/reference/fetchdigitalpassporton-chaindatausingtokenid.md): This endpoint allows you to search for digital passport details. - URL: `POST - {{url}}/api/getCertificate` - Body: - `certificateId` - Token ID on the blockchain of the digital passport. - `passphrase` - Digital passport passphrase. ⚠️ Optional if your wallet is the digital passport owner or issuer. - Success: The digital passport information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/retrieve-nft-data) - [Search for Digital Passports using Data](https://docs.nmp.arianee.com/reference/searchfordigitalpassportsusingdata.md): This endpoint allows you to retrieve a list of digital passports matching specified criteria. - URL: `GET -` `{{url}}/certificate/v2/search` - Query Params: - `limit` - ⚠️ We highly recommend defining a limit that does not exceed 500 digital passports to avoid issues. Example: /certificate/?limit=50. - `q` - JSON encoded key/value request to filter results. ⚠️ When testing in API reference stringify your JSON object. - `s` - JSON encoded key/value request to sort results. ⚠️ When testing in API reference stringify your JSON object. Default value: `{"blockNumberCreation":-1}` - `p` - Projection allows you to define specific fields to return in the payload. - Success: Target digital passports are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/search-for-digital-passports) - [Count Digital Passports using Data](https://docs.nmp.arianee.com/reference/countdigitalpassportsusingdata.md): This endpoint allows you to retrieve the count of digital passports on your NFT Management Platform. - URL: `GET - {{url}}/certificate/v2/count` - Query Params: `q` - JSON encoded key/value request to filter results. ⚠️ When testing in API reference stringify your JSON object. - Success: The count is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/count-dpp) - [Report Distributed Digital Passports using Tags](https://docs.nmp.arianee.com/reference/reportdistributeddigitalpassportsusingtags.md): This endpoint allows you to get the list of digital passports with a target tag. - URL: `POST - {{url}}/certificate/getListOfSmartAssetsIdByTags` - Body: - `tags` - Tag of the digital passport to count. - `tagRule` - Tag of the digital passport to count. - `uniqueOwner` - The digital passport has had one unique owner since its creation. - Success: Distributed digital passports `tokenId` are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/get-nfts-list-by-tags) - [Report Digital Passports Transfers](https://docs.nmp.arianee.com/reference/reportdigitalpassportstransfers.md): This endpoint allows you to get a report of past transfers during a period. - URL: `GET - {{url}}/reports/certificates/pastTransfer` - Parameters - `fromTimestamp` - Starting date of the report. - `toTimestamp` - Ending date of the report. - Success: The past transfers report is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/report-nft-transfers) - [Create Profile](https://docs.nmp.arianee.com/reference/createprofile.md): This endpoint allows you to create a new profile. - URL: `POST - {{url}}/profile` - Body: - `name` - The name of the profile. - `rights`\- An array of rights associated with the profile (`admin`, `certRead`, `certCreate`, `certPrint`, `certDelete`, `certDelete`, `certRecover`, `messageSend`, `assetsUpload`, `identityUpdate`, `accountManage`, `messageSetupAuto`, `usersManage`, `eventCreate`, `reporting`, `smartContractSend)` - Success: The profile information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-profile) - [Fetch All Profiles](https://docs.nmp.arianee.com/reference/fetchallprofiles.md): This endpoint allows you to retrieve profile information of our NFT Management Platform. - URL: `GET - {{url}}/profile` - Success: All profiles are returned. [For more information, read our detailed API information.](https://docs.nmp.arianee.com/docs/fetch-profiles#fetch-all-profiles) - [Update Profile](https://docs.nmp.arianee.com/reference/updateprofile.md): This endpoint allows you to update a specific profile using its ID. - URL: `PUT - {{url}}/profile/:id` - Body: - `name` - The name of the profile. - `rights`\- An array of rights associated with the profile (`admin`, `certRead`, `certCreate`, `certPrint`, `certDelete`, `certDelete`, `certRecover`, `messageSend`, `assetsUpload`, `identityUpdate`, `accountManage`, `messageSetupAuto`, `usersManage`, `eventCreate`, `reporting`, `smartContractSend)` - Success: The profile information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/update-profile) - [Fetch a Profile](https://docs.nmp.arianee.com/reference/fetchaprofile.md): This endpoint allows you to retrieve information for a specific profile. - URL: `GET - {{url}}/profile/:id` - Parameter: `id` - ID of the profile. - Success: The profile information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/fetch-profiles#fetch-profiles-details) - [Delete Profile](https://docs.nmp.arianee.com/reference/deleteprofile.md): This endpoint allows you to delete a specific profile by providing the profile ID. - URL: `DELETE - {{url}}/profile/:id` - Parameter: `id` - ID of the profile. - Success: The profile information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/delete-profile) - [Create User](https://docs.nmp.arianee.com/reference/createuser.md): This endpoint allows you to create a new user for your NFT Management Platform. - URL: `POST - {{url}}/users/create` - Body: - `email` - The email of the user. - `profile` - The profile information of the user. - `addressOrDomain` - Allows the authorization of an Ethereum address, such as`brand.eth`, or a domain name, such as `brand.com`. - Success: The profile information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/create-user) - [Update User](https://docs.nmp.arianee.com/reference/updateuser.md): This endpoint allows you to update user information. - URL: `POST - {{url}}/users/update` - Body: - `email` - The email of the user. - `id` - The ID of the user. - `profile` - The profile information of the user. - `userId` - The ID of the user. - Success: The user information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/update-user) - [Generate/Update User's API Key](https://docs.nmp.arianee.com/reference/generateupdateusersapikey.md): This endpoint allows you to generate the first API key of a user or update it. Updating an API key will revoke the previous one. - URL: `PUT - {{url}}/users/:userID/apiKey` - Parameter: `userID` - The ID of the user that must have the API key generated. - Success: The API key is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/manage-users-api-key) - [Fetch All Users](https://docs.nmp.arianee.com/reference/fetchallusers.md): This endpoint allows you to fetch all the users of our NFT Management Platform and their information such as their IDs or their rights. - URL: `GET - {{url}}/users` - Success: All users are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/fetch-users) - [Delete User](https://docs.nmp.arianee.com/reference/deleteuser.md): This endpoint allows you to delete the access of a user on your NFT Management Platform. - URL: `POST - {{url}}/users/delete` - Body: `uid` - ID of the user to be deleted. - Success: The profile information is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/revoke-user) - [Create Template](https://docs.nmp.arianee.com/reference/createtemplate.md): This endpoint allows you to import a template on your NFT Management Platform to pair your physical products to digital passports by using The Forge app. - URL: `POST - {{url}}/smartAssetTemplate` - Body: - `blockchainProperties` -`isTransferable`: Set `true` if the digital passport is claimable. `showTransferableOption`: Set `true` to display the **Transferable** option on the app. - `metadata` - `name`: Name of the product, `icon`: Product icon displayed in the app. - `content` - Content of the template. More information on content with [JSON Schema](https://docs.nmp.arianee.com/docs/nft-schema-1). - Success: The template has been imported. [For more information, read our detailed API information.](https://docs.nmp.arianee.com/docs/create-template-api) - [Update Template](https://docs.nmp.arianee.com/reference/updatetemplate.md): Update an existing template. - URL: `PUT - {{url}}/smartAssetTemplate` - Parameter: `id` - ID of the template to update. - Body: - `blockchainProperties` -`isTransferable`: Set `true` if the digital passport is claimable. `showTransferableOption`: Set `true` to display the **Transferable** option on the app. - `metadata` - `name`: Name of the product, `icon`: Product icon displayed in the app. - `content` - Content of the template. More information on content with [JSON Schema](https://docs.nmp.arianee.com/docs/nft-schema-1). - Success: The template has been updated. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/update-template) - [Fetch All Templates](https://docs.nmp.arianee.com/reference/fetchalltemplates.md): This endpoint allows you to get the list of templates available on your NFT Management Platform. - URL: `GET - {{url}}/smartAssetTemplate` - Success: All templates available on your NFT Management Platform are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/authentication-1#fetch-all-templates-api) - [Fetch a Template](https://docs.nmp.arianee.com/reference/fetchatemplate.md): This endpoint allows you to fetch a template previously uploaded on your NFT Management Platform. - URL: `GET - {{url}}/smartAssetTemplate/:id` - Parameter: `id` - ID of the template to fetch. - Success: The target template is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/authentication-1#fetch-a-template-api) - [Delete Template](https://docs.nmp.arianee.com/reference/deletetemplate.md): This endpoint allows you to delete a template from your NFT Management Platform. - URL: `DELETE - {{url}}/smartAssetTemplate` - Parameter: `id` - ID of the template to delete. - Success: The template has been removed from your NFT Management Platform. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/delete-template-api) - [Create Arianee Event Template](https://docs.nmp.arianee.com/reference/createarianeeeventtemplate.md): This endpoint allows you to create an event template. - URL: `POST - {{url}}/arianeeEventTemplate` - Parameters: - `metadata` - Contains additional information about the event template. - `name` - The display name of the event template. Example: "Repair Event". - `icon` - A URL pointing to an icon that visually represents the event template. - `content` - Contains the core event information respecting the Event Schema. - Success: The event template has been created. [For more information, read the API documentation.](https://docs.nmp.arianee.com/docs/create-event-template) - [Update Arianee Event Template](https://docs.nmp.arianee.com/reference/updatearianeeeventtemplate.md): This endpoint allows you to - URL: `PUT - {{url}}/arianeeEventTemplate/:id` - Parameters: - `id` - ID of the event template. - `metadata` - Contains additional information about the event template. - `name` - The display name of the event template. Example: "Repair Event". - `icon` - A URL pointing to an icon that visually represents the event template. - `content` - Contains the core event information respecting the Event Schema. - Success: The event template has been updated. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/update-event-template) - [Fetch All Arianee Events](https://docs.nmp.arianee.com/reference/fetchallarianeeevents.md): This endpoint allows you to retrieve all the event templates available on your NFT Management Platform. - URL: `GET - {{url}}/arianeeEventTemplate` - Success: All the event templates are returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/fetch-event-templates) - [Fetch Arianee Event Template](https://docs.nmp.arianee.com/reference/fetcharianeeeventtemplate.md): This endpoint allows you to retrieve a specific template. - URL: `POST - {{url}}/arianeeEventTemplate/:id` - Parameter: `id` - ID of the event template. - Success: The target event template is returned. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/fetch-event-templates) - [Delete Arianee Event Template](https://docs.nmp.arianee.com/reference/deletearianeeeventtemplate.md): This endpoint allows you to remove an event template from your NFT Management Platform. - URL: `POST - {{url}}/arianeeEventTemplate` - Parameter: `id` - ID of the event template. - Success: The event template has been removed. [For more information, read our detailed API documentation.](https://docs.nmp.arianee.com/docs/delete-event-template) ## Changelog - [💫 New in NMP: Client Account Wallet!](https://docs.nmp.arianee.com/changelog/changelog-23.md) - [🚀 Event Template API for Digital Product Lifecycle Management](https://docs.nmp.arianee.com/changelog/changelog-22.md) - [📅 Custom Date on Arianee Events](https://docs.nmp.arianee.com/changelog/changelog-21.md) - [🎆 2025's Fresh Start Updates](https://docs.nmp.arianee.com/changelog/changelog-20.md) - [🎉 Wrapping Up the Year with Updates!](https://docs.nmp.arianee.com/changelog/changelog-19.md) - [🗝️ Access Right Management](https://docs.nmp.arianee.com/changelog/changelog-18.md) - [🔧 Bug Fixes](https://docs.nmp.arianee.com/changelog/changelog-17.md) - [🪄 Enhanced Product Page UX](https://docs.nmp.arianee.com/changelog/changelog-16.md) - [⏱️ History on Product Pages](https://docs.nmp.arianee.com/changelog/changelog-15.md) - [🧬 Arianee Shopify Plugin](https://docs.nmp.arianee.com/changelog/changelog-14.md)