Display Digital Passports
Fetch digital passport information and content through the ID of the link.
Fetch Owned Digital Passports
Retrieve all the information and content of digital passports owned by the user.
URL
To fetch all the owned digital passports, use https://custody.arianee.com/{{client}}/{{chainType}}/nft/getOwned.
POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/getOwned
Return Payload
| Status Code | Success | Description |
|---|---|---|
200 | true | Owned digital passports are 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://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"
}
]
},
"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 Code | Success | Description |
|---|---|---|
400 | false | The network may be incorrect. |
404 | false | The wallet may not exist. You are not authenticated. |
{
"errors": [
{
"type": "field",
"value": "tesnet",
"msg": "network must be testnet or mainnet",
"path": "network",
"location": "params"
}
]
}
Fetch Digital Passport Information using Link
Fetch digital passport information and content through the ID of the link.
URL
To retrieve the digital passport data and content, use https://custody.arianee.com/{{client}}/{{chainType}}/nft/getFromLink.
POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/getFromLink
Body
| Field | Type | Required | Description |
|---|---|---|---|
link | String | โ | Link of the digital passport. |
{
"link": "https://test.arianee.net/2855435,0ry35uk9pmcw"
}
Return Payload
| Status Code | Success | Description |
|---|---|---|
200 | true | The digital passport information and content are returned. |
{
"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
| Status Code | Success | Description |
|---|---|---|
400 | false | The parameter in the request may be wrong. |
404 | false | The wallet may not exist. You are not authenticated. |
404 | false | The digital passport could not be retrieved using this link. |
{
"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"
}
]
}
Fetch Digital Passport using Token ID
Fetch digital passport information and content through the ID of the given token.
URL
To retrieve the digital passport data and content, use https://custody.arianee.com/{{client}}/{{chainType}}/nft/get.
POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/get
Body
| Field | Type | Required | Description |
|---|---|---|---|
protocolName | String - testnet, mainnet, arianeetestnet, mumbai, polygon, arialabs, stadetoulousain, ysl, testnetSbt, arianeeSupernet, arianeesbt, tezostestnet, supernettestnet, etherlinktestnet | โ | Protocol on which the digital passport has been minted. Dig deeper into Arianee Protocols. |
smartAsset | Object | โ | Object integrating the digital passport to retrieve. |
smartAsset โ id | String | โ | Identification number of the digital passport. |
{
"protocolName": "testnet",
"smartAsset": {
"id": "287574096"
}
}
Return Payload
| Status Code | Success | Description |
|---|---|---|
200 | true | The 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 Code | Success | Description |
|---|---|---|
400 | false | The parameter in the request may be wrong. |
404 | false | The wallet may not exist. You are not authenticated. |
404 | false | The digital passport could not be retrieved using this link. |
{
"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"
}
]
}
Updated 12 days ago