#docs-olvy-share-feedback {
    background-color: #05b959;
    color: white;
    position: fixed !important;
    top: 50%;
    right: 0;
    transform: translateY(-50%) rotate(180deg);
    cursor: pointer;
    border-radius: 0 0.5rem 0.5rem 0;
    padding: 0.625rem 0.375rem;
    writing-mode: vertical-rl;
}

.supported-chains--logo-container {
    display: flex;
    justify-content: center;
    align-items: center;
    position: relative;
    top: 4px;
}

.supported-chains--chain-logo {
    height: 20px;
    width: 20px;
    margin: 0;
}


var OlvyConfig = { workspaceAlias: "crossmint" };

const feedbackButton = document.createElement("div");
feedbackButton.id = "docs-olvy-share-feedback";
feedbackButton.textContent = "Feedback";
document.body.appendChild(feedbackButton);

(function initOlvy(document, scriptTagName, scriptSrc) {
    // Create and configure script element
    const scriptElement = document.createElement(scriptTagName);
    scriptElement.async = true;
    scriptElement.src = scriptSrc;

    // Insert script into document
    const firstScript = document.getElementsByTagName(scriptTagName)[0];
    firstScript.parentNode.insertBefore(scriptElement, firstScript);
})(document, "script", "https://app.olvy.co/scriptV2.js");


Classes

Type Aliases

Functions

Reference

Crossmint Docs

About Crossmint

Getting Started

Using AI Assistants

A user management solution tightly integrated with all other Crossmint products

Introduction to Authentication | Crossmint Docs

Introduction

Quickstart ⚡

Mint and distribute tokens at scale, reliably

Crossmint offers a suite of Minting Tools to create, update, delete and manage tokens, all accessible via REST APIs and a no-code dashboard. Get started in 5 minutes with Crossmint.

Minting Tools Introduction | Crossmint Docs

Allow your users to buy onchain assets using any payment method

Crossmint Payments - Introduction | Crossmint Docs

Explore the APIs and test them live from the browser

Creates a new wallet of specified type. If called with an idempotency key or for a user who already has a wallet, returns existing wallet. When linkedUser is provided, subsequent calls with the same linkedUser will return the existing wallet. Supports both custodial and non-custodial wallet types.

**API scope required**: `wallets.create`

Create Wallet

Retrieves a wallet by its locator (address or user identifier and wallet type)

**API scope required**: `wallets.read`

Get Wallet By Locator

Get the balance of a wallet for a given chain and currency

**API scope required**: `wallets:balance.read`

Get Wallet Balance

Send funds to a wallet.

**API scope required**: `wallets.fund`

Fund Wallet

Fetch the NFTs in a provided wallet

**API scope required**: `wallets:nfts.read`


Get NFTs from Wallet

Creates a new transaction for the specified wallet. Transaction will be automatically broadcast once it has all necessary approvals.

**API scope required**: `wallets:transactions.create`

Create Transaction

Retrieves the current status and details of a specific transaction.

**API scope required**: `wallets:transactions.read`

Get Transaction

Retrieves all transactions associated with the specified wallet.

**API scope required**: `wallets:transactions.read`

Get Wallet Transactions

Submit approval signature for a pending transaction. Required for transactions using external signers.

**API scope required**: `wallets:transactions.sign`

Approve Transaction

Creates a new signature for signing messages or typed data.

**API scope required**: `wallets:signatures.create`

Create Signature

Retrieves all signatures associated with the specified wallet.

**API scope required**: `wallets:signatures.read`

Get All Signatures

Retrieves details about a specific signature by its ID.

**API scope required**: `wallets:signatures.read`

Get Signature

Submit approval for a signature to sign a message or typed data.

**API scope required**: `wallets:signatures.create`

Approve Signature

Register a delegated key for a smart wallet with optional restrictions around permissions and expiry date.

**API scope required**: `wallets.create`

Register Delegated Signer

Retrieve details about a specific delegated signer by its locator.

**API scope required**: `wallets.read`

Get Delegated Signer

Sends a token of any type from this wallet to a recipient

Transfer Token

Mint your NFTs and deliver them to a web3 wallet or an email address

**API scope required**: `nfts.create`


Mint NFT

This pathway allows you to mint NFTs and guarantee idempotency
to ensure you never double mint for the same NFT. 

**API scope required**: `nfts.create`


Mint NFT with ID

Mint your SFTs and deliver them to a web3 wallet or an email address

**API scope required**: `nfts.create`


Mint SFT

Get a list of all the NFTs in a given collection.

**API scope required**: `nfts.read`


Get All NFTs

Get the status and associated information for a mint operation.

**API scope required**: `nfts.read`


Mint Status

Edit a minted NFT's metadata on IPFS. 

If you are using a custom baseURI, invoking this will overwrite the specific tokenURI for the edited token.

**API scope required**: `nfts.update`


Edit NFT

Burn a minted NFT.

**API scope required**: `nfts.delete`


Burn NFT

Create a new collection with a pre-computed id, or get an existing one if the id already exists

**API scope required**: `collections.create`

Create IP Collection

Create IP Collection (Idempotent)

Get a collection by its id deployed on the Story chain

**API scope required**: `collections.read`

Get IP Collection

Get all collections associated with the Developer Project

**API scope required**: `collections.read`

Get All IP Collections

Get all IP Assets in a collection

**API scope required**: `nfts.read`

Get IP Assets in Collection

Get a single IP Asset

**API scope required**: `nfts.read`

Get IP Asset

Create a new IP Asset

**API scope required**: `nfts.create`

Create IP Asset

Create a new IP Asset with a pre-computed id, or get an existing one if the id already exists

**API scope required**: `nfts.create`

Create IP Asset (Idempotent)

Update an existing IP Asset

**API scope required**: `nfts.update`

Update IP Asset

Get an action by its id

**API scope required**: `nfts.create`

Get IP Action

Get the licenses of an IP Asset

The ipassetId parameter should be the Story Protocol asset ID (not the Crossmint ID). Must start with '0x' followed by hexadecimal characters.

**API scope required**: `nfts.read`

Get IP Asset License

Get the graph of an IP Asset, by default it will fetch the first level of parents and children (depth = 1). You can customize the depth using the query parameter 'depth' to a maximum of 3. Maximum 100 parents or children will be returned for each level.

The ipAssetId parameter should be the Story Protocol asset ID (not the Crossmint ID). Must start with '0x' followed by hexadecimal characters.

**API scope required**: `nfts.read`

Get IP Asset Graph

Create a collection that you can mint NFTs/SFTs from

**API scope required**: `collections.create`


Create Collection

Create a collection that you can mint NFTs/SFTs from. This API is idempotent, 
if you call it multiple times with the same ID, only one will be created.

**API scope required**: `collections.create`


Create Collection (Idempotent)

List all collections created under the current Crossmint project

**API scope required**: `collections.read`


Get All Collections

Get information about a specific collection.

**API scope required**: `collections.read`


Get Collection Info

Update the sales details of a collection

**API scope required**: `collections.update`


Update Collection

Configure royalties for all NFTs in a collection.

This API is only supported for EVM chains and implements the EIP-2981 standard.

**API scope required**: `collections.update`


Set Royalties

Fetch the royalty configuration for a collection, from its current state
in the blockchain. 

This API is only supported on EVM chains.

If you call GET too soon after PUT/DELETE,
you may not yet see your latest changes, as they can take a few seconds to
record on the blockchain.

**API scope required**: `collections.read`


Get Royalties Configuration

Remove all royalties from a given collection. No new NFT sales will yield royalties to the creator. 

This API is only supported on EVM Chains.

**API scope required**: `collections.update`


Remove Royalties

Update the Base URI of a collection. Setting the baseURI enables
excluding the metadata param when minting. Tokens minted without the metadata
param will have a tokenURI of: 

`{BASE_URI}/{TOKEN_ID}`

This API is currently only supported on EVM Chains.

**API scope required**: `collections.update`


Set Base URI

Get the Base URI of a collection as it appears onchain.

**API scope required**: `collections.read`


Get Base URI

Update the transferable status of a collection. 

This API is supported on EVM and Aptos chains. 
You must contact sales to gain access to this API. 

**API scope required**: `collections.update`


Set Transferability

Get the transferable status of a collection. 

This API is supported on EVM and Aptos chains. 

You must contact sales to gain access to this API. 

**API scope required**: `collections.read`


Get Transferability

Create a token template, that NFTs or SFTs may be minted from

**API scope required**: `nfts.create`


Create Template

Create a token template with preconfigured metadata

**API scope required**: `nfts.create`


Create Template with ID

Fetch the contents of a token template.

**API scope required**: `nfts.read`


Get Template

Get all of the templates for a collection

**API scope required**: `nfts.read`


Get All Templates

Edit a Token template.

**API scope required**: `nfts.update`


Edit Template

Delete a Token template.

**API scope required**: `nfts.delete`


Delete Template

Create a template, similar to an NFT collection, for issuing verifiable credentials.

**API scope required** `credentials:template.create`


Create Credential template

Issue a credential and deliver it to a wallet or email address.

**API scope required** `credentials.create`


Issue Credential

Get a verifiable credential by the ID associated with it. 

This ID will have the format: `urn:uuid:<UUID>`. For example: `urn:uuid:64f9877d-a19a-4205-8d61-f8c2abed5766`

**API scope required** `credentials.read`. This enpoint will work also with a client side API key.


Get Credential by Credential ID

Get a verifiable credential by the ID associated with the minted NFT.

This ID will have the format: `<UUID>`. For example: `d7eb777b-e9b4-4f34-ab5f-ce199111166a`

**API scope required** `credentials.read`. This endpoint will not work with a client side API key.


Get Credential by NFT ID

Get a verifiable credential by the NFT locator. 

This locator will have the format: `<chain>:<contract_address>:<tokenId>`. 
For example: `polygon:0x1234abcde...:1`

**API scope required** `credentials.read`. This enpoint will work also with a client side API key.


Get Credential by NFT Locator

Verify that a verifiable credential is valid.

**API scope required** `credentials.read`


Verify Credential

Revoke a verifiable credential by the credential ID. 
This involves burning the associated nft.

This ID will have the format: `urn:uuid:<UUID>`. For example: `urn:uuid:64f9877d-a19a-4205-8d61-f8c2abed5766`

**API scope required** `credentials.create`.


Revoke Credential

Create or import a credential type with a random UUID. This is how you define a custom credential schema.

**API scope required** `credentials.create`


Create Credential Type

Create or import a type with a given name. This is how you define a custom credential schema.

**API scope required** `credentials.create`


Create Credential Type with Name

Get the schema of a given type by name (or id)
        
**API scope required** `credentials.read`


Get a Credential Type

Creates a new order that can be used to complete a headless checkout.

**API scope required**: `orders.create`


Create Order

Get specific order by ID.

**API scope required**: `orders.read`


Get Order

Edit an existing order. You can update the recipient, the payment method, and/or the locale.

**API scope required**: `orders.update`


Edit Order

Check Token Support

Use this API to poll for the status of asynchonous actions such as NFT mints, transfers, etc.

**API scope required**: `nfts.create`


Get Action Status

Get usage data for a project.

**API scope required** `projects:usage.read`


Get Usage

Class by class and method by method documentation for Crossmint's SDKs.

Manage and configure your Crossmint projects directly from the command line

Getting started

Get started with the Crossmint CLI

Browse guides tailored to your business vertical or use case

Overview

Infrastructure for AI agents to participate in the real economy

AI Agent Toolkit

Create, manage, and monetize IP assets on Story Protocol using Crossmint

Register your music on Story in under 5 minutes

Music Quickstart ⚡

Register your literature works on Story in under 5 minutes

Literature Quickstart ⚡

Register your designs on Story in under 5 minutes

Images Quickstart ⚡

A complete history of Crossmint's product updates and new features

Timeline

Changelog Timeline

Tap into 40+ chains in one single integration

Supported Chains

Staging vs Production

Staging vs Production Environments

Learn how to get your account and collection verified

Account Verification

Project & Team Management

Project and Team Management

Create wallets for your users, company, or agents

Enterprise-grade wallets with best-in-class security, social login and flexible custody. Get started in 5 minutes with Crossmint.

Overview of Wallets | Crossmint Docs

Crossmint Wallets Architecture | Crossmint Docs

Architecture

Crossmint Wallets Signers and custody | Crossmint Docs

Signers and custody

Create user wallets from your frontend in under 5 minutes

Learn how to create and manage wallets directly in your web application. Get started in 5 minutes with Crossmint.

React SDK | Create and Manage Wallets in Your Frontend

React

Create user wallets from your backend in under 5 minutes

Learn how to create and manage wallets directly in your backend application. Get started in 5 minutes with Crossmint.

SDK Reference

Wallets SDK

Credentials SDK

Reference

Classes

Type Aliases

Functions

SDK Reference

Wallets SDK

Credentials SDK

​Classes

​Type Aliases

​Functions

Classes

Type Aliases

Functions