Fetch Message using ID

Fetch a dMessage by providing its ID and retrieve associated information such as a digital passport's receiver, if it has been read, and the content.

Workflow

Let's start 🚀

URL

To fetch the dMessage information, use https://custody.arianee.com/{{client}}/{{network}}/messages/get.

URL

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

Body

Field	Type	Required	Description
id	Number	✅	dMessage identification number.
protocolName	String - testnet, mainnet, arianeetestnet, mumbai, polygon, arialabs, stadetoulousain, ysl, testnetSbt, arianeeSupernet, arianeesbt, tezostestnet, supernettestnet	✅	Protocol on which the dMessage and its receiver have been minted. Dig deeper into Arianee Protocols.

Body Example

{
    "id": "617768167",
    "protocolName": "testnet"
}

Return Payload

Status Code	Description
200	The dMessage's information and content are returned.

200 Return Payload

{
    "data": {
        "id": "617768167",
        "certificateId": "287574096",
        "content": {
            "$schema": "https://cert.arianee.org/version1/ArianeeMessage-i18n.json",
            "language": "en-US",
            "title": "Welcome to Arianee NFTs",
            "content": " Test automessage 25/04 15:38"
        },
        "rawContent": {
            "$schema": "https://cert.arianee.org/version1/ArianeeMessage-i18n.json",
            "language": "en-US",
            "title": "Welcome to Arianee NFTs",
            "content": " Test automessage 25/04 15:38"
        },
        "imprint": "TODO",
        "isRead": true,
        "protocol": {
            "name": "testnet",
            "chainId": 77
        },
        "receiver": "0xa45d9dacbea470cf93e8454aca5eca4e62fb5fcf",
        "sender": "0x57f5111a7e997a7ba63cc8976c92decbd86c1b08",
        "timestamp": 1686817705
    }
}

Status Code

Status Code	Description
400	The body of the request may be wrong.
500	Error server.

400 Return Payload

{
    "errors": [
        {
            "type": "field",
            "msg": "Invalid value",
            "path": "id",
            "location": "body"
        },
        {
            "type": "field",
            "msg": "id parameter is required and must be a string",
            "path": "id",
            "location": "body"
        },
        {
            "type": "field",
            "msg": "Invalid value",
            "path": "protocolName",
            "location": "body"
        },
        {
            "type": "field",
            "msg": "protocolName parameter is required and must be a string",
            "path": "protocolName",
            "location": "body"
        }
    ]
}