· 5 years ago · Aug 26, 2020, 12:00 AM
1{
2 "openapi": "3.0.0",
3 "info": {
4 "title": "Benekiva [API]",
5 "description": "Benekiva API provides robust ways of interacting with Benekiva Application. \nPrior to accessing this documentation, you will need to contact Benekiva team so that they can provision a test server for you.\nOnce you have your client portal with developer credentials, please login and obtain API Key and Client Secret.\n\nPlease reach out Benekiva technical support team (techsupport@benekiva.com) to obtain your API Key, Client Secret as well as API server information exclusively prepared for you.\n\nOnce you have API key and Client Secret, run 'Get Auth Token' API to obtain AuthToken that needs to be put as part of Authorization header as Bearer Token for any further API calls. Please note - this does not apply to SSO Auth Token Request.",
6 "contact": {},
7 "version": "1.0"
8 },
9 "servers": [
10 {
11 "url": "https://api.benekiva.com",
12 "variables": {}
13 }
14 ],
15 "paths": {
16 "/auth/authtoken": {
17 "post": {
18 "tags": ["AUTHORIZATION"],
19 "summary": "Get Auth Token",
20 "operationId": "GetAuthToken",
21 "parameters": [],
22 "requestBody": {
23 "description": "",
24 "content": {
25 "application/json": {
26 "schema": {
27 "$ref": "#/components/schemas/GetAuthTokenRequest"
28 },
29 "example": {
30 "apiKey": "[API KEY]",
31 "clientSecret": "[CLIENT SECRET]"
32 }
33 }
34 },
35 "required": true,
36 "x-send-file-in-body": false
37 },
38 "responses": {
39 "200": {
40 "description": "",
41 "headers": {}
42 }
43 },
44 "deprecated": false
45 }
46 },
47 "/auth/generatessotoken": {
48 "post": {
49 "tags": ["AUTHORIZATION"],
50 "summary": "Request SSO URI",
51 "description": "SSO handshake can be done between authorized client with valid apiKey and client Secret and Benekiva in the granted role of either FHD or CSR.\n\nThis is preliminary release of SSO feature and subjected to change although not architecturally.\n\n\"apiKey\" and \"clientSecret\" can be obtained from Benekiva by login in as dev credential. Please reach out to Benekiva team if you do not have those credentials handy or needs tutorial to reset them.\n\n\"grant Role\" - This can either take \"CSR\" or \"FHD\" as values.\n\nIf the supplied value is \"FHD\", \"fhNum\" becomes required field.\n\n\"incUsers\" - This accepts array of email addresses for which you need to see all the claims submitted and processed too. This comes handy if one employee needs to see and process claims started by another employee. It only works for the included users whose role is the same as \"grant role\" above.\n\n\"authorizedEmail\" is the person's email to whom authorization need to be granted. If email is not found in Benekiva, the user account will be created automatically.\n\n\nIn the Response object, Sso_Uri can be directly called upon to connect to single sign on into Benekiva.\n\n\n",
52 "operationId": "RequestSSOURI",
53 "parameters": [],
54 "requestBody": {
55 "description": "",
56 "content": {
57 "application/json": {
58 "schema": {
59 "$ref": "#/components/schemas/RequestSSOURIRequest"
60 },
61 "example": {
62 "apiKey": "[apiKey]",
63 "clientSecret": "[clientSecret]",
64 "grantRole": "[FHD or CSR]",
65 "polNum": "[polNum]",
66 "fhNum": "[fhNum]",
67 "incUsers": ["Array of email addresses"],
68 "authorizedEmail": "[Email Address of Authorized Person To Be Granted]"
69 }
70 }
71 },
72 "required": true,
73 "x-send-file-in-body": false
74 },
75 "responses": {
76 "200": {
77 "description": "",
78 "headers": {}
79 }
80 },
81 "deprecated": false
82 }
83 },
84 "/api/agents/{agentId}": {
85 "get": {
86 "tags": ["AGENTS"],
87 "summary": "GET SINGLE AGENT",
88 "description": "Suitable For Single Query of a Agent with a given ID.",
89 "operationId": "GETSINGLEAGENT",
90 "parameters": [
91 {
92 "name": "Content-Type",
93 "in": "header",
94 "description": "",
95 "required": true,
96 "style": "simple",
97 "schema": {
98 "type": "string",
99 "example": "application/json"
100 }
101 },
102 {
103 "name": "agentId",
104 "in": "path",
105 "description": "",
106 "required": true,
107 "style": "simple",
108 "schema": {
109 "type": "string"
110 }
111 }
112 ],
113 "responses": {
114 "200": {
115 "description": "",
116 "headers": {}
117 }
118 },
119 "deprecated": false
120 },
121 "patch": {
122 "tags": ["AGENTS"],
123 "summary": "UPDATE SINGLE AGENT",
124 "description": "Update part of AGENT payload.",
125 "operationId": "UPDATESINGLEAGENT",
126 "parameters": [
127 {
128 "name": "agentId",
129 "in": "path",
130 "description": "",
131 "required": true,
132 "style": "simple",
133 "schema": {
134 "type": "string"
135 }
136 }
137 ],
138 "requestBody": {
139 "description": "",
140 "content": {
141 "application/json": {
142 "schema": {
143 "$ref": "#/components/schemas/UPDATESINGLEAGENTREQUEST"
144 },
145 "example": {
146 "accountNumber": "424234243",
147 "routingNumber": "SFFAF"
148 }
149 }
150 },
151 "required": true,
152 "x-send-file-in-body": false
153 },
154 "responses": {
155 "200": {
156 "description": "",
157 "headers": {}
158 }
159 },
160 "deprecated": false
161 }
162 },
163 "/api/agents/search": {
164 "post": {
165 "tags": ["AGENTS"],
166 "summary": "AGENT SEARCH",
167 "description": "Retrieve a list of agents by page number, size, sort, order and search text.\n\n",
168 "operationId": "AGENTSEARCH",
169 "parameters": [],
170 "requestBody": {
171 "description": "",
172 "content": {
173 "application/json": {
174 "schema": {
175 "$ref": "#/components/schemas/AGENTSEARCHREQUEST"
176 },
177 "example": {
178 "page": 1,
179 "size": 20,
180 "sort": "updatedAt",
181 "order": "asc",
182 "searchText": "{{searchText}}"
183 }
184 }
185 },
186 "required": true,
187 "x-send-file-in-body": false
188 },
189 "responses": {
190 "200": {
191 "description": "",
192 "headers": {}
193 }
194 },
195 "deprecated": false
196 }
197 },
198 "/api/agents/batchupload": {
199 "put": {
200 "tags": ["AGENTS"],
201 "summary": "Agents Batch Upload",
202 "description": "isFresh property is important as it determines whether the list needs to be inserted or simply updated.\n\nisFresh = true means list to be inserted.\n\nisFresh = false means list to be updated.",
203 "operationId": "AgentsBatchUpload",
204 "parameters": [],
205 "requestBody": {
206 "description": "",
207 "content": {
208 "application/json": {
209 "schema": {
210 "$ref": "#/components/schemas/AgentsBatchUploadRequest"
211 },
212 "example": {
213 "isFresh": true,
214 "funeralHomes": [
215 {
216 "fhZip": "827110",
217 "fhState": "Hawaii",
218 "fhCity": "Newcastle",
219 "fhAddr2": "",
220 "fhAddr1": "350 Dare Court",
221 "fhTaxID": "287476638",
222 "fhEmail": "Dana@company.com",
223 "mainfhNum": "LIQUICOM",
224 "fhNum": "ONTAGENE",
225 "fhName": "Leonard Murphy"
226 },
227 {
228 "fhZip": "461084",
229 "fhState": "Texas",
230 "fhCity": "Wildwood",
231 "fhAddr2": "",
232 "fhAddr1": "275 Glen Street",
233 "fhTaxID": "198339074",
234 "fhEmail": "Gallegos@company.com",
235 "mainfhNum": "OPTIQUE",
236 "fhNum": "RODEOLOGY",
237 "fhName": "Roman Pena"
238 },
239 {
240 "fhZip": "167324",
241 "fhState": "Maryland",
242 "fhCity": "Tonopah",
243 "fhAddr2": "",
244 "fhAddr1": "184 Fillmore Avenue",
245 "fhTaxID": "734071693",
246 "fhEmail": "Ewing@company.com",
247 "mainfhNum": "BOSTONIC",
248 "fhNum": "SOPRANO",
249 "fhName": "Chrystal Buckner"
250 },
251 {
252 "fhZip": "409148",
253 "fhState": "Wyoming",
254 "fhCity": "Orick",
255 "fhAddr2": "",
256 "fhAddr1": "182 Baycliff Terrace",
257 "fhTaxID": "571950629",
258 "fhEmail": "Garrett@company.com",
259 "mainfhNum": "LUMBREX",
260 "fhNum": "COREPAN",
261 "fhName": "Whitney Cooley"
262 },
263 {
264 "fhZip": "318951",
265 "fhState": "Nebraska",
266 "fhCity": "Hillsboro",
267 "fhAddr2": "",
268 "fhAddr1": "973 Stryker Court",
269 "fhTaxID": "404362529",
270 "fhEmail": "Dolly@company.com",
271 "mainfhNum": "ULTRIMAX",
272 "fhNum": "DYNO",
273 "fhName": "Dionne Hoffman"
274 },
275 {
276 "fhZip": "626505",
277 "fhState": "Missouri",
278 "fhCity": "Convent",
279 "fhAddr2": "",
280 "fhAddr1": "273 Truxton Street",
281 "fhTaxID": "670298313",
282 "fhEmail": "Manuela@company.com",
283 "mainfhNum": "INVENTURE",
284 "fhNum": "GEEKOL",
285 "fhName": "Graciela Fisher"
286 },
287 {
288 "fhZip": "626189",
289 "fhState": "Utah",
290 "fhCity": "Courtland",
291 "fhAddr2": "",
292 "fhAddr1": "149 Williams Place",
293 "fhTaxID": "535695628",
294 "fhEmail": "Mullen@company.com",
295 "mainfhNum": "DEEPENDS",
296 "fhNum": "MITROC",
297 "fhName": "Ingrid Aguilar"
298 },
299 {
300 "fhZip": "397650",
301 "fhState": "Puerto Rico",
302 "fhCity": "Knowlton",
303 "fhAddr2": "",
304 "fhAddr1": "660 Baltic Street",
305 "fhTaxID": "829224322",
306 "fhEmail": "Figueroa@company.com",
307 "mainfhNum": "GLOBOIL",
308 "fhNum": "ISONUS",
309 "fhName": "Bartlett Hull"
310 },
311 {
312 "fhZip": "426132",
313 "fhState": "District Of Columbia",
314 "fhCity": "Cataract",
315 "fhAddr2": "",
316 "fhAddr1": "133 Fountain Avenue",
317 "fhTaxID": "599008111",
318 "fhEmail": "Dickerson@company.com",
319 "mainfhNum": "ZILLA",
320 "fhNum": "TRI@TRIBALOG",
321 "fhName": "Holmes Gates"
322 }
323 ]
324 }
325 }
326 },
327 "required": true,
328 "x-send-file-in-body": false
329 },
330 "responses": {
331 "200": {
332 "description": "",
333 "headers": {}
334 }
335 },
336 "deprecated": false
337 }
338 },
339 "/api/agents/deleteall": {
340 "delete": {
341 "tags": ["AGENTS"],
342 "summary": "Agents Delete ALL",
343 "description": "DELETE ALL",
344 "operationId": "AgentsDeleteALL",
345 "parameters": [
346 {
347 "name": "Content-Type",
348 "in": "header",
349 "description": "",
350 "required": true,
351 "style": "simple",
352 "schema": {
353 "type": "string",
354 "example": "application/json"
355 }
356 }
357 ],
358 "responses": {
359 "200": {
360 "description": "",
361 "headers": {}
362 }
363 },
364 "deprecated": false
365 }
366 },
367 "/api/agents/list": {
368 "get": {
369 "tags": ["AGENTS"],
370 "summary": "Agent List",
371 "description": "Retrieves list of all active agents",
372 "operationId": "AgentList",
373 "parameters": [
374 {
375 "name": "Content-Type",
376 "in": "header",
377 "description": "",
378 "required": true,
379 "style": "simple",
380 "schema": {
381 "type": "string",
382 "example": "application/json"
383 }
384 }
385 ],
386 "responses": {
387 "200": {
388 "description": "",
389 "headers": {}
390 }
391 },
392 "deprecated": false
393 }
394 },
395 "/api/policies": {
396 "get": {
397 "tags": ["POLICIES"],
398 "summary": "Get Policy List",
399 "operationId": "GetPolicyList",
400 "parameters": [
401 {
402 "name": "Content-Type",
403 "in": "header",
404 "description": "",
405 "required": true,
406 "style": "simple",
407 "schema": {
408 "type": "string",
409 "example": "application/json"
410 }
411 }
412 ],
413 "responses": {
414 "200": {
415 "description": "",
416 "headers": {}
417 }
418 },
419 "deprecated": false
420 }
421 },
422 "/api/policies/deleteall": {
423 "delete": {
424 "tags": ["POLICIES"],
425 "summary": "Remove All Policies",
426 "operationId": "RemoveAllPolicies",
427 "parameters": [
428 {
429 "name": "Content-Type",
430 "in": "header",
431 "description": "",
432 "required": true,
433 "style": "simple",
434 "schema": {
435 "type": "string",
436 "example": "application/json"
437 }
438 }
439 ],
440 "responses": {
441 "200": {
442 "description": "",
443 "headers": {}
444 }
445 },
446 "deprecated": false
447 }
448 },
449 "/api/policies/batchupload": {
450 "put": {
451 "tags": ["POLICIES"],
452 "summary": "Policies Batch Upload",
453 "description": "This end point is used for uploading batch of policy holder information. Please use maximum of 1000 records for each call. Indicate \"isFresh\" as true if the intention is to create records from scratch.",
454 "operationId": "PoliciesBatchUpload",
455 "parameters": [],
456 "requestBody": {
457 "description": "",
458 "content": {
459 "application/json": {
460 "schema": {
461 "$ref": "#/components/schemas/PoliciesBatchUploadRequest"
462 },
463 "example": {
464 "isFresh": true,
465 "policies": [
466 {
467 "claimQuote": "1463.96",
468 "FHMainNum": "543582",
469 "FHNum": "827344",
470 "insuredLName": "Osborn",
471 "insuredFName": "Dale",
472 "insuredDOB": "Mon Jul 24 1978 21:38:50 GMT+0000 (UTC)",
473 "datIssDate": "Wed Nov 02 2005 04:24:04 GMT+0000 (UTC)",
474 "polProdCode": "741 AB262",
475 "polContractReason": "OH",
476 "polContractStatus": "F",
477 "polNum": "759064920"
478 },
479 {
480 "claimQuote": "2314.89",
481 "FHMainNum": "894591",
482 "FHNum": "777414",
483 "insuredLName": "Calderon",
484 "insuredFName": "Frank",
485 "insuredDOB": "Thu Jan 24 1946 03:10:52 GMT+0000 (UTC)",
486 "datIssDate": "Tue May 17 2005 00:56:45 GMT+0000 (UTC)",
487 "polProdCode": "498 AB197",
488 "polContractReason": "VT",
489 "polContractStatus": "E",
490 "polNum": "127488742"
491 },
492 {
493 "claimQuote": "2982.11",
494 "FHMainNum": "769177",
495 "FHNum": "371874",
496 "insuredLName": "Burns",
497 "insuredFName": "Miranda",
498 "insuredDOB": "Wed Mar 30 1960 12:42:20 GMT+0000 (UTC)",
499 "datIssDate": "Mon Nov 25 2002 14:06:40 GMT+0000 (UTC)",
500 "polProdCode": "955 YT297",
501 "polContractReason": "WY",
502 "polContractStatus": "B",
503 "polNum": "270618819"
504 },
505 {
506 "claimQuote": "1637.89",
507 "FHMainNum": "297940",
508 "FHNum": "340634",
509 "insuredLName": "Mcfarland",
510 "insuredFName": "Vickie",
511 "insuredDOB": "Wed Feb 05 1975 18:37:29 GMT+0000 (UTC)",
512 "datIssDate": "Fri Apr 23 2004 04:25:19 GMT+0000 (UTC)",
513 "polProdCode": "992 DC177",
514 "polContractReason": "IL",
515 "polContractStatus": "B",
516 "polNum": "121771836"
517 },
518 {
519 "claimQuote": "1668.07",
520 "FHMainNum": "392247",
521 "FHNum": "615491",
522 "insuredLName": "Callahan",
523 "insuredFName": "Morrow",
524 "insuredDOB": "Sat Jun 28 1975 16:07:46 GMT+0000 (UTC)",
525 "datIssDate": "Mon Nov 28 2016 17:48:48 GMT+0000 (UTC)",
526 "polProdCode": "822 GF238",
527 "polContractReason": "HI",
528 "polContractStatus": "D",
529 "polNum": "483496940"
530 },
531 {
532 "claimQuote": "1016.88",
533 "FHMainNum": "680215",
534 "FHNum": "757303",
535 "insuredLName": "Burnett",
536 "insuredFName": "Battle",
537 "insuredDOB": "Sat May 24 1975 21:57:51 GMT+0000 (UTC)",
538 "datIssDate": "Tue Mar 08 2011 02:36:53 GMT+0000 (UTC)",
539 "polProdCode": "593 DC251",
540 "polContractReason": "CO",
541 "polContractStatus": "A",
542 "polNum": "305725865"
543 },
544 {
545 "claimQuote": "1185.18",
546 "FHMainNum": "606284",
547 "FHNum": "447954",
548 "insuredLName": "Brooks",
549 "insuredFName": "Caroline",
550 "insuredDOB": "Tue May 10 1966 04:14:11 GMT+0000 (UTC)",
551 "datIssDate": "Wed Feb 07 2007 15:56:44 GMT+0000 (UTC)",
552 "polProdCode": "983 AB211",
553 "polContractReason": "SC",
554 "polContractStatus": "B",
555 "polNum": "747525404"
556 },
557 {
558 "claimQuote": "2814.76",
559 "FHMainNum": "530481",
560 "FHNum": "560727",
561 "insuredLName": "Baird",
562 "insuredFName": "Townsend",
563 "insuredDOB": "Thu Oct 02 1980 12:36:21 GMT+0000 (UTC)",
564 "datIssDate": "Mon Jun 04 2001 16:33:30 GMT+0000 (UTC)",
565 "polProdCode": "313 YT247",
566 "polContractReason": "OK",
567 "polContractStatus": "A",
568 "polNum": "115153339"
569 },
570 {
571 "claimQuote": "2806.70",
572 "FHMainNum": "154309",
573 "FHNum": "429665",
574 "insuredLName": "Jenkins",
575 "insuredFName": "Gillespie",
576 "insuredDOB": "Thu Mar 08 1962 05:29:37 GMT+0000 (UTC)",
577 "datIssDate": "Wed Jul 23 2014 14:35:04 GMT+0000 (UTC)",
578 "polProdCode": "443 GF214",
579 "polContractReason": "OR",
580 "polContractStatus": "C",
581 "polNum": "551210142"
582 },
583 {
584 "claimQuote": "2387.21",
585 "FHMainNum": "775469",
586 "FHNum": "167026",
587 "insuredLName": "Bennett",
588 "insuredFName": "Jenna",
589 "insuredDOB": "Sun Jul 21 1996 10:49:25 GMT+0000 (UTC)",
590 "datIssDate": "Mon Jan 01 2001 17:55:46 GMT+0000 (UTC)",
591 "polProdCode": "828 AB287",
592 "polContractReason": "MD",
593 "polContractStatus": "E",
594 "polNum": "387930624"
595 },
596 {
597 "claimQuote": "2220.15",
598 "FHMainNum": "383622",
599 "FHNum": "712061",
600 "insuredLName": "Harvey",
601 "insuredFName": "Verna",
602 "insuredDOB": "Tue Dec 10 1935 15:03:55 GMT+0000 (UTC)",
603 "datIssDate": "Wed Jan 17 2007 17:36:36 GMT+0000 (UTC)",
604 "polProdCode": "710 GF243",
605 "polContractReason": "DC",
606 "polContractStatus": "E",
607 "polNum": "670759805"
608 },
609 {
610 "claimQuote": "3666.54",
611 "FHMainNum": "824789",
612 "FHNum": "104109",
613 "insuredLName": "Alford",
614 "insuredFName": "Head",
615 "insuredDOB": "Thu Jul 04 1974 00:06:49 GMT+0000 (UTC)",
616 "datIssDate": "Fri Nov 04 2011 20:35:33 GMT+0000 (UTC)",
617 "polProdCode": "654 AB110",
618 "polContractReason": "NY",
619 "polContractStatus": "B",
620 "polNum": "795855008"
621 },
622 {
623 "claimQuote": "166.60",
624 "FHMainNum": "410917",
625 "FHNum": "898618",
626 "insuredLName": "Pickett",
627 "insuredFName": "Graham",
628 "insuredDOB": "Sun Jan 10 1932 06:04:13 GMT+0000 (UTC)",
629 "datIssDate": "Tue Aug 17 1999 04:37:33 GMT+0000 (UTC)",
630 "polProdCode": "43 GF278",
631 "polContractReason": "AL",
632 "polContractStatus": "F",
633 "polNum": "116674209"
634 }
635 ]
636 }
637 }
638 },
639 "required": true,
640 "x-send-file-in-body": false
641 },
642 "responses": {
643 "200": {
644 "description": "",
645 "headers": {}
646 }
647 },
648 "deprecated": false
649 }
650 },
651 "/api/policyholders/beneficiarybatchupload": {
652 "get": {
653 "tags": ["POLICIES"],
654 "summary": "Beneficiary Batch Upload",
655 "operationId": "BeneficiaryBatchUpload",
656 "parameters": [
657 {
658 "name": "Content-Type",
659 "in": "header",
660 "description": "",
661 "required": true,
662 "style": "simple",
663 "schema": {
664 "type": "string",
665 "example": "application/json"
666 }
667 }
668 ],
669 "responses": {
670 "200": {
671 "description": "",
672 "headers": {}
673 }
674 },
675 "deprecated": false
676 },
677 "put": {
678 "tags": ["BENEFICIARIES"],
679 "summary": "Beneficiary Batch Upload",
680 "operationId": "PutBeneficiaryBatchUpload",
681 "parameters": [],
682 "requestBody": {
683 "description": "",
684 "content": {
685 "application/json": {
686 "schema": {
687 "$ref": "#/components/schemas/BeneficiaryBatchUploadRequest"
688 },
689 "example": {
690 "policies": [
691 {
692 "polNum": "0003021194",
693 "Beneficiaries": [
694 {
695 "FirstName": "VANESSA",
696 "LastName": "SMITH",
697 "MiddleName": "",
698 "SuffixName": "",
699 "AddressLine1": "322 E SOUTHWINDS DR",
700 "AddressLine2": "",
701 "City": "NEWPORT",
702 "PostalCode": "28570",
703 "State": "NC",
704 "PhoneNumber": "2528085413"
705 },
706 {
707 "FirstName": "CHELSEA",
708 "LastName": "HILSINGER",
709 "MiddleName": "A",
710 "SuffixName": "",
711 "AddressLine1": "202 ANITA FORTE DR",
712 "AddressLine2": "",
713 "City": "CAPE CARTERET",
714 "PostalCode": "28584",
715 "State": "NC",
716 "PhoneNumber": "2527257972"
717 }
718 ]
719 }
720 ]
721 }
722 }
723 },
724 "required": true,
725 "x-send-file-in-body": false
726 },
727 "responses": {
728 "200": {
729 "description": "",
730 "headers": {}
731 }
732 },
733 "deprecated": false
734 }
735 },
736 "/api/caseloads/financialinfo": {
737 "post": {
738 "tags": ["POLICIES"],
739 "summary": "Financial Info",
740 "description": "This endpoint is used for obtaining all terminated policies with the payouts information for given begin date and end date.",
741 "operationId": "FinancialInfo",
742 "parameters": [],
743 "requestBody": {
744 "description": "",
745 "content": {
746 "application/json": {
747 "schema": {
748 "$ref": "#/components/schemas/FinancialInfoRequest"
749 },
750 "example": {
751 "beginDate": "05/21/2018",
752 "endDate": "05/22/2018"
753 }
754 }
755 },
756 "required": true,
757 "x-send-file-in-body": false
758 },
759 "responses": {
760 "200": {
761 "description": "",
762 "headers": {}
763 }
764 },
765 "deprecated": false
766 }
767 },
768 "/api/caseloads/streamfile": {
769 "post": {
770 "tags": ["POLICIES"],
771 "summary": "Stream file",
772 "description": "This end point is called to fetch the document (currently in PDF format). In order to do so, you will need to have pdfFileId property handy and pass it as body request.\n\n",
773 "operationId": "Streamfile",
774 "parameters": [],
775 "requestBody": {
776 "description": "",
777 "content": {
778 "application/json": {
779 "schema": {
780 "$ref": "#/components/schemas/StreamfileRequest"
781 },
782 "example": {
783 "fileId": "[FILE ID]"
784 }
785 }
786 },
787 "required": true,
788 "x-send-file-in-body": false
789 },
790 "responses": {
791 "200": {
792 "description": "",
793 "headers": {}
794 }
795 },
796 "deprecated": false
797 }
798 },
799 "/api/pay/getStatusDetails": {
800 "post": {
801 "tags": ["POLICIES"],
802 "summary": "Payout Details By Transaction ID",
803 "description": "Get Payout details by providing transaction Id.",
804 "operationId": "PayoutDetailsByTransactionID",
805 "parameters": [],
806 "requestBody": {
807 "description": "",
808 "content": {
809 "application/json": {
810 "schema": {
811 "$ref": "#/components/schemas/PayoutDetailsByTransactionIDRequest"
812 },
813 "example": {
814 "transactionId": "{{transactionId}}"
815 }
816 }
817 },
818 "required": true,
819 "x-send-file-in-body": false
820 },
821 "responses": {
822 "200": {
823 "description": "",
824 "headers": {}
825 }
826 },
827 "deprecated": false
828 }
829 },
830 "/api/caseloads/uploadDocument/{caseloadID}": {
831 "post": {
832 "tags": ["POLICIES"],
833 "summary": "Upload a Single File for Caseload",
834 "description": "This end point is used to uploading document for a given caseload. This end point requires caseload id as part of the URL.",
835 "operationId": "UploadaSingleFileforCaseload",
836 "parameters": [
837 {
838 "name": "Content-Type",
839 "in": "header",
840 "description": "",
841 "required": true,
842 "style": "simple",
843 "schema": {
844 "type": "string",
845 "example": "application/javascript"
846 }
847 },
848 {
849 "name": "caseloadID",
850 "in": "path",
851 "description": "",
852 "required": true,
853 "style": "simple",
854 "schema": {
855 "type": "string"
856 }
857 }
858 ],
859 "requestBody": {
860 "content": {
861 "application/x-www-form-urlencoded": {
862 "encoding": {},
863 "schema": {
864 "required": ["file"],
865 "type": "object",
866 "properties": {
867 "file": {
868 "type": "string",
869 "description": "This is required field. A single source file is expected."
870 }
871 }
872 }
873 }
874 },
875 "required": false,
876 "x-send-file-in-body": false
877 },
878 "responses": {
879 "200": {
880 "description": "",
881 "headers": {}
882 }
883 },
884 "deprecated": false
885 }
886 },
887 "/batchprocess/postrun": {
888 "post": {
889 "tags": ["BATCH RUN"],
890 "summary": "POST RUN BATCH JOB",
891 "operationId": "POSTRUNBATCHJOB",
892 "parameters": [],
893 "requestBody": {
894 "description": "",
895 "content": {
896 "application/json": {
897 "schema": {
898 "$ref": "#/components/schemas/POSTRUNBATCHJOBREQUEST"
899 },
900 "example": {
901 "restoreId": "Sep25th-0105"
902 }
903 }
904 },
905 "required": true,
906 "x-send-file-in-body": false
907 },
908 "responses": {
909 "200": {
910 "description": "",
911 "headers": {}
912 }
913 },
914 "deprecated": false
915 }
916 },
917 "/batchprocess/prerun": {
918 "post": {
919 "tags": ["BATCH RUN"],
920 "summary": "PRE RUN BATCH JOB",
921 "operationId": "PRERUNBATCHJOB",
922 "parameters": [],
923 "requestBody": {
924 "description": "",
925 "content": {
926 "application/json": {
927 "schema": {
928 "$ref": "#/components/schemas/PRERUNBATCHJOBREQUEST"
929 },
930 "example": {
931 "restoreId": "Sep25th-0105"
932 }
933 }
934 },
935 "required": true,
936 "x-send-file-in-body": false
937 },
938 "responses": {
939 "200": {
940 "description": "",
941 "headers": {}
942 }
943 },
944 "deprecated": false
945 }
946 },
947 "/api/dedicatedbenes/{dedicatedBeneID}": {
948 "get": {
949 "tags": ["DEDICATED BENEFICIARIES"],
950 "summary": "GET SINGLE DEDICATED BENE",
951 "description": "Suitable For Single Query of a DEDICATED BENE with a given ID.",
952 "operationId": "GETSINGLEDEDICATEDBENE",
953 "parameters": [
954 {
955 "name": "Content-Type",
956 "in": "header",
957 "description": "",
958 "required": true,
959 "style": "simple",
960 "schema": {
961 "type": "string",
962 "example": "application/json"
963 }
964 },
965 {
966 "name": "dedicatedBeneID",
967 "in": "path",
968 "description": "",
969 "required": true,
970 "style": "simple",
971 "schema": {
972 "type": "string"
973 }
974 }
975 ],
976 "responses": {
977 "200": {
978 "description": "",
979 "headers": {}
980 }
981 },
982 "deprecated": false
983 },
984 "patch": {
985 "tags": ["DEDICATED BENEFICIARIES"],
986 "summary": "UPDATE SINGLE DEDICATED BENE",
987 "description": "Update part of DEDICATED BENE payload.",
988 "operationId": "UPDATESINGLEDEDICATEDBENE",
989 "parameters": [
990 {
991 "name": "dedicatedBeneID",
992 "in": "path",
993 "description": "",
994 "required": true,
995 "style": "simple",
996 "schema": {
997 "type": "string"
998 }
999 }
1000 ],
1001 "requestBody": {
1002 "description": "",
1003 "content": {
1004 "application/json": {
1005 "schema": {
1006 "$ref": "#/components/schemas/UPDATESINGLEDEDICATEDBENEREQUEST"
1007 },
1008 "example": {
1009 "accountNumber": "424234243",
1010 "routingNumber": "SFFAF"
1011 }
1012 }
1013 },
1014 "required": true,
1015 "x-send-file-in-body": false
1016 },
1017 "responses": {
1018 "200": {
1019 "description": "",
1020 "headers": {}
1021 }
1022 },
1023 "deprecated": false
1024 }
1025 },
1026 "/api/dedicatedbenes/search": {
1027 "post": {
1028 "tags": ["DEDICATED BENEFICIARIES"],
1029 "summary": "DEDICATED BENE SEARCH",
1030 "description": "Retrieve a list of dedicated beneficiaries by page number, size, sort, order and search text.\n\n",
1031 "operationId": "DEDICATEDBENESEARCH",
1032 "parameters": [],
1033 "requestBody": {
1034 "description": "",
1035 "content": {
1036 "application/json": {
1037 "schema": {
1038 "$ref": "#/components/schemas/DEDICATEDBENESEARCHREQUEST"
1039 },
1040 "example": {
1041 "page": 1,
1042 "size": 20,
1043 "sort": "updatedAt",
1044 "order": "asc",
1045 "searchText": "{{searchText}}"
1046 }
1047 }
1048 },
1049 "required": true,
1050 "x-send-file-in-body": false
1051 },
1052 "responses": {
1053 "200": {
1054 "description": "",
1055 "headers": {}
1056 }
1057 },
1058 "deprecated": false
1059 }
1060 },
1061 "/api/dedicatedbenes/batchupload": {
1062 "put": {
1063 "tags": ["DEDICATED BENEFICIARIES"],
1064 "summary": "DEDICATED BENE BATCH UPLOAD",
1065 "description": "isFresh property is important as it determines whether the list needs to be inserted or simply updated.\n\nisFresh = true means list to be inserted.\n\nisFresh = false means list to be updated.",
1066 "operationId": "DEDICATEDBENEBATCHUPLOAD",
1067 "parameters": [],
1068 "requestBody": {
1069 "description": "",
1070 "content": {
1071 "application/json": {
1072 "schema": {
1073 "$ref": "#/components/schemas/DEDICATEDBENEBATCHUPLOADREQUEST"
1074 },
1075 "example": {
1076 "isFresh": true,
1077 "funeralHomes": [
1078 {
1079 "fhZip": "827110",
1080 "fhState": "Hawaii",
1081 "fhCity": "Newcastle",
1082 "fhAddr2": "",
1083 "fhAddr1": "350 Dare Court",
1084 "fhTaxID": "287476638",
1085 "fhEmail": "Dana@company.com",
1086 "mainfhNum": "LIQUICOM",
1087 "fhNum": "ONTAGENE",
1088 "fhName": "Leonard Murphy"
1089 },
1090 {
1091 "fhZip": "461084",
1092 "fhState": "Texas",
1093 "fhCity": "Wildwood",
1094 "fhAddr2": "",
1095 "fhAddr1": "275 Glen Street",
1096 "fhTaxID": "198339074",
1097 "fhEmail": "Gallegos@company.com",
1098 "mainfhNum": "OPTIQUE",
1099 "fhNum": "RODEOLOGY",
1100 "fhName": "Roman Pena"
1101 },
1102 {
1103 "fhZip": "167324",
1104 "fhState": "Maryland",
1105 "fhCity": "Tonopah",
1106 "fhAddr2": "",
1107 "fhAddr1": "184 Fillmore Avenue",
1108 "fhTaxID": "734071693",
1109 "fhEmail": "Ewing@company.com",
1110 "mainfhNum": "BOSTONIC",
1111 "fhNum": "SOPRANO",
1112 "fhName": "Chrystal Buckner"
1113 },
1114 {
1115 "fhZip": "409148",
1116 "fhState": "Wyoming",
1117 "fhCity": "Orick",
1118 "fhAddr2": "",
1119 "fhAddr1": "182 Baycliff Terrace",
1120 "fhTaxID": "571950629",
1121 "fhEmail": "Garrett@company.com",
1122 "mainfhNum": "LUMBREX",
1123 "fhNum": "COREPAN",
1124 "fhName": "Whitney Cooley"
1125 },
1126 {
1127 "fhZip": "318951",
1128 "fhState": "Nebraska",
1129 "fhCity": "Hillsboro",
1130 "fhAddr2": "",
1131 "fhAddr1": "973 Stryker Court",
1132 "fhTaxID": "404362529",
1133 "fhEmail": "Dolly@company.com",
1134 "mainfhNum": "ULTRIMAX",
1135 "fhNum": "DYNO",
1136 "fhName": "Dionne Hoffman"
1137 },
1138 {
1139 "fhZip": "626505",
1140 "fhState": "Missouri",
1141 "fhCity": "Convent",
1142 "fhAddr2": "",
1143 "fhAddr1": "273 Truxton Street",
1144 "fhTaxID": "670298313",
1145 "fhEmail": "Manuela@company.com",
1146 "mainfhNum": "INVENTURE",
1147 "fhNum": "GEEKOL",
1148 "fhName": "Graciela Fisher"
1149 },
1150 {
1151 "fhZip": "626189",
1152 "fhState": "Utah",
1153 "fhCity": "Courtland",
1154 "fhAddr2": "",
1155 "fhAddr1": "149 Williams Place",
1156 "fhTaxID": "535695628",
1157 "fhEmail": "Mullen@company.com",
1158 "mainfhNum": "DEEPENDS",
1159 "fhNum": "MITROC",
1160 "fhName": "Ingrid Aguilar"
1161 },
1162 {
1163 "fhZip": "397650",
1164 "fhState": "Puerto Rico",
1165 "fhCity": "Knowlton",
1166 "fhAddr2": "",
1167 "fhAddr1": "660 Baltic Street",
1168 "fhTaxID": "829224322",
1169 "fhEmail": "Figueroa@company.com",
1170 "mainfhNum": "GLOBOIL",
1171 "fhNum": "ISONUS",
1172 "fhName": "Bartlett Hull"
1173 },
1174 {
1175 "fhZip": "426132",
1176 "fhState": "District Of Columbia",
1177 "fhCity": "Cataract",
1178 "fhAddr2": "",
1179 "fhAddr1": "133 Fountain Avenue",
1180 "fhTaxID": "599008111",
1181 "fhEmail": "Dickerson@company.com",
1182 "mainfhNum": "ZILLA",
1183 "fhNum": "TRI@TRIBALOG",
1184 "fhName": "Holmes Gates"
1185 }
1186 ]
1187 }
1188 }
1189 },
1190 "required": true,
1191 "x-send-file-in-body": false
1192 },
1193 "responses": {
1194 "200": {
1195 "description": "",
1196 "headers": {}
1197 }
1198 },
1199 "deprecated": false
1200 }
1201 },
1202 "/api/dedicatedbenes/deleteall": {
1203 "delete": {
1204 "tags": ["DEDICATED BENEFICIARIES"],
1205 "summary": "DEDICATED BENE DELETE ALL",
1206 "description": "DELETE ALL",
1207 "operationId": "DEDICATEDBENEDELETEALL",
1208 "parameters": [
1209 {
1210 "name": "Content-Type",
1211 "in": "header",
1212 "description": "",
1213 "required": true,
1214 "style": "simple",
1215 "schema": {
1216 "type": "string",
1217 "example": "application/json"
1218 }
1219 }
1220 ],
1221 "responses": {
1222 "200": {
1223 "description": "",
1224 "headers": {}
1225 }
1226 },
1227 "deprecated": false
1228 }
1229 },
1230 "/api/dedicatedbenes/list": {
1231 "get": {
1232 "tags": ["DEDICATED BENEFICIARIES"],
1233 "summary": "DEDICATED BENE LIST",
1234 "description": "Retrieves list of all active DEDICATED BENEFICIARIES",
1235 "operationId": "DEDICATEDBENELIST",
1236 "parameters": [
1237 {
1238 "name": "Content-Type",
1239 "in": "header",
1240 "description": "",
1241 "required": true,
1242 "style": "simple",
1243 "schema": {
1244 "type": "string",
1245 "example": "application/json"
1246 }
1247 }
1248 ],
1249 "responses": {
1250 "200": {
1251 "description": "",
1252 "headers": {}
1253 }
1254 },
1255 "deprecated": false
1256 }
1257 },
1258 "/api/funeralhomes/{funeralHomeID}": {
1259 "get": {
1260 "tags": ["FUNERAL HOMES"],
1261 "summary": "GET SINGLE FH",
1262 "description": "Suitable For Single Query of a Funeral Home With a given ID.",
1263 "operationId": "GETSINGLEFH",
1264 "parameters": [
1265 {
1266 "name": "Content-Type",
1267 "in": "header",
1268 "description": "",
1269 "required": true,
1270 "style": "simple",
1271 "schema": {
1272 "type": "string",
1273 "example": "application/json"
1274 }
1275 },
1276 {
1277 "name": "funeralHomeID",
1278 "in": "path",
1279 "description": "",
1280 "required": true,
1281 "style": "simple",
1282 "schema": {
1283 "type": "string"
1284 }
1285 }
1286 ],
1287 "responses": {
1288 "200": {
1289 "description": "",
1290 "headers": {}
1291 }
1292 },
1293 "deprecated": false
1294 },
1295 "patch": {
1296 "tags": ["FUNERAL HOMES"],
1297 "summary": "UPDATE SINGLE FH",
1298 "description": "Update part of Funeral home payload.",
1299 "operationId": "UPDATESINGLEFH",
1300 "parameters": [
1301 {
1302 "name": "funeralHomeID",
1303 "in": "path",
1304 "description": "",
1305 "required": true,
1306 "style": "simple",
1307 "schema": {
1308 "type": "string"
1309 }
1310 }
1311 ],
1312 "requestBody": {
1313 "description": "",
1314 "content": {
1315 "application/json": {
1316 "schema": {
1317 "$ref": "#/components/schemas/UPDATESINGLEFHREQUEST"
1318 },
1319 "example": {
1320 "accountNumber": "424234243",
1321 "routingNumber": "SFFAF"
1322 }
1323 }
1324 },
1325 "required": true,
1326 "x-send-file-in-body": false
1327 },
1328 "responses": {
1329 "200": {
1330 "description": "",
1331 "headers": {}
1332 }
1333 },
1334 "deprecated": false
1335 }
1336 },
1337 "/api/funeralhomes/search": {
1338 "post": {
1339 "tags": ["FUNERAL HOMES"],
1340 "summary": "FH SEARCH",
1341 "description": "Retrieve a list of funeral homes by page number, size, sort, order and search text.\n\n",
1342 "operationId": "FHSEARCH",
1343 "parameters": [],
1344 "requestBody": {
1345 "description": "",
1346 "content": {
1347 "application/json": {
1348 "schema": {
1349 "$ref": "#/components/schemas/FHSEARCHREQUEST"
1350 },
1351 "example": {
1352 "page": 1,
1353 "size": 20,
1354 "sort": "updatedAt",
1355 "order": "asc",
1356 "searchText": "{{searchText}}"
1357 }
1358 }
1359 },
1360 "required": true,
1361 "x-send-file-in-body": false
1362 },
1363 "responses": {
1364 "200": {
1365 "description": "",
1366 "headers": {}
1367 }
1368 },
1369 "deprecated": false
1370 }
1371 },
1372 "/api/funeralhomes/batchupload": {
1373 "put": {
1374 "tags": ["FUNERAL HOMES"],
1375 "summary": "Funeral Homes Batch Upload",
1376 "description": "isFresh property is important as it determines whether the list needs to be inserted or simply updated.\n\nisFresh = true means list to be inserted.\n\nisFresh = false means list to be updated.",
1377 "operationId": "FuneralHomesBatchUpload",
1378 "parameters": [],
1379 "requestBody": {
1380 "description": "",
1381 "content": {
1382 "application/json": {
1383 "schema": {
1384 "$ref": "#/components/schemas/FuneralHomesBatchUploadRequest"
1385 },
1386 "example": {
1387 "isFresh": true,
1388 "funeralHomes": [
1389 {
1390 "fhZip": "827110",
1391 "fhState": "Hawaii",
1392 "fhCity": "Newcastle",
1393 "fhAddr2": "",
1394 "fhAddr1": "350 Dare Court",
1395 "fhTaxID": "287476638",
1396 "fhEmail": "Dana@company.com",
1397 "mainfhNum": "LIQUICOM",
1398 "fhNum": "ONTAGENE",
1399 "fhName": "Leonard Murphy"
1400 },
1401 {
1402 "fhZip": "461084",
1403 "fhState": "Texas",
1404 "fhCity": "Wildwood",
1405 "fhAddr2": "",
1406 "fhAddr1": "275 Glen Street",
1407 "fhTaxID": "198339074",
1408 "fhEmail": "Gallegos@company.com",
1409 "mainfhNum": "OPTIQUE",
1410 "fhNum": "RODEOLOGY",
1411 "fhName": "Roman Pena"
1412 },
1413 {
1414 "fhZip": "167324",
1415 "fhState": "Maryland",
1416 "fhCity": "Tonopah",
1417 "fhAddr2": "",
1418 "fhAddr1": "184 Fillmore Avenue",
1419 "fhTaxID": "734071693",
1420 "fhEmail": "Ewing@company.com",
1421 "mainfhNum": "BOSTONIC",
1422 "fhNum": "SOPRANO",
1423 "fhName": "Chrystal Buckner"
1424 },
1425 {
1426 "fhZip": "409148",
1427 "fhState": "Wyoming",
1428 "fhCity": "Orick",
1429 "fhAddr2": "",
1430 "fhAddr1": "182 Baycliff Terrace",
1431 "fhTaxID": "571950629",
1432 "fhEmail": "Garrett@company.com",
1433 "mainfhNum": "LUMBREX",
1434 "fhNum": "COREPAN",
1435 "fhName": "Whitney Cooley"
1436 },
1437 {
1438 "fhZip": "318951",
1439 "fhState": "Nebraska",
1440 "fhCity": "Hillsboro",
1441 "fhAddr2": "",
1442 "fhAddr1": "973 Stryker Court",
1443 "fhTaxID": "404362529",
1444 "fhEmail": "Dolly@company.com",
1445 "mainfhNum": "ULTRIMAX",
1446 "fhNum": "DYNO",
1447 "fhName": "Dionne Hoffman"
1448 },
1449 {
1450 "fhZip": "626505",
1451 "fhState": "Missouri",
1452 "fhCity": "Convent",
1453 "fhAddr2": "",
1454 "fhAddr1": "273 Truxton Street",
1455 "fhTaxID": "670298313",
1456 "fhEmail": "Manuela@company.com",
1457 "mainfhNum": "INVENTURE",
1458 "fhNum": "GEEKOL",
1459 "fhName": "Graciela Fisher"
1460 },
1461 {
1462 "fhZip": "626189",
1463 "fhState": "Utah",
1464 "fhCity": "Courtland",
1465 "fhAddr2": "",
1466 "fhAddr1": "149 Williams Place",
1467 "fhTaxID": "535695628",
1468 "fhEmail": "Mullen@company.com",
1469 "mainfhNum": "DEEPENDS",
1470 "fhNum": "MITROC",
1471 "fhName": "Ingrid Aguilar"
1472 },
1473 {
1474 "fhZip": "397650",
1475 "fhState": "Puerto Rico",
1476 "fhCity": "Knowlton",
1477 "fhAddr2": "",
1478 "fhAddr1": "660 Baltic Street",
1479 "fhTaxID": "829224322",
1480 "fhEmail": "Figueroa@company.com",
1481 "mainfhNum": "GLOBOIL",
1482 "fhNum": "ISONUS",
1483 "fhName": "Bartlett Hull"
1484 },
1485 {
1486 "fhZip": "426132",
1487 "fhState": "District Of Columbia",
1488 "fhCity": "Cataract",
1489 "fhAddr2": "",
1490 "fhAddr1": "133 Fountain Avenue",
1491 "fhTaxID": "599008111",
1492 "fhEmail": "Dickerson@company.com",
1493 "mainfhNum": "ZILLA",
1494 "fhNum": "TRI@TRIBALOG",
1495 "fhName": "Holmes Gates"
1496 }
1497 ]
1498 }
1499 }
1500 },
1501 "required": true,
1502 "x-send-file-in-body": false
1503 },
1504 "responses": {
1505 "200": {
1506 "description": "",
1507 "headers": {}
1508 }
1509 },
1510 "deprecated": false
1511 }
1512 },
1513 "/api/funeralhomes/deleteall": {
1514 "delete": {
1515 "tags": ["FUNERAL HOMES"],
1516 "summary": "Funeral Homes Delete ALL",
1517 "description": "DELETE ALL",
1518 "operationId": "FuneralHomesDeleteALL",
1519 "parameters": [
1520 {
1521 "name": "Content-Type",
1522 "in": "header",
1523 "description": "",
1524 "required": true,
1525 "style": "simple",
1526 "schema": {
1527 "type": "string",
1528 "example": "application/json"
1529 }
1530 }
1531 ],
1532 "responses": {
1533 "200": {
1534 "description": "",
1535 "headers": {}
1536 }
1537 },
1538 "deprecated": false
1539 }
1540 },
1541 "/api/funeralhomes/list": {
1542 "get": {
1543 "tags": ["FUNERAL HOMES"],
1544 "summary": "Funeral Homes List",
1545 "operationId": "FuneralHomesList",
1546 "parameters": [
1547 {
1548 "name": "Content-Type",
1549 "in": "header",
1550 "description": "",
1551 "required": true,
1552 "style": "simple",
1553 "schema": {
1554 "type": "string",
1555 "example": "application/json"
1556 }
1557 }
1558 ],
1559 "responses": {
1560 "200": {
1561 "description": "",
1562 "headers": {}
1563 }
1564 },
1565 "deprecated": false
1566 }
1567 }
1568 },
1569 "components": {
1570 "schemas": {
1571 "GetAuthTokenRequest": {
1572 "title": "GetAuthTokenRequest",
1573 "required": ["apiKey", "clientSecret"],
1574 "type": "object",
1575 "properties": {
1576 "apiKey": {
1577 "type": "string"
1578 },
1579 "clientSecret": {
1580 "type": "string"
1581 }
1582 },
1583 "example": {
1584 "apiKey": "[API KEY]",
1585 "clientSecret": "[CLIENT SECRET]"
1586 }
1587 },
1588 "RequestSSOURIRequest": {
1589 "title": "RequestSSOURIRequest",
1590 "required": [
1591 "apiKey",
1592 "clientSecret",
1593 "grantRole",
1594 "polNum",
1595 "fhNum",
1596 "incUsers",
1597 "authorizedEmail"
1598 ],
1599 "type": "object",
1600 "properties": {
1601 "apiKey": {
1602 "type": "string"
1603 },
1604 "clientSecret": {
1605 "type": "string"
1606 },
1607 "grantRole": {
1608 "type": "string"
1609 },
1610 "polNum": {
1611 "type": "string"
1612 },
1613 "fhNum": {
1614 "type": "string"
1615 },
1616 "incUsers": {
1617 "type": "array",
1618 "items": {
1619 "type": "string"
1620 },
1621 "description": ""
1622 },
1623 "authorizedEmail": {
1624 "type": "string"
1625 }
1626 },
1627 "example": {
1628 "apiKey": "[apiKey]",
1629 "clientSecret": "[clientSecret]",
1630 "grantRole": "[FHD or CSR]",
1631 "polNum": "[polNum]",
1632 "fhNum": "[fhNum]",
1633 "incUsers": ["Array of email addresses"],
1634 "authorizedEmail": "[Email Address of Authorized Person To Be Granted]"
1635 }
1636 },
1637 "UPDATESINGLEAGENTREQUEST": {
1638 "title": "UPDATESINGLEAGENTREQUEST",
1639 "required": ["accountNumber", "routingNumber"],
1640 "type": "object",
1641 "properties": {
1642 "accountNumber": {
1643 "type": "string"
1644 },
1645 "routingNumber": {
1646 "type": "string"
1647 }
1648 },
1649 "example": {
1650 "accountNumber": "424234243",
1651 "routingNumber": "SFFAF"
1652 }
1653 },
1654 "AGENTSEARCHREQUEST": {
1655 "title": "AGENTSEARCHREQUEST",
1656 "required": ["page", "size", "sort", "order", "searchText"],
1657 "type": "object",
1658 "properties": {
1659 "page": {
1660 "type": "integer",
1661 "format": "int32"
1662 },
1663 "size": {
1664 "type": "integer",
1665 "format": "int32"
1666 },
1667 "sort": {
1668 "type": "string"
1669 },
1670 "order": {
1671 "type": "string"
1672 },
1673 "searchText": {
1674 "type": "string"
1675 }
1676 },
1677 "example": {
1678 "page": 1,
1679 "size": 20,
1680 "sort": "updatedAt",
1681 "order": "asc",
1682 "searchText": "{{searchText}}"
1683 }
1684 },
1685 "AgentsBatchUploadRequest": {
1686 "title": "AgentsBatchUploadRequest",
1687 "required": ["isFresh", "funeralHomes"],
1688 "type": "object",
1689 "properties": {
1690 "isFresh": {
1691 "type": "boolean"
1692 },
1693 "funeralHomes": {
1694 "type": "array",
1695 "items": {
1696 "$ref": "#/components/schemas/FuneralHome"
1697 },
1698 "description": ""
1699 }
1700 },
1701 "example": {
1702 "isFresh": true,
1703 "funeralHomes": [
1704 {
1705 "fhZip": "827110",
1706 "fhState": "Hawaii",
1707 "fhCity": "Newcastle",
1708 "fhAddr2": "",
1709 "fhAddr1": "350 Dare Court",
1710 "fhTaxID": "287476638",
1711 "fhEmail": "Dana@company.com",
1712 "mainfhNum": "LIQUICOM",
1713 "fhNum": "ONTAGENE",
1714 "fhName": "Leonard Murphy"
1715 },
1716 {
1717 "fhZip": "461084",
1718 "fhState": "Texas",
1719 "fhCity": "Wildwood",
1720 "fhAddr2": "",
1721 "fhAddr1": "275 Glen Street",
1722 "fhTaxID": "198339074",
1723 "fhEmail": "Gallegos@company.com",
1724 "mainfhNum": "OPTIQUE",
1725 "fhNum": "RODEOLOGY",
1726 "fhName": "Roman Pena"
1727 },
1728 {
1729 "fhZip": "167324",
1730 "fhState": "Maryland",
1731 "fhCity": "Tonopah",
1732 "fhAddr2": "",
1733 "fhAddr1": "184 Fillmore Avenue",
1734 "fhTaxID": "734071693",
1735 "fhEmail": "Ewing@company.com",
1736 "mainfhNum": "BOSTONIC",
1737 "fhNum": "SOPRANO",
1738 "fhName": "Chrystal Buckner"
1739 },
1740 {
1741 "fhZip": "409148",
1742 "fhState": "Wyoming",
1743 "fhCity": "Orick",
1744 "fhAddr2": "",
1745 "fhAddr1": "182 Baycliff Terrace",
1746 "fhTaxID": "571950629",
1747 "fhEmail": "Garrett@company.com",
1748 "mainfhNum": "LUMBREX",
1749 "fhNum": "COREPAN",
1750 "fhName": "Whitney Cooley"
1751 },
1752 {
1753 "fhZip": "318951",
1754 "fhState": "Nebraska",
1755 "fhCity": "Hillsboro",
1756 "fhAddr2": "",
1757 "fhAddr1": "973 Stryker Court",
1758 "fhTaxID": "404362529",
1759 "fhEmail": "Dolly@company.com",
1760 "mainfhNum": "ULTRIMAX",
1761 "fhNum": "DYNO",
1762 "fhName": "Dionne Hoffman"
1763 },
1764 {
1765 "fhZip": "626505",
1766 "fhState": "Missouri",
1767 "fhCity": "Convent",
1768 "fhAddr2": "",
1769 "fhAddr1": "273 Truxton Street",
1770 "fhTaxID": "670298313",
1771 "fhEmail": "Manuela@company.com",
1772 "mainfhNum": "INVENTURE",
1773 "fhNum": "GEEKOL",
1774 "fhName": "Graciela Fisher"
1775 },
1776 {
1777 "fhZip": "626189",
1778 "fhState": "Utah",
1779 "fhCity": "Courtland",
1780 "fhAddr2": "",
1781 "fhAddr1": "149 Williams Place",
1782 "fhTaxID": "535695628",
1783 "fhEmail": "Mullen@company.com",
1784 "mainfhNum": "DEEPENDS",
1785 "fhNum": "MITROC",
1786 "fhName": "Ingrid Aguilar"
1787 },
1788 {
1789 "fhZip": "397650",
1790 "fhState": "Puerto Rico",
1791 "fhCity": "Knowlton",
1792 "fhAddr2": "",
1793 "fhAddr1": "660 Baltic Street",
1794 "fhTaxID": "829224322",
1795 "fhEmail": "Figueroa@company.com",
1796 "mainfhNum": "GLOBOIL",
1797 "fhNum": "ISONUS",
1798 "fhName": "Bartlett Hull"
1799 },
1800 {
1801 "fhZip": "426132",
1802 "fhState": "District Of Columbia",
1803 "fhCity": "Cataract",
1804 "fhAddr2": "",
1805 "fhAddr1": "133 Fountain Avenue",
1806 "fhTaxID": "599008111",
1807 "fhEmail": "Dickerson@company.com",
1808 "mainfhNum": "ZILLA",
1809 "fhNum": "TRI@TRIBALOG",
1810 "fhName": "Holmes Gates"
1811 }
1812 ]
1813 }
1814 },
1815 "FuneralHome": {
1816 "title": "FuneralHome",
1817 "required": [
1818 "fhZip",
1819 "fhState",
1820 "fhCity",
1821 "fhAddr2",
1822 "fhAddr1",
1823 "fhTaxID",
1824 "fhEmail",
1825 "mainfhNum",
1826 "fhNum",
1827 "fhName"
1828 ],
1829 "type": "object",
1830 "properties": {
1831 "fhZip": {
1832 "type": "string"
1833 },
1834 "fhState": {
1835 "type": "string"
1836 },
1837 "fhCity": {
1838 "type": "string"
1839 },
1840 "fhAddr2": {
1841 "type": "string"
1842 },
1843 "fhAddr1": {
1844 "type": "string"
1845 },
1846 "fhTaxID": {
1847 "type": "string"
1848 },
1849 "fhEmail": {
1850 "type": "string"
1851 },
1852 "mainfhNum": {
1853 "type": "string"
1854 },
1855 "fhNum": {
1856 "type": "string"
1857 },
1858 "fhName": {
1859 "type": "string"
1860 }
1861 },
1862 "example": {
1863 "fhZip": "827110",
1864 "fhState": "Hawaii",
1865 "fhCity": "Newcastle",
1866 "fhAddr2": "",
1867 "fhAddr1": "350 Dare Court",
1868 "fhTaxID": "287476638",
1869 "fhEmail": "Dana@company.com",
1870 "mainfhNum": "LIQUICOM",
1871 "fhNum": "ONTAGENE",
1872 "fhName": "Leonard Murphy"
1873 }
1874 },
1875 "PoliciesBatchUploadRequest": {
1876 "title": "PoliciesBatchUploadRequest",
1877 "required": ["isFresh", "policies"],
1878 "type": "object",
1879 "properties": {
1880 "isFresh": {
1881 "type": "boolean"
1882 },
1883 "policies": {
1884 "type": "array",
1885 "items": {
1886 "$ref": "#/components/schemas/Policy"
1887 },
1888 "description": ""
1889 }
1890 },
1891 "example": {
1892 "isFresh": true,
1893 "policies": [
1894 {
1895 "claimQuote": "1463.96",
1896 "FHMainNum": "543582",
1897 "FHNum": "827344",
1898 "insuredLName": "Osborn",
1899 "insuredFName": "Dale",
1900 "insuredDOB": "Mon Jul 24 1978 21:38:50 GMT+0000 (UTC)",
1901 "datIssDate": "Wed Nov 02 2005 04:24:04 GMT+0000 (UTC)",
1902 "polProdCode": "741 AB262",
1903 "polContractReason": "OH",
1904 "polContractStatus": "F",
1905 "polNum": "759064920"
1906 },
1907 {
1908 "claimQuote": "2314.89",
1909 "FHMainNum": "894591",
1910 "FHNum": "777414",
1911 "insuredLName": "Calderon",
1912 "insuredFName": "Frank",
1913 "insuredDOB": "Thu Jan 24 1946 03:10:52 GMT+0000 (UTC)",
1914 "datIssDate": "Tue May 17 2005 00:56:45 GMT+0000 (UTC)",
1915 "polProdCode": "498 AB197",
1916 "polContractReason": "VT",
1917 "polContractStatus": "E",
1918 "polNum": "127488742"
1919 },
1920 {
1921 "claimQuote": "2982.11",
1922 "FHMainNum": "769177",
1923 "FHNum": "371874",
1924 "insuredLName": "Burns",
1925 "insuredFName": "Miranda",
1926 "insuredDOB": "Wed Mar 30 1960 12:42:20 GMT+0000 (UTC)",
1927 "datIssDate": "Mon Nov 25 2002 14:06:40 GMT+0000 (UTC)",
1928 "polProdCode": "955 YT297",
1929 "polContractReason": "WY",
1930 "polContractStatus": "B",
1931 "polNum": "270618819"
1932 },
1933 {
1934 "claimQuote": "1637.89",
1935 "FHMainNum": "297940",
1936 "FHNum": "340634",
1937 "insuredLName": "Mcfarland",
1938 "insuredFName": "Vickie",
1939 "insuredDOB": "Wed Feb 05 1975 18:37:29 GMT+0000 (UTC)",
1940 "datIssDate": "Fri Apr 23 2004 04:25:19 GMT+0000 (UTC)",
1941 "polProdCode": "992 DC177",
1942 "polContractReason": "IL",
1943 "polContractStatus": "B",
1944 "polNum": "121771836"
1945 },
1946 {
1947 "claimQuote": "1668.07",
1948 "FHMainNum": "392247",
1949 "FHNum": "615491",
1950 "insuredLName": "Callahan",
1951 "insuredFName": "Morrow",
1952 "insuredDOB": "Sat Jun 28 1975 16:07:46 GMT+0000 (UTC)",
1953 "datIssDate": "Mon Nov 28 2016 17:48:48 GMT+0000 (UTC)",
1954 "polProdCode": "822 GF238",
1955 "polContractReason": "HI",
1956 "polContractStatus": "D",
1957 "polNum": "483496940"
1958 },
1959 {
1960 "claimQuote": "1016.88",
1961 "FHMainNum": "680215",
1962 "FHNum": "757303",
1963 "insuredLName": "Burnett",
1964 "insuredFName": "Battle",
1965 "insuredDOB": "Sat May 24 1975 21:57:51 GMT+0000 (UTC)",
1966 "datIssDate": "Tue Mar 08 2011 02:36:53 GMT+0000 (UTC)",
1967 "polProdCode": "593 DC251",
1968 "polContractReason": "CO",
1969 "polContractStatus": "A",
1970 "polNum": "305725865"
1971 },
1972 {
1973 "claimQuote": "1185.18",
1974 "FHMainNum": "606284",
1975 "FHNum": "447954",
1976 "insuredLName": "Brooks",
1977 "insuredFName": "Caroline",
1978 "insuredDOB": "Tue May 10 1966 04:14:11 GMT+0000 (UTC)",
1979 "datIssDate": "Wed Feb 07 2007 15:56:44 GMT+0000 (UTC)",
1980 "polProdCode": "983 AB211",
1981 "polContractReason": "SC",
1982 "polContractStatus": "B",
1983 "polNum": "747525404"
1984 },
1985 {
1986 "claimQuote": "2814.76",
1987 "FHMainNum": "530481",
1988 "FHNum": "560727",
1989 "insuredLName": "Baird",
1990 "insuredFName": "Townsend",
1991 "insuredDOB": "Thu Oct 02 1980 12:36:21 GMT+0000 (UTC)",
1992 "datIssDate": "Mon Jun 04 2001 16:33:30 GMT+0000 (UTC)",
1993 "polProdCode": "313 YT247",
1994 "polContractReason": "OK",
1995 "polContractStatus": "A",
1996 "polNum": "115153339"
1997 },
1998 {
1999 "claimQuote": "2806.70",
2000 "FHMainNum": "154309",
2001 "FHNum": "429665",
2002 "insuredLName": "Jenkins",
2003 "insuredFName": "Gillespie",
2004 "insuredDOB": "Thu Mar 08 1962 05:29:37 GMT+0000 (UTC)",
2005 "datIssDate": "Wed Jul 23 2014 14:35:04 GMT+0000 (UTC)",
2006 "polProdCode": "443 GF214",
2007 "polContractReason": "OR",
2008 "polContractStatus": "C",
2009 "polNum": "551210142"
2010 },
2011 {
2012 "claimQuote": "2387.21",
2013 "FHMainNum": "775469",
2014 "FHNum": "167026",
2015 "insuredLName": "Bennett",
2016 "insuredFName": "Jenna",
2017 "insuredDOB": "Sun Jul 21 1996 10:49:25 GMT+0000 (UTC)",
2018 "datIssDate": "Mon Jan 01 2001 17:55:46 GMT+0000 (UTC)",
2019 "polProdCode": "828 AB287",
2020 "polContractReason": "MD",
2021 "polContractStatus": "E",
2022 "polNum": "387930624"
2023 },
2024 {
2025 "claimQuote": "2220.15",
2026 "FHMainNum": "383622",
2027 "FHNum": "712061",
2028 "insuredLName": "Harvey",
2029 "insuredFName": "Verna",
2030 "insuredDOB": "Tue Dec 10 1935 15:03:55 GMT+0000 (UTC)",
2031 "datIssDate": "Wed Jan 17 2007 17:36:36 GMT+0000 (UTC)",
2032 "polProdCode": "710 GF243",
2033 "polContractReason": "DC",
2034 "polContractStatus": "E",
2035 "polNum": "670759805"
2036 },
2037 {
2038 "claimQuote": "3666.54",
2039 "FHMainNum": "824789",
2040 "FHNum": "104109",
2041 "insuredLName": "Alford",
2042 "insuredFName": "Head",
2043 "insuredDOB": "Thu Jul 04 1974 00:06:49 GMT+0000 (UTC)",
2044 "datIssDate": "Fri Nov 04 2011 20:35:33 GMT+0000 (UTC)",
2045 "polProdCode": "654 AB110",
2046 "polContractReason": "NY",
2047 "polContractStatus": "B",
2048 "polNum": "795855008"
2049 },
2050 {
2051 "claimQuote": "166.60",
2052 "FHMainNum": "410917",
2053 "FHNum": "898618",
2054 "insuredLName": "Pickett",
2055 "insuredFName": "Graham",
2056 "insuredDOB": "Sun Jan 10 1932 06:04:13 GMT+0000 (UTC)",
2057 "datIssDate": "Tue Aug 17 1999 04:37:33 GMT+0000 (UTC)",
2058 "polProdCode": "43 GF278",
2059 "polContractReason": "AL",
2060 "polContractStatus": "F",
2061 "polNum": "116674209"
2062 }
2063 ]
2064 }
2065 },
2066 "Policy": {
2067 "title": "Policy",
2068 "required": [
2069 "claimQuote",
2070 "FHMainNum",
2071 "FHNum",
2072 "insuredLName",
2073 "insuredFName",
2074 "insuredDOB",
2075 "datIssDate",
2076 "polProdCode",
2077 "polContractReason",
2078 "polContractStatus",
2079 "polNum"
2080 ],
2081 "type": "object",
2082 "properties": {
2083 "claimQuote": {
2084 "type": "string"
2085 },
2086 "FHMainNum": {
2087 "type": "string"
2088 },
2089 "FHNum": {
2090 "type": "string"
2091 },
2092 "insuredLName": {
2093 "type": "string"
2094 },
2095 "insuredFName": {
2096 "type": "string"
2097 },
2098 "insuredDOB": {
2099 "type": "string"
2100 },
2101 "datIssDate": {
2102 "type": "string"
2103 },
2104 "polProdCode": {
2105 "type": "string"
2106 },
2107 "polContractReason": {
2108 "type": "string"
2109 },
2110 "polContractStatus": {
2111 "type": "string"
2112 },
2113 "polNum": {
2114 "type": "string"
2115 }
2116 },
2117 "example": {
2118 "claimQuote": "1463.96",
2119 "FHMainNum": "543582",
2120 "FHNum": "827344",
2121 "insuredLName": "Osborn",
2122 "insuredFName": "Dale",
2123 "insuredDOB": "Mon Jul 24 1978 21:38:50 GMT+0000 (UTC)",
2124 "datIssDate": "Wed Nov 02 2005 04:24:04 GMT+0000 (UTC)",
2125 "polProdCode": "741 AB262",
2126 "polContractReason": "OH",
2127 "polContractStatus": "F",
2128 "polNum": "759064920"
2129 }
2130 },
2131 "FinancialInfoRequest": {
2132 "title": "FinancialInfoRequest",
2133 "required": ["beginDate", "endDate"],
2134 "type": "object",
2135 "properties": {
2136 "beginDate": {
2137 "type": "string"
2138 },
2139 "endDate": {
2140 "type": "string"
2141 }
2142 },
2143 "example": {
2144 "beginDate": "05/21/2018",
2145 "endDate": "05/22/2018"
2146 }
2147 },
2148 "StreamfileRequest": {
2149 "title": "StreamfileRequest",
2150 "required": ["fileId"],
2151 "type": "object",
2152 "properties": {
2153 "fileId": {
2154 "type": "string"
2155 }
2156 },
2157 "example": {
2158 "fileId": "[FILE ID]"
2159 }
2160 },
2161 "PayoutDetailsByTransactionIDRequest": {
2162 "title": "PayoutDetailsByTransactionIDRequest",
2163 "required": ["transactionId"],
2164 "type": "object",
2165 "properties": {
2166 "transactionId": {
2167 "type": "string"
2168 }
2169 },
2170 "example": {
2171 "transactionId": "{{transactionId}}"
2172 }
2173 },
2174 "POSTRUNBATCHJOBREQUEST": {
2175 "title": "POSTRUNBATCHJOBREQUEST",
2176 "required": ["restoreId"],
2177 "type": "object",
2178 "properties": {
2179 "restoreId": {
2180 "type": "string"
2181 }
2182 },
2183 "example": {
2184 "restoreId": "Sep25th-0105"
2185 }
2186 },
2187 "PRERUNBATCHJOBREQUEST": {
2188 "title": "PRERUNBATCHJOBREQUEST",
2189 "required": ["restoreId"],
2190 "type": "object",
2191 "properties": {
2192 "restoreId": {
2193 "type": "string"
2194 }
2195 },
2196 "example": {
2197 "restoreId": "Sep25th-0105"
2198 }
2199 },
2200 "BeneficiaryBatchUploadRequest": {
2201 "title": "BeneficiaryBatchUploadRequest",
2202 "required": ["policies"],
2203 "type": "object",
2204 "properties": {
2205 "policies": {
2206 "type": "array",
2207 "items": {
2208 "$ref": "#/components/schemas/Policy1"
2209 },
2210 "description": ""
2211 }
2212 },
2213 "example": {
2214 "policies": [
2215 {
2216 "polNum": "0003021194",
2217 "Beneficiaries": [
2218 {
2219 "FirstName": "VANESSA",
2220 "LastName": "SMITH",
2221 "MiddleName": "",
2222 "SuffixName": "",
2223 "AddressLine1": "322 E SOUTHWINDS DR",
2224 "AddressLine2": "",
2225 "City": "NEWPORT",
2226 "PostalCode": "28570",
2227 "State": "NC",
2228 "PhoneNumber": "2528085413"
2229 },
2230 {
2231 "FirstName": "CHELSEA",
2232 "LastName": "HILSINGER",
2233 "MiddleName": "A",
2234 "SuffixName": "",
2235 "AddressLine1": "202 ANITA FORTE DR",
2236 "AddressLine2": "",
2237 "City": "CAPE CARTERET",
2238 "PostalCode": "28584",
2239 "State": "NC",
2240 "PhoneNumber": "2527257972"
2241 }
2242 ]
2243 }
2244 ]
2245 }
2246 },
2247 "Policy1": {
2248 "title": "Policy1",
2249 "required": ["polNum", "Beneficiaries"],
2250 "type": "object",
2251 "properties": {
2252 "polNum": {
2253 "type": "string"
2254 },
2255 "Beneficiaries": {
2256 "type": "array",
2257 "items": {
2258 "$ref": "#/components/schemas/Beneficiary"
2259 },
2260 "description": ""
2261 }
2262 },
2263 "example": {
2264 "polNum": "0003021194",
2265 "Beneficiaries": [
2266 {
2267 "FirstName": "VANESSA",
2268 "LastName": "SMITH",
2269 "MiddleName": "",
2270 "SuffixName": "",
2271 "AddressLine1": "322 E SOUTHWINDS DR",
2272 "AddressLine2": "",
2273 "City": "NEWPORT",
2274 "PostalCode": "28570",
2275 "State": "NC",
2276 "PhoneNumber": "2528085413"
2277 },
2278 {
2279 "FirstName": "CHELSEA",
2280 "LastName": "HILSINGER",
2281 "MiddleName": "A",
2282 "SuffixName": "",
2283 "AddressLine1": "202 ANITA FORTE DR",
2284 "AddressLine2": "",
2285 "City": "CAPE CARTERET",
2286 "PostalCode": "28584",
2287 "State": "NC",
2288 "PhoneNumber": "2527257972"
2289 }
2290 ]
2291 }
2292 },
2293 "Beneficiary": {
2294 "title": "Beneficiary",
2295 "required": [
2296 "FirstName",
2297 "LastName",
2298 "MiddleName",
2299 "SuffixName",
2300 "AddressLine1",
2301 "AddressLine2",
2302 "City",
2303 "PostalCode",
2304 "State",
2305 "PhoneNumber"
2306 ],
2307 "type": "object",
2308 "properties": {
2309 "FirstName": {
2310 "type": "string"
2311 },
2312 "LastName": {
2313 "type": "string"
2314 },
2315 "MiddleName": {
2316 "type": "string"
2317 },
2318 "SuffixName": {
2319 "type": "string"
2320 },
2321 "AddressLine1": {
2322 "type": "string"
2323 },
2324 "AddressLine2": {
2325 "type": "string"
2326 },
2327 "City": {
2328 "type": "string"
2329 },
2330 "PostalCode": {
2331 "type": "string"
2332 },
2333 "State": {
2334 "type": "string"
2335 },
2336 "PhoneNumber": {
2337 "type": "string"
2338 }
2339 },
2340 "example": {
2341 "FirstName": "VANESSA",
2342 "LastName": "SMITH",
2343 "MiddleName": "",
2344 "SuffixName": "",
2345 "AddressLine1": "322 E SOUTHWINDS DR",
2346 "AddressLine2": "",
2347 "City": "NEWPORT",
2348 "PostalCode": "28570",
2349 "State": "NC",
2350 "PhoneNumber": "2528085413"
2351 }
2352 },
2353 "UPDATESINGLEDEDICATEDBENEREQUEST": {
2354 "title": "UPDATESINGLEDEDICATEDBENEREQUEST",
2355 "required": ["accountNumber", "routingNumber"],
2356 "type": "object",
2357 "properties": {
2358 "accountNumber": {
2359 "type": "string"
2360 },
2361 "routingNumber": {
2362 "type": "string"
2363 }
2364 },
2365 "example": {
2366 "accountNumber": "424234243",
2367 "routingNumber": "SFFAF"
2368 }
2369 },
2370 "DEDICATEDBENESEARCHREQUEST": {
2371 "title": "DEDICATEDBENESEARCHREQUEST",
2372 "required": ["page", "size", "sort", "order", "searchText"],
2373 "type": "object",
2374 "properties": {
2375 "page": {
2376 "type": "integer",
2377 "format": "int32"
2378 },
2379 "size": {
2380 "type": "integer",
2381 "format": "int32"
2382 },
2383 "sort": {
2384 "type": "string"
2385 },
2386 "order": {
2387 "type": "string"
2388 },
2389 "searchText": {
2390 "type": "string"
2391 }
2392 },
2393 "example": {
2394 "page": 1,
2395 "size": 20,
2396 "sort": "updatedAt",
2397 "order": "asc",
2398 "searchText": "{{searchText}}"
2399 }
2400 },
2401 "DEDICATEDBENEBATCHUPLOADREQUEST": {
2402 "title": "DEDICATEDBENEBATCHUPLOADREQUEST",
2403 "required": ["isFresh", "funeralHomes"],
2404 "type": "object",
2405 "properties": {
2406 "isFresh": {
2407 "type": "boolean"
2408 },
2409 "funeralHomes": {
2410 "type": "array",
2411 "items": {
2412 "$ref": "#/components/schemas/FuneralHome"
2413 },
2414 "description": ""
2415 }
2416 },
2417 "example": {
2418 "isFresh": true,
2419 "funeralHomes": [
2420 {
2421 "fhZip": "827110",
2422 "fhState": "Hawaii",
2423 "fhCity": "Newcastle",
2424 "fhAddr2": "",
2425 "fhAddr1": "350 Dare Court",
2426 "fhTaxID": "287476638",
2427 "fhEmail": "Dana@company.com",
2428 "mainfhNum": "LIQUICOM",
2429 "fhNum": "ONTAGENE",
2430 "fhName": "Leonard Murphy"
2431 },
2432 {
2433 "fhZip": "461084",
2434 "fhState": "Texas",
2435 "fhCity": "Wildwood",
2436 "fhAddr2": "",
2437 "fhAddr1": "275 Glen Street",
2438 "fhTaxID": "198339074",
2439 "fhEmail": "Gallegos@company.com",
2440 "mainfhNum": "OPTIQUE",
2441 "fhNum": "RODEOLOGY",
2442 "fhName": "Roman Pena"
2443 },
2444 {
2445 "fhZip": "167324",
2446 "fhState": "Maryland",
2447 "fhCity": "Tonopah",
2448 "fhAddr2": "",
2449 "fhAddr1": "184 Fillmore Avenue",
2450 "fhTaxID": "734071693",
2451 "fhEmail": "Ewing@company.com",
2452 "mainfhNum": "BOSTONIC",
2453 "fhNum": "SOPRANO",
2454 "fhName": "Chrystal Buckner"
2455 },
2456 {
2457 "fhZip": "409148",
2458 "fhState": "Wyoming",
2459 "fhCity": "Orick",
2460 "fhAddr2": "",
2461 "fhAddr1": "182 Baycliff Terrace",
2462 "fhTaxID": "571950629",
2463 "fhEmail": "Garrett@company.com",
2464 "mainfhNum": "LUMBREX",
2465 "fhNum": "COREPAN",
2466 "fhName": "Whitney Cooley"
2467 },
2468 {
2469 "fhZip": "318951",
2470 "fhState": "Nebraska",
2471 "fhCity": "Hillsboro",
2472 "fhAddr2": "",
2473 "fhAddr1": "973 Stryker Court",
2474 "fhTaxID": "404362529",
2475 "fhEmail": "Dolly@company.com",
2476 "mainfhNum": "ULTRIMAX",
2477 "fhNum": "DYNO",
2478 "fhName": "Dionne Hoffman"
2479 },
2480 {
2481 "fhZip": "626505",
2482 "fhState": "Missouri",
2483 "fhCity": "Convent",
2484 "fhAddr2": "",
2485 "fhAddr1": "273 Truxton Street",
2486 "fhTaxID": "670298313",
2487 "fhEmail": "Manuela@company.com",
2488 "mainfhNum": "INVENTURE",
2489 "fhNum": "GEEKOL",
2490 "fhName": "Graciela Fisher"
2491 },
2492 {
2493 "fhZip": "626189",
2494 "fhState": "Utah",
2495 "fhCity": "Courtland",
2496 "fhAddr2": "",
2497 "fhAddr1": "149 Williams Place",
2498 "fhTaxID": "535695628",
2499 "fhEmail": "Mullen@company.com",
2500 "mainfhNum": "DEEPENDS",
2501 "fhNum": "MITROC",
2502 "fhName": "Ingrid Aguilar"
2503 },
2504 {
2505 "fhZip": "397650",
2506 "fhState": "Puerto Rico",
2507 "fhCity": "Knowlton",
2508 "fhAddr2": "",
2509 "fhAddr1": "660 Baltic Street",
2510 "fhTaxID": "829224322",
2511 "fhEmail": "Figueroa@company.com",
2512 "mainfhNum": "GLOBOIL",
2513 "fhNum": "ISONUS",
2514 "fhName": "Bartlett Hull"
2515 },
2516 {
2517 "fhZip": "426132",
2518 "fhState": "District Of Columbia",
2519 "fhCity": "Cataract",
2520 "fhAddr2": "",
2521 "fhAddr1": "133 Fountain Avenue",
2522 "fhTaxID": "599008111",
2523 "fhEmail": "Dickerson@company.com",
2524 "mainfhNum": "ZILLA",
2525 "fhNum": "TRI@TRIBALOG",
2526 "fhName": "Holmes Gates"
2527 }
2528 ]
2529 }
2530 },
2531 "UPDATESINGLEFHREQUEST": {
2532 "title": "UPDATESINGLEFHREQUEST",
2533 "required": ["accountNumber", "routingNumber"],
2534 "type": "object",
2535 "properties": {
2536 "accountNumber": {
2537 "type": "string"
2538 },
2539 "routingNumber": {
2540 "type": "string"
2541 }
2542 },
2543 "example": {
2544 "accountNumber": "424234243",
2545 "routingNumber": "SFFAF"
2546 }
2547 },
2548 "FHSEARCHREQUEST": {
2549 "title": "FHSEARCHREQUEST",
2550 "required": ["page", "size", "sort", "order", "searchText"],
2551 "type": "object",
2552 "properties": {
2553 "page": {
2554 "type": "integer",
2555 "format": "int32"
2556 },
2557 "size": {
2558 "type": "integer",
2559 "format": "int32"
2560 },
2561 "sort": {
2562 "type": "string"
2563 },
2564 "order": {
2565 "type": "string"
2566 },
2567 "searchText": {
2568 "type": "string"
2569 }
2570 },
2571 "example": {
2572 "page": 1,
2573 "size": 20,
2574 "sort": "updatedAt",
2575 "order": "asc",
2576 "searchText": "{{searchText}}"
2577 }
2578 },
2579 "FuneralHomesBatchUploadRequest": {
2580 "title": "FuneralHomesBatchUploadRequest",
2581 "required": ["isFresh", "funeralHomes"],
2582 "type": "object",
2583 "properties": {
2584 "isFresh": {
2585 "type": "boolean"
2586 },
2587 "funeralHomes": {
2588 "type": "array",
2589 "items": {
2590 "$ref": "#/components/schemas/FuneralHome"
2591 },
2592 "description": ""
2593 }
2594 },
2595 "example": {
2596 "isFresh": true,
2597 "funeralHomes": [
2598 {
2599 "fhZip": "827110",
2600 "fhState": "Hawaii",
2601 "fhCity": "Newcastle",
2602 "fhAddr2": "",
2603 "fhAddr1": "350 Dare Court",
2604 "fhTaxID": "287476638",
2605 "fhEmail": "Dana@company.com",
2606 "mainfhNum": "LIQUICOM",
2607 "fhNum": "ONTAGENE",
2608 "fhName": "Leonard Murphy"
2609 },
2610 {
2611 "fhZip": "461084",
2612 "fhState": "Texas",
2613 "fhCity": "Wildwood",
2614 "fhAddr2": "",
2615 "fhAddr1": "275 Glen Street",
2616 "fhTaxID": "198339074",
2617 "fhEmail": "Gallegos@company.com",
2618 "mainfhNum": "OPTIQUE",
2619 "fhNum": "RODEOLOGY",
2620 "fhName": "Roman Pena"
2621 },
2622 {
2623 "fhZip": "167324",
2624 "fhState": "Maryland",
2625 "fhCity": "Tonopah",
2626 "fhAddr2": "",
2627 "fhAddr1": "184 Fillmore Avenue",
2628 "fhTaxID": "734071693",
2629 "fhEmail": "Ewing@company.com",
2630 "mainfhNum": "BOSTONIC",
2631 "fhNum": "SOPRANO",
2632 "fhName": "Chrystal Buckner"
2633 },
2634 {
2635 "fhZip": "409148",
2636 "fhState": "Wyoming",
2637 "fhCity": "Orick",
2638 "fhAddr2": "",
2639 "fhAddr1": "182 Baycliff Terrace",
2640 "fhTaxID": "571950629",
2641 "fhEmail": "Garrett@company.com",
2642 "mainfhNum": "LUMBREX",
2643 "fhNum": "COREPAN",
2644 "fhName": "Whitney Cooley"
2645 },
2646 {
2647 "fhZip": "318951",
2648 "fhState": "Nebraska",
2649 "fhCity": "Hillsboro",
2650 "fhAddr2": "",
2651 "fhAddr1": "973 Stryker Court",
2652 "fhTaxID": "404362529",
2653 "fhEmail": "Dolly@company.com",
2654 "mainfhNum": "ULTRIMAX",
2655 "fhNum": "DYNO",
2656 "fhName": "Dionne Hoffman"
2657 },
2658 {
2659 "fhZip": "626505",
2660 "fhState": "Missouri",
2661 "fhCity": "Convent",
2662 "fhAddr2": "",
2663 "fhAddr1": "273 Truxton Street",
2664 "fhTaxID": "670298313",
2665 "fhEmail": "Manuela@company.com",
2666 "mainfhNum": "INVENTURE",
2667 "fhNum": "GEEKOL",
2668 "fhName": "Graciela Fisher"
2669 },
2670 {
2671 "fhZip": "626189",
2672 "fhState": "Utah",
2673 "fhCity": "Courtland",
2674 "fhAddr2": "",
2675 "fhAddr1": "149 Williams Place",
2676 "fhTaxID": "535695628",
2677 "fhEmail": "Mullen@company.com",
2678 "mainfhNum": "DEEPENDS",
2679 "fhNum": "MITROC",
2680 "fhName": "Ingrid Aguilar"
2681 },
2682 {
2683 "fhZip": "397650",
2684 "fhState": "Puerto Rico",
2685 "fhCity": "Knowlton",
2686 "fhAddr2": "",
2687 "fhAddr1": "660 Baltic Street",
2688 "fhTaxID": "829224322",
2689 "fhEmail": "Figueroa@company.com",
2690 "mainfhNum": "GLOBOIL",
2691 "fhNum": "ISONUS",
2692 "fhName": "Bartlett Hull"
2693 },
2694 {
2695 "fhZip": "426132",
2696 "fhState": "District Of Columbia",
2697 "fhCity": "Cataract",
2698 "fhAddr2": "",
2699 "fhAddr1": "133 Fountain Avenue",
2700 "fhTaxID": "599008111",
2701 "fhEmail": "Dickerson@company.com",
2702 "mainfhNum": "ZILLA",
2703 "fhNum": "TRI@TRIBALOG",
2704 "fhName": "Holmes Gates"
2705 }
2706 ]
2707 }
2708 }
2709 },
2710 "securitySchemes": {
2711 "httpBearer": {
2712 "type": "http",
2713 "scheme": "bearer"
2714 }
2715 }
2716 },
2717 "security": [
2718 {
2719 "httpBearer": []
2720 }
2721 ],
2722 "tags": [
2723 {
2724 "name": "AUTHORIZATION"
2725 },
2726 {
2727 "name": "AGENTS"
2728 },
2729 {
2730 "name": "POLICIES"
2731 },
2732 {
2733 "name": "BATCH RUN"
2734 },
2735 {
2736 "name": "BENEFICIARIES",
2737 "description": "Please follow the sample payload data and create your payload accordingly. The only mapper in this case is by policy number. So make sure you provide that correctly"
2738 },
2739 {
2740 "name": "DEDICATED BENEFICIARIES",
2741 "description": "These are dedicated beneficiaries who process claims on behalf of an organization on regular basis. These can be a estate or an agent or both. "
2742 },
2743 {
2744 "name": "FUNERAL HOMES"
2745 }
2746 ]
2747}
2748