GET RequestFile4/RequestClaims?apikey={apikey}&TrusteeID={TrusteeID}&CaseNumber={CaseNumber}&SSN={SSN}&CourtClaimNumber={CourtClaimNumber}&ClaimAmount={ClaimAmount}&CreditorName={CreditorName}

Returns detailed information about a claim. The API attempts to match on a case and a specific claim on the case based on the input parameters provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apikey

The apikey used for authentication. Required.

 string

Required
TrusteeID

Alphanumeric Trustee Identifier. Optional.

 string

Required
CaseNumber

A Specific 7 digit Case number to find. Required.

 string

Required
SSN

Last 4 of the debtor SSN. Optional.

 string

Required
CourtClaimNumber

Alphanumeric claim identifier. Used to match to a specific claim. Optional.

 string

Required
ClaimAmount

Money amount of claim. Must be in decimal format. Used to match to a specific claim. Optional.

 string

Required
CreditorName

Name of creditor on the claim being searched for. Must be 4 characters or longer. Matching attempts fuzzy search for creditor name. Optional.

 string

Required

Response Information

Response Schema Document

Resource Description

The api will attempt to match on case with either CaseNumber + TrusteeID or CaseNumber + SSN. Then will attempt to match on claim with CourtClaimNumber + ClaimAmount, CourtClaimNumber + CreditorName (fuzzy search), or ClaimAmount + CreditorName (fuzzy search)..

RequestFileClaims
NameDescriptionTypeAdditional information
MatcherResults

MatchClaimResults

None.
Claims

Claim4

None.

Response Formats

application/xml, text/xml

Sample: 
<RequestFileClaims xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <Claims>
    <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>
    <Continuing_Indicator_Description>sample string 80</Continuing_Indicator_Description>
    <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>
    <IsClaimMarked>sample string 69</IsClaimMarked>
    <Last_Disburse>sample string 62</Last_Disburse>
    <MaxPayAMT>sample string 29</MaxPayAMT>
    <MonthlyPaymentAMT>sample string 16</MonthlyPaymentAMT>
    <MortgageLink>sample string 76</MortgageLink>
    <Mortgage_Address1>sample string 70</Mortgage_Address1>
    <Mortgage_Address2>sample string 71</Mortgage_Address2>
    <Mortgage_Address3>sample string 72</Mortgage_Address3>
    <Mortgage_City>sample string 73</Mortgage_City>
    <Mortgage_Due_DT>sample string 45</Mortgage_Due_DT>
    <Mortgage_State>sample string 74</Mortgage_State>
    <Mortgage_ZipCode>sample string 75</Mortgage_ZipCode>
    <NDC_Case_ID>sample string 31</NDC_Case_ID>
    <NDC_Claim_ID>sample string 32</NDC_Claim_ID>
    <NDC_Creditor_ID>sample string 68</NDC_Creditor_ID>
    <NoCheck>sample string 25</NoCheck>
    <No_Check_Indicator_Description>sample string 78</No_Check_Indicator_Description>
    <No_Cost_Description>sample string 83</No_Cost_Description>
    <No_Cost_Indicator>sample string 82</No_Cost_Indicator>
    <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>
    <Reserve_Indicator_Description>sample string 81</Reserve_Indicator_Description>
    <ScheduleAMT>sample string 15</ScheduleAMT>
    <Service_Provider>sample string 30</Service_Provider>
    <Status_Description>sample string 49</Status_Description>
    <StopDisbursement>sample string 26</StopDisbursement>
    <Stop_Disburse_Indicator_Description>sample string 79</Stop_Disburse_Indicator_Description>
    <TrusteePercent>sample string 24</TrusteePercent>
    <Trustee_Claim_Type>sample string 77</Trustee_Claim_Type>
    <UCI>sample string 33</UCI>
  </Claims>
  <MatcherResults>
    <CaseNumber_Match>sample string 6</CaseNumber_Match>
    <ClaimAmount_Match>sample string 9</ClaimAmount_Match>
    <CourtClaimNumber_Match>sample string 8</CourtClaimNumber_Match>
    <CreditorName_Match>sample string 10</CreditorName_Match>
    <NDC_Case_ID>sample string 3</NDC_Case_ID>
    <NDC_Claim_ID>sample string 4</NDC_Claim_ID>
    <ResultCase>sample string 1</ResultCase>
    <ResultClaim>sample string 2</ResultClaim>
    <SSN_Match>sample string 7</SSN_Match>
    <TrusteeID_Match>sample string 5</TrusteeID_Match>
  </MatcherResults>
</RequestFileClaims>

application/json, text/json

Sample: 
{
  "MatcherResults": {
    "ResultCase": "sample string 1",
    "ResultClaim": "sample string 2",
    "NDC_Case_ID": "sample string 3",
    "NDC_Claim_ID": "sample string 4",
    "TrusteeID_Match": "sample string 5",
    "CaseNumber_Match": "sample string 6",
    "SSN_Match": "sample string 7",
    "CourtClaimNumber_Match": "sample string 8",
    "ClaimAmount_Match": "sample string 9",
    "CreditorName_Match": "sample string 10"
  },
  "Claims": {
    "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",
    "NDC_Creditor_ID": "sample string 68",
    "IsClaimMarked": "sample string 69",
    "Mortgage_Address1": "sample string 70",
    "Mortgage_Address2": "sample string 71",
    "Mortgage_Address3": "sample string 72",
    "Mortgage_City": "sample string 73",
    "Mortgage_State": "sample string 74",
    "Mortgage_ZipCode": "sample string 75",
    "MortgageLink": "sample string 76",
    "Trustee_Claim_Type": "sample string 77",
    "No_Check_Indicator_Description": "sample string 78",
    "Stop_Disburse_Indicator_Description": "sample string 79",
    "Continuing_Indicator_Description": "sample string 80",
    "Reserve_Indicator_Description": "sample string 81",
    "No_Cost_Indicator": "sample string 82",
    "No_Cost_Description": "sample string 83"
  }
}