Individual Links

Before you begin

The individual links are ideal when brands want to distribute distinct digital passport links or QR codes to each user. Once a customer lands on this link or scans the QR code, the digital passport will be reserved for this customer to avoid a disappointing claiming experience.

These individual links are ideal for distributing digital passports as a gift after purchase for example that is sent via email. Each digital passport is associated with its link which makes your distribution more secure and limits the potential farming of the pool of digital passports.

Use case example: Your brand wishes to send a digital passport as a gift after a purchase for customers.

⚠️

• When a user scans a code or clicks an individual link, but does not necessarily request the ownership of the digital passport. The digital passport is removed from the pool of digital passport to be distributed. This is secure the claiming experience of each user.
• In the case of many digital passports that have been scanned but not claimed, you can reset digital passports to make them available for distribution again.
• You must trigger an API call per digital passport. Example, if you need to generate 50 individual links, the API must be called 50 times.

Let's start 🚀

URL

To distribute your digital passports, use the dispenser/distribution/reserveOne.

GET - https://{{nmpUrl}}/dispenser/distribution/reserveOne

📌

The API is authenticated with the user rights required → certCreate

Return Payload

// linkObject return

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

// link return

https://test.arianee.net/440105186,v6lsj4vhg5dx

Errors

{
    "name": "API Error",
    "description": "No NFT found to distribute",
    "code": "nmp.back.dispenser.oneToOne.noNFTsToSend",
    "httpCode": 400
}