Messaging API calls

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

post

https://api-testnet.truvera.iohttps://api.truvera.io

/messaging/encrypt

Messaging encrypt

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

typestringOptional

payloadobjectRequired

senderDidstringRequired

algorithmstring · enumOptionalDefault: ECDH-1PU+A256KWPossible values:

Responses

200

Message has been encrypted, returning an encrypted DIDComm Message

application/json

Default response

codeintegerOptional

400

Message failed to encrypt

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

404

DID was not found

application/json

post

/messaging/encrypt

HTTPcURLJavaScriptPython

POST /messaging/encrypt HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "type": "text",
  "payload": {},
  "senderDid": "text",
  "algorithm": "ECDH-1PU+A256KW",
  "recipientDids": [
    "text"
  ]
}

{
  "code": 1
}

Decrypt Message

Parameters

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

post

https://api-testnet.truvera.iohttps://api.truvera.io

/messaging/decrypt

Decrypts a JSON Web Message

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

jweobjectRequired

Responses

200

Message has been decrypted, returning a DIDComm message

application/json

Default response

codeintegerOptional

400

Message failed to decrypt

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

404

DID was not found

application/json

post

/messaging/decrypt

HTTPcURLJavaScriptPython

POST /messaging/decrypt HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "jwe": {}
}

{
  "code": 1
}

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

post

https://api-testnet.truvera.iohttps://api.truvera.io

/messaging/sign

Signs a DIDComm message as a base64 encoded JWT

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

payloadobjectRequired

senderDidstringRequired

typestringOptional

Responses

200

Message has been sent

application/json

Default response

codeintegerOptional

400

Message failed to send

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

404

DID was not found

application/json

post

/messaging/sign

HTTPcURLJavaScriptPython

POST /messaging/sign HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "payload": {},
  "senderDid": "text",
  "type": "text"
}

{
  "code": 1
}

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

post

https://api-testnet.truvera.iohttps://api.truvera.io

/messaging/verify

Verifies a JWS in its compacted form

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

jwsstringRequired

Responses

200

Message is verified

application/json

Default response

codeintegerOptional

400

Message failed to verify

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

404

DID was not found

application/json

post

/messaging/verify

HTTPcURLJavaScriptPython

POST /messaging/verify HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "jws": "text"
}

{
  "code": 1
}

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

post

https://api-testnet.truvera.iohttps://api.truvera.io

/messaging/send

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

Authorizations

bearerAuthaccessTokennextAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

tostringRequired

messageobjectRequired

Responses

200

Message has been sent

application/json

Default response

codeintegerOptional

400

Message failed to send

application/json

402

Transaction limit reached or upgrade required to proceed

application/json

404

DID was not found

application/json

post

/messaging/send

HTTPcURLJavaScriptPython

POST /messaging/send HTTP/1.1
Host: api-testnet.truvera.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "to": "text",
  "message": {}
}

{
  "code": 1
}