API Reference
Wallets
- POSTCreate Wallet
- GETGet Wallet By Locator
- GETGet Wallet Balance
- POSTFund Wallet
- GETGet NFTs from Wallet
- POSTCreate Transaction
- GETGet Transaction
- GETGet Wallet Transactions
- POSTApprove Transaction
- POSTCreate Signature
- GETGet All Signatures
- GETGet Signature
- POSTApprove Signature
- POSTRegister Delegated Signer
- GETGet Delegated Signer
NFTs
NFT Collections
NFT Templates
Verifiable Credentials
Verifiable Credential Types
Verifiable Credential Templates
Headless Checkout
Action Status
Admin
Subscriptions
Create Credential template
Create a template, similar to an NFT collection, for issuing verifiable credentials.
API scope required credentials:template.create
Key obtained from the Crossmint developer console, reflecting the API scope granted.
The name of your collection (Max length: 32).
Direct link to your Verifiable Credential Template image.
A brief description of credential (Max length: 64).
The chain to mint the nft on.
Credentials parameters
The type of credentials inside the collection.
Where to store the credential
Only if storage is 'delegated', the endpoint to retrieve the credential from
Whether to encrypt the credential, ensuring data privacy. Only the subject and issuer have the authentication to decrypt the credential.
Issuer information, fill only if using delegated
storage.
The issuer's did
The issuer's endpoint to sign credentials
Token used for auth on the issuer endpoint
Authorizations
Key obtained from the Crossmint developer console, reflecting the API scope granted.
Body
The chain to mint the nft on.
polygon
Credentials parameters
The type of credentials inside the collection.
Where to store the credential
crossmint
, crossmint-private
, decentralized-ipfs
, delegated
Whether to encrypt the credential, ensuring data privacy. Only the subject and issuer have the authentication to decrypt the credential.
crossmint-recoverable
, decentralized-lit
, none
Only if storage is 'delegated', the endpoint to retrieve the credential from
Issuer information, fill only if using delegated
storage.
Response
The response is of type string
.