API Key Scopes

API keys are needed to authorize requests against some of the Crossmint HTTP APIs. By using an API key, Crossmint knows which project is making the call, and can deduct credits off your quota.

API key scopes are the permissions a key has to access or modify certain resources in your Crossmint developer project. It's a good security practice to enable only the permissions you need, and not more.

📘

API keys are not needed to use Crossmint to accept credit card or cross chain payments

Crossmint's payment products do not require API keys. To use them follow the documentation under payments.

API key scopes can be configured from the API Keys section of the developer console. Please note that these are project based and you can have multiple keys with different levels of permissions.

Minting API

ScopeDescription
collections.createCreate Minting API collections
collections.readRead Minting API collections
collections.updateUpdate Minting API collections
nfts.createMint NFTs, SFTs and cNFTs
nfts.deleteBurn NFTs, SFTs and cNFTs
nfts.readRead NFTs, SFTs and cNFTs
nfts.updateUpdate NFTs, SFTs and cNFTs
nfts.mintGrants all the scopes above.

This scope is deprecated but still active for previous developers

Wallets API

ScopeDescription
wallets.createCreate wallets programmatically
wallets.readGet wallet addresses
wallets:nfts.readFetch the wallet contents
wallets:nfts.transferInitiate an NFT transfer request from a user wallet

Payments

ScopeDescription
nfts.checkoutGenerate a checkout url programmatically