HomeDocumentationRecipesAPI ReferenceChangelog
Arianee Protocol DocumentationLog In
Documentation
These docs are for v1.9. Click to read the latest docs for v2.1.

Fetch Digital Passport Information using Link

Before you begin

Fetch digital passport information and content through the ID of the link.

Let's start 🚀

To retrieve the digital passport data and content, use https://custody.arianee.com/{{client}}/{{network}}/nft/getFromLink.

InputMandatoryTypeDescription
linkStringLink of the digital passport.
{
    "link": "https://test.arianee.net/2855435,0ry35uk9pmcw"
}

Example:

curl --request POST \
     --url https://test.arianee.com/client/testnet/nft/getFromLink \
     --header 'accept: application/json; charset=utf-8' \
     --header 'authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6Ikp...' \
     --header 'content-type: application/json' \
     --data '
{
  "link": "https://test.arianee.net/2855435,0ry35uk9pmcw"
}
'

Result:

httpCodeDescription
200The digital passport information and content are returned.
400The parameter in the request may be wrong.
{
    "data": {
        "certificateId": "2855435",
        "content": {
            "language": "en-US",
            "i18n": [],
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
            "name": "King Smurf",
            "medias": [
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://nmp.arianee.com/pub/1682666238271-tss_logo_king.png"
                }
            ]
        },
        "rawContent": {
            "language": "en-US",
            "i18n": [],
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
            "name": "King Smurf",
            "medias": [
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://nmp.arianee.com/pub/1682666238271-tss_logo_king.png"
                }
            ]
        },
        "blockchainEvents": [
            {
                "isSentToWebhook": true,
                "_id": "6489b728ac32e00110c60d38",
                "blockNumber": 30573489,
                "eventName": "Transfer",
                "eventData": {
                    "address": "0x512C1FCF401133680f373a386F3f752b98070BC5",
                    "blockHash": "0xab5cecec112ce2e717358716df8af39c9df4f07dd661d50ffeebffd37076d1a9",
                    "blockNumber": 30573489,
                    "logIndex": 1,
                    "removed": false,
                    "transactionHash": "0x07eefe588f2e91f07125e965839991f8786a1c5cef4382575187bdfb9ff764df",
                    "transactionIndex": 0,
                    "transactionLogIndex": "0x1",
                    "id": "log_7a9ee469",
                    "returnValues": {
                        "0": "0x0000000000000000000000000000000000000000",
                        "1": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                        "2": "2855435",
                        "_from": "0x0000000000000000000000000000000000000000",
                        "_to": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                        "_tokenId": "2855435"
                    },
                    "event": "Transfer",
                    "signature": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                    "raw": {
                        "data": "0x",
                        "topics": [
                            "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                            "0x0000000000000000000000000000000000000000000000000000000000000000",
                            "0x00000000000000000000000057f5111a7e997a7ba63cc8976c92decbd86c1b08",
                            "0x00000000000000000000000000000000000000000000000000000000002b920b"
                        ]
                    }
                },
                "returnValues": {
                    "0": "0x0000000000000000000000000000000000000000",
                    "1": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "2": "2855435",
                    "_from": "0x0000000000000000000000000000000000000000",
                    "_to": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "_tokenId": "2855435"
                },
                "logBloom": "0x000000000000000c0000000000100000000000100000000000000004000004000000000000000000000000000004000000010000000000000000000010004000000000000000001000000008000000000010000000000000000000000000000000000000020000000000000000000820000000000000000004400010200020000000000000000000000000000000000004000000000000000000000001000000800000000200000000000000000000002000000000000000000000000000000800000002000000000000000800000000801000100040000000000000000024008000800000008000000000000000000800004004020014000000000000000000",
                "timestamp": 1686746920,
                "logIndex": 1,
                "transactionHash": "0x07eefe588f2e91f07125e965839991f8786a1c5cef4382575187bdfb9ff764df",
                "eventHash": "18f5917e8f0242afda7dde956a3cd8e111604f1d",
                "smartContractName": "smartAssetContract",
                "contractAddress": "0x512c1fcf401133680f373a386f3f752b98070bc5",
                "chainId": 77,
                "network": "testnet",
                "createdAt": "2023-06-14T12:48:40.762Z",
                "updatedAt": "2023-06-14T12:48:42.065Z",
                "__v": 0
            }
        ],
        "imprint": "0x29fe428abb74d3b86427ee617f244de8c50909f74882ce662047d1467e4fe0bc",
        "isAuthentic": true,
        "isRequestable": false,
        "issuer": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
        "owner": "0x57f5111a7e997a7ba63cc8976c92decbd86c1b08",
        "protocol": {
            "name": "testnet",
            "chainId": 77
        }
    },
    "arianeeEvents": []
}
{
    "errors": [
        {
            "type": "field",
            "msg": "Invalid value",
            "path": "link",
            "location": "body"
        },
        {
            "type": "field",
            "msg": "link parameter is required and must be a string",
            "path": "link",
            "location": "body"
        }
    ]
}