Collection Registration and Verification API

Crossmint provides an API to facilitate collection registration and verification. This functionality is for launchpads that want to use Crossmint’s checkout and allow their users to go through the KYC and collection verification flow.

​

Before you get started:

Contact your Crossmint customer success engineer to request the collections.write scope be added to an existing API key. You will need to provide the projectId associated with the API key you will be using.

Your contract also needs to meet certain requirements. Please refer to the Bring your Own Collection documentation page for further information.

​

Collection Registration and Verification process

Once a user has created a collection on your launchpad, you can optionally choose to register the collection with Crossmint to enable Credit Card payments. This API abstracts away much of the complexity involved from the user when they perform KYC and the collection verification process.

As the launchpad, you will pass information about the collection as parameters to the API. Crossmint will then return a URL where the user can complete the KYC and collection verification. This API call’s structure is as follows:

The returned URL must be the URL that your user needs to be directed to. The user can complete the verification with that URL.

​

Get Collection status

You can check the status of your user’s verification with the get collection status endpoint. Upon a successful request, the verification status for the seller and collection may have either of the following values:

• verified - The user has successfully completed the verification.
• failed - The verification failed.
• crossmint-review - It is being reviewed by the Crossmint team.
• unverified - The user has not initiated or completed the verification process.

​

FAQs

   VerificationCategory {
    LOYALTY: "loyalty",
    ART: "art",
    MUSIC: "music",
    GAMING: "gaming",
    TICKETING: "ticketing",
    CHARITY: "charity",
    OTHER: "other",
   }