Integrating Redaction in Transcripts & Messages

Description

Insurance Carriers can enable Hi Marley redaction of any sensitive information (e.g bank account number, social security number) received from their customer.

Please get in touch with your Hi Marley Customer Success Manager if you would like to learn more about redaction. 

The redaction setting for the organization also impacts any integrations that capture message data either as JSON payloads or PDF Transcripts. As shown below, redacted information will be generated as black dots.

Here is my SSN - ●●●●●●●●●●●

Redaction can also be enforced or disabled per API request and Webhook subscription. 

 

API Requests

The download case transcript API endpoint now includes an optional redacted query parameter.

GET/api/case/actions/download/{caseId}?redacted=true

Webhook Subscriptions

Any webhooks that generate transcripts or messages in our SFTP site or as a JSON payload now include an optional subscription field named redacted (example below).

{
  "EVENT_ID": 3,
  "PGP_KEY": "BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION",
  "format": "${caseData.brand}/${primaryContact.first}-${primaryContact.last}/${partialId}",
  "redacted": true
}

 

Example: Redacted Message JSON Payload

{
   "caseData" : {
      "id" : "29c9da5a-7656-4164-973e-7924398ffd7d",
      "archived" : false,
      "claimNumber" : "Auto-49728-2430",
      "dateOfLoss" : "2022-08-02T15:25:54",
      "policyNumber" : "Auto-78759-91420",
      "deductible" : "Auto-54125-35883",
      "brand" : "Lovable Insurance Northeast"
   },
   "state" : "open",
   "caseType" : "claim",
   "customer" : {
      "id" : "86491246-2ef2-4986-bd74-ea46cd6d82c7",
      "first" : "Jean-Luc",
      "last" : "Picard",
      "email" : "[e-mail]",
      "mobile" : "[phone]",
      "role" : "enduser",
      "optStatus" : true,
      "optStatusDetail" : "OPTED_IN"
   },
   "primaryContact" : {
      "id" : "b8c724e4-2930-4aec-8934-4641f51cf285",
      "first" : "Lovable",
      "last" : "Adjuster",
      "email" : "[e-mail]",
      "role" : "operator"
   },
   "createTime" : "2022-05-18T13:24:25.006Z",
   "referenceId" : "Auto-49728-2430",
   "privacy" : "public",
   "marleyNumber" : "[phone]",
   "languagePreference" : "fr",
   "secondaryOperators" : [],
   "messages" : [
      {
         "id" : "3e5302e8-108f-49f1-864a-8e9b3d2c02a6",
         "type" : "text",
         "formatting" : "standard",
         "data" : "Here is my SSN - ●●●●●●●●●●●",
         "channelSource" : "mobile",
         "author" : {
            "_id" : "92e6acea-775d-44f3-9d61-c968fb8760b1",
            "role" : "enduser",
            "profile" : {
               "firstName" : "Jean-Luc",
               "lastName" : "Picard"
            }
         },
         "createdAt" : "2022-08-04T22:48:23.813Z",
         "dateFormatted" : "08-04-2022",
         "timeFormatted" : "6:48:23 PM EDT"
      }
   ]
}