Minting an NFD
URL
POST https://signing-api.sign.net/signing-api/mintDocument
Parameters
Header | Type | Description |
---|---|---|
Authorization | String | Bearer API Key of the user account to be retrieved from. Can be retrieved from the user's profile page. |
Body | Type | Description |
file | object | PDF file that will be minted as an Non-fungible document(NFD). |
image | object | (optional) - image used as thumbnail for NFD |
unitName | string | Name of token used to govern NFD once created. Maximum of 8 characters. e.g. Alice |
assetName | string | Full name of NFD, maximum of 32 characters. E.g. Alice manuscript |
description | string or null | (optional) - Short description of NFD. |
pages | number or null | (optional) - total number of pages in your PDF file |
wordCount | number or null | (optional) - total number of words in your PDF file |
language | string or null | (optional) - Lanaguage of document |
creator | string or null | (optional) - Author or creator of document |
creatorEmail | string or null | (optional) - Email or creator of document |
creationDate | string | (optional) - Date of publish of document. |
storeOnIPFS | boolean | Choose if pdf file and image file will be stored on IPFS. |
nftStandard | string - 'ARC3' or 'ARC69' | Algorand NFT Standard |
Postman example

If the minting of the document is successful, e.g. ARC3
{
"status": "OK",
"data": {
"assetId": 666855864,
"transactionId": "D4QRNPWFRZD2WJ4KFQSFUIXKJ6URW6JODQSURLZ7HA4BHCSGCSXQ",
"pdfIpfsUrl": "https://gateway.pinata.cloud/ipfs/QmNtRepHj3cHHJqmUEv6hwbgDV7zSiXdPpfVz77e6c6zZ5",
"imageIpfsUrl": "https://gateway.pinata.cloud/ipfs/QmaR1Tt1Xyorq4xXGWWVpxKD92rMWPED4pxnkqwC5nMczG",
"nftMetadata": {
"decimals": 0,
"document_url": "https://gateway.pinata.cloud/ipfs/QmNtRepHj3cHHJqmUEv6hwbgDV7zSiXdPpfVz77e6c6zZ5",
"document_integrity": "sha256-1rQzGgj+aDeIMpq4naJRZjsOdscluvdxaoWIWV2Lk90=",
"document_mimetype": "application/pdf",
"name": "CLOUDHACK",
"properties": {
"creator": "CLOUDFEST",
"creator_email": null,
"creation_date": null,
"description": "cloudfest_nfd",
"document_words": 587,
"document_pages": 2,
"document_locale": "english",
"preview_url": "https://gateway.pinata.cloud/ipfs/QmaR1Tt1Xyorq4xXGWWVpxKD92rMWPED4pxnkqwC5nMczG",
"image_mimetype": "image/jpeg"
},
"unitName": "HACK"
}
}
}
Error codes
Name | Description |
---|---|
INVALID_API_KEY | Invalid internal API key. The internal API keys does not match. |
INVALID_USER_API_KEY | The user API key provided does not match any existing records. |
NO_PERMISSION | The user does not have the permissions to perform this function. |
INVALID_DATA | There are missing data, or data provided was invalid |
NO_FILE_ATTACHED | There are no files attached(one of the parameters) |
FILE_ATTACHMENT_ISSUE | There are more than 2 files attached in the request body |
INVALID_FILE_TYPE | For document file, file uploaded must be of .pdf format. For image, please upload a file of .png or .jpeg format. |
Updated over 1 year ago