Messaging

Operations about DIDComm messaging. DIDComm messages are addressed by DID using Dock's relay service.

The current most common use case for the messaging service is to send credentials and presentation requests to the Truvera Wallet, but other clients can use it too.

Encrypt Message

In most cases you'll want to ensure the privacy of the message by encrypting it before sending.

Parameters

Name	In	Type	Required	Description
body	body	object	true	The recipients, sender and message
» type	body	string	false	none
» payload	body	object	true	none
» senderDid	body	string	true	none
» algorithm	body	string	false	none
» recipientDids	body	[oneOf]	true	none

Enumerated Values

Parameter	Value
» algorithm	ECDH-1PU+A256KW
» algorithm	ECDH-ES+A256KW

Messaging encrypt

POSThttps://api-testnet.truvera.io/messaging/encrypt

Body

application/json

The recipients, sender and message

typestring

payload*object

senderDid*string

algorithmenum

ECDH-1PU+A256KWECDH-ES+A256KW

recipientDids*array of one of

Response

200400402404

Message has been encrypted, returning an encrypted DIDComm Message

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/messaging/encrypt', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "senderDid": "text",
      "recipientDids": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200400402404

{
  "code": 0
}

Decrypt Message

Parameters

Name	In	Type	Required	Description
body	body	object	true	The JWM
» jwe	body	object	true	none

Decrypts a JSON Web Message

POSThttps://api-testnet.truvera.io/messaging/decrypt

Body

application/json

The JWM

jwe*object

Response

200400402404

Message has been decrypted, returning a DIDComm message

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/messaging/decrypt', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400402404

{
  "code": 0
}

Signing Messages

Signing a message helps to prove to the recipient that the message is valid and unaltered. The message will be signed as a Base64 encoded JWT.

Parameters

Name	In	Type	Required	Description
body	body	object	true	The message payload
» payload	body	object	true	none
» senderDid	body	string	true	none
» type	body	string	false	none

Signs a DIDComm message as a base64 encoded JWT

POSThttps://api-testnet.truvera.io/messaging/sign

Body

application/json

The message payload

payload*object

senderDid*string

typestring

Response

200400402404

Message has been sent

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/messaging/sign', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "senderDid": "text"
    }),
});
const data = await response.json();

Response

200400402404

{
  "code": 0
}

Verifying a Message

Verify that the message is valid.

Parameters

Name	In	Type	Required	Description
body	body	object	true	The message payload
» jws	body	string	true	none

Verifies a JWS in its compacted form

POSThttps://api-testnet.truvera.io/messaging/verify

Body

application/json

The message payload

jws*string

Response

200400402404

Message is verified

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/messaging/verify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "jws": "text"
    }),
});
const data = await response.json();

Response

200400402404

{
  "code": 0
}

Send Message

Sends a DIDComm message using our relay service and DID service endpoints, it also returns a URL for QR code scanning. Supports encrypted, plaintext and signed DIDComm messages. You can generate an encrypted DIDComm message by calling the /messaging/encrypt route.

The typ attribute must be a DIDComm type (i.e. starts with "application/didcomm").

Parameters

Name	In	Type	Required	Description
body	body	object	true	The message payload
» to	body	string	true	none
» message	body	Message	true	none

Sends a DIDComm message using our relay service and DID service endpoints, it also returns a URL for QR code scanning. Supports encrypted, plaintext and signed DIDComm messages. You can generate an encrypted DIDComm message by calling the /messaging/encrypt route

POSThttps://api-testnet.truvera.io/messaging/send

Body

application/json

The message payload

to*string

message*object

Response

200400402404

Message has been sent

Body

application/json

codeinteger

Request

JavaScriptCurlPython

const response = await fetch('https://api-testnet.truvera.io/messaging/send', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "to": "text"
    }),
});
const data = await response.json();

Response

200400402404

{
  "code": 0
}