Mintable

API Reference

Authorize

IMPORTANT: Call from the back-end. This endpoint is used to check if a user owns a particular token (or any token of a particular collection). You will need to authenticate using your Mintology API Key, and also the Project ID that you set for one of your projects. If you do not specify a contract_address, we will use the contract associated with your project ID. If you do not specify a token_id, we will check if the wallet contain any tokens from the contract.

IMPORTANT: Call from the back-end. This endpoint is used to get the list of tokens that a user owns from a particular collection. You will need to authenticate using your Mintology API Key, and also the Project ID that you set for your project. If you do not specify a contract_address, we will use the contract associated with your project.

List authorized tokens

Mintable Wallets

IMPORTANT: Call from the back-end. Create a new Mintable Wallet. This also creates a Mintable account, so users have the ability to claim custody of their private keys. Please note that a username can be provided: if you do not provide a username, a random one will be generated and the user will be able to modify it from the <a href='https://mintable.com'>Mintable</a> website. This is a display name used on the site to reference the user, since the email address is confidential. This endpoint should always be called from your backend to prevent any potential spamming or exposing your private API key.

Create

IMPORTANT: Call from the back-end. Once a user has taken custody of their Mintable Wallet, this permanently removes the private key from our systems. To ensure the user has indeed received and stored their private key, we require you to send us a hash of the last 8 characters of the key itself: once we have checked it against the actual key and, if the match is successful, we delete the key. The hash function used here is SHA-256 (please see <a href='https://xorbin.com/tools/sha256-hash-calculator'>this example</a>). This endpoint should always be called from your backend to prevent any potential spamming or exposing your private API key.

Remove

IMPORTANT: Call from the back-end. When a user wants to take custody of their Mintable Wallet, you can call this endpoint to initiate the process. When you call the endpoint, we will send an email to the user, with an OTP which will have to be provided to access the private key of the wallet. This flow ensures that the request was indeed initiated by the user, since we will be sending this email from our systems. In order to access the private key, both the OTP sent to the user, and the request ID returned by this endpoint will have to be provided. This endpoint should always be called from your backend to prevent any potential spamming or exposing your private API key.

Request to export

IMPORTANT: Call from the back-end. Export the Mintable wallet private key. This endpoint requires the request_id (which you got when calling 'Request to Export Mintable Wallet', and the OTP which was sent to the user by that endpoint (called code here). This endpoint should always be called from your backend to prevent any potential spamming or exposing your private API key.

Approve export

Generating an ImmutableX L2 user account for an Ethereum L1 account

Register imx user

Minting an NFT refers to the process of creating a unique digital asset on a IMX blockchain, typically using the Ethereum network.

Mint imx item

Transferring an NFT, or a non-fungible token, refers to the process of sending ownership of the digital asset from one address on the IMX blockchain to another.

Transfer imx item

Info

Retrieve project information such as details and configuration.

Project info

Metadata

IMPORTANT: Call from the back-end. Update your NFT metadata that consist of things like: token name, image, animation_url and etc...

Update

Premints

Returns a list of premint items. The premints are returned sorted by updated date, with the most recent premints before.

List

Create token details like name, image, animation_url and etc...

Retrieve premint details like name, image, animation_url and etc...

Retrieve

Update token details like name, image, animation_url and etc...

Import token details like name, image, animation_url and etc...

Import

Mint

This API endpoint is designed for minting NFTs straight into a user's wallet. Ideal for selling NFTs, targeted airdrops, or minting collectibles. Supports both custom Mintable Wallets and standard crypto wallets.
Note: If you don't pass in a metadata object - it will create a random NFT using your pre-mint data you've set up on the self serve dashboard. But if you pass in a metadata object, it will mint a new NFT with the new metadata object you passed in. 
Note: Keeping 'mint' and 'claim' endpoints separate simplifies analytics, making it easier to track each call's specific purpose.

Claim

This endpoint will mint a free NFT to your user's wallet (which can be a Mintable Wallet, or their existing crypto wallet). This is the endpoint you should use for discount coupons, proof of attendance, and in general NFTs which you do not intend to sell.
Note: Separating the mint and claim endpoints will allow you to clearly identify the purpose of each call in your analytics.

Projects

IMPORTANT: Call from the back-end. Requires: API KEY in the header. Returns a list of all projects you have created.

IMPORTANT: Call from the back-end. Requires: API KEY in the header. Creates a new project under your account with the specified details.

IMPORTANT: Call from the back-end. Requires: API KEY in the header. This will return all of the projects details of the project that is specified by its project ID.

IMPORTANT: Call from the back-end. Requires: API KEY in the header. Updates the project with the specified ID with the specified details. Please check `/Projects/Create` for a description of the parameters.

Delete a project from the platform. But once deployed the smart contract will exist on the blockchain and you will be able to manage it without Mintology. This is a permanent action and cannot be undone.

IMPORTANT: Call from the back-end. Requires: API KEY in the header. Deploy the project with the specified ID with the specified details. A project must be deployed before tokens can be minted. IMPORTANT: If you are using Generative NFTs on the dashboard, you need to make the NFTs before deploying.

Deploy

Wallets

IMPORTANT: Call from the back-end. Given email address to retrieve the Mintable wallet details like address. This endpoint will only allow you to query Mintable wallets created by your organization. This endpoint should always be called from your backend to prevent any potential spamming or exposing your private API key.

Find by email

Mintology API

Mintology Documentation

Optional username that will be tied to using this private key

username

Email address that will be tied to using this private key

email

API-Key

Project Id - found on your dashboard on dashboard.mintology.app

projectId

data

message

Metadata for the NFT being minted. If absent, the metadata defined in the project will be used.

Sections