Retrieve all NFT Collections that have been created for your project application.

Fetch Collections

x api key

Contains a list of all Collections created for a project containing their `status`, `id`, `collectionId` (AssetHub ID), and additional data.

A bad request will contain a list of errors for invalid fields.

Unauthorized. The API key is missing or has expired if you are using a key with an expiration date that you configured when creating the key.

Forbidden. The API key that you provided is not valid or does not exist.

Mufi

Tools for fan engagement, creator monetization, and payments processing

Introduction

Quickstart

Tips to keep yourself and your users safe

Best Practices

Retrieve the current version of the API. This endpoint serves as a health check to ensure the API is operational and can be used to verify the availability of new API endpoints based on the version number. It returns a JSON object containing the version string, which can be useful for debugging and ensuring compatibility with client applications.

API Version

Authentication

Security

Learn how Mufi manages your wallet secrets

Custodians

Learn how to attach your non custodial wallet

Bring Your Own Wallet

# User and Wallet Creation Process

Users are created immediately and will have a blockchain wallet asynchronously created in the background.

Wallet generation involves securely splitting the private key into encrypted fragments using **[Shamir's Secret Sharing Scheme (SSSS)](https://en.wikipedia.org/wiki/Shamir%28s_secret_sharing)**. These fragments are then distributed across a fault-tolerant, distributed storage system across multiple platform providers with an additional layer of re-encryption to enhance security.

For large batches of users, the wallet creation process may take a few minutes to complete depending on the batch size and system load. Once complete, the users and their wallets are fully operational and available for blockchain transactions.

## Key Features of the Process:

**API Key Association**: Each user is linked to your organization's project application via the API key for secure access.

**Asynchronous Processing**: User wallet creation occurs in the background to avoid delays in the user experience.

**Enhanced Security**: Wallet secrets are created and split into encrypted fragments (SSSS) and stored in a distributed system with re-encryption.


Create User

Retrieve detailed information about a user, including their associated wallets, by querying with `email`, `id`, or `referenceId`.

Fetch User

Retrieve users linked to your project application using your API key. This `POST` endpoint allows querying by `email`, `id`, or `referenceId`. Use only one field; priority is given to `email`, then `referenceId`, and finally `id` in the MuFi database.

Fetch Users

Set a user to activated. Activation status is required to manage any features associated with their wallets. The current date is used as the activation date. You can query the activation status of a user using the `POST /v1/users/activation` endpoint.

Activate User

Get the activation status of a user. Users are activated after calling the `POST /v1/users/activate` endpoint.

User Activation Status

Get the balances of a users's wallets for a given blockchain. Balances include tokens, but do not currently include NFT collection items.

Get Wallet Contents

Documentation for the Mufi Engagement API

Create an NFT Collection on AssetHub for various purposes like rewards, loyalty programs, and badges. Collections are created asynchronously and include a status to track their progress. ### Status Descriptions: - **Pending**: The Collection record was created in the MuFi database and is pending to be submitted to the blockchain. - **Processing**: The Collection is being created on the blockchain. - **Created**: The Collection was successfully created on the blockchain and is awaiting metadata to be set. - **CreatedWithMetadata**: The Collection was created on the blockchain and the metadata was successfully set. The metadata is a separate blockchain transaction. - **Failed**: The Collection creation failed on the blockchain.

Create Collection

Retrieve a collection using its unique MuFi database ID. *Note: Collections have distinct IDs on the blockchain and in the MuFi database. Use the MuFi database ID for queries.*

Fetch Collection

Mint NFT Collection items to a list of users. Unique NFT IDs are minted sequentially from 1 to the length of the user list. Subsequent requests to the endpoint will mint the next batch of NFTs starting from the last minted NFT ID.

Airdrop Collection

Add multiple users as customers to your project.

Get a customer associated with your project.

Get many users associated with a project.

Set a user to activated. The current date is used.

Mint items in a collection to a list of customers for your project. All customers must have an existential balance, which is the minimum balance required to store on-chain data for an address, to receive a direct airdrop. If a customer's balance is less than the existential balance, a voucher will be created for them to claim the item at a later time.

Get the balances of a users's wallets for a given blockchain.

Engagement API

API Playground

Fetch Collections

Authorizations

Response