Fetch Digital Passport Information using ID

Fetch digital passport information and content through the ID of the given token.

Workflow

Let's start πŸš€

URL

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

POST - https://custody.arianee.com/{{client}}/{{network}}/nft/get

Body

FieldTypeRequiredDescription
protocolNameString - testnet, mainnet, arianeetestnet, mumbai, polygon, arialabs, stadetoulousain, ysl, testnetSbt, arianeeSupernet, arianeesbt, tezostestnet, supernettestnetβœ…Protocol on which the digital passport has been minted.
Dig deeper into Arianee Protocols.
smartAssetObjectβœ…Object integrating the digital passport to retrieve.
smartAsset β†’ idStringβœ…Identification number of the digital passport.
{
    "protocolName": "testnet",
    "smartAsset": {
        "id": "287574096"
    }
}

Return Payload

Status CodeSuccessDescription
200trueThe digital passport information is returned.
{
    "data": {
        "certificateId": "287574096",
        "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"
                }
            ],
            "parentCertificates": [
                {
                    "type": "Full",
                    "arianeeLink": "https://test.arianee.net/2855435,0ry35uk9pmcw"
                }
            ],
            "customAttributes": [
                {
                    "type": "deferred_claim",
                    "value": "https://nmp.arianee.com"
                }
            ]
        },
        "rawContent": {
            "language": "en-US",
            "i18n": [],
            "$schema": "https://cert.arianee.org/version5/ArianeeProductCertificate-i18n.json",
            "name": "King Smurf",
            "medias": [
                {
                    "mediaType": "picture",
                    "type": "product",
                    "url": "https://bdh-stef.api.staging.arianee.com/pub/1682666238271-tss_logo_king.png"
                }
            ],
            "parentCertificates": [
                {
                    "type": "Full",
                    "arianeeLink": "https://test.arianee.net/2855435,0ry35uk9pmcw"
                }
            ],
            "customAttributes": [
                {
                    "type": "deferred_claim",
                    "value": "https://nmp.arianee.com"
                }
            ]
        },
        "blockchainEvents": [
            {
                "isSentToWebhook": true,
                "_id": "648a1b0fac32e0af12c68555",
                "blockNumber": 30578604,
                "eventName": "Transfer",
                "eventData": {
                    "address": "0x512C1FCF401133680f373a386F3f752b98070BC5",
                    "blockHash": "0xf4ba8cd65c311a4eba9d84d371b62d4df3ab856b65f17b73184d185858803075",
                    "blockNumber": 30578604,
                    "logIndex": 1,
                    "removed": false,
                    "transactionHash": "0x3d70cd7c8e6414139773b7c09e9657b01c97562cddc49efc7a59e8d6b3b73a54",
                    "transactionIndex": 0,
                    "transactionLogIndex": "0x1",
                    "id": "log_25f9461d",
                    "returnValues": {
                        "0": "0x0000000000000000000000000000000000000000",
                        "1": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                        "2": "287574096",
                        "_from": "0x0000000000000000000000000000000000000000",
                        "_to": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                        "_tokenId": "287574096"
                    },
                    "event": "Transfer",
                    "signature": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                    "raw": {
                        "data": "0x",
                        "topics": [
                            "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                            "0x0000000000000000000000000000000000000000000000000000000000000000",
                            "0x00000000000000000000000057f5111a7e997a7ba63cc8976c92decbd86c1b08",
                            "0x0000000000000000000000000000000000000000000000000000000011240850"
                        ]
                    }
                },
                "returnValues": {
                    "0": "0x0000000000000000000000000000000000000000",
                    "1": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "2": "287574096",
                    "_from": "0x0000000000000000000000000000000000000000",
                    "_to": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "_tokenId": "287574096"
                },
                "logBloom": "0x000000000008000c0000000000100000000000100000000000000004000004000000000000000000000000000004000082010000000000000000000010004000000000000000001000000008040000000010000000000000000010000000000010800000020080000000020000000800000080000100010104200010210020000000000000000000000000000000000004000000000000400000000001000000800000000200000200000000000000002000000000000000000000000000000800000002000000000000000800000000801000100044000000000000000020040000000000008000000000000000000a00804006020014000001000000000001",
                "timestamp": 1686772495,
                "logIndex": 1,
                "transactionHash": "0x3d70cd7c8e6414139773b7c09e9657b01c97562cddc49efc7a59e8d6b3b73a54",
                "eventHash": "dab38b2fd5a9bdf386e5618872e25da239d9c38c",
                "smartContractName": "smartAssetContract",
                "contractAddress": "0x512c1fcf401133680f373a386f3f752b98070bc5",
                "chainId": 77,
                "network": "testnet",
                "createdAt": "2023-06-14T19:54:55.712Z",
                "updatedAt": "2023-06-14T19:54:56.675Z",
                "__v": 0
            },
            {
                "isSentToWebhook": true,
                "_id": "648acb8bac32e008b2c6a96c",
                "blockNumber": 30587640,
                "eventName": "Transfer",
                "eventData": {
                    "address": "0x512C1FCF401133680f373a386F3f752b98070BC5",
                    "blockHash": "0x392992158ab4d65ca52c2b8a9369a095dc57b505b93e65d53069fc9f55f62327",
                    "blockNumber": 30587640,
                    "logIndex": 1,
                    "removed": false,
                    "transactionHash": "0x328c52075c65ba2831e3d1a668089a7bd3ac1be75b5dfac310e79aea76f27ff5",
                    "transactionIndex": 1,
                    "transactionLogIndex": "0x0",
                    "id": "log_356cb4ff",
                    "returnValues": {
                        "0": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                        "1": "0xa45D9DACBeA470CF93E8454aca5EcA4E62fB5FCf",
                        "2": "287574096",
                        "_from": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                        "_to": "0xa45D9DACBeA470CF93E8454aca5EcA4E62fB5FCf",
                        "_tokenId": "287574096"
                    },
                    "event": "Transfer",
                    "signature": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                    "raw": {
                        "data": "0x",
                        "topics": [
                            "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                            "0x00000000000000000000000057f5111a7e997a7ba63cc8976c92decbd86c1b08",
                            "0x000000000000000000000000a45d9dacbea470cf93e8454aca5eca4e62fb5fcf",
                            "0x0000000000000000000000000000000000000000000000000000000011240850"
                        ]
                    }
                },
                "returnValues": {
                    "0": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "1": "0xa45D9DACBeA470CF93E8454aca5EcA4E62fB5FCf",
                    "2": "287574096",
                    "_from": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "_to": "0xa45D9DACBeA470CF93E8454aca5EcA4E62fB5FCf",
                    "_tokenId": "287574096"
                },
                "logBloom": "0x00000000000800080000000000000000000000000000000000000004000000000000000000000000000000200000000000010000000000000000000010004000000000000000001000000008000000000000000000000000000000000000000000000000001000000000000000000000000000000000000004200010000020000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000800000002000100000000010000000000000000000000000000000000000000000000040000000000000000000000000000000004020010000000000000000001",
                "timestamp": 1686817675,
                "logIndex": 1,
                "transactionHash": "0x328c52075c65ba2831e3d1a668089a7bd3ac1be75b5dfac310e79aea76f27ff5",
                "eventHash": "329dd6cdc262b14fc65c60a103d10c7d41e406be",
                "smartContractName": "smartAssetContract",
                "contractAddress": "0x512c1fcf401133680f373a386f3f752b98070bc5",
                "chainId": 77,
                "network": "testnet",
                "createdAt": "2023-06-15T08:27:55.399Z",
                "updatedAt": "2023-06-15T08:27:55.878Z",
                "__v": 0
            }
        ],
        "imprint": "0xff1536b7bb96a5134c4b48963741b54be9214b201ee7cc855717792b32848e2a",
        "isAuthentic": true,
        "isRequestable": false,
        "issuer": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
        "owner": "0xa45d9dacbea470cf93e8454aca5eca4e62fb5fcf",
        "protocol": {
            "name": "testnet",
            "chainId": 77
        }
    },
    "arianeeEvents": []
}

Errors

Status CodeSuccessDescription
400falseThe parameter in the request may be wrong.
403falseThe wallet is not the digital passport owner.
{
    "errors": [
        {
            "type": "field",
            "msg": "Invalid value",
            "path": "smartAsset",
            "location": "body"
        },
        {
            "type": "field",
            "msg": "smartAsset parameter is required and must be an object",
            "path": "smartAsset",
            "location": "body"
        },
        {
            "type": "field",
            "msg": "Invalid value",
            "path": "smartAsset.id",
            "location": "body"
        },
        {
            "type": "field",
            "msg": "smartAsset.id parameter is required and must be a string",
            "path": "smartAsset.id",
            "location": "body"
        }
    ]
}