Fetch & Read Messages

Fetch Received Messages

Fetch the dMessage a customer receives and retrieve information such as the digital passport receiver, if they have been read, and the content.

URL

To fetch all the dMessages received by a digital passport owner, use https://custody.arianee.com/{{client}}/{{chainType}}/messages/getReceived.

GET - https://custody.arianee.com/{{client}}/{{chainType}}/messages/getReceived

Return Payload

Status CodeSuccessDescription
200trueThe dMessages are returned.
[
    {
        "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
        }
    }
]

Error

Status CodeSuccessDescription
404falseThe wallet may not exist. You are not authenticated.

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.

URL

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

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

Body

FieldTypeRequiredDescription
idNumberโœ…dMessage identification number.
protocolNameString - 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.
{
    "id": "617768167",
    "protocolName": "testnet"
}

Return Payload

Status CodeDescription
200The dMessage's information and content are returned.
{
    "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 CodeSuccessDescription
400falseThe body of the request may be wrong.
404falseThe wallet may not exist. You are not authenticated.
500falseError server.
{
    "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"
        }
    ]
}

Mark Message as Read

URL

Use the https://custody.arianee.com/{{client}}/{{chainType}}/messages/markAsRead.

POST - https://custody.arianee.com/{{client}}/{{chainType}}/messages/markAsRead

Body

FieldTypeRequiredDescription
idNumberโœ…Message identification number to be marked as read.
protocolNameString - testnet, mainnet, arianeetestnet, mumbai, polygon, arialabs, stadetoulousain, ysl, testnetSbt, arianeeSupernet, arianeesbt, tezostestnet, supernettestnetโœ…Protocol on which the message has been sent.
Dig deeper into Arianee Protocols.
{
    "id": "606514080",
    "protocolName": "testnet"
}

Return Payload

Status CodeSuccessDescription
200truetrue: The message is marked as read.
false: The message has already been marked as read.
{
    "success": true
}

Errors

Status CodeSuccessDescription
400falseNot authorized. You must be authenticated.
404falseThe wallet may not exist. You are not authenticated.
404falseNo message was found using this ID.