GET Claims3?apikey={apikey}&NDC_Claim_ID={NDC_Claim_ID}
Returns a specific Claim by its Claim ID. ** 06/17/2015 - Added additional elements to response of Claim2 api **
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| apikey |
The apikey used for authentication. Required. |
string |
Required |
| NDC_Claim_ID |
The ID of the Claim requested. Required. |
string |
Required |
Response Information
Response Schema Document
Resource Description
A single Claim object
Claim3| Name | Description | Type | Additional information |
|---|---|---|---|
| Claim_Num | string |
None. |
|
| ClaimDescription | string |
None. |
|
| ClaimLevel | string |
None. |
|
| Comments | string |
None. |
|
| AccountNumber | string |
None. |
|
| Creditor_PK | string |
None. |
|
| CreditorName | string |
None. |
|
| CreditorAddressLine1 | string |
None. |
|
| CreditorAddressLine2 | string |
None. |
|
| CreditorCity | string |
None. |
|
| CreditorContactName | string |
None. |
|
| CreditorPhone | string |
None. |
|
| CreditorNumber | string |
None. |
|
| ClaimAMT | string |
None. |
|
| ScheduleAMT | string |
None. |
|
| MonthlyPaymentAMT | string |
None. |
|
| CollateralValueAMT | string |
None. |
|
| PrincipalPaidToDate | string |
None. |
|
| PrincipalOwedAMT | string |
None. |
|
| PrincipalDueAMT | string |
None. |
|
| InterestRate | string |
None. |
|
| InterestPaidAMT | string |
None. |
|
| InterestDueAMT | string |
None. |
|
| TrusteePercent | string |
None. |
|
| NoCheck | string |
None. |
|
| StopDisbursement | string |
None. |
|
| Continuing | string |
None. |
|
| Reserve | string |
None. |
|
| MaxPayAMT | string |
None. |
|
| Service_Provider | string |
None. |
|
| NDC_Case_ID | string |
None. |
|
| NDC_Claim_ID | string |
None. |
|
| UCI | string |
None. |
|
| ClaimTypeCode | string |
None. |
|
| ClassTypeCode | string |
None. |
|
| ClassTypeDescription | string |
None. |
|
| Reference_No | string |
None. |
|
| Creditor_Petition_Address1 | string |
None. |
|
| Creditor_Petition_Address2 | string |
None. |
|
| Creditor_Petition_City | string |
None. |
|
| Creditor_Petition_State | string |
None. |
|
| Creditor_Petition_ZipCode | string |
None. |
|
| Claim_Start_Payment_DT | string |
None. |
|
| Court_Claim_Num | string |
None. |
|
| Mortgage_Due_DT | string |
None. |
|
| Percent_To_Be_Paid | string |
None. |
|
| Percent_Paid_To_Date | string |
None. |
|
| FinalReportCategory | string |
None. |
|
| Status_Description | string |
None. |
|
| Filed_DT | string |
None. |
|
| Collateral_Description | string |
None. |
|
| Current_Fix_Pay_AMT | string |
None. |
|
| Fix_Pay_Start | string |
None. |
|
| Fix_Pay_Arrearages | string |
None. |
|
| Amt_Allowed | string |
None. |
|
| Amt_Claimed | string |
None. |
|
| Proof_Of_Claim_Amt | string |
None. |
|
| Distrib_Source | string |
None. |
|
| Distrib_Status | string |
None. |
|
| Filed_By | string |
None. |
|
| Amended | string |
None. |
|
| Last_Disburse | string |
None. |
|
| Interest_Not_Satisfied | string |
None. |
|
| Interest_Next_Month | string |
None. |
|
| ClaimTagClaimIdentifier | string |
None. |
|
| ClaimTagPaymentType | string |
None. |
|
| ClaimTag | string |
None. |
Response Formats
application/xml, text/xml
Sample:
<Claim3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models"> <AccountNumber>sample string 5</AccountNumber> <Amended>sample string 61</Amended> <Amt_Allowed>sample string 55</Amt_Allowed> <Amt_Claimed>sample string 56</Amt_Claimed> <ClaimAMT>sample string 14</ClaimAMT> <ClaimDescription>sample string 2</ClaimDescription> <ClaimLevel>sample string 3</ClaimLevel> <ClaimTag>sample string 67</ClaimTag> <ClaimTagClaimIdentifier>sample string 65</ClaimTagClaimIdentifier> <ClaimTagPaymentType>sample string 66</ClaimTagPaymentType> <ClaimTypeCode>sample string 34</ClaimTypeCode> <Claim_Num>sample string 1</Claim_Num> <Claim_Start_Payment_DT>sample string 43</Claim_Start_Payment_DT> <ClassTypeCode>sample string 35</ClassTypeCode> <ClassTypeDescription>sample string 36</ClassTypeDescription> <CollateralValueAMT>sample string 17</CollateralValueAMT> <Collateral_Description>sample string 51</Collateral_Description> <Comments>sample string 4</Comments> <Continuing>sample string 27</Continuing> <Court_Claim_Num>sample string 44</Court_Claim_Num> <CreditorAddressLine1>sample string 8</CreditorAddressLine1> <CreditorAddressLine2>sample string 9</CreditorAddressLine2> <CreditorCity>sample string 10</CreditorCity> <CreditorContactName>sample string 11</CreditorContactName> <CreditorName>sample string 7</CreditorName> <CreditorNumber>sample string 13</CreditorNumber> <CreditorPhone>sample string 12</CreditorPhone> <Creditor_PK>sample string 6</Creditor_PK> <Creditor_Petition_Address1>sample string 38</Creditor_Petition_Address1> <Creditor_Petition_Address2>sample string 39</Creditor_Petition_Address2> <Creditor_Petition_City>sample string 40</Creditor_Petition_City> <Creditor_Petition_State>sample string 41</Creditor_Petition_State> <Creditor_Petition_ZipCode>sample string 42</Creditor_Petition_ZipCode> <Current_Fix_Pay_AMT>sample string 52</Current_Fix_Pay_AMT> <Distrib_Source>sample string 58</Distrib_Source> <Distrib_Status>sample string 59</Distrib_Status> <Filed_By>sample string 60</Filed_By> <Filed_DT>sample string 50</Filed_DT> <FinalReportCategory>sample string 48</FinalReportCategory> <Fix_Pay_Arrearages>sample string 54</Fix_Pay_Arrearages> <Fix_Pay_Start>sample string 53</Fix_Pay_Start> <InterestDueAMT>sample string 23</InterestDueAMT> <InterestPaidAMT>sample string 22</InterestPaidAMT> <InterestRate>sample string 21</InterestRate> <Interest_Next_Month>sample string 64</Interest_Next_Month> <Interest_Not_Satisfied>sample string 63</Interest_Not_Satisfied> <Last_Disburse>sample string 62</Last_Disburse> <MaxPayAMT>sample string 29</MaxPayAMT> <MonthlyPaymentAMT>sample string 16</MonthlyPaymentAMT> <Mortgage_Due_DT>sample string 45</Mortgage_Due_DT> <NDC_Case_ID>sample string 31</NDC_Case_ID> <NDC_Claim_ID>sample string 32</NDC_Claim_ID> <NoCheck>sample string 25</NoCheck> <Percent_Paid_To_Date>sample string 47</Percent_Paid_To_Date> <Percent_To_Be_Paid>sample string 46</Percent_To_Be_Paid> <PrincipalDueAMT>sample string 20</PrincipalDueAMT> <PrincipalOwedAMT>sample string 19</PrincipalOwedAMT> <PrincipalPaidToDate>sample string 18</PrincipalPaidToDate> <Proof_Of_Claim_Amt>sample string 57</Proof_Of_Claim_Amt> <Reference_No>sample string 37</Reference_No> <Reserve>sample string 28</Reserve> <ScheduleAMT>sample string 15</ScheduleAMT> <Service_Provider>sample string 30</Service_Provider> <Status_Description>sample string 49</Status_Description> <StopDisbursement>sample string 26</StopDisbursement> <TrusteePercent>sample string 24</TrusteePercent> <UCI>sample string 33</UCI> </Claim3>
application/json, text/json
Sample:
{
"Claim_Num": "sample string 1",
"ClaimDescription": "sample string 2",
"ClaimLevel": "sample string 3",
"Comments": "sample string 4",
"AccountNumber": "sample string 5",
"Creditor_PK": "sample string 6",
"CreditorName": "sample string 7",
"CreditorAddressLine1": "sample string 8",
"CreditorAddressLine2": "sample string 9",
"CreditorCity": "sample string 10",
"CreditorContactName": "sample string 11",
"CreditorPhone": "sample string 12",
"CreditorNumber": "sample string 13",
"ClaimAMT": "sample string 14",
"ScheduleAMT": "sample string 15",
"MonthlyPaymentAMT": "sample string 16",
"CollateralValueAMT": "sample string 17",
"PrincipalPaidToDate": "sample string 18",
"PrincipalOwedAMT": "sample string 19",
"PrincipalDueAMT": "sample string 20",
"InterestRate": "sample string 21",
"InterestPaidAMT": "sample string 22",
"InterestDueAMT": "sample string 23",
"TrusteePercent": "sample string 24",
"NoCheck": "sample string 25",
"StopDisbursement": "sample string 26",
"Continuing": "sample string 27",
"Reserve": "sample string 28",
"MaxPayAMT": "sample string 29",
"Service_Provider": "sample string 30",
"NDC_Case_ID": "sample string 31",
"NDC_Claim_ID": "sample string 32",
"UCI": "sample string 33",
"ClaimTypeCode": "sample string 34",
"ClassTypeCode": "sample string 35",
"ClassTypeDescription": "sample string 36",
"Reference_No": "sample string 37",
"Creditor_Petition_Address1": "sample string 38",
"Creditor_Petition_Address2": "sample string 39",
"Creditor_Petition_City": "sample string 40",
"Creditor_Petition_State": "sample string 41",
"Creditor_Petition_ZipCode": "sample string 42",
"Claim_Start_Payment_DT": "sample string 43",
"Court_Claim_Num": "sample string 44",
"Mortgage_Due_DT": "sample string 45",
"Percent_To_Be_Paid": "sample string 46",
"Percent_Paid_To_Date": "sample string 47",
"FinalReportCategory": "sample string 48",
"Status_Description": "sample string 49",
"Filed_DT": "sample string 50",
"Collateral_Description": "sample string 51",
"Current_Fix_Pay_AMT": "sample string 52",
"Fix_Pay_Start": "sample string 53",
"Fix_Pay_Arrearages": "sample string 54",
"Amt_Allowed": "sample string 55",
"Amt_Claimed": "sample string 56",
"Proof_Of_Claim_Amt": "sample string 57",
"Distrib_Source": "sample string 58",
"Distrib_Status": "sample string 59",
"Filed_By": "sample string 60",
"Amended": "sample string 61",
"Last_Disburse": "sample string 62",
"Interest_Not_Satisfied": "sample string 63",
"Interest_Next_Month": "sample string 64",
"ClaimTagClaimIdentifier": "sample string 65",
"ClaimTagPaymentType": "sample string 66",
"ClaimTag": "sample string 67"
}