# Create a Life Claim Setup a Life Claim based on defined configuration and optionally setup the Life Claim payments. Endpoint: POST /create-life-claim Version: v1 Security: apiKeyAuth, bearerAuth ## Header parameters: - `vbasoftware-database` (string, required) Target database ## Request fields (application/json): - `subscriber_ID` (string,null) - `member_Seq` (string,null) - `plan_ID` (string,null) - `volume` (number,null) - `claimNumber` (string,null) - `deathDate` (string,null) - `lastDayWorked` (string,null) - `causeOfDeath` (integer,null) - `illness` (integer,null) - `illnessDuration` (integer,null) - `illnessDurationType` (string,null) - `attendingProviderID` (string,null) - `attendingFirstName` (string,null) - `attendingLastName` (string,null) - `attendingOrgName` (string,null) - `attendingAddress` (string,null) - `attendingAddress2` (string,null) - `attendingCity` (string,null) - `attendingState` (string,null) - `attendingZipCode` (string,null) - `attendingEntityID` (string,null) - `diagType` (string,null) - `diag1` (string,null) - `diag2` (string,null) - `diag3` (string,null) - `diag4` (string,null) - `payTo` (string,null) - `mailTo` (string,null) - `exCode1` (string,null) - `exCode2` (string,null) - `place` (string,null) - `receivedDate` (string,null) - `procedureCode` (string,null) - `createPayment` (boolean) - `customFields` (array,null) - `customFields.idCodeValue_Key` (integer, required) Key value identifying a specific ID Code value Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected. - `customFields.entry_Date` (string) Date record was first added to the system - `customFields.entry_User` (string,null) User that first added the record to the system - `customFields.iD_Code` (string, required) Identifier for a specific ID Code - `customFields.iD_Code_Data` (string,null) Data value for the ID Code when it is a string - `customFields.iD_Code_Data_Date` (string,null) Data value for the ID Code when it is a datetime field - `customFields.iD_Code_Data_Decimal` (number,null) Data value for the ID Code when it is a decimal - `customFields.iD_Code_Data_Number` (integer,null) Data value for the ID Code when it is a integer - `customFields.iD_Code_Data_Option` (boolean,null) Data value for the ID Code when it is a bit - `customFields.key_Column1` (string,null) Key value column name that the ID Code is associated with - `customFields.key_Column2` (string,null) Additional key value column name that the ID Code is associated with (if needed) - `customFields.key_Column3` (string,null) Additional key value column name that the ID Code is associated with (if needed) - `customFields.key_Column4` (string,null) Additional key value column name that the ID Code is associated with (if needed) - `customFields.key_Column5` (string,null) Additional key value column name that the ID Code is associated with (if needed) - `customFields.key_DataType1` (string,null) Data type of the key value column the ID Code is associated with - `customFields.key_DataType2` (string,null) Additional data type of the key value column the ID Code is associated with (if needed) - `customFields.key_DataType3` (string,null) Additional data type of the key value column the ID Code is associated with (if needed) - `customFields.key_DataType4` (string,null) Additional data type of the key value column the ID Code is associated with (if needed) - `customFields.key_DataType5` (string,null) Additional data type of the key value column the ID Code is associated with (if needed) - `customFields.key_Value1` (string,null) Value of the key value column the ID Code is associated with - `customFields.key_Value2` (string,null) Additional value of the key value column the ID Code is associated with (if needed) - `customFields.key_Value3` (string,null) Additional value of the key value column the ID Code is associated with (if needed) - `customFields.key_Value4` (string,null) Additional value of the key value column the ID Code is associated with (if needed) - `customFields.key_Value5` (string,null) Additional value of the key value column the ID Code is associated with (if needed) - `customFields.type` (string, required) Type of the ID Code - `customFields.update_Date` (string) Date the record was last updated in the system - `customFields.update_User` (string,null) User that last updated the record in the system - `beneficiaries` (array,null) - `beneficiaries.subscriber_ID` (string, required) References Members.Subscriber_ID value on the parent record. - `beneficiaries.member_Seq` (string, required) References Members.Member_Seq value on the parent record. - `beneficiaries.beneficiary_ID` (string,null) Unique identifier for this beneficiary on this member. - `beneficiaries.address` (string,null) Primary address of the Beneficiary. - `beneficiaries.address2` (string,null) Address line 2 of the Beneficiary's primary address. - `beneficiaries.assignment` (number,null) A set amount paid to a beneficiary. - `beneficiaries.city` (string,null) City of the Beneficiary's primary address. - `beneficiaries.country_ID` (string,null) Identifier of the country of the Beneficiary's primary address. - `beneficiaries.date_Of_Birth` (string,null) Date of birth of the Beneficiary. - `beneficiaries.end_Date` (string,null) End date of the Beneficiary's status. - `beneficiaries.entry_Date` (string) Date when the record was first added to the system. - `beneficiaries.entry_User` (string,null) User that first added the record to the system. - `beneficiaries.exclude_Interest` (boolean, required) Indicates if interest should be excluded when adjudicating Life claims paid to this beneficiary. Note: The database will apply a default value of False for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of False to meet the API requirements and ensure that the functionality occurs as expected. - `beneficiaries.first_Name` (string,null) First name of the Beneficiary. - `beneficiaries.last_Name` (string,null) Last name of the Beneficiary. - `beneficiaries.long_Name` (string,null) Full name of the Beneficiary. - `beneficiaries.middle_Name` (string,null) Middle name of the Beneficiary. - `beneficiaries.percentage` (number,null) Percentage of the benefit that is allotted to the associated Beneficiary. - `beneficiaries.primary_Beneficiary` (boolean,null) Indicates whether the associated Beneficiary is the primary Beneficiary. - `beneficiaries.relationship` (string,null) Relationship of the Beneficiary to the Member. - `beneficiaries.ssn` (string,null) Social security number of the Beneficiary. - `beneficiaries.secondary_Beneficiary` (boolean,null) This flag indicates if this beneficiary is secondary. - `beneficiaries.start_Date` (string,null) Start date of the Beneficiary's status. - `beneficiaries.state` (string,null) State of the Beneficiary's primary address. - `beneficiaries.tertiary_Beneficiary` (boolean,null) This flag indicates if this tertiary is secondary. - `beneficiaries.update_Date` (string) Date when the record was last updated in the system. - `beneficiaries.update_User` (string,null) User that last updated the record in the system. - `beneficiaries.zip` (string,null) Zip code of the Beneficiary's primary address. - `lifeBenefits` (array,null) - `lifeBenefits.batch_Number` (integer, required) - `lifeBenefits.benefit_Code` (string, required) - `lifeBenefits.entry_Date` (string) - `lifeBenefits.entry_User` (string,null) - `lifeBenefits.update_Date` (string) - `lifeBenefits.update_User` (string,null) - `documents` (array,null) - `documents.noteData` (object) - `documents.noteData.note_Key` (integer, required) Key value used to identify a specific note - `documents.noteData.effective_Date` (string,null) Date the information in the note goes into effect - `documents.noteData.note_Alert` (boolean, required) Flag identifying if there is an alert associated with the note - `documents.noteData.note_Alert_End` (string,null) Date the alert associated with a note terminates - `documents.noteData.note_Category` (string,null) Identifies the 'Category' of note. Note 'Category' are configured within 'Note Configuration'. - `documents.noteData.note_Data` (string,null) Text data of the note. - `documents.noteData.note_Priority` (string,null) Identifies the 'Priority' of note. Note 'Priority' are configured within 'Note Configuration'. - `documents.noteData.note_Subject` (string,null) Description of the note's subject. - `documents.noteData.note_Type` (string,null) Identifies the 'Type' of note. Note 'Types' are configured within 'Note Configuration'. - `documents.noteData.term_Date` (string,null) Date the information in the note terminates - `documents.noteAttachments` (array,null) - `documents.noteAttachments.attachment_Key` (integer, required) Key value identifying an attachment to a note Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected. - `documents.noteAttachments.attachment` (string,null) Attachment data assocaited with a note - `documents.noteAttachments.attachment_File` (string,null) Name of the file that has been uploaded as an attachment. - `documents.noteAttachments.attachment_Path` (string,null) Path of the file that has been uploaded as an attachment. - `documents.noteAttachments.note_Key` (integer, required) Key value identifying the note that attachment is associated with Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected. ## Response 200 fields (text/plain): - `data` (integer) - `error` (object) - `error.detail` (string,null) A human-readable explanation specific to this occurrence of the problem. - `error.instance` (string,null) A URI reference that identifies the specific occurrence of the problem.It may or may not yield further information if dereferenced. - `error.status` (integer) The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. - `error.title` (string,null) A short, human-readable summary of the problem type.It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization(e.g., using proactive content negotiation; see[RFC7231], Section 3.4). - `error.type` (string,null) A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". - `debug` (object) - `debug.activityID` (string, required) ## Response 401 fields