API Resources
Legitimate allows agencies and developers to create entirely custom digital experiences on the Legitimate platform for a given set of tags using our APIs.
Last updated
Was this helpful?
Legitimate allows agencies and developers to create entirely custom digital experiences on the Legitimate platform for a given set of tags using our APIs.
Last updated
Was this helpful?
Direct access to our APIs are available to our enterprise clients. Different plans are available depending on the number of tags supported, API usage limits, custom domains for endpoints, and CORS domain allowlists.
API request and response interfaces are subject to change. Changes will be versioned. All customers will be notified of changes and provided upgrade instructions.
All standard tag resources can be accessed from our external API gateway domain. This domain can be accessed without authentication tokens, API keys, or CORS restrictions.
A fair usage rate limit per API endpoint and per IP or browser client applies. Contact us to request an API key if you expect high usage rates.
Our API endpoints allow you to build a more robust user experience. For example, you can call a to obtain the digital ID and blockchain information associated with the tag. With the given information about the digital ID, you can then call our APIs to the digital ID to a given user wallet or ownership when the item is sold or given away.
Below, we've suggested several considerations to take into account when building your application.
The initial state of the digital ID token is when the tag has been tapped for the first time. The ownership of the token is ready to be claimed by the user.
We suggest a preview of the product metadata and digital experience, as well as a short summary of what to expect before asking the user to login or connect their wallet to claim the NFT.
owner_address = null
After the user has claimed ownership of the digital ID and the token has been transferred to their wallet, anyone who has access to the phygital item can be shown exclusive digital content. Keep in mind that owners often let their friends and family tap the tag as well so any content or digital activations that can encourage sharing can help expand your reach and encourage more engagement.
owner_address = 0xaBcD...
In the event that a link generated by the NFC tag is shared and reused, or invalid tag information is passed in, an error page should inform the user to tap the tag on the item again.
(optional)
For collectible items and items that may be resold, traded, and ownership transferred, we suggest adding the ability for owners to reset the ownership so the token can be claimed again. Because Legitimate pays blockchain transaction fees, resetting ownership and allowing new owners to start over with the claim process is a more seamless experience. The old owner can reset the token before giving the item away, or if the old owner forgot to reset, the new owner can also reset and claim the token as if were new.