{ "openapi": "3.0.0", "servers": [ { "url": "https://uw-data-services.lp.prod.aws.glic.com" } ], "tags": [ { "name": "Credit", "description": "TRLCreditController" }, { "name": "v1" }, { "name": "MVR", "description": "MVRController" }, { "name": "UWExtData", "description": "UWExternalDataController" }, { "name": "MIB", "description": "MIBController" }, { "name": "LABPiQ", "description": "LabPiQController" }, { "name": "FACEXCHANGE", "description": "FacExchangeController" }, { "name": "HAPI" }, { "name": "Human API", "description": "HAPIController" }, { "name": "IRIX", "description": "IRIXController" }, { "name": "apphealth", "description": "AppHealthController" }, { "name": "ExistingInsRequest" }, { "name": "UWData", "description": "UWDataController" }, { "name": "InstantId", "description": "InstantIdController" } ], "paths": { "/v1/uwdata/mvr/mvr-inquiry": { "post": { "tags": [ "MVR" ], "summary": "Mvr Inquiry Request", "operationId": "verifyConsumerMvr", "description": "Mvr Inquiry Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 } } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "mvr_request_data": { "client": { "first_name": "John", "middle_name": "", "last_name": "Mellon", "date_of_birth": "1993-03-24", "tax_id": "123456789", "driver_license": { "parameterList": [ { "value": "", "name": "" } ], "history": "CURRENT", "type": "COMMERCIAL", "state": "", "number": "", "drivingExperienceLength": 0, "status": "" } } }, "data_validity_period_in_days": -1, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "mvr_request_data": { "title": "Mvr Request Data", "type": "object", "properties": { "client": { "title": "Client", "required": [ "date_of_birth", "first_name", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "driver_license": { "title": "DriversLicenseType", "type": "object", "properties": { "parameterList": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" } } } }, "history": { "type": "string", "enum": [ "CURRENT", "PRIOR" ] }, "type": { "type": "string", "enum": [ "COMMERCIAL", "PERSONAL" ] }, "state": { "type": "string" }, "number": { "type": "string" }, "drivingExperienceLength": { "type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "status": { "type": "string" } }, "description": "DriversLicenseType of the applicant" } }, "description": "Client Data" } }, "description": "Mvr Request Data" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/uwdata/irix/saveimagedoc": { "post": { "tags": [ "IRIX" ], "summary": "Save Image Doc", "operationId": "saveImageDoc_1", "description": "This method is going to be called by ILGC Application by passing order id and image information(key value pair)", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "cuw_order_id": 0, "key_name_key_value": [ { "key_name": "", "key_value": "" } ], "vendor_tracking_id": "", "app_case_id": "", "policy_number": "", "source_form_num": "" } } }, "schema": { "required": [ "cuw_order_id", "key_name_key_value" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "cuw_order_id": { "title": "CUW Order Id", "type": "integer", "description": "CUW Order Id", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "key_name_key_value": { "title": "Key Name Key Value", "type": "array", "description": "Key Name Key Value", "items": { "title": "Key Name Key Value", "required": [ "key_name", "key_value" ], "type": "object", "properties": { "key_name": { "title": "Key Name", "maxLength": 50, "minLength": 1, "type": "string", "description": "Order Key Name" }, "key_value": { "title": "Key Value", "maxLength": 100, "minLength": 1, "type": "string", "description": "Order Key Value" } }, "description": "Key Name Key Value" } }, "vendor_tracking_id": { "title": "Vendor Tracking Id", "type": "string", "description": "Vendor Tracking Id" }, "app_case_id": { "title": "Galaxy Case Id", "type": "string", "description": "Galaxy Case Id" }, "policy_number": { "title": "Policy Number", "type": "string", "description": "Policy Number" }, "source_form_num": { "title": "Form Number", "type": "string", "description": "Form Number" } } } } }, "description": "" } } }, "/v1/uwdata/irix/gettemporderurl": { "post": { "tags": [ "IRIX" ], "summary": "Get Temp Order URL By ORDER ID", "operationId": "RetrieveIRIXTempOrderURL", "description": "Search for Centralized Underwriting data based on the unique underwriting Id.", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "order_id": 0, "milliman_page_and_screen_options": { "display_page": "ORDER DETAIL", "view_screen_sort": "BY DRUG", "view_screen_view_option": "SUMMARIES", "table_sort_column": "BRAND NAME", "table_sort_order": "SUMMARIES" }, "milliman_user_info": { "user_id": "", "user_first_name": "", "user_last_name": "" } } } }, "schema": { "required": [ "order_id" ], "type": "object", "properties": { "order_id": { "title": "orderId", "type": "integer", "description": "OrderId", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "milliman_page_and_screen_options": { "title": "millimanPageAndScreenOptions", "type": "object", "properties": { "display_page": { "title": "displayPage", "type": "string", "description": "Defines the order page you want to be rendered, can be any of the above enumerated values.", "enum": [ "ORDER DETAIL", "DRUG", "PHARMACY", "DOCTOR", "SURVEY", "DEMOGRAPHIC", "MIB", "MVR" ] }, "view_screen_sort": { "title": "viewScreenSort", "type": "string", "description": "If the DisplayPage element contains ORDER DETAIL, then this element is responsible for determining if the view is by drug or by indication", "enum": [ "BY DRUG", "BY INDICATION" ] }, "view_screen_view_option": { "title": "viewScreenViewOption", "type": "string", "description": "If the DisplayPage element contains ORDER DETAIL, then this element is responsible for determining if the view contains summary information only, or summary with additional drug details, or show all which also shows doctor information.", "enum": [ "SUMMARIES", "DRUGS", "SHOW ALL" ] }, "table_sort_column": { "title": "tableSortColumn", "type": "string", "description": "If the DisplayPage element contains DRUG, then this element is responsible for determining the rendered page�s sort column.", "enum": [ "BRAND NAME", "GENERIC NAME", "PRIORITY", "FILL DATE", "DOCTOR", "PHARMACY", "QUANTITY", "DAYS SUPPLY" ] }, "table_sort_order": { "title": "tableSortOrder", "type": "string", "description": "If the DisplayPage element contains DRUG, then this element is responsible for determining the rendered page�s sort direction.", "enum": [ "SUMMARIES", "DRUGS", "SHOW ALL" ] } }, "description": "Milliman page and screen options" }, "milliman_user_info": { "title": "millimanUserInfo", "type": "object", "properties": { "user_id": { "title": "userId", "type": "string", "description": "User Id of the logged in user" }, "user_first_name": { "title": "userFirstName", "type": "string", "description": "First Name of the logged in user" }, "user_last_name": { "title": "userLastName", "type": "string", "description": "Last Name of the logged in user" } }, "description": "The UserInfo element and the three sub-elements track who the user is who requested to view the order. The credential values stored in these elements are based on the identity of the individual within the client system. They are simply used by IntelliScript to log the identity of the individual for tracking purposes." } } } } }, "description": "" } } }, "/v1/uwdata/facexchange/quotesubmitstatus": { "post": { "tags": [ "IRIX" ], "summary": "Retrieve FacExchangeSubmitCase Status", "operationId": "retrieveQuoteSubmissionStatus", "description": "Retrieve FacExchange Order", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "order_id": 0, "data_validity_period_in_days": -1, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "order_id", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "order_id": { "title": "OrderId", "type": "integer", "description": "OrderId", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/uwdata/irix/retrieveorder": { "post": { "tags": [ "IRIX" ], "summary": "Retrieve IRIX Order", "operationId": "retrieveOrder", "description": "Retrieve IRIX Order", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "order_id": 0, "data_validity_period_in_days": -1, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "order_id", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "order_id": { "title": "OrderId", "type": "integer", "description": "OrderId", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/uwdata/irix/submitorder": { "post": { "tags": [ "IRIX" ], "summary": "Submit Rx Request", "operationId": "submitRxRequest", "description": "Submit Rx Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "order_id": 0, "order_reused": true } } }, "schema": { "required": [ "order_id", "order_reused" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "order_id": { "type": "integer", "description": "Order Key Id", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "order_reused": { "type": "boolean", "description": "Order reused indicator to indicate whether it is an existing order or new order" } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "client": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "tax_id": "123456789", "gender": "M", "date_of_birth": "1993-03-24" }, "order_request_data": { "state": "NY", "zip_code": "", "zip_code2": "", "zip_code3": "", "zip_code4": "", "order_reference_number": "", "alternate_order_reference_number": "", "signature_type": "WET", "order_medical_data": "Yes" }, "data_validity_period_in_days": -1, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "client": { "title": "IRIXClient", "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" } }, "description": "Client details" }, "order_request_data": { "title": "OrderRequestData", "required": [ "order_reference_number", "signature_type" ], "type": "object", "properties": { "state": { "title": "State", "maxLength": 2, "type": "string", "description": "Two-letter state abbreviation for the applicant�s home state" }, "zip_code": { "title": "ZipCode", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code2": { "title": "ZipCode2", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code3": { "title": "ZipCode3", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code4": { "title": "ZipCode4", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "order_reference_number": { "title": "OrderReference", "maxLength": 15, "minLength": 1, "type": "string", "description": "Client supplied field typically containing a unique value representing the case. A policy number, order number or case number is commonly used to populate this field" }, "alternate_order_reference_number": { "title": "AlternateOrderReference", "maxLength": 50, "type": "string", "description": "Additional client supplied field typically used to identify the case. Although this field is not required by the schema, product accounts can be configured to require it. In addition, some setups will validate the provided values against an approved list. This is generally configured upon client request." }, "signature_type": { "title": "SignatureType", "type": "string", "description": "Although not required by the schema, this field is required for all new implementations. Valid values are: 1.WET 2.ESIG and 3.ORAL", "enum": [ "WET", "ESIG", "ORAL" ] }, "order_medical_data": { "title": "OrderMedicalData", "type": "string", "description": "Although not required by the schema, this field is Optional for all new implementations. Valid values are: Yes, No", "enum": [ "Yes", "No" ] } }, "description": "Request data needed for IRIX Submit order" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/uwdata/updateUwData": { "post": { "tags": [ "UWData" ], "summary": "Updates the UW data record", "operationId": "updateUwData", "description": "Updates the UW Blob & Filenet DocId", "responses": { "202": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "406": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "client": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "tax_id": "123456789", "client_type": "", "gender": "M", "date_of_birth": "1993-03-24", "maritial_status": "", "email": "", "comments": "", "client_key_id": 0, "client_sub_key_id": 0 }, "app_data": { "ref_number": "", "ref_type": "" }, "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 }, "app_case_id": "", "policy_number": "" } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "client": { "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "client_type": { "type": "string" }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "maritial_status": { "title": "maritialStatus", "type": "string", "description": "Marital Status" }, "email": { "title": "email", "type": "string", "description": "email" }, "comments": { "title": "comments", "type": "string", "description": "comments" }, "client_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "client_sub_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } } }, "app_data": { "type": "object", "properties": { "ref_number": { "type": "string" }, "ref_type": { "type": "string" } } }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" }, "app_case_id": { "type": "string" }, "policy_number": { "type": "string" } } } } }, "description": "" } } }, "/v1/uwdata/saveimagedoc": { "post": { "tags": [ "UWData" ], "summary": "Save Image Doc", "operationId": "saveImageDoc", "description": "${uwdata.get.orderdatabytrackid.notes}", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "cuw_order_id": 0, "key_name_key_value": [ { "key_name": "", "key_value": "" } ], "vendor_tracking_id": "", "app_case_id": "", "policy_number": "", "source_form_num": "" } } }, "schema": { "required": [ "cuw_order_id", "key_name_key_value" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "cuw_order_id": { "title": "CUW Order Id", "type": "integer", "description": "CUW Order Id", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "key_name_key_value": { "title": "Key Name Key Value", "type": "array", "description": "Key Name Key Value", "items": { "title": "Key Name Key Value", "required": [ "key_name", "key_value" ], "type": "object", "properties": { "key_name": { "title": "Key Name", "maxLength": 50, "minLength": 1, "type": "string", "description": "Order Key Name" }, "key_value": { "title": "Key Value", "maxLength": 100, "minLength": 1, "type": "string", "description": "Order Key Value" } }, "description": "Key Name Key Value" } }, "vendor_tracking_id": { "title": "Vendor Tracking Id", "type": "string", "description": "Vendor Tracking Id" }, "app_case_id": { "title": "Galaxy Case Id", "type": "string", "description": "Galaxy Case Id" }, "policy_number": { "title": "Policy Number", "type": "string", "description": "Policy Number" }, "source_form_num": { "title": "Form Number", "type": "string", "description": "Form Number" } } } } }, "description": "" } } }, "/v1/uwdata/uwext/uwdatabyid/{uwDataId}": { "get": { "tags": [ "UWData" ], "summary": "Get Underwriting Data By UW Data ID Externally", "parameters": [ { "name": "uwDataId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } } ], "operationId": "getUWDataById_1", "description": "Search for Centralized Underwriting data based on the unique underwriting Id.", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } } } }, "/v1/uwdata/saveUWDataWithVendorTrackingId": { "post": { "tags": [ "UWData" ], "operationId": "saveUWDataWithVendorTrackingId", "description": " ", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 }, "policy_number": "", "vendor_tracking_id": "" } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" }, "policy_number": { "type": "string" }, "vendor_tracking_id": { "type": "string" } } } } }, "description": "" } } }, "/v1/uwdata/": { "post": { "tags": [ "UWData" ], "summary": "CreateUWData", "operationId": "createUWData", "description": "Create underwriting data into the Centralized Underwriting database.", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "client": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "tax_id": "123456789", "client_type": "", "gender": "M", "date_of_birth": "1993-03-24", "maritial_status": "", "email": "", "comments": "", "client_key_id": 0, "client_sub_key_id": 0 }, "app_data": { "ref_number": "", "ref_type": "" }, "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 }, "app_case_id": "", "policy_number": "" } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "client": { "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "client_type": { "type": "string" }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "maritial_status": { "title": "maritialStatus", "type": "string", "description": "Marital Status" }, "email": { "title": "email", "type": "string", "description": "email" }, "comments": { "title": "comments", "type": "string", "description": "comments" }, "client_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "client_sub_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } } }, "app_data": { "type": "object", "properties": { "ref_number": { "type": "string" }, "ref_type": { "type": "string" } } }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" }, "app_case_id": { "type": "string" }, "policy_number": { "type": "string" } } } } }, "description": "" } } }, "/v1/uwdata/getClientData": { "post": { "tags": [ "UWData" ], "summary": "Get Underwriting Data By transRefGuid", "operationId": "getClientData", "description": "${uwdata.get.clientdatabytransRefGuid.notes}", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" } } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" } } } } }, "description": "" } } }, "/v1/uwdata/orderdatabytrackingid/{vendorTrackingId}": { "get": { "tags": [ "UWData" ], "summary": "Get Underwriting Data By UW Data ID", "parameters": [ { "name": "vendorTrackingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "operationId": "getOrderDetailsByTrackingId", "description": "${uwdata.get.orderdatabytrackid.notes}", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } } } }, "/v1/uwdata/{uwDataId}": { "get": { "tags": [ "UWData" ], "summary": "Get Underwriting Data By UW Data ID", "parameters": [ { "name": "uwDataId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } } ], "operationId": "getUWDataById", "description": "Search for Centralized Underwriting data based on the unique underwriting Id.", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" } } } }, "/v1/uwdata/docidsbydataid/{uwdataid}": { "get": { "tags": [ "UWData" ], "summary": "Get Document Ids", "parameters": [ { "name": "uwdataid", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } } ], "operationId": "getDocidsByDataid", "description": "Get document ids for given UW Data Id", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": {} } }, "schema": {} } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } } } }, "/v1/apphealth/": { "get": { "tags": [ "apphealth" ], "summary": "Get Application Health", "parameters": [ { "name": "vendorTest", "in": "query", "required": false, "schema": { "type": "string" } } ], "operationId": "getApplicationHealth", "description": "Health Check monitoring service", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "appStatusCd": "", "appStatusDesc": "", "dbStatus": "", "appBuildVersion": "", "appCommitHash": "", "envProperites": "", "vendorConnectionResponses": [ { "vendorName": "", "vendorUrl": "", "isSuccess": true, "connectionInformation": "", "errorResponse": "" } ] } } }, "schema": { "type": "object", "properties": { "appStatusCd": { "type": "string" }, "appStatusDesc": { "type": "string" }, "dbStatus": { "type": "string" }, "appBuildVersion": { "type": "string" }, "appCommitHash": { "type": "string" }, "envProperites": { "type": "string" }, "vendorConnectionResponses": { "type": "array", "items": { "type": "object", "properties": { "vendorName": { "type": "string" }, "vendorUrl": { "type": "string" }, "isSuccess": { "type": "boolean" }, "connectionInformation": { "type": "string" }, "errorResponse": { "type": "string" } } } } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } } } }, "/v1/uwdata/facexchange/submitcase": { "post": { "tags": [ "FACEXCHANGE" ], "summary": "Submit FacExchange Request", "operationId": "submitFacExRequest", "description": "Submit FacExchange Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "order_id": 0, "order_status": "INITIATED", "external_tracking_id": "", "failure_reason": "", "transaction_receipt_id": "", "order_reused": true } } }, "schema": { "required": [ "order_id", "order_reused" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "order_id": { "type": "integer", "description": "Order Key Id", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "external_tracking_id": { "type": "string" }, "failure_reason": { "type": "string" }, "transaction_receipt_id": { "type": "string" }, "order_reused": { "type": "boolean", "description": "Order reused indicator to indicate whether it is an existing order or new order" } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "client": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "tax_id": "123456789", "client_type": "", "gender": "M", "date_of_birth": "1993-03-24", "maritial_status": "", "email": "", "comments": "", "client_key_id": 0, "client_sub_key_id": 0 }, "order_request_data": { "state": "NY", "zip_code": "", "zip_code2": "", "zip_code3": "", "zip_code4": "", "order_reference_number": "", "alternate_order_reference_number": "", "signature_type": "WET", "order_medical_data": "Yes" }, "data_validity_period_in_days": 5, "policy_num_or_case_id": "123456", "order_ref_type": "POL", "fac_exchange_case_submit_xml": "", "file_name_with_ext": "", "file_upload_data": "" } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "client": { "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "client_type": { "type": "string" }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "maritial_status": { "title": "maritialStatus", "type": "string", "description": "Marital Status" }, "email": { "title": "email", "type": "string", "description": "email" }, "comments": { "title": "comments", "type": "string", "description": "comments" }, "client_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "client_sub_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } } }, "order_request_data": { "title": "OrderRequestData", "required": [ "order_reference_number", "signature_type" ], "type": "object", "properties": { "state": { "title": "State", "maxLength": 2, "type": "string", "description": "Two-letter state abbreviation for the applicant�s home state" }, "zip_code": { "title": "ZipCode", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code2": { "title": "ZipCode2", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code3": { "title": "ZipCode3", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code4": { "title": "ZipCode4", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "order_reference_number": { "title": "OrderReference", "maxLength": 15, "minLength": 1, "type": "string", "description": "Client supplied field typically containing a unique value representing the case. A policy number, order number or case number is commonly used to populate this field" }, "alternate_order_reference_number": { "title": "AlternateOrderReference", "maxLength": 50, "type": "string", "description": "Additional client supplied field typically used to identify the case. Although this field is not required by the schema, product accounts can be configured to require it. In addition, some setups will validate the provided values against an approved list. This is generally configured upon client request." }, "signature_type": { "title": "SignatureType", "type": "string", "description": "Although not required by the schema, this field is required for all new implementations. Valid values are: 1.WET 2.ESIG and 3.ORAL", "enum": [ "WET", "ESIG", "ORAL" ] }, "order_medical_data": { "title": "OrderMedicalData", "type": "string", "description": "Although not required by the schema, this field is Optional for all new implementations. Valid values are: Yes, No", "enum": [ "Yes", "No" ] } }, "description": "Request data needed for IRIX Submit order" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] }, "fac_exchange_case_submit_xml": { "type": "string" }, "file_name_with_ext": { "type": "string" }, "file_upload_data": { "type": "string" } } } } }, "description": "" } } }, "/v1/uwdata/mib/mibupdate": { "post": { "tags": [ "MIB" ], "summary": "Mib Update Request", "operationId": "mibUpdate", "description": "Mib Update Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "order_status": "INITIATED", "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 } } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "selected_services": { "mib_service": "CHECKING SERVICE", "mib_follow_up_indicator": "TRUE" }, "client": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "prefix": "", "suffix": "", "tax_id": "123456789", "gender": "M", "date_of_birth": "1993-03-24", "residence_state": "", "residence_state_desc": "", "residence_country": "", "residence_country_desc": "", "residence_zip": "", "birth_country": "", "birth_country_desc": "", "birth_jurisdiction": "", "birth_jurisdiction_desc": "", "occupation": "", "govt_id_tc": "" }, "application_info_type": { "tracking_id": "", "ho_assigned_app_number": "", "issuing_company": "GLIC" }, "mib_codes": [], "policy": { "policy_number": "", "product_type": "", "policy_status": "", "issue_nation": "", "jurisdiction": "", "reinsurance_ind": true, "holding_form": "" }, "coverage": { "face_amount": 0, "benefit_mode": "", "current_amount": 0, "benefit_amt_acc": 0, "benefit_amt_sick": 0, "benefit_amt_maximum": 0 }, "data_validity_period_in_days": 5, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "selected_services": { "title": "selectedServices", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "mib_service": { "title": "mibService", "type": "string", "description": "Type of service requested for MIB", "enum": [ "CHECKING SERVICE", "IAI", "DIRS" ] }, "mib_follow_up_indicator": { "title": "mibFollowUpIndicator", "type": "string", "description": "Type of service requested for MIB", "enum": [ "TRUE", "FALSE" ] } }, "description": "MIB selectedServices details" }, "client": { "title": "client", "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "prefix": { "title": "prefix", "maxLength": 50, "minLength": 1, "type": "string", "description": "Prefix of the applicant" }, "suffix": { "title": "suffix", "maxLength": 50, "minLength": 1, "type": "string", "description": "Suffix of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "residence_state": { "title": "ResidenceState", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence State of the applicant" }, "residence_state_desc": { "title": "ResidenceStateDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence State of the applicant" }, "residence_country": { "title": "ResidenceCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence Country of the applicant" }, "residence_country_desc": { "title": "ResidenceCountryDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc of Residence Country of the applicant" }, "residence_zip": { "title": "ResidenceZip", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence Zip of the applicant" }, "birth_country": { "title": "BirthCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Birth Country of the applicant" }, "birth_country_desc": { "title": "BirthCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc Of Birth Country of the applicant" }, "birth_jurisdiction": { "title": "BirthJurisdiction", "maxLength": 50, "minLength": 1, "type": "string", "description": "Birth Jurisdiction of the applicant" }, "birth_jurisdiction_desc": { "title": "BirthJurisdictionDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc Of Birth Jurisdiction of the applicant" }, "occupation": { "title": "occupation", "maxLength": 50, "minLength": 1, "type": "string", "description": "Occupation of the applicant" }, "govt_id_tc": { "title": "GovtIdTc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Govt Id Tc of the applicant" } }, "description": "Client details" }, "application_info_type": { "title": "ApplicationInfoType", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "tracking_id": { "title": "TrackingID", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy No" }, "ho_assigned_app_number": { "title": "HOAssignedAppNumber", "maxLength": 50, "minLength": 1, "type": "string", "description": "Assigned App Number" }, "issuing_company": { "title": "IssuingCompany", "type": "string", "description": "Issuing Company", "enum": [ "GLIC", "GIAC", "BLIC" ] } }, "description": "Application Info Type" }, "mib_codes": { "title": "MibCodes", "maxLength": 50, "minLength": 1, "type": "array", "description": "MibCodes", "items": { "title": "MibCodes", "maxLength": 50, "minLength": 1, "type": "string", "description": "MibCodes" } }, "policy": { "title": "policy", "required": [ "product_type" ], "type": "object", "properties": { "policy_number": { "title": "PolicyNumber", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy Number of Application" }, "product_type": { "title": "ProductType", "maxLength": 50, "minLength": 1, "type": "string", "description": "ProductType Selected on the policy" }, "policy_status": { "title": "PolicyStatus", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy Status" }, "issue_nation": { "title": "IssueNation", "maxLength": 50, "minLength": 1, "type": "string", "description": "Issue Nation of the policy " }, "jurisdiction": { "title": "Jurisdiction", "maxLength": 50, "minLength": 1, "type": "string", "description": "Jurisdiction" }, "reinsurance_ind": { "title": "ReinsuranceInd", "type": "boolean", "description": "Reinsurance indicator on the policy" }, "holding_form": { "type": "string" } }, "description": "Policy details" }, "coverage": { "title": "coverage", "required": [ "face_amount" ], "type": "object", "properties": { "face_amount": { "title": "FaceAmount", "maxLength": 50, "minLength": 1, "type": "number", "description": "Face Amount of the applicant" }, "benefit_mode": { "title": "benefitMode", "maxLength": 50, "minLength": 1, "type": "string", "description": "Benefit Mode of the applicant" }, "current_amount": { "title": "CurrentAmount", "maxLength": 50, "minLength": 1, "type": "number", "description": "Current Amount of the applicant" }, "benefit_amt_acc": { "title": "BenefitAmtAcc", "type": "number", "description": "BenefitAmtAcc" }, "benefit_amt_sick": { "title": "BenefitAmtSick", "type": "number", "description": "BenefitAmtSick" }, "benefit_amt_maximum": { "title": "BenefitAmtMaximum", "type": "number", "description": "BenefitAmtMaximum" } }, "description": "Coverage details" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/uwdata/mib/mibinquiry": { "post": { "tags": [ "MIB" ], "summary": "Mib Inquiry Request", "operationId": "mibInquiry", "description": "Mib Inquiry Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "order_status": "INITIATED", "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 } } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "requested_mib_services": { "selected_services": [ { "mib_service": "CHECKING SERVICE", "mib_follow_up_indicator": "TRUE" } ] }, "client": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "prefix": "", "suffix": "", "tax_id": "123456789", "gender": "M", "date_of_birth": "1993-03-24", "residence_state": "", "residence_state_desc": "", "residence_country": "", "residence_country_desc": "", "residence_zip": "", "birth_country": "", "birth_country_desc": "", "birth_jurisdiction": "", "birth_jurisdiction_desc": "", "occupation": "", "govt_id_tc": "" }, "policy": { "policy_number": "", "product_type": "", "policy_status": "", "issue_nation": "", "jurisdiction": "", "reinsurance_ind": true, "holding_form": "" }, "coverage": { "face_amount": 0, "benefit_mode": "", "current_amount": 0, "benefit_amt_acc": 0, "benefit_amt_sick": 0, "benefit_amt_maximum": 0 }, "application_info_type": { "tracking_id": "", "ho_assigned_app_number": "", "issuing_company": "GLIC" }, "data_validity_period_in_days": 5, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "requested_mib_services": { "title": "requestedMibServices", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "selected_services": { "title": "selectedServices", "type": "array", "description": "Type of service requested for MIB", "items": { "title": "selectedServices", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "mib_service": { "title": "mibService", "type": "string", "description": "Type of service requested for MIB", "enum": [ "CHECKING SERVICE", "IAI", "DIRS" ] }, "mib_follow_up_indicator": { "title": "mibFollowUpIndicator", "type": "string", "description": "Type of service requested for MIB", "enum": [ "TRUE", "FALSE" ] } }, "description": "MIB selectedServices details" } } }, "description": "MIB ServiceDescriptor details" }, "client": { "title": "client", "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "prefix": { "title": "prefix", "maxLength": 50, "minLength": 1, "type": "string", "description": "Prefix of the applicant" }, "suffix": { "title": "suffix", "maxLength": 50, "minLength": 1, "type": "string", "description": "Suffix of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "residence_state": { "title": "ResidenceState", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence State of the applicant" }, "residence_state_desc": { "title": "ResidenceStateDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence State of the applicant" }, "residence_country": { "title": "ResidenceCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence Country of the applicant" }, "residence_country_desc": { "title": "ResidenceCountryDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc of Residence Country of the applicant" }, "residence_zip": { "title": "ResidenceZip", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence Zip of the applicant" }, "birth_country": { "title": "BirthCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Birth Country of the applicant" }, "birth_country_desc": { "title": "BirthCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc Of Birth Country of the applicant" }, "birth_jurisdiction": { "title": "BirthJurisdiction", "maxLength": 50, "minLength": 1, "type": "string", "description": "Birth Jurisdiction of the applicant" }, "birth_jurisdiction_desc": { "title": "BirthJurisdictionDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc Of Birth Jurisdiction of the applicant" }, "occupation": { "title": "occupation", "maxLength": 50, "minLength": 1, "type": "string", "description": "Occupation of the applicant" }, "govt_id_tc": { "title": "GovtIdTc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Govt Id Tc of the applicant" } }, "description": "Client details" }, "policy": { "title": "policy", "required": [ "product_type" ], "type": "object", "properties": { "policy_number": { "title": "PolicyNumber", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy Number of Application" }, "product_type": { "title": "ProductType", "maxLength": 50, "minLength": 1, "type": "string", "description": "ProductType Selected on the policy" }, "policy_status": { "title": "PolicyStatus", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy Status" }, "issue_nation": { "title": "IssueNation", "maxLength": 50, "minLength": 1, "type": "string", "description": "Issue Nation of the policy " }, "jurisdiction": { "title": "Jurisdiction", "maxLength": 50, "minLength": 1, "type": "string", "description": "Jurisdiction" }, "reinsurance_ind": { "title": "ReinsuranceInd", "type": "boolean", "description": "Reinsurance indicator on the policy" }, "holding_form": { "type": "string" } }, "description": "Policy details" }, "coverage": { "title": "coverage", "required": [ "face_amount" ], "type": "object", "properties": { "face_amount": { "title": "FaceAmount", "maxLength": 50, "minLength": 1, "type": "number", "description": "Face Amount of the applicant" }, "benefit_mode": { "title": "benefitMode", "maxLength": 50, "minLength": 1, "type": "string", "description": "Benefit Mode of the applicant" }, "current_amount": { "title": "CurrentAmount", "maxLength": 50, "minLength": 1, "type": "number", "description": "Current Amount of the applicant" }, "benefit_amt_acc": { "title": "BenefitAmtAcc", "type": "number", "description": "BenefitAmtAcc" }, "benefit_amt_sick": { "title": "BenefitAmtSick", "type": "number", "description": "BenefitAmtSick" }, "benefit_amt_maximum": { "title": "BenefitAmtMaximum", "type": "number", "description": "BenefitAmtMaximum" } }, "description": "Coverage details" }, "application_info_type": { "title": "ApplicationInfoType", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "tracking_id": { "title": "TrackingID", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy No" }, "ho_assigned_app_number": { "title": "HOAssignedAppNumber", "maxLength": 50, "minLength": 1, "type": "string", "description": "Assigned App Number" }, "issuing_company": { "title": "IssuingCompany", "type": "string", "description": "Issuing Company", "enum": [ "GLIC", "GIAC", "BLIC" ] } }, "description": "Application Info Type" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/credit/trl/search": { "post": { "tags": [ "Credit" ], "summary": "TRLCreditSearch", "operationId": "search", "description": "Search for credit information by call TransUnion vendor service", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "credit_search_response_data": { "policyNumber": "", "applicationId": "", "trackingId": "", "creditIndicators": { "fileHit": "", "ssnMatch": "", "isSuppressed": "", "isFreeze": "", "isMinor": "", "isDisputed": "", "isAddrMismatch": "" }, "person": { "firstName": "", "middleName": "", "lastName": "", "prefix": "", "suffix": "", "taxId": "", "birthDate": "" }, "address": { "addrSource": "", "addrStatus": "", "addrQualifier": "", "streetUnparsed": "", "streetNumber": "", "streetName": "", "streetType": "", "city": "", "state": "", "zipCode": "" }, "creditScore": { "scoreResult": "", "isDerogatoryAlert": true, "isFileInquiriesImpactedScore": true, "noScoreReason": "", "scoreFactors": { "scoreFactors": [ { "scoreRank": "", "scoreCode": "" } ] } } }, "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 }, "order_status": "INITIATED" } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "credit_search_response_data": { "type": "object", "properties": { "policyNumber": { "type": "string", "description": "Policy Number" }, "applicationId": { "type": "string", "description": "Application Id" }, "trackingId": { "type": "string", "description": "Tracking Id" }, "creditIndicators": { "type": "object", "properties": { "fileHit": { "type": "string" }, "ssnMatch": { "type": "string" }, "isSuppressed": { "type": "string" }, "isFreeze": { "type": "string" }, "isMinor": { "type": "string" }, "isDisputed": { "type": "string" }, "isAddrMismatch": { "type": "string" } }, "description": "Credit Indicators" }, "person": { "type": "object", "properties": { "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" }, "taxId": { "type": "string" }, "birthDate": { "type": "string", "format": "date" } }, "description": "Person Search" }, "address": { "type": "object", "properties": { "addrSource": { "type": "string" }, "addrStatus": { "type": "string" }, "addrQualifier": { "type": "string" }, "streetUnparsed": { "type": "string" }, "streetNumber": { "type": "string" }, "streetName": { "type": "string" }, "streetType": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" } }, "description": "Address Search" }, "creditScore": { "type": "object", "properties": { "scoreResult": { "type": "string" }, "isDerogatoryAlert": { "type": "boolean" }, "isFileInquiriesImpactedScore": { "type": "boolean" }, "noScoreReason": { "type": "string" }, "scoreFactors": { "type": "object", "properties": { "scoreFactors": { "type": "array", "items": { "type": "object", "properties": { "scoreRank": { "type": "string" }, "scoreCode": { "type": "string" } } } } } } }, "description": "Credit Score" } }, "description": "Credit Search Response Data" }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "credit_search_filter": { "policy_number": "", "application_id": "", "tracking_id": "", "product_code": "", "person": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "tax_id": "123456789", "date_of_birth": "1993-03-24", "prefix": "", "suffix": "" }, "address": { "addr_line1": "", "addr_line2": "", "addr_line3": "", "city": "", "state": "", "zip_code": "" } }, "data_validity_period_in_days": -1, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "credit_search_filter": { "title": "Instant ID Request Data", "type": "object", "properties": { "policy_number": { "type": "string" }, "application_id": { "type": "string" }, "tracking_id": { "type": "string" }, "product_code": { "type": "string" }, "person": { "required": [ "date_of_birth", "first_name", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "prefix": { "type": "string" }, "suffix": { "type": "string" } } }, "address": { "type": "object", "properties": { "addr_line1": { "type": "string" }, "addr_line2": { "type": "string" }, "addr_line3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" } } } }, "description": "Instant ID Request Data" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/uwdata/hapi/submitOrder": { "post": { "tags": [ "HAPI" ], "summary": "Submit HAPI Request", "operationId": "submitHAPIOrder", "description": "Submit HAPI Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "clientUserId": "your-policy-number", "humanId": "ef14404e9860776f6300e3e4cb10f84a", "firstName": "Maxwell", "lastName": "Forrest", "dateOfBirth": "Forrest", "suggestedSources": [], "createdAt": "2020-02-21T18:23:21.445Z", "updatedAt": "2020-02-21T18:23:21.445Z", "status": "invited", "inviteLink": "https://hapi-link.humanapi.co/...", "docId": "DOC01020102103" } } }, "schema": { "type": "object", "properties": { "clientUserId": { "type": "string" }, "humanId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dateOfBirth": { "type": "string" }, "suggestedSources": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "status": { "type": "string" }, "inviteLink": { "type": "string" }, "docId": { "title": "Document Id", "type": "string", "description": "Document Id " } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "client": { "first_name": "John", "last_name": "Mellon", "middle_name": "", "tax_id": "123456789", "gender": "M", "date_of_birth": "1993-03-24", "email": "", "client_key_id": 0, "client_sub_key_id": 0, "client_type": "", "maritial_status": "", "comments": "", "phone": "(555) 213-5555", "address": { "street1": "969-1762 Buttery Rd.", "street2": "6818 Eget St.", "city": "Boise", "state": "ID", "zip": "83712" } }, "data_validity_period_in_days": 5, "policy_num_or_case_id": "123456", "order_ref_type": "POL", "Request Data": { "orderType": "HAPI", "autoInvite": true, "suggestedSources": [ "['Max Forrest M.D.','Angel Memorial Hospital']" ], "conditions": [ "COPD , " ], "providers": [ { "name": "Maxwell Forrest M.D.", "organizationName": "Brentwood North Family Practice", "address": { "street1": "969-1762 Buttery Rd.", "street2": "6818 Eget St.", "city": "Boise", "state": "ID", "zip": "83712" }, "phone": "(425) 288-2332", "fax": "(715) 912-6931", "mrn": "000TB0009-3" } ], "attachments": [ { "contentType": "application/pdf", "type": "hipaaAuthorization", "encoding": "base64", "content": "iVBORw0KGgoAAAANSUhEUgAABuoAAAYiCA..." } ], "relation": true } } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "client": { "title": "client", "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "email": { "title": "email", "type": "string", "description": "email" }, "client_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "client_sub_key_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "client_type": { "type": "string" }, "maritial_status": { "title": "maritialStatus", "type": "string", "description": "Marital Status" }, "comments": { "title": "comments", "type": "string", "description": "comments" }, "phone": { "title": "Phone", "maxLength": 50, "minLength": 1, "type": "string", "description": "(Optional)a valid North american phone number" }, "address": { "type": "object", "properties": { "street1": { "type": "string" }, "street2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" } } } }, "description": "Client details" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] }, "Request Data": { "title": "Request Data", "required": [ "autoInvite", "orderType", "relation" ], "type": "object", "properties": { "orderType": { "title": "OrderType", "maxLength": 50, "minLength": 1, "type": "string", "description": "OrderType Shouble Be HAPI" }, "autoInvite": { "title": "autoInvite", "type": "boolean", "description": "autoInvite Shouble Be true / false" }, "suggestedSources": { "title": "Suggested Sources", "type": "array", "description": "A list of provider names, which we will include in communications with the applicant", "items": { "title": "Suggested Sources", "type": "string", "description": "A list of provider names, which we will include in communications with the applicant" } }, "conditions": { "title": "Conditions", "maxLength": 500, "minLength": 1, "type": "array", "description": "(Optional) A list of underlying conditions or risk factors that rise to the\r\npoint of concern for underwriting. This data is used by Human API to\r\noptimize data processing and presentation of medical data to the\r\nunderwriters", "items": { "title": "Conditions", "maxLength": 500, "minLength": 1, "type": "string", "description": "(Optional) A list of underlying conditions or risk factors that rise to the\r\npoint of concern for underwriting. This data is used by Human API to\r\noptimize data processing and presentation of medical data to the\r\nunderwriters" } }, "providers": { "title": "Providers", "maxLength": 500, "minLength": 1, "type": "array", "description": "(Optional) a list of healthcare providers", "items": { "title": "Providers", "maxLength": 500, "minLength": 1, "type": "object", "properties": { "name": { "type": "string" }, "organizationName": { "type": "string" }, "address": { "type": "object", "properties": { "street1": { "type": "string" }, "street2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" } } }, "phone": { "type": "string" }, "fax": { "type": "string" }, "mrn": { "type": "string" } }, "description": "(Optional) a list of healthcare providers" } }, "attachments": { "title": "Attachments", "type": "array", "description": "(Optional) a list of documents attached to the case.", "items": { "title": "Attachments", "type": "object", "properties": { "contentType": { "type": "string" }, "type": { "type": "string" }, "encoding": { "type": "string" }, "content": { "type": "string" } }, "description": "(Optional) a list of documents attached to the case." } }, "relation": { "title": "relation", "type": "boolean", "description": "Relation Type Shouble Be true /false" } }, "description": "Request Data" } } } } }, "description": "" } } }, "/v1/uwdata/labpiq/inquiry": { "post": { "tags": [ "LABPiQ" ], "summary": "Submit LabPiQ Request", "operationId": "submitLabPQOrder", "description": "Submit LabPiQ Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "order_status": "INITIATED", "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 } } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "client": { "first_name": "John", "last_name": "Mellon", "gender": "1", "date_of_birth": "1993-03-24", "tax_id": "123456789", "address": { "address_type": "Residence", "address_line1": "3041 HAMPTON CIR", "city": "BIRMINGHAM", "state": "AL", "postal_code": "08105-7876" }, "telephone": [ { "phone_type": "HOME", "area_code": "432", "phone_number": "7514241" } ] }, "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "data_validity_period_in_days": -1, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days" ], "type": "object", "properties": { "client": { "title": "LABPiQClient", "required": [ "address", "date_of_birth", "first_name", "gender", "last_name", "tax_id", "telephone" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "gender": { "pattern": "M|F", "type": "string", "enum": [ "1", "2" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "address": { "title": "Address", "required": [ "address_line1", "address_type", "city", "postal_code", "state" ], "type": "object", "properties": { "address_type": { "pattern": "Residence", "type": "string" }, "address_line1": { "pattern": "[^<>&]+$", "type": "string" }, "city": { "pattern": "^(?!\\s*$)[a-zA-Z0-9.\\s](?:[ '.\\-a-zA-Z0-9]*[a-zA-Z0-9.\\s])?$|^$", "type": "string" }, "state": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string" }, "postal_code": { "pattern": "^[0-9]{5}[-]?(?:[0-9]{4})?$|^$", "type": "string" } }, "description": "Address of the person" }, "telephone": { "title": "Phone", "maxItems": 3, "minItems": 1, "type": "array", "description": "Telephone of the person", "items": { "title": "Phone", "required": [ "area_code", "phone_number", "phone_type" ], "type": "object", "properties": { "phone_type": { "pattern": "Home|Business|Mobile|Cell", "type": "string", "enum": [ "HOME", "BUSINESS", "MOBILE", "CELL" ] }, "area_code": { "maxLength": 3, "minLength": 3, "pattern": "(^[0-9]+$|^$)", "type": "string" }, "phone_number": { "maxLength": 7, "minLength": 7, "pattern": "^[0-9]{7}$|^$", "type": "string" } }, "description": "Telephone of the person" } } }, "description": "Client details" }, "transaction": { "required": [ "lob" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "pattern": "Life", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } } }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } }, "/v1/uwdata/existing-insurance/di": { "post": { "tags": [ "ExistingInsRequest" ], "summary": "DI ExistingInsurance Search", "operationId": "searchExistingDIInsurance", "description": "DI ExistingInsurance Search", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "carrier_name": "IGO", "carrier_system_name": "Ipipeline" }, "policies": [ { "policy_number": "", "line_of_business": "", "confidence_level": "", "amount_of_insurance": "", "policy_status_cd": "", "policy_status_desc": "", "policy_status_category": "", "product_type": "", "plan_name": "", "rate_class": "", "policy_date": "", "effective_date": "", "claim_date": "", "application_date": "", "relationship_type": "", "reinsurance_code": "", "nature_of_business": "", "has_claims": true, "uw_decision": "", "table_rating": "", "uw_rating_cd": "", "temp_flat_extra": "", "perm_flat_extra": "", "dividend": { "option_name": "D", "option_amount": 15000 }, "parties": [ { "party_type": "", "flipped_ind": true, "first_name": "", "middle_name": "", "last_name": "", "ssn": "", "date_of_birth": "", "role_cd": "", "role_desc": "" } ], "rider_benefit": [ { "rider_name": "WOP", "rider_amount": 13000 } ], "is_pos_eligible": true, "is_sum_risk": true } ] } } }, "schema": { "required": [ "policies" ], "type": "object", "properties": { "transaction": { "required": [ "carrier_name", "carrier_system_name", "trans_date", "trans_ref_guid" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 32, "minLength": 32, "type": "string", "description": "Trans Ref GUID" }, "trans_date": { "title": "Trans Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "carrier_name": { "title": "Carrier Name", "type": "string", "description": "Carrier Name" }, "carrier_system_name": { "title": "Carrier System Name", "type": "string", "description": "Carrier System Name" } } }, "policies": { "title": "Policies list", "type": "array", "description": "Policies list", "items": { "title": "Policies list", "type": "object", "properties": { "policy_number": { "type": "string" }, "line_of_business": { "type": "string" }, "confidence_level": { "type": "string" }, "amount_of_insurance": { "type": "string" }, "policy_status_cd": { "type": "string" }, "policy_status_desc": { "type": "string" }, "policy_status_category": { "type": "string" }, "product_type": { "type": "string" }, "plan_name": { "type": "string" }, "rate_class": { "type": "string" }, "policy_date": { "type": "string", "format": "date" }, "effective_date": { "type": "string", "format": "date" }, "claim_date": { "type": "string", "format": "date" }, "application_date": { "type": "string", "format": "date" }, "relationship_type": { "type": "string" }, "reinsurance_code": { "type": "string" }, "nature_of_business": { "type": "string" }, "has_claims": { "type": "boolean" }, "uw_decision": { "type": "string" }, "table_rating": { "type": "string" }, "uw_rating_cd": { "type": "string" }, "temp_flat_extra": { "type": "string" }, "perm_flat_extra": { "type": "string" }, "dividend": { "type": "object", "properties": { "option_name": { "title": "New Policy Divedend Options", "type": "string", "description": "New Policy Divedend Options" }, "option_amount": { "title": "New Policy Divedend Amount", "type": "number", "description": "New Policy Divedend Amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308 } } }, "parties": { "type": "array", "items": { "type": "object", "properties": { "party_type": { "type": "string" }, "flipped_ind": { "type": "boolean" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "ssn": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "role_cd": { "type": "string" }, "role_desc": { "type": "string" } } } }, "rider_benefit": { "type": "array", "items": { "required": [ "rider_name" ], "type": "object", "properties": { "rider_name": { "title": "New Policy Riders", "type": "string", "description": "New Policy Riders" }, "rider_amount": { "title": "New Policy Benefit Amount", "type": "number", "description": "New Policy Benefit Amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308 } } } }, "is_pos_eligible": { "type": "boolean" }, "is_sum_risk": { "type": "boolean" } }, "description": "Policies list" } } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "carrier_name": "IGO", "carrier_system_name": "Ipipeline" }, "first_name": "", "last_name": "", "date_of_birth": "", "middle_name": "", "ssn": "" } } }, "schema": { "type": "object", "properties": { "transaction": { "required": [ "carrier_name", "carrier_system_name", "trans_date", "trans_ref_guid" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 32, "minLength": 32, "type": "string", "description": "Trans Ref GUID" }, "trans_date": { "title": "Trans Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "carrier_name": { "title": "Carrier Name", "type": "string", "description": "Carrier Name" }, "carrier_system_name": { "title": "Carrier System Name", "type": "string", "description": "Carrier System Name" } } }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string" }, "middle_name": { "type": "string" }, "ssn": { "type": "string" } } } } }, "description": "" } } }, "/v1/uwdata/existing-insurance/life": { "post": { "tags": [ "ExistingInsRequest" ], "summary": "Life ExistingInsurance Search", "operationId": "searchExistingLifeInsurance", "description": "Life ExistingInsurance Search", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "carrier_name": "IGO", "carrier_system_name": "Ipipeline" }, "policies": [ { "policy_number": "", "line_of_business": "", "confidence_level": "", "amount_of_insurance": "", "policy_status_cd": "", "policy_status_desc": "", "policy_status_category": "", "product_type": "", "plan_name": "", "rate_class": "", "policy_date": "", "effective_date": "", "claim_date": "", "application_date": "", "relationship_type": "", "reinsurance_code": "", "nature_of_business": "", "has_claims": true, "uw_decision": "", "table_rating": "", "uw_rating_cd": "", "temp_flat_extra": "", "perm_flat_extra": "", "dividend": { "option_name": "D", "option_amount": 15000 }, "parties": [ { "party_type": "", "flipped_ind": true, "first_name": "", "middle_name": "", "last_name": "", "ssn": "", "date_of_birth": "", "role_cd": "", "role_desc": "" } ], "rider_benefit": [ { "rider_name": "WOP", "rider_amount": 13000 } ], "is_pos_eligible": true, "is_sum_risk": true } ] } } }, "schema": { "required": [ "policies" ], "type": "object", "properties": { "transaction": { "required": [ "carrier_name", "carrier_system_name", "trans_date", "trans_ref_guid" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 32, "minLength": 32, "type": "string", "description": "Trans Ref GUID" }, "trans_date": { "title": "Trans Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "carrier_name": { "title": "Carrier Name", "type": "string", "description": "Carrier Name" }, "carrier_system_name": { "title": "Carrier System Name", "type": "string", "description": "Carrier System Name" } } }, "policies": { "title": "Policies list", "type": "array", "description": "Policies list", "items": { "title": "Policies list", "type": "object", "properties": { "policy_number": { "type": "string" }, "line_of_business": { "type": "string" }, "confidence_level": { "type": "string" }, "amount_of_insurance": { "type": "string" }, "policy_status_cd": { "type": "string" }, "policy_status_desc": { "type": "string" }, "policy_status_category": { "type": "string" }, "product_type": { "type": "string" }, "plan_name": { "type": "string" }, "rate_class": { "type": "string" }, "policy_date": { "type": "string", "format": "date" }, "effective_date": { "type": "string", "format": "date" }, "claim_date": { "type": "string", "format": "date" }, "application_date": { "type": "string", "format": "date" }, "relationship_type": { "type": "string" }, "reinsurance_code": { "type": "string" }, "nature_of_business": { "type": "string" }, "has_claims": { "type": "boolean" }, "uw_decision": { "type": "string" }, "table_rating": { "type": "string" }, "uw_rating_cd": { "type": "string" }, "temp_flat_extra": { "type": "string" }, "perm_flat_extra": { "type": "string" }, "dividend": { "type": "object", "properties": { "option_name": { "title": "New Policy Divedend Options", "type": "string", "description": "New Policy Divedend Options" }, "option_amount": { "title": "New Policy Divedend Amount", "type": "number", "description": "New Policy Divedend Amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308 } } }, "parties": { "type": "array", "items": { "type": "object", "properties": { "party_type": { "type": "string" }, "flipped_ind": { "type": "boolean" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "ssn": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "role_cd": { "type": "string" }, "role_desc": { "type": "string" } } } }, "rider_benefit": { "type": "array", "items": { "required": [ "rider_name" ], "type": "object", "properties": { "rider_name": { "title": "New Policy Riders", "type": "string", "description": "New Policy Riders" }, "rider_amount": { "title": "New Policy Benefit Amount", "type": "number", "description": "New Policy Benefit Amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308 } } } }, "is_pos_eligible": { "type": "boolean" }, "is_sum_risk": { "type": "boolean" } }, "description": "Policies list" } } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "carrier_name": "IGO", "carrier_system_name": "Ipipeline" }, "first_name": "", "last_name": "", "date_of_birth": "", "middle_name": "", "ssn": "" } } }, "schema": { "type": "object", "properties": { "transaction": { "required": [ "carrier_name", "carrier_system_name", "trans_date", "trans_ref_guid" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 32, "minLength": 32, "type": "string", "description": "Trans Ref GUID" }, "trans_date": { "title": "Trans Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "carrier_name": { "title": "Carrier Name", "type": "string", "description": "Carrier Name" }, "carrier_system_name": { "title": "Carrier System Name", "type": "string", "description": "Carrier System Name" } } }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string" }, "middle_name": { "type": "string" }, "ssn": { "type": "string" } } } } }, "description": "" } } }, "/v1/uwdata/existing-insurance/lifedi": { "post": { "tags": [ "ExistingInsRequest" ], "summary": "Life & DI ExistingInsurance Search", "operationId": "searchExistingLifeDIInsurance", "description": "Life & DI ExistingInsurance Search", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "carrier_name": "IGO", "carrier_system_name": "Ipipeline" }, "policies": [ { "policy_number": "", "line_of_business": "", "confidence_level": "", "amount_of_insurance": "", "policy_status_cd": "", "policy_status_desc": "", "policy_status_category": "", "product_type": "", "plan_name": "", "rate_class": "", "policy_date": "", "effective_date": "", "claim_date": "", "application_date": "", "relationship_type": "", "reinsurance_code": "", "nature_of_business": "", "has_claims": true, "uw_decision": "", "table_rating": "", "uw_rating_cd": "", "temp_flat_extra": "", "perm_flat_extra": "", "dividend": { "option_name": "D", "option_amount": 15000 }, "parties": [ { "party_type": "", "flipped_ind": true, "first_name": "", "middle_name": "", "last_name": "", "ssn": "", "date_of_birth": "", "role_cd": "", "role_desc": "" } ], "rider_benefit": [ { "rider_name": "WOP", "rider_amount": 13000 } ], "is_pos_eligible": true, "is_sum_risk": true } ] } } }, "schema": { "required": [ "policies" ], "type": "object", "properties": { "transaction": { "required": [ "carrier_name", "carrier_system_name", "trans_date", "trans_ref_guid" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 32, "minLength": 32, "type": "string", "description": "Trans Ref GUID" }, "trans_date": { "title": "Trans Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "carrier_name": { "title": "Carrier Name", "type": "string", "description": "Carrier Name" }, "carrier_system_name": { "title": "Carrier System Name", "type": "string", "description": "Carrier System Name" } } }, "policies": { "title": "Policies list", "type": "array", "description": "Policies list", "items": { "title": "Policies list", "type": "object", "properties": { "policy_number": { "type": "string" }, "line_of_business": { "type": "string" }, "confidence_level": { "type": "string" }, "amount_of_insurance": { "type": "string" }, "policy_status_cd": { "type": "string" }, "policy_status_desc": { "type": "string" }, "policy_status_category": { "type": "string" }, "product_type": { "type": "string" }, "plan_name": { "type": "string" }, "rate_class": { "type": "string" }, "policy_date": { "type": "string", "format": "date" }, "effective_date": { "type": "string", "format": "date" }, "claim_date": { "type": "string", "format": "date" }, "application_date": { "type": "string", "format": "date" }, "relationship_type": { "type": "string" }, "reinsurance_code": { "type": "string" }, "nature_of_business": { "type": "string" }, "has_claims": { "type": "boolean" }, "uw_decision": { "type": "string" }, "table_rating": { "type": "string" }, "uw_rating_cd": { "type": "string" }, "temp_flat_extra": { "type": "string" }, "perm_flat_extra": { "type": "string" }, "dividend": { "type": "object", "properties": { "option_name": { "title": "New Policy Divedend Options", "type": "string", "description": "New Policy Divedend Options" }, "option_amount": { "title": "New Policy Divedend Amount", "type": "number", "description": "New Policy Divedend Amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308 } } }, "parties": { "type": "array", "items": { "type": "object", "properties": { "party_type": { "type": "string" }, "flipped_ind": { "type": "boolean" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "ssn": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "role_cd": { "type": "string" }, "role_desc": { "type": "string" } } } }, "rider_benefit": { "type": "array", "items": { "required": [ "rider_name" ], "type": "object", "properties": { "rider_name": { "title": "New Policy Riders", "type": "string", "description": "New Policy Riders" }, "rider_amount": { "title": "New Policy Benefit Amount", "type": "number", "description": "New Policy Benefit Amount", "format": "double", "minimum": -1.7976931348623157e+308, "maximum": 1.7976931348623157e+308 } } } }, "is_pos_eligible": { "type": "boolean" }, "is_sum_risk": { "type": "boolean" } }, "description": "Policies list" } } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "carrier_name": "IGO", "carrier_system_name": "Ipipeline" }, "first_name": "", "last_name": "", "date_of_birth": "", "middle_name": "", "ssn": "" } } }, "schema": { "type": "object", "properties": { "transaction": { "required": [ "carrier_name", "carrier_system_name", "trans_date", "trans_ref_guid" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 32, "minLength": 32, "type": "string", "description": "Trans Ref GUID" }, "trans_date": { "title": "Trans Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "carrier_name": { "title": "Carrier Name", "type": "string", "description": "Carrier Name" }, "carrier_system_name": { "title": "Carrier System Name", "type": "string", "description": "Carrier System Name" } } }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string" }, "middle_name": { "type": "string" }, "ssn": { "type": "string" } } } } }, "description": "" } } }, "/v1/uwdata/instantid/validate": { "post": { "tags": [ "InstantId" ], "summary": "Submit Instant Id Validate Request", "operationId": "verifyConsumerInstantID", "description": "Submit Instant Id Validate Request", "responses": { "200": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "uw_data": { "uw_data_id": 0, "uw_data_blob": "", "uw_data_blob_type": "", "vendor_name": "", "received_date": "", "uw_data_type": "", "doc_id": "", "filenet_repo": "", "uw_order_id": 0 } } } }, "schema": { "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "uw_data": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64", "minimum": -9223372036854776000, "maximum": 9223372036854776000 } }, "description": "UW Data" } } } } }, "description": "" }, "400": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "404": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" }, "500": { "content": { "application/json": { "examples": { "Example_1": { "value": { "status": 0, "message": "" } } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "message": { "type": "string", "description": "Error Message" } } } } }, "description": "" } }, "requestBody": { "content": { "application/json": { "examples": { "Example_1": { "value": { "transaction": { "trans_ref_guid": "970d5797-88ba-4251-ae2e-467397d76f28", "trans_date": "", "source_system": "STP", "lob": "LIFE", "distribution_channel": "DTC" }, "instant_id_request_data": { "client": { "first_name": "John", "middle_name": "", "last_name": "Mellon", "date_of_birth": "1993-03-24", "tax_id": "123456789", "telephone": { "phone_type": "CELL", "country_code": "1", "area_code": "314", "phone_exchange": "489", "phone_number": "5607" }, "address": { "address_type": "PRIMARY", "address_line1": "3041 HAMPTON CIR", "address_line2": "", "city": "BIRMINGHAM", "state": "AL", "postal_code": "35242" } } }, "data_validity_period_in_days": -1, "policy_num_or_case_id": "123456", "order_ref_type": "POL" } } }, "schema": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "instant_id_request_data": { "title": "Instant ID Request Data", "type": "object", "properties": { "client": { "title": "Client", "required": [ "address", "date_of_birth", "first_name", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant" }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed." }, "telephone": { "title": "Telephone", "type": "object", "properties": { "phone_type": { "title": "PhoneType", "type": "string", "description": "Classification", "enum": [ "CELL", "CONTACT", "CONTACTFAX", "CURRENTEMPLOYER", "EDUCATOR", "EMPLOYER", "FORMER", "PHYSICIANMEDICAL", "POLICYOWNER", "PREVIOUSEMPLOYER", "REFERENCE", "RESIDENCE", "RESIDENCEFAX", "WORK", "WORKFAX" ] }, "country_code": { "title": "CountryCode", "maxLength": 3, "minLength": 1, "type": "string", "description": "Country Code" }, "area_code": { "title": "AreaCode", "maxLength": 3, "minLength": 3, "type": "string", "description": "Telephone number area code" }, "phone_exchange": { "title": "PhoneExchange", "maxLength": 3, "minLength": 3, "type": "string", "description": "Phone Exchange" }, "phone_number": { "title": "PhoneNumber", "maxLength": 4, "minLength": 4, "type": "string", "description": "Telephone number" } }, "description": "Telephone of the applicant" }, "address": { "title": "Address", "required": [ "address_line1", "address_type", "postal_code", "state" ], "type": "object", "properties": { "address_type": { "title": "AddressType", "maxLength": 50, "minLength": 1, "type": "string", "description": "Address type of the applicant", "enum": [ "PRIMARY", "EDUCATION", "FORMER", "MAILING", "RESIDENCE", "WORK", "PROPERTY", "RISK" ] }, "address_line1": { "title": "addressLine1", "maxLength": 20, "minLength": 1, "type": "string", "description": "Address Line 1 of the applicant" }, "address_line2": { "title": "street2", "maxLength": 20, "minLength": 1, "type": "string", "description": "Address Line 2 of the applicant" }, "city": { "title": "City", "maxLength": 20, "type": "string", "description": "Address City for the applicant" }, "state": { "title": "State", "maxLength": 2, "type": "string", "description": "Address State for the applicant" }, "postal_code": { "title": "PostalCode", "maxLength": 5, "type": "string", "description": "Address zipcode for the applicant" } }, "description": "Address of the applicant" } }, "description": "Client Data" } }, "description": "Instant ID Request Data" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "minimum": -2147483648, "maximum": 2147483647 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } } } }, "description": "" } } } }, "info": { "title": "UW Data Services", "version": "1.1.0", "description": "These are the APIs to Retrieve, Search, Add and Update the Policy data for Individual Markets.", "x-category": "Individual Markets", "x-long-description": "", "x-website": "", "x-public": false, "x-thumbnail": "https://rapidapi-prod-apis.s3.amazonaws.com/827314ca-e66f-4940-8351-afc940d5d466.png", "x-version-lifecycle": "active", "x-external-custom-id": "a06071b6-2438-4a18-b18d-78e4c0d3ba33", "x-badges": [], "x-collections": [] }, "security": [], "components": { "schemas": { "ErrorResponse": { "type": "object", "properties": { "status": { "type": "integer", "description": "Error Status", "format": "int32" }, "message": { "type": "string", "description": "Error Message" } } }, "AppData": { "type": "object", "properties": { "ref_number": { "type": "string" }, "ref_type": { "type": "string" } } }, "Client": { "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "client_type": { "type": "string" }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "example": "M", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" }, "maritial_status": { "title": "maritialStatus", "type": "string", "description": "Marital Status" }, "email": { "title": "email", "type": "string", "description": "email" }, "comments": { "title": "comments", "type": "string", "description": "comments" }, "client_key_id": { "type": "integer", "format": "int64" }, "client_sub_key_id": { "type": "integer", "format": "int64" } } }, "TransactionDetail": { "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request", "example": "970d5797-88ba-4251-ae2e-467397d76f28" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "example": "AUS", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "type": "string", "description": "Line of business", "example": "IDI", "enum": [ "LIFE", "IDI", "COMBO", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "example": "DTC", "enum": [ "DTC", "INTERMEDIARY" ] } }, "description": "Transaction Detail" }, "UWData": { "type": "object", "properties": { "uw_data_id": { "type": "integer", "format": "int64" }, "uw_data_blob": { "type": "string" }, "uw_data_blob_type": { "type": "string" }, "vendor_name": { "type": "string" }, "received_date": { "type": "string", "format": "date-time" }, "uw_data_type": { "type": "string" }, "doc_id": { "type": "string" }, "filenet_repo": { "type": "string" }, "uw_order_id": { "type": "integer", "format": "int64" } }, "description": "UW Data" }, "UWDataUpdateRequest": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "client": { "$ref": "#/components/schemas/Client" }, "app_data": { "$ref": "#/components/schemas/AppData" }, "uw_data": { "$ref": "#/components/schemas/UWData" }, "app_case_id": { "type": "string" }, "policy_number": { "type": "string" } } }, "KeyNameValue": { "title": "Key Name Key Value", "required": [ "key_name", "key_value" ], "type": "object", "properties": { "key_name": { "title": "Key Name", "maxLength": 50, "minLength": 1, "type": "string", "description": "Order Key Name" }, "key_value": { "title": "Key Value", "maxLength": 100, "minLength": 1, "type": "string", "description": "Order Key Value" } }, "description": "Key Name Key Value" }, "UWKeyValueRequestData": { "required": [ "cuw_order_id", "key_name_key_value" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "cuw_order_id": { "title": "CUW Order Id", "type": "integer", "description": "CUW Order Id", "format": "int64" }, "key_name_key_value": { "title": "Key Name Key Value", "type": "array", "description": "Key Name Key Value", "items": { "$ref": "#/components/schemas/KeyNameValue" } }, "vendor_tracking_id": { "title": "Vendor Tracking Id", "type": "string", "description": "Vendor Tracking Id" }, "app_case_id": { "title": "Galaxy Case Id", "type": "string", "description": "Galaxy Case Id" }, "policy_number": { "title": "Policy Number", "type": "string", "description": "Policy Number" }, "source_form_num": { "title": "Form Number", "type": "string", "description": "Form Number" } } }, "BasicGetOrderDetailsResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "order_id": { "type": "integer", "format": "int64" }, "lob": { "type": "string" }, "client": { "$ref": "#/components/schemas/Client" }, "app_case_id": { "type": "string" }, "policy_number": { "type": "string" } } }, "UWDataCreateRequest": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "uw_data": { "$ref": "#/components/schemas/UWData" }, "policy_number": { "type": "string" }, "vendor_tracking_id": { "type": "string" } } }, "DriversLicenseType": { "title": "DriversLicenseType", "type": "object", "properties": { "parameterList": { "type": "array", "xml": { "name": "parameter" }, "items": { "$ref": "#/components/schemas/ParameterType" } }, "history": { "type": "string", "xml": { "attribute": true }, "enum": [ "CURRENT", "PRIOR" ] }, "type": { "type": "string", "xml": { "attribute": true }, "enum": [ "COMMERCIAL", "PERSONAL" ] }, "state": { "type": "string", "xml": { "attribute": true } }, "number": { "type": "string", "xml": { "attribute": true } }, "drivingExperienceLength": { "type": "integer", "format": "int32", "xml": { "name": "driving_experience_length", "attribute": true } }, "status": { "type": "string", "xml": { "attribute": true } } }, "description": "DriversLicenseType of the applicant" }, "MvrClient": { "title": "Client", "required": [ "date_of_birth", "first_name", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "driver_license": { "$ref": "#/components/schemas/DriversLicenseType" } }, "description": "Client Data" }, "MvrRequest": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "mvr_request_data": { "$ref": "#/components/schemas/MvrRequestData" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "example": -1 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "MvrRequestData": { "title": "Mvr Request Data", "type": "object", "properties": { "client": { "$ref": "#/components/schemas/MvrClient" } }, "description": "Mvr Request Data" }, "ParameterType": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string", "xml": { "attribute": true } } } }, "MvrResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "uw_data": { "$ref": "#/components/schemas/UWData" } } }, "Coverage": { "title": "coverage", "required": [ "face_amount" ], "type": "object", "properties": { "face_amount": { "title": "FaceAmount", "maxLength": 50, "minLength": 1, "type": "number", "description": "Face Amount of the applicant" }, "benefit_mode": { "title": "benefitMode", "maxLength": 50, "minLength": 1, "type": "string", "description": "Benefit Mode of the applicant" }, "current_amount": { "title": "CurrentAmount", "maxLength": 50, "minLength": 1, "type": "number", "description": "Current Amount of the applicant" }, "benefit_amt_acc": { "title": "BenefitAmtAcc", "type": "number", "description": "BenefitAmtAcc" }, "benefit_amt_sick": { "title": "BenefitAmtSick", "type": "number", "description": "BenefitAmtSick" }, "benefit_amt_maximum": { "title": "BenefitAmtMaximum", "type": "number", "description": "BenefitAmtMaximum" } }, "description": "Coverage details" }, "MIBApplicationInfo": { "title": "ApplicationInfoType", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "tracking_id": { "title": "TrackingID", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy No" }, "ho_assigned_app_number": { "title": "HOAssignedAppNumber", "maxLength": 50, "minLength": 1, "type": "string", "description": "Assigned App Number" }, "issuing_company": { "title": "IssuingCompany", "type": "string", "description": "Issuing Company", "enum": [ "GLIC", "GIAC", "BLIC" ] } }, "description": "Application Info Type" }, "MIBClient": { "title": "client", "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "prefix": { "title": "prefix", "maxLength": 50, "minLength": 1, "type": "string", "description": "Prefix of the applicant" }, "suffix": { "title": "suffix", "maxLength": 50, "minLength": 1, "type": "string", "description": "Suffix of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "example": "M", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" }, "residence_state": { "title": "ResidenceState", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence State of the applicant" }, "residence_state_desc": { "title": "ResidenceStateDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence State of the applicant" }, "residence_country": { "title": "ResidenceCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence Country of the applicant" }, "residence_country_desc": { "title": "ResidenceCountryDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc of Residence Country of the applicant" }, "residence_zip": { "title": "ResidenceZip", "maxLength": 50, "minLength": 1, "type": "string", "description": "Residence Zip of the applicant" }, "birth_country": { "title": "BirthCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Birth Country of the applicant" }, "birth_country_desc": { "title": "BirthCountry", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc Of Birth Country of the applicant" }, "birth_jurisdiction": { "title": "BirthJurisdiction", "maxLength": 50, "minLength": 1, "type": "string", "description": "Birth Jurisdiction of the applicant" }, "birth_jurisdiction_desc": { "title": "BirthJurisdictionDesc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Desc Of Birth Jurisdiction of the applicant" }, "occupation": { "title": "occupation", "maxLength": 50, "minLength": 1, "type": "string", "description": "Occupation of the applicant" }, "govt_id_tc": { "title": "GovtIdTc", "maxLength": 50, "minLength": 1, "type": "string", "description": "Govt Id Tc of the applicant" } }, "description": "Client details" }, "MIBServiceDescriptor": { "title": "selectedServices", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "mib_service": { "title": "mibService", "type": "string", "description": "Type of service requested for MIB", "enum": [ "CHECKING SERVICE", "IAI", "DIRS" ] }, "mib_follow_up_indicator": { "title": "mibFollowUpIndicator", "type": "string", "description": "Type of service requested for MIB", "enum": [ "TRUE", "FALSE" ] } }, "description": "MIB selectedServices details" }, "MIBUpdateRequestData": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "selected_services": { "$ref": "#/components/schemas/MIBServiceDescriptor" }, "client": { "$ref": "#/components/schemas/MIBClient" }, "application_info_type": { "$ref": "#/components/schemas/MIBApplicationInfo" }, "mib_codes": { "title": "MibCodes", "maxLength": 50, "minLength": 1, "type": "array", "description": "MibCodes", "items": { "title": "MibCodes", "maxLength": 50, "minLength": 1, "type": "string", "description": "MibCodes" } }, "policy": { "$ref": "#/components/schemas/PolicyData" }, "coverage": { "$ref": "#/components/schemas/Coverage" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "example": 5 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "PolicyData": { "title": "policy", "required": [ "product_type" ], "type": "object", "properties": { "policy_number": { "title": "PolicyNumber", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy Number of Application" }, "product_type": { "title": "ProductType", "maxLength": 50, "minLength": 1, "type": "string", "description": "ProductType Selected on the policy" }, "policy_status": { "title": "PolicyStatus", "maxLength": 50, "minLength": 1, "type": "string", "description": "Policy Status" }, "issue_nation": { "title": "IssueNation", "maxLength": 50, "minLength": 1, "type": "string", "description": "Issue Nation of the policy " }, "jurisdiction": { "title": "Jurisdiction", "maxLength": 50, "minLength": 1, "type": "string", "description": "Jurisdiction" }, "reinsurance_ind": { "title": "ReinsuranceInd", "type": "boolean", "description": "Reinsurance indicator on the policy", "example": false }, "holding_form": { "type": "string" } }, "description": "Policy details" }, "MIBInquiryResponseData": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "uw_data": { "$ref": "#/components/schemas/UWData" } } }, "MIBInquiryRequestData": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "requested_mib_services": { "$ref": "#/components/schemas/RequestedMIBServices" }, "client": { "$ref": "#/components/schemas/MIBClient" }, "policy": { "$ref": "#/components/schemas/PolicyData" }, "coverage": { "$ref": "#/components/schemas/Coverage" }, "application_info_type": { "$ref": "#/components/schemas/MIBApplicationInfo" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "example": 5 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "RequestedMIBServices": { "title": "requestedMibServices", "maxLength": 50, "minLength": 1, "type": "object", "properties": { "selected_services": { "title": "selectedServices", "type": "array", "description": "Type of service requested for MIB", "items": { "$ref": "#/components/schemas/MIBServiceDescriptor" } } }, "description": "MIB ServiceDescriptor details" }, "LABPiQAddress": { "title": "Address", "required": [ "address_line1", "address_type", "city", "postal_code", "state" ], "type": "object", "properties": { "address_type": { "pattern": "Residence", "type": "string", "example": "Residence" }, "address_line1": { "pattern": "[^<>&]+$", "type": "string", "example": "3041 HAMPTON CIR" }, "city": { "pattern": "^(?!\\s*$)[a-zA-Z0-9.\\s](?:[ '.\\-a-zA-Z0-9]*[a-zA-Z0-9.\\s])?$|^$", "type": "string", "example": "BIRMINGHAM" }, "state": { "maxLength": 2, "minLength": 2, "pattern": "^[A-Z]{2}$", "type": "string", "example": "AL" }, "postal_code": { "pattern": "^[0-9]{5}[-]?(?:[0-9]{4})?$|^$", "type": "string", "example": "08105-7876" } }, "description": "Address of the person" }, "LABPiQClient": { "title": "LABPiQClient", "required": [ "address", "date_of_birth", "first_name", "gender", "last_name", "tax_id", "telephone" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "gender": { "pattern": "M|F", "type": "string", "example": "M", "enum": [ "1", "2" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "address": { "$ref": "#/components/schemas/LABPiQAddress" }, "telephone": { "title": "Phone", "maxItems": 3, "minItems": 1, "type": "array", "description": "Telephone of the person", "items": { "$ref": "#/components/schemas/LABPiQPhone" } } }, "description": "Client details" }, "LABPiQPhone": { "title": "Phone", "required": [ "area_code", "phone_number", "phone_type" ], "type": "object", "properties": { "phone_type": { "pattern": "Home|Business|Mobile|Cell", "type": "string", "example": "Mobile", "enum": [ "HOME", "BUSINESS", "MOBILE", "CELL" ] }, "area_code": { "maxLength": 3, "minLength": 3, "pattern": "(^[0-9]+$|^$)", "type": "string", "example": "432" }, "phone_number": { "maxLength": 7, "minLength": 7, "pattern": "^[0-9]{7}$|^$", "type": "string", "example": "7514241" } }, "description": "Telephone of the person" }, "LABPiQSubmitOrderRequestData": { "required": [ "data_validity_period_in_days" ], "type": "object", "properties": { "client": { "$ref": "#/components/schemas/LABPiQClient" }, "transaction": { "$ref": "#/components/schemas/LABPiQTxnDetail" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "example": -1 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "LABPiQTxnDetail": { "required": [ "lob" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 36, "minLength": 36, "type": "string", "description": "Transaction refernce GUID(globally unique identifier) is a 128 bit number which should be unique for each request", "example": "970d5797-88ba-4251-ae2e-467397d76f28" }, "trans_date": { "title": "Transaction Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "source_system": { "title": "Source System", "type": "string", "description": "Source System", "example": "STP", "enum": [ "STP", "ILGC", "AUS", "GUARDIANDIGITAL", "RESONANT", "ICC", "SIMON", "TITAN" ] }, "lob": { "title": "lob", "pattern": "Life", "type": "string", "description": "Line of business", "example": "Life", "enum": [ "LIFE", "IDI", "GROUP" ] }, "distribution_channel": { "title": "Distribution Channel", "type": "string", "description": "Distribution Channel", "example": "DTC", "enum": [ "DTC", "INTERMEDIARY" ] } } }, "LABPiQOrderResponseData": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "uw_data": { "$ref": "#/components/schemas/UWData" } } }, "IRIXClient": { "title": "IRIXClient", "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "example": "M", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" } }, "description": "Client details" }, "IRIXSubmitOrderRequestData": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "client": { "$ref": "#/components/schemas/IRIXClient" }, "order_request_data": { "$ref": "#/components/schemas/OrderRequestData" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "example": -1 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "OrderRequestData": { "title": "OrderRequestData", "required": [ "order_reference_number", "signature_type" ], "type": "object", "properties": { "state": { "title": "State", "maxLength": 2, "type": "string", "description": "Two-letter state abbreviation for the applicant�s home state", "example": "NY" }, "zip_code": { "title": "ZipCode", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code2": { "title": "ZipCode2", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code3": { "title": "ZipCode3", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "zip_code4": { "title": "ZipCode4", "maxLength": 9, "type": "string", "description": "Zip codes for the applicant�s home addresses. Zip codes can be passed as either 5 or 9 integer values without dashes or spaces" }, "order_reference_number": { "title": "OrderReference", "maxLength": 15, "minLength": 1, "type": "string", "description": "Client supplied field typically containing a unique value representing the case. A policy number, order number or case number is commonly used to populate this field" }, "alternate_order_reference_number": { "title": "AlternateOrderReference", "maxLength": 50, "type": "string", "description": "Additional client supplied field typically used to identify the case. Although this field is not required by the schema, product accounts can be configured to require it. In addition, some setups will validate the provided values against an approved list. This is generally configured upon client request." }, "signature_type": { "title": "SignatureType", "type": "string", "description": "Although not required by the schema, this field is required for all new implementations. Valid values are: 1.WET 2.ESIG and 3.ORAL", "example": "WET", "enum": [ "WET", "ESIG", "ORAL" ] }, "order_medical_data": { "title": "OrderMedicalData", "type": "string", "description": "Although not required by the schema, this field is Optional for all new implementations. Valid values are: Yes, No", "example": "Yes/No", "enum": [ "Yes", "No" ] } }, "description": "Request data needed for IRIX Submit order" }, "IRIXSubmitOrderResponseData": { "required": [ "order_id", "order_reused" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_id": { "type": "integer", "description": "Order Key Id", "format": "int64" }, "order_reused": { "type": "boolean", "description": "Order reused indicator to indicate whether it is an existing order or new order" } } }, "IrixRetrieveOrderRequestData": { "required": [ "data_validity_period_in_days", "order_id", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_id": { "title": "OrderId", "type": "integer", "description": "OrderId", "format": "int64" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "example": -1 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "IrixRetrieveOrderResponseData": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "uw_data": { "$ref": "#/components/schemas/UWData" } } }, "IrixTempUrlRequestData": { "required": [ "order_id" ], "type": "object", "properties": { "order_id": { "title": "orderId", "type": "integer", "description": "OrderId", "format": "int64" }, "milliman_page_and_screen_options": { "$ref": "#/components/schemas/MillimanPageAndScreenOptions" }, "milliman_user_info": { "$ref": "#/components/schemas/MillimanUserInfo" } } }, "MillimanPageAndScreenOptions": { "title": "millimanPageAndScreenOptions", "type": "object", "properties": { "display_page": { "title": "displayPage", "type": "string", "description": "Defines the order page you want to be rendered, can be any of the above enumerated values.", "enum": [ "ORDER DETAIL", "DRUG", "PHARMACY", "DOCTOR", "SURVEY", "DEMOGRAPHIC", "MIB", "MVR" ] }, "view_screen_sort": { "title": "viewScreenSort", "type": "string", "description": "If the DisplayPage element contains ORDER DETAIL, then this element is responsible for determining if the view is by drug or by indication", "enum": [ "BY DRUG", "BY INDICATION" ] }, "view_screen_view_option": { "title": "viewScreenViewOption", "type": "string", "description": "If the DisplayPage element contains ORDER DETAIL, then this element is responsible for determining if the view contains summary information only, or summary with additional drug details, or show all which also shows doctor information.", "enum": [ "SUMMARIES", "DRUGS", "SHOW ALL" ] }, "table_sort_column": { "title": "tableSortColumn", "type": "string", "description": "If the DisplayPage element contains DRUG, then this element is responsible for determining the rendered page�s sort column.", "enum": [ "BRAND NAME", "GENERIC NAME", "PRIORITY", "FILL DATE", "DOCTOR", "PHARMACY", "QUANTITY", "DAYS SUPPLY" ] }, "table_sort_order": { "title": "tableSortOrder", "type": "string", "description": "If the DisplayPage element contains DRUG, then this element is responsible for determining the rendered page�s sort direction.", "enum": [ "SUMMARIES", "DRUGS", "SHOW ALL" ] } }, "description": "Milliman page and screen options" }, "MillimanUserInfo": { "title": "millimanUserInfo", "type": "object", "properties": { "user_id": { "title": "userId", "type": "string", "description": "User Id of the logged in user" }, "user_first_name": { "title": "userFirstName", "type": "string", "description": "First Name of the logged in user" }, "user_last_name": { "title": "userLastName", "type": "string", "description": "Last Name of the logged in user" } }, "description": "The UserInfo element and the three sub-elements track who the user is who requested to view the order. The credential values stored in these elements are based on the identity of the individual within the client system. They are simply used by IntelliScript to log the identity of the individual for tracking purposes." }, "IrixTempUrlResponseData": { "type": "object", "properties": { "response_message": { "type": "string", "description": "Response Message if any" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "redirect_url": { "type": "string", "description": "Secure pre-authenticated url from Milliman to check IRIX Data" } } }, "Address": { "title": "Address", "required": [ "address_line1", "address_type", "postal_code", "state" ], "type": "object", "properties": { "address_type": { "title": "AddressType", "maxLength": 50, "minLength": 1, "type": "string", "description": "Address type of the applicant", "example": "residence", "enum": [ "PRIMARY", "EDUCATION", "FORMER", "MAILING", "RESIDENCE", "WORK", "PROPERTY", "RISK" ] }, "address_line1": { "title": "addressLine1", "maxLength": 20, "minLength": 1, "type": "string", "description": "Address Line 1 of the applicant", "example": "3041 HAMPTON CIR" }, "address_line2": { "title": "street2", "maxLength": 20, "minLength": 1, "type": "string", "description": "Address Line 2 of the applicant" }, "city": { "title": "City", "maxLength": 20, "type": "string", "description": "Address City for the applicant", "example": "BIRMINGHAM" }, "state": { "title": "State", "maxLength": 2, "type": "string", "description": "Address State for the applicant", "example": "AL" }, "postal_code": { "title": "PostalCode", "maxLength": 5, "type": "string", "description": "Address zipcode for the applicant", "example": "35242" } }, "description": "Address of the applicant" }, "InstantIdClient": { "title": "Client", "required": [ "address", "date_of_birth", "first_name", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "telephone": { "$ref": "#/components/schemas/Telephone" }, "address": { "$ref": "#/components/schemas/Address" } }, "description": "Client Data" }, "InstantIdRequest": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "instant_id_request_data": { "$ref": "#/components/schemas/InstantIdRequestData" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "example": -1 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "InstantIdRequestData": { "title": "Instant ID Request Data", "type": "object", "properties": { "client": { "$ref": "#/components/schemas/InstantIdClient" } }, "description": "Instant ID Request Data" }, "Telephone": { "title": "Telephone", "type": "object", "properties": { "phone_type": { "title": "PhoneType", "type": "string", "description": "Classification", "example": "residence", "enum": [ "CELL", "CONTACT", "CONTACTFAX", "CURRENTEMPLOYER", "EDUCATOR", "EMPLOYER", "FORMER", "PHYSICIANMEDICAL", "POLICYOWNER", "PREVIOUSEMPLOYER", "REFERENCE", "RESIDENCE", "RESIDENCEFAX", "WORK", "WORKFAX" ] }, "country_code": { "title": "CountryCode", "maxLength": 3, "minLength": 1, "type": "string", "description": "Country Code", "example": "1" }, "area_code": { "title": "AreaCode", "maxLength": 3, "minLength": 3, "type": "string", "description": "Telephone number area code", "example": "314" }, "phone_exchange": { "title": "PhoneExchange", "maxLength": 3, "minLength": 3, "type": "string", "description": "Phone Exchange", "example": "489" }, "phone_number": { "title": "PhoneNumber", "maxLength": 4, "minLength": 4, "type": "string", "description": "Telephone number", "example": "5607" } }, "description": "Telephone of the applicant" }, "InstantIdResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "uw_data": { "$ref": "#/components/schemas/UWData" } } }, "HAPIClient": { "title": "client", "required": [ "date_of_birth", "first_name", "gender", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "gender": { "title": "Gender", "type": "string", "description": "Gender of the applicant. Valid values are M and F ", "example": "M", "enum": [ "M", "F" ] }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" }, "email": { "title": "email", "type": "string", "description": "email" }, "client_key_id": { "type": "integer", "format": "int64" }, "client_sub_key_id": { "type": "integer", "format": "int64" }, "client_type": { "type": "string" }, "maritial_status": { "title": "maritialStatus", "type": "string", "description": "Marital Status" }, "comments": { "title": "comments", "type": "string", "description": "comments" }, "phone": { "title": "Phone", "maxLength": 50, "minLength": 1, "type": "string", "description": "(Optional)a valid North american phone number", "example": "(555) 213-5555" }, "address": { "$ref": "#/components/schemas/SubmitorderAddress" } }, "description": "Client details" }, "HAPISubmitOrderRequestData": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "client": { "$ref": "#/components/schemas/HAPIClient" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "example": 5 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] }, "Request Data": { "$ref": "#/components/schemas/RequestData" } } }, "RequestData": { "title": "Request Data", "required": [ "autoInvite", "orderType", "relation" ], "type": "object", "properties": { "orderType": { "title": "OrderType", "maxLength": 50, "minLength": 1, "type": "string", "description": "OrderType Shouble Be HAPI", "example": "HAPI" }, "autoInvite": { "title": "autoInvite", "type": "boolean", "description": "autoInvite Shouble Be true / false", "example": false }, "suggestedSources": { "title": "Suggested Sources", "type": "array", "description": "A list of provider names, which we will include in communications with the applicant", "example": "['Max Forrest M.D.','Angel Memorial Hospital']", "items": { "title": "Suggested Sources", "type": "string", "description": "A list of provider names, which we will include in communications with the applicant", "example": "['Max Forrest M.D.','Angel Memorial Hospital']" } }, "conditions": { "title": "Conditions", "maxLength": 500, "minLength": 1, "type": "array", "description": "(Optional) A list of underlying conditions or risk factors that rise to the\r\npoint of concern for underwriting. This data is used by Human API to\r\noptimize data processing and presentation of medical data to the\r\nunderwriters", "example": "COPD , ", "items": { "title": "Conditions", "maxLength": 500, "minLength": 1, "type": "string", "description": "(Optional) A list of underlying conditions or risk factors that rise to the\r\npoint of concern for underwriting. This data is used by Human API to\r\noptimize data processing and presentation of medical data to the\r\nunderwriters", "example": "COPD , " } }, "providers": { "title": "Providers", "maxLength": 500, "minLength": 1, "type": "array", "description": "(Optional) a list of healthcare providers", "items": { "$ref": "#/components/schemas/SubmitorderProviders" } }, "attachments": { "title": "Attachments", "type": "array", "description": "(Optional) a list of documents attached to the case.", "items": { "$ref": "#/components/schemas/SubmitorderAttachments" } }, "relation": { "title": "relation", "type": "boolean", "description": "Relation Type Shouble Be true /false", "example": true } }, "description": "Request Data" }, "SubmitorderAddress": { "type": "object", "properties": { "street1": { "type": "string", "example": "969-1762 Buttery Rd." }, "street2": { "type": "string", "example": "6818 Eget St." }, "city": { "type": "string", "example": "Boise" }, "state": { "type": "string", "example": "ID" }, "zip": { "type": "string", "example": "83712" } } }, "SubmitorderAttachments": { "title": "Attachments", "type": "object", "properties": { "contentType": { "type": "string", "example": "application/pdf" }, "type": { "type": "string", "example": "hipaaAuthorization" }, "encoding": { "type": "string", "example": "base64" }, "content": { "type": "string", "example": "iVBORw0KGgoAAAANSUhEUgAABuoAAAYiCA..." } }, "description": "(Optional) a list of documents attached to the case." }, "SubmitorderProviders": { "title": "Providers", "maxLength": 500, "minLength": 1, "type": "object", "properties": { "name": { "type": "string", "example": "Maxwell Forrest M.D." }, "organizationName": { "type": "string", "example": "Brentwood North Family Practice" }, "address": { "$ref": "#/components/schemas/SubmitorderAddress" }, "phone": { "type": "string", "example": "(425) 288-2332" }, "fax": { "type": "string", "example": "(715) 912-6931" }, "mrn": { "type": "string", "example": "000TB0009-3" } }, "description": "(Optional) a list of healthcare providers" }, "HAPISubmitOrderResponse": { "type": "object", "properties": { "clientUserId": { "type": "string", "example": "your-policy-number" }, "humanId": { "type": "string", "example": "ef14404e9860776f6300e3e4cb10f84a" }, "firstName": { "type": "string", "example": "Maxwell" }, "lastName": { "type": "string", "example": "Forrest" }, "dateOfBirth": { "type": "string", "example": "Forrest" }, "suggestedSources": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "example": "2020-02-21T18:23:21.445Z" }, "updatedAt": { "type": "string", "example": "2020-02-21T18:23:21.445Z" }, "status": { "type": "string", "example": "invited" }, "inviteLink": { "type": "string", "example": "https://hapi-link.humanapi.co/..." }, "docId": { "title": "Document Id", "type": "string", "description": "Document Id ", "example": "DOC01020102103" } } }, "ClientLookupRequest": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" } } }, "UWDataLookupResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "client": { "$ref": "#/components/schemas/Client" }, "uwData": { "$ref": "#/components/schemas/UWData" } } }, "FacExSubmitCaseRequestData": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "client": { "$ref": "#/components/schemas/Client" }, "order_request_data": { "$ref": "#/components/schemas/OrderRequestData" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value if data is not to be reused, zero for same day", "format": "int32", "example": 5 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] }, "fac_exchange_case_submit_xml": { "type": "string" }, "file_name_with_ext": { "type": "string" }, "file_upload_data": { "type": "string" } } }, "FacExSubmitCaseResponseData": { "required": [ "order_id", "order_reused" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_id": { "type": "integer", "description": "Order Key Id", "format": "int64" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "external_tracking_id": { "type": "string" }, "failure_reason": { "type": "string" }, "transaction_receipt_id": { "type": "string" }, "order_reused": { "type": "boolean", "description": "Order reused indicator to indicate whether it is an existing order or new order" } } }, "FacExRetrieveOrderRequestData": { "required": [ "data_validity_period_in_days", "order_id", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_id": { "title": "OrderId", "type": "integer", "description": "OrderId", "format": "int64" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "example": -1 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "FacExRetrieveOrderResponseData": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] }, "uw_data": { "$ref": "#/components/schemas/UWData" } } }, "ExistingInsRequest": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/Transaction" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "date_of_birth": { "type": "string" }, "middle_name": { "type": "string" }, "ssn": { "type": "string" } } }, "Transaction": { "required": [ "carrier_name", "carrier_system_name", "trans_date", "trans_ref_guid" ], "type": "object", "properties": { "trans_ref_guid": { "title": "Trans Ref GUID", "maxLength": 32, "minLength": 32, "type": "string", "description": "Trans Ref GUID", "example": "970d5797-88ba-4251-ae2e-467397d76f28" }, "trans_date": { "title": "Trans Date", "type": "string", "description": "Transaction Date", "format": "date-time" }, "carrier_name": { "title": "Carrier Name", "type": "string", "description": "Carrier Name", "example": "IGO" }, "carrier_system_name": { "title": "Carrier System Name", "type": "string", "description": "Carrier System Name", "example": "Ipipeline" } } }, "Dividend": { "type": "object", "properties": { "option_name": { "title": "New Policy Divedend Options", "type": "string", "description": "New Policy Divedend Options", "example": "D" }, "option_amount": { "title": "New Policy Divedend Amount", "type": "number", "description": "New Policy Divedend Amount", "format": "double", "example": 15000 } } }, "ExistingInsParty": { "type": "object", "properties": { "party_type": { "type": "string" }, "flipped_ind": { "type": "boolean" }, "first_name": { "type": "string" }, "middle_name": { "type": "string" }, "last_name": { "type": "string" }, "ssn": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "role_cd": { "type": "string" }, "role_desc": { "type": "string" } } }, "ExistingInsPolicy": { "title": "Policies list", "type": "object", "properties": { "policy_number": { "type": "string" }, "line_of_business": { "type": "string" }, "confidence_level": { "type": "string" }, "amount_of_insurance": { "type": "string" }, "policy_status_cd": { "type": "string" }, "policy_status_desc": { "type": "string" }, "policy_status_category": { "type": "string" }, "product_type": { "type": "string" }, "plan_name": { "type": "string" }, "rate_class": { "type": "string" }, "policy_date": { "type": "string", "format": "date" }, "effective_date": { "type": "string", "format": "date" }, "claim_date": { "type": "string", "format": "date" }, "application_date": { "type": "string", "format": "date" }, "relationship_type": { "type": "string" }, "reinsurance_code": { "type": "string" }, "nature_of_business": { "type": "string" }, "has_claims": { "type": "boolean" }, "uw_decision": { "type": "string" }, "table_rating": { "type": "string" }, "uw_rating_cd": { "type": "string" }, "temp_flat_extra": { "type": "string" }, "perm_flat_extra": { "type": "string" }, "dividend": { "$ref": "#/components/schemas/Dividend" }, "parties": { "type": "array", "items": { "$ref": "#/components/schemas/ExistingInsParty" } }, "rider_benefit": { "type": "array", "items": { "$ref": "#/components/schemas/RiderAndBenefit" } }, "is_pos_eligible": { "type": "boolean" }, "is_sum_risk": { "type": "boolean" } }, "description": "Policies list" }, "ExistingInsResponse": { "required": [ "policies" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/Transaction" }, "policies": { "title": "Policies list", "type": "array", "description": "Policies list", "items": { "$ref": "#/components/schemas/ExistingInsPolicy" } } } }, "RiderAndBenefit": { "required": [ "rider_name" ], "type": "object", "properties": { "rider_name": { "title": "New Policy Riders", "type": "string", "description": "New Policy Riders", "example": "WOP" }, "rider_amount": { "title": "New Policy Benefit Amount", "type": "number", "description": "New Policy Benefit Amount", "format": "double", "example": 13000 } } }, "UWDataUpdateResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "uwDataId": { "type": "integer", "description": "UW Data Id", "format": "int64" }, "clientKeyId": { "type": "integer", "description": "Client Key Id", "format": "int64" }, "clientSubKeyId": { "type": "integer", "description": "Client Sub Key Id", "format": "int64" }, "clientExists": { "type": "boolean", "description": "Client Exists" } } }, "AddressSearchFilter": { "type": "object", "properties": { "addr_line1": { "type": "string" }, "addr_line2": { "type": "string" }, "addr_line3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip_code": { "type": "string" } } }, "CreditSearchFilter": { "title": "Instant ID Request Data", "type": "object", "properties": { "policy_number": { "type": "string" }, "application_id": { "type": "string" }, "tracking_id": { "type": "string" }, "product_code": { "type": "string" }, "person": { "$ref": "#/components/schemas/PersonSearchFilter" }, "address": { "$ref": "#/components/schemas/AddressSearchFilter" } }, "description": "Instant ID Request Data" }, "CreditSearchRequest": { "required": [ "data_validity_period_in_days", "transaction" ], "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "credit_search_filter": { "$ref": "#/components/schemas/CreditSearchFilter" }, "data_validity_period_in_days": { "title": "DataValidityPeriodInDays", "type": "integer", "description": "Numeric value DataValidityPeriodInDays for reusability logic. Any negative value such as -1 if data is not to be reused, zero for same day.", "format": "int32", "example": -1 }, "policy_num_or_case_id": { "title": "PolicyNumOrCaseId", "type": "string", "description": "Policy Number Or Galaxy Case ID", "example": "123456" }, "order_ref_type": { "title": "OrderReType", "type": "string", "description": "Order reference type of that Policy", "enum": [ "POL", "CASEID" ] } } }, "PersonSearchFilter": { "required": [ "date_of_birth", "first_name", "last_name", "tax_id" ], "type": "object", "properties": { "first_name": { "title": "FirstName", "maxLength": 50, "minLength": 1, "type": "string", "description": "First name of the applicant", "example": "John" }, "last_name": { "title": "LastName", "maxLength": 50, "minLength": 1, "type": "string", "description": "Last name of the applicant", "example": "Mellon" }, "middle_name": { "title": "MiddleName", "maxLength": 50, "type": "string", "description": "Middle name of the applicant" }, "tax_id": { "title": "SSN", "maxLength": 9, "minLength": 9, "type": "string", "description": "Applicant�s Social Security Number. This value should be submitted whenever possible. SSN is passed without dashes or spaces, and must always consist of all 9 characters. Partial values are not allowed.", "example": "123456789" }, "date_of_birth": { "title": "DOB", "type": "string", "description": "Applicant�s date of birth. A valid date is required. The date format is YYYY-MM-DD", "format": "date", "example": "1993-03-24" }, "prefix": { "type": "string" }, "suffix": { "type": "string" } } }, "AddressSearch": { "type": "object", "properties": { "addrSource": { "type": "string" }, "addrStatus": { "type": "string" }, "addrQualifier": { "type": "string" }, "streetUnparsed": { "type": "string" }, "streetNumber": { "type": "string" }, "streetName": { "type": "string" }, "streetType": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" } }, "description": "Address Search" }, "CreditIndicators": { "type": "object", "properties": { "fileHit": { "type": "string" }, "ssnMatch": { "type": "string" }, "isSuppressed": { "type": "string" }, "isFreeze": { "type": "string" }, "isMinor": { "type": "string" }, "isDisputed": { "type": "string" }, "isAddrMismatch": { "type": "string" } }, "description": "Credit Indicators" }, "CreditScore": { "type": "object", "properties": { "scoreResult": { "type": "string" }, "isDerogatoryAlert": { "type": "boolean" }, "isFileInquiriesImpactedScore": { "type": "boolean" }, "noScoreReason": { "type": "string" }, "scoreFactors": { "$ref": "#/components/schemas/ScoreFactors" } }, "description": "Credit Score" }, "CreditSearchResponse": { "type": "object", "properties": { "transaction": { "$ref": "#/components/schemas/TransactionDetail" }, "credit_search_response_data": { "$ref": "#/components/schemas/CreditSearchResponseData" }, "uw_data": { "$ref": "#/components/schemas/UWData" }, "order_status": { "type": "string", "description": "Order Status", "enum": [ "INITIATED", "INPROGRESS", "SUCCESS", "FAILURE", "NOT_FOUND" ] } } }, "CreditSearchResponseData": { "type": "object", "properties": { "policyNumber": { "type": "string", "description": "Policy Number" }, "applicationId": { "type": "string", "description": "Application Id" }, "trackingId": { "type": "string", "description": "Tracking Id" }, "creditIndicators": { "$ref": "#/components/schemas/CreditIndicators" }, "person": { "$ref": "#/components/schemas/PersonSearch" }, "address": { "$ref": "#/components/schemas/AddressSearch" }, "creditScore": { "$ref": "#/components/schemas/CreditScore" } }, "description": "Credit Search Response Data" }, "PersonSearch": { "type": "object", "properties": { "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" }, "taxId": { "type": "string" }, "birthDate": { "type": "string", "format": "date" } }, "description": "Person Search" }, "ScoreFactor": { "type": "object", "properties": { "scoreRank": { "type": "string" }, "scoreCode": { "type": "string" } } }, "ScoreFactors": { "type": "object", "properties": { "scoreFactors": { "type": "array", "items": { "$ref": "#/components/schemas/ScoreFactor" } } } }, "DocData": { "title": "Document Data", "required": [ "doc_id", "doc_type" ], "type": "object", "properties": { "doc_id": { "title": "Doc Id", "type": "string", "description": "Doc Id" }, "doc_type": { "title": "Doc Type", "type": "string", "description": "Doc Type" } }, "description": "Document Data" }, "DocidsByDataidResponseData": { "required": [ "doc_data", "doc_repo" ], "type": "object", "properties": { "doc_data": { "title": "Document Data", "type": "array", "description": "Document Data", "items": { "$ref": "#/components/schemas/DocData" } }, "doc_repo": { "title": "Document Repo", "type": "string", "description": "Document Repo" } } }, "AppHealth": { "type": "object", "properties": { "appStatusCd": { "type": "string" }, "appStatusDesc": { "type": "string" }, "dbStatus": { "type": "string" }, "appBuildVersion": { "type": "string" }, "appCommitHash": { "type": "string" }, "envProperites": { "type": "string" }, "vendorConnectionResponses": { "type": "array", "items": { "$ref": "#/components/schemas/VendorConnectionResponse" } } } }, "VendorConnectionResponse": { "type": "object", "properties": { "vendorName": { "type": "string" }, "vendorUrl": { "type": "string" }, "isSuccess": { "type": "boolean" }, "connectionInformation": { "type": "string" }, "errorResponse": { "type": "string" } } } }, "securitySchemes": {} }, "x-gateways": [], "x-documentation": { "tutorials": [], "spotlights": [] }, "x-rapidapi-info": { "apiVersionId": "apiversion_edb6acf5-268d-42a7-964c-0e965d402c69", "apiId": "api_7dfeccd1-6174-45bc-bd93-2ff05656a852" } }