light-mode-image
Learn
API ReferenceMessaging

Send a message

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_SEND_STARTMESSAGING_SEND_SUCCESSMESSAGING_SEND_FAIL
POST/v1/messaging/send

Sends an encrypted JWM (JSON Web Messaging) format message to a service endpoint defined in a public DID document.

Analytic events

  • MESSAGING_SEND_START
  • MESSAGING_SEND_SUCCESS
  • MESSAGING_SEND_FAIL

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

to?string

Recipient DID.

message?|

Message in JWE (JSON Web Encryption) format. This endpoint only accepts Encrypted payloads to ensure that messages are encrypted-at-rest whilst in messaging inboxes. The message should be encrypted for the recipient based on a key available in the DID Document.

Response Body

application/json

curl -X POST "https://example.vii.au01.mattr.global/v1/messaging/send" \  -H "Content-Type: application/json" \  -d '{    "to": "did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d",    "message": {      "protected": "eyJhbGciOiJYQzIwUCJ9",      "recipients": [        {          "header": {            "alg": "ECDH-1PU+A256KW",            "kid": "did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d#z6LSsvqSJkBvVEsDC8cxMHuQ3sKoLRMXB1MdtoLrMUq6A8Rg",            "epk": {              "kty": "OKP",              "crv": "X25519",              "x": "kYsO02jWHATTJel6OpePqlkdDmKlE5VOr18UblgL8W0"            },            "skid": "did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy"          },          "encryption_key": "n1VUf5SQdSFNtb8DHzYfJJ_lFhJcGDAPJWG8Y1W3d2qYyPzyxMhyaA"        },        {          "header": {            "alg": "ECDH-1PU+A256KW",            "kid": "did:key:z6MkgxxdrThaRd7HbeAA4pYEwAgKT6ZXy2aNTcPkmeF1yWHN#z6LSgDiT1CkducmcSPaq9E1Uj1qdSXBjsUNqqLQLrUu8EHWd",            "epk": {              "kty": "OKP",              "crv": "X25519",              "x": "P3jcIMPGK8thxyHxUsWB5fEsLnltJqRDWMNywtexk24"            },            "skid": "did:key:z6Mko4PvuwKzmjtaKTEV6ZhMSYqX5myTSe3L3Md4feiwCoua#z6LSkKk8HK73jYfUQRBHX3Qeb1Agv39qVNFn7n2PjRvjpPcy"          },          "encryption_key": "5ZOTqwj8NredkXEOp4ZDLL1ohRQqNTS508BTkLlUVCkDoYvizCIdrg"        }      ],      "ciphertext": "Dl4zBqMeEDwcnyyc17nYvSQ048fcsha_Lm0dfer1nqfo5y8oHvD2VGNTp_lawNJMWCzQF3NDZxxKFz__wTUeHCqisCE_DWbjo_W-R3avzW9S-JFajv9NRtjlfd5yp-1TtD2N5d-8oTtMGdAxq3dftN2Od1xRe4stubJBebl3nf8-lG99DIVGdL8Y-D98kFDxnMxgCKn4RXyHnMowFWlhQCooLeYqo8aWjqVFkzuJzn-p47W7rV9BCuoVThhVuNkjQm_dhBrqu0QMpjJucz7OvOHp0mojdYNKwvWT6dfOVNXetMlKjWCGtCTNFaDTGLc4agdcTjAlaF1iedcVXDOLqVvEugXWGlusE3a68y6gmPnqHjXR6CsEfPwkb5hKKtsyrh1eHu_9UUang5o6N76mummVw4UZkDF6tP1PVGPvyctz82tthnOcjO5mZQG41xfMEMNxWtF8P8wCh4LotpdexXtYigzBgkI1Qoa_FK1czYWAUovysAJCTOZtmg==",      "iv": "jSd3E-ElCHE-QhSDxrQ-Jv4eQhkxOj0s",      "tag": "dbDolGVDdvYsYdn-vVrICw=="    }  }'
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Decrypt a message POST

Decrypts a provided message where the tenant manages the keys for the defined `recipientDidUrl`. ### **Analytic events** * MESSAGING_DECRYPT_START * MESSAGING_DECRYPT_SUCCESS * MESSAGING_DECRYPT_FAIL

Create an inbox POST

Creates an inbox that can register DIDs and then hold messages sent to those DIDs service points. ### **Analytic events** * MESSAGING_INBOX_CREATE_START * MESSAGING_INBOX_CREATE_SUCCESS * MESSAGING_INBOX_CREATE_FAIL