For the complete documentation index, see llms.txt. This page is also available as Markdown.

Minting an NFT

Use this endpoint to mint an NFT to an existing wallet, identified by one of the following parameters:

  • wallet address

  • wallet ID

  • email address

  • phone number

Make sure to supply a contract ID for a contract that your account has permission to mint on. Need help getting set up? Reach out to us

Endpoint Details

Description
Data

API Name

HTTP Method

POST

URL

/v1/nft/mint

Headers

Key
Value

Content-Type

application/json

x-api-key

API_KEY

Query Parameters

Parameter
Type
Description

contractId

string

Identifier for the contract, formatted as contract_<UUID>

nftTokenId

string

Identifier for the NFT. (required)

quantity

number, optional

Number of NFTs to mint.

User can be identified by one of the parameter:

Parameter
Type
Description

walletAddress

string, optional

Address

walletId

string, optional

Wallet ID (wallet_UUID)

email

string, optional

Wallet email

phone

string, optional

Wallet phone, format: "+12223334444"

Payload Example:

{
  "contractId": "contract_6635e90e-31f0-11ee-be56-0242ac120002",
  "nftTokenId": "123456",
  "quantity": 2,
  "walletId": "wallet_43fba5e9-e2ae-4417-a198-16c646c7c9f1"
}

Successful Response

Error Response

Error Messages

  • Validation error:

    • { "code: 400, "message": "Validation error: \"email\" with value \"...\" fails to match the Email pattern" }

  • More than one user identifier:

    • { "code": 400, "message": "Validation error: \"value\" failed custom validation because More than one wallet identifier is defined in the request." }

  • Contract not assigned:

    • { "code": 400, "message": "Contract not found" }

  • Unauthorized API Key:

    • { "code": 400, "message": "Invalid API key" }

  • Wallet not found:

    • { "code": 400, "message": "Wallet not found" }

Examples

Last updated