Decrypt a message

POST/v1/messaging/decrypt

Decrypts a provided message where the tenant manages the keys for the defined recipientDidUrl.

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_DECRYPT_STARTMESSAGING_DECRYPT_SUCCESSMESSAGING_DECRYPT_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Decryption parameters

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/v1/messaging/decrypt" \  -H "Content-Type: application/json" \  -d '{    "jwe": "eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDp3ZWI6bWF0dHIuZ2xvYmFsI0V5MkN2V2N5MzQifQ.eyJtZXNzYWdlIjoidGVzdCJ9.dMvOGkfbRrjUJL7XYYAp1UxoHlt8J0N5_vRRLpTEHtQ4s8lwnMd0lhg7HiZVfvEyzk54f6J0CgTV5oHzVscdAA"  }'

{  "payload": "string",  "senderDidUrl": "did:web:organization.com#2vcj3MjR4d",  "senderPublicJwk": {},  "recipientDidUrl": "did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d"}

POST/v1/messaging/decrypt

Decrypts a provided message where the tenant manages the keys for the defined recipientDidUrl.

Roles

adminissuermanaged-issuer

Analytics Events

MESSAGING_DECRYPT_STARTMESSAGING_DECRYPT_SUCCESSMESSAGING_DECRYPT_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Decryption parameters

TypeScript Definitions

Use the request body type in TypeScript.

jwe*|

The jwe object to be decrypted. It can be extracted from the jwe attribute of the response body you get when encrypting a message. Alternatively, you can use a jwe string using Base64 encoding method and following the JWE open-standard: BASE64URL(UTF8(JWE Protected Header)) || '.' || BASE64URL(JWE Encrypted Key) || '.' || BASE64URL(JWE Initialization Vector) || '.' || BASE64URL(JWE Ciphertext) || '.' || ASE64URL(JWE Authentication Tag)

Response Body

`application/json`

curl -X POST "https://example.com/v1/messaging/decrypt" \  -H "Content-Type: application/json" \  -d '{    "jwe": "eyJhbGciOiJFZERTQSIsImtpZCI6ImRpZDp3ZWI6bWF0dHIuZ2xvYmFsI0V5MkN2V2N5MzQifQ.eyJtZXNzYWdlIjoidGVzdCJ9.dMvOGkfbRrjUJL7XYYAp1UxoHlt8J0N5_vRRLpTEHtQ4s8lwnMd0lhg7HiZVfvEyzk54f6J0CgTV5oHzVscdAA"  }'

{  "payload": "string",  "senderDidUrl": "did:web:organization.com#2vcj3MjR4d",  "senderPublicJwk": {},  "recipientDidUrl": "did:key:z6MkgmEkNM32vyFeMXcQA7AfQDznu47qHCZpy2AYH2Dtdu1d"}

Roles

Analytics Events

Authorization

Request Body

Response Body

200application/json

400application/json

Decrypt a message

Roles

Analytics Events

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`

`application/json`

`application/json`