Push Transcript

Based on passed in caseId, the associated pdf transcript for the case is pushed to your organizations folder on the Hi Marley SFTP.

For information on SFTP configuration, learn more from this guide.

Service Name	Push Transcript
Service Type	REST
Method	PUT
UAT (Sandbox) URL	https://integration.uat.marley.ai/api/case/actions/push-transcript/{caseId}
Production URL	https://integration.himarley.io/api/case/actions/push-transcript/{caseId}
Technical Documentation	View technical documentation with sample request and response payloads hosted on Postman.

 

Table of Contents

• API Request
  • Flow
  • Request Example
  • Request Path Breakdown
  • Request Body Breakdown
• API Response 
  • Response Payload Example
  • Response Fields Breakdown
• Common Errors to Handle

API Request

Flow

1. Send API request with the path parameter of the Hi Marley Case ID.
   1. In the request body, specify the:
      1. pgpKey (optional) - BASE64_PGP_KEY_FOR_OPTIONAL_ENCRYPTION
      2. format (example) - ${caseData.brand}/${caseData.claimNumber}_${caseData.id}
      3. redacted - true or false
2. Hi Marley receives the request and validates the Case ID exists.
3. Hi Marley responds with - "status": "Started upload".
4. The transcript is uploaded to the customer folder on Hi Marleys SFTP site.

Request Example

https://integration.uat.marley.ai/api/case/actions/push-transcript/8f4acac7-9e77-4cc6-a2a9-e18dfae3873b1

 

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
caseId		The Case ID associated with the Hi Marley Case.	string	true	8f4acac7-9e77-4cc6-a2a9-e18dfae3873b1	caseId exists within Hi Marley.

 

Request Body Breakdown

Property	Description	Type	Required	Example
pgpKey	Base64 encoded Public pgpKey to encrypt  transcripts.	string	false	"pgpKey":"LS0tLS1CRUdJTiBQR1AgUFVCTElDIEtFWSBCTE9DS y0tLS0tDQ0KVmVyNCdmREaW9yNFJRVk5MWkNBWg0NClZPTXVacGN KaFFLdm45YVppcGlNDQowTmN3dGg0cVhOZFkrdGJfjkdlsafjkdlafdjkls afdafdsafdsw1UE1pKdmc0NjR3RXFqV28rV3FjMnBydW1zVDZnYmpidA 0NCnJGd2ZLTFk5dWZwQWhaYVBiRkYrcm94K3RhSWZZMGNDOHN6Nz B4aTRnTTNaajRoakVK2cUU0YklQRnZ1YVVOak1RQw0NCm1XZ1Y1QUlp eTNHRzk2ZUJwQ3Z6QM29PQUFDZ2tRWjlSREVMQVVxNTdhK3dDZmQ4"
format	The filename/format of the file location and title based on Hi Marley tokens. Available Filename Format Templates documentation.	string	false	"format":"{caseData.brand}/${caseData.claimNumber}_${caseData.id}"
redacted	If set to true, redaction is applied to sensitive values within the transcript such as SSN & bank account numbers. Omitting this field will default to the organizations redaction setting.	boolean	false	"redacted": true

 

API Response 

Response Payload Example

{
    "status": "Started upload"
}

 

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
status		The status of the transcript upload for the associated case in the API request. Note, the status will be 'started upload' even when a file has successfully been uploaded.	string	true	"status": "Started upload"

Common Errors to Handle

• [404] Case Not Found - More Details