Fetch Digital Passport Data

⚠️

Only the issuer and owner of a digital passport have the rights retrieve information.

Passphrase is not required in the request of this API as the NFT Management Platform is issuer of the digital passport and hence can retrieve information about it.

URL

Use the api/getCertificate defining the parameters you wish to return.

POST - https://{{nmpUrl}}/api/getCertificate

📌
NFT Management Platform user rights required to call this API → certRead

Field	Type	Required	Description
`certificateId`	Number	✅	Digital passport identification number
`passphrase`	String	❌	Digital passport passphrase ⚠️ Optional if your wallet is the digital passport owner or issuer
`isRequestable`	Boolean	❌	Digital passport claim information
`content`	Boolean	❌	NFT content information
`issuer`	Object	❌	Issuer information
`rpcURI`	URI	❌	RPC URI
`owner`	Boolean	❌	Digital passport current owner information
`events`	Boolean	❌	Information on digital passport transactions and lifecycle
`arianeeEvents`	Boolean	❌	Information on Arianee events linked to the digital passport
`advanced`	Object	❌	Advanced parameters
`languages`	Object	❌	Languages of the digital passport
`arianeeProofToken`	String	❌	Token with the right to claim digital passport ownership
`messageSenders`	Boolean	❌	Wallet message sender wallet address

[
  918276735,
  "hm0ncta9lrk4",
  {
    "isRequestable": true,
    "content": true,
    "issuer": {
      "waitingIdentity": false,
      "forceRefresh": false,
      "rpcURI": "https://documentation.arianee.firebaseapp.com/rpc"
    },
    "owner": true,
    "events": true,
    "arianeeEvents": true,
    "advanced": {
      "languages": [
        "fr",
        "us",
        "jp"
      ],
      "arianeeProofToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJFVEgifQ==.eyJpc3MiOiIweGJiNDEwRDM1RUMwMDBhNTEwMEZlOTM5QjQxZkEyOTk3OTc5OUQzNDIiLCJzY29wZSI6ImFsbCIsImV4cCI6MTYwMDE2MDEwODUwMywiaWF0IjoxNjAwMTU5ODA4NTA0LCJjaGFpbiI6Im1haW5uZXQiLCJzdWIiOiJjZXJ0aWZpY2F0ZSIsInN1YklkIjo4NzYxNTMxfQ==.0x0a9e3f2c769631b7b9f2a41c3e26262388b0868d3972c0067630ddd846acaba90e0686efcd049fdcd5a6cac97530730328a7cbdf1b19c7996491bba1287db0781c"
    },
    "messageSenders": true
  }
]

Return Payload

The digital passport information is returned.

{
    "certificateId": 918276735,
    "content": {
        "isRawAuthentic": false,
        "isAuthentic": false
    },
    "issuer": {
        "identity": {
            "data": {
                "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
                "name": "NFT name",
                "companyName": "Arianee",
                "arianeeMembership": "associate_member",
                "rpcEndpoint": "https://documentation.arianee.api.staging.arianee.com/rpc"
            },
            "isAuthentic": true,
            "isApproved": true,
            "imprint": "0xdfee9c6b92e2cb9a5fc6b4b394f46926510fc66db9faa694c53c61d4307cf883",
            "address": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08"
        },
        "isIdentityAuthentic": true,
        "isIdentityVerified": true,
        "imprint": "0xdfee9c6b92e2cb9a5fc6b4b394f46926510fc66db9faa694c53c61d4307cf883"
    },
    "isRequestable": true,
    "owner": {
        "publicKey": "0x57f5111a7e997a7ba63cc8976c92decbd86c1b08",
        "address": "0x57f5111a7e997a7ba63cc8976c92decbd86c1b08",
        "isOwner": true
    },
    "events": {
        "transfer": [
            {
                "identity": {
                    "data": {
                        "$schema": "https://cert.arianee.org/version2/ArianeeBrandIdentity-i18n.json",
                        "name": "NFT name",
                        "companyName": "Arianee",
                        "arianeeMembership": "associate_member",
                        "rpcEndpoint": "https://documentation.arianee.api.staging.arianee.com/rpc"
                    },
                    "isAuthentic": true,
                    "isApproved": true,
                    "imprint": "0xdfee9c6b92e2cb9a5fc6b4b394f46926510fc66db9faa694c53c61d4307cf883",
                    "address": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08"
                },
                "address": "0x512C1FCF401133680f373a386F3f752b98070BC5",
                "blockHash": "0x60c9060e2bf7401f331c192c81fc158044205aeaf69a687b928c1873fd45e389",
                "blockNumber": 28540658,
                "logIndex": 1,
                "removed": false,
                "transactionHash": "0x379087fde6ce640029cef9306874ae1875fe4b6e625d3e187b2f735c4b46e612",
                "transactionIndex": 0,
                "transactionLogIndex": "0x1",
                "id": "log_92acbcba",
                "returnValues": {
                    "0": "0x0000000000000000000000000000000000000000",
                    "1": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "2": "918276735",
                    "_from": "0x0000000000000000000000000000000000000000",
                    "_to": "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08",
                    "_tokenId": "918276735"
                },
                "event": "Transfer",
                "signature": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                "raw": {
                    "data": "0x",
                    "topics": [
                        "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",
                        "0x0000000000000000000000000000000000000000000000000000000000000000",
                        "0x00000000000000000000000057f5111a7e997a7ba63cc8976c92decbd86c1b08",
                        "0x0000000000000000000000000000000000000000000000000000000036bbca7f"
                    ]
                },
                "timestamp": 1675864990
            }
        ],
        "arianeeEvents": []
    },
    "messageSenders": {
        "0x57F5111A7e997a7Ba63CC8976C92decbd86C1B08": true
    }
}

Errors

⚠️
When the return is empty, you certificateId may be incorrect.

{
    "certificateId": 76608909993,
    "events": {
        "transfer": [],
        "arianeeEvents": []
    }
}