Description

Based on passed in caseId, the associated pdf transcript for the case is pushed to your organizations folder on the Hi Marley SFTP site. For information on SFTP configuration see the admin endpoints. Format and PGPKey fields are optional.

Service Name	Push Transcript to Hi Marley SFTP
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}

View technical documentation with sample request and response payload on Postman.

API Request
API Response
- Response Payload Example
- Response Fields Breakdown
Common Errors to Handle
- [404] Case Not Found

API Request

Flow

Send API request with the path parameter of caseId.
Hi Marley receives requests and validates the CaseID is for a valid Hi Marley case.
API Response received with status: "Started upload", indicating that the transcript for the associated Hi Marley case is being uploaded to the Hi Marley SFTP site.
The transcript can then be downloaded via a FTP job set up by your organization.
1. In order to establish a connection to Hi Marley SFTP site, please work with your infosec team to whitelist Hi Marley SFTP site IPs.
2. Generate a SSH-RSA Key, then use the POST /admin/sftp/public-ssh-keys API to register your SSH-RSA key to Hi Marley SFTP.
  1. To retrieve Hi Marley SFTP IPs please contact steven.colon@himarley.com or jeremie.quinones@himarley.com.
  2. For more information, reference documentatiom:
    1. https://himarley.zendesk.com/hc/en-us/articles/4405648246035-SFTP-Integration-for-Case-Transcripts-and-Media-Files
    2. https://himarley.zendesk.com/hc/en-us/articles/4406144499347-SFTP-Site-Admin-Overview

Request Example

https://integration.uat.marley.ai/api/case/actions/close/8f4acac7-9e77-4cc6-a2a9-e18dfae3873b

Request Path Breakdown

Property	Values	Description	Type	Required	Example	Validation
caseId		The case identifier for the Hi Marley Case.	string	true	8f4acac7-9e77-4cc6-a2a9-e18dfae3873b	CaseID Exists

API Response

Response Payload Example

{
    "caseData": {
        "id": "8f4acac7-9e77-4cc6-a2a9-e18dfae3873b",
        "archived": true,
        "claimNumber": "Auto-Test2727409123",
        "dateOfLoss": "2022-04-13T05:49:44.722Z",
        "policyNumber": "Auto-213r1s23456",
        "deductible": 1000,
        "brand": "TestBrand1"
    },
    "state": "closed",
    "caseType": "claim",
    "customer": {
        "id": "81f45989-c62d-4544-93a5-fd8b5f9936e7",
        "first": "MARY",
        "last": "KRICK",
        "email": "testertester123@verizon.net",
        "mobile": "+15552321111",
        "role": "enduser",
        "optStatus": true,
        "optStatusDetail": "OPTED_IN"
    },
    "primaryContact": {
        "id": "5bea662f-2026-4bfa-be39-57a9ae6b083f",
        "first": "Jason",
        "last": "Stone",
        "email": "jason.stone@insurco1.com",
        "role": "operator"
    },
    "createTime": "2022-08-30T16:47:28.619Z",
    "referenceId": "Auto-Test2727409123",
    "privacy": "public",
    "marleyNumber": "+17622165564",
    "closedAt": "2022-10-13T17:26:27.338Z",
    "languagePreference": "en",
    "secondaryOperators": []
}

Response Fields Breakdown

Property	Element	Description	Type	Required	Example
caseData	id	The case identifier for the Hi Marley Case.	string	true	"caseId": "8f4acac7-9e77-4cc6-a2a9-e18dfae3873b"
	archived	Indicates if case is closed.	string	true	"archived": true
	claimNumber	Fields associated to claim/policy record.	string	true (only claim caseType)	"claimNumber": "Auto-Test2727409123"
	dateOfLoss		string	false	"dateOfLoss": "2022-04-13T05:49:44.722Z"
	policyNumber		string	true (only policy caseType)	"policyNumber": "Auto-213r1s23456"
	deductible		string	false	"deductible": 1000
	brand	Subsidiary/Underwriter associated with case	string	true (only if brands are in-use)	"brand": "TestBrand1"
state		The current status of the case state. open close	enum	true	"state": "closed"
caseType		The type of Hi Marley Case. case claim policy	enum	true	"caseType": "claim"
customer	id	The identifier generated and assigned to the customer.	string	true	"id": "81f45989-c62d-4544-93a5-fd8b5f9936e7"
	first	The customers given name.	string	true	"first": "MARY"
	last	The last name of the person assigned to the Hi Marley case.	string	true	"last": "KRICK"
	email	The customers email address.	string	false	"email": "testertester123@verizon.net"
	mobile	The customers mobile number.	string	true	"mobile": "+15552321111"
	role	The customers role. Always set to enduser.	enum	true	"role": "enduser"
	optStatus	The current opt status for the customer.	boolean	true	"optStatus": true
	optStatusDetail	Description of the current opt status for the customer.	string	true	"optStatusDetail": "OPTED_IN"
primaryContact	id	The identifier of the person assigned to the Hi Marley case.	string	false	"id": "5bea662f-2026-4bfa-be39-57a9ae6b083f"
	first	The first name of the person assigned to the Hi Marley case.	string	false	"first": "Jason"
	last	The last name of the person assigned to the Hi Marley case.	string	false	"last": "Stone"
	email	The email of the person assigned to the Hi Marley case.	string	false	"email": "jason.stone@insurco1.com"
	role	The role of the person assigned to the Hi Marley case.	string	false	"role": "operator"
createTime		The time of the case creation.	smalldatetime	true	"createTime": "2022-08-30T16:47:28.619Z"
referenceId		The case reference identifier for the Hi Marley Case.	string	true	"referenceId": "Auto-Test2727409123"
privacy		The case privacy status. public private-redacted	enum	true	"privacy": "public"
marleyNumber		The assigned phone number from an organization pool used to conduct messaging for the current case.	string	true	"marleyNumber": "+17622165564"
languagePreference		The preferred language for the current Hi Marley case.	enum	true	"languagePreference": "en"
secondaryOperators	id	The identifier of the person assigned to the Hi Marley case.	string	false	"id": "1cba88af-fac3-425a-9b2b-0faa5779b0e9"
	first	The first name of the person assigned to the Hi Marley case.	string	false	"first": "Tom"
	last	The last name of the person assigned to the Hi Marley case.	string	false	"last": "Smith"
	email	The email of the person assigned to the Hi Marley case.	string	false	"email": "tom.smith@insuranceco.com"
	role	The role of the person assigned to the Hi Marley case.	enum	false	"role": "operator"

Common Errors to Handle

[404] Case Not Found - More Details

Push Transcript to Hi Marley SFTP