GET ClaimAttributeHistory?apikey={apikey}&NDC_Claim_ID={NDC_Claim_ID}&Attribute={Attribute}&HistoryDate={HistoryDate}

Returns the historical values of a given Claim as tracked by the NDC. The response provides the Old Value, New Value and data of change for various attributes of a Claim

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

The apikey used for authentication. Required.

 string

Required
NDC_Claim_ID

The ID of the Claim requested. Required.

 string

Required
Attribute

The specified Attribute to lookup changes for on the given claim. If not provided all changes are returned. Optional. If you don't provide the Attribute parameter then all historical values will be returned for the Claim. The available attributes to lookup changes for are: Continuing_Ind, NO_Check_Ind, Reserve_Ind, Stop_Disburse_Ind, Level, Account_NO, Interest_Rate, Percent_Paid, Trustee_PCT, Claim_AMT, Claim_Adjustment_AMT, Collateral_Value_AMT, Interest_Due_AMT, Interest_Paid_AMT, Max_Pay_AMT, Monthly_Payment_AMT, Principal_Due_AMT, Principal_Owed_AMT, Principal_PTD_AMT, Schedule_AMT, Comment, DSO_Ind, UCI, Creditor_Petition_Address1, Creditor_Petition_Address2, Creditor_Petition_City, Creditor_Petition_State, Creditor_Petition_ZipCode, Claim_Start_Payment_DT, Court_Claim_Num, Mortgage_Due_DT, PCT_Paid, FinalReportCategory, Status_Description, Filed_DT, Mortgage_Address1, Mortgage_Address2, Mortgage_Address3, Mortgage_City, Mortgage_State, Mortgage_ZipCode, MortgageLink, Trustee_Claim_Type, No_Check_Indicator_Description, Stop_Disburse_Indicator_Description, Continuing_Indicator_Description, Reserve_Indicator_Description, No_Cost_Indicator, No_Cost_Description

 string

None.
HistoryDate

A single History Date in the form of MM/DD/YYYY. Returns only changes after the given HistoryDate. If no date is provided all history is returned. Optional.

 date

None.

Response Information

Response Schema Document

Resource Description

The Claim Attributes that change (old value and new value and date of change).

Collection of ClaimAttributeHistory
NameDescriptionTypeAdditional information
Action

string

None.
CaseNumber

string

None.
Claim_Num

string

None.
NDC_Claim_ID

string

None.
NDC_Case_ID

string

None.
AttributeName

string

None.
OldValue

string

None.
NewValue

string

None.
ChangeDate

string

None.

Response Formats

application/xml, text/xml

Sample: 
<ArrayOfClaimAttributeHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <ClaimAttributeHistory>
    <Action>sample string 1</Action>
    <AttributeName>sample string 6</AttributeName>
    <CaseNumber>sample string 2</CaseNumber>
    <ChangeDate>sample string 9</ChangeDate>
    <Claim_Num>sample string 3</Claim_Num>
    <NDC_Case_ID>sample string 5</NDC_Case_ID>
    <NDC_Claim_ID>sample string 4</NDC_Claim_ID>
    <NewValue>sample string 8</NewValue>
    <OldValue>sample string 7</OldValue>
  </ClaimAttributeHistory>
  <ClaimAttributeHistory>
    <Action>sample string 1</Action>
    <AttributeName>sample string 6</AttributeName>
    <CaseNumber>sample string 2</CaseNumber>
    <ChangeDate>sample string 9</ChangeDate>
    <Claim_Num>sample string 3</Claim_Num>
    <NDC_Case_ID>sample string 5</NDC_Case_ID>
    <NDC_Claim_ID>sample string 4</NDC_Claim_ID>
    <NewValue>sample string 8</NewValue>
    <OldValue>sample string 7</OldValue>
  </ClaimAttributeHistory>
</ArrayOfClaimAttributeHistory>

application/json, text/json

Sample: 
[
  {
    "Action": "sample string 1",
    "CaseNumber": "sample string 2",
    "Claim_Num": "sample string 3",
    "NDC_Claim_ID": "sample string 4",
    "NDC_Case_ID": "sample string 5",
    "AttributeName": "sample string 6",
    "OldValue": "sample string 7",
    "NewValue": "sample string 8",
    "ChangeDate": "sample string 9"
  },
  {
    "Action": "sample string 1",
    "CaseNumber": "sample string 2",
    "Claim_Num": "sample string 3",
    "NDC_Claim_ID": "sample string 4",
    "NDC_Case_ID": "sample string 5",
    "AttributeName": "sample string 6",
    "OldValue": "sample string 7",
    "NewValue": "sample string 8",
    "ChangeDate": "sample string 9"
  }
]