GET RequestFile2?apikey={apikey}&TrusteeID={TrusteeID}&Case_Num={Case_Num}&Debtor1SSN={Debtor1SSN}&Debtor2SSN={Debtor2SSN}&CustCode={CustCode}
Attempts to match the input parameters to a case in our repository and return the case/claim/ledger output in response. The api returns a Success or Failure results and the IssueCodes that the process encountered. ** 07/28/2014 - Added additional elements to response of original Claim and Ledger api **
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| apikey |
The apikey used for authentication. Required. |
string |
Required |
| TrusteeID |
4-5 character Alphanumeric Trustee Identifier. To get a full list of TrusteeID's please reference the Trustee api |
string |
None. |
| Case_Num |
Only numeric values allowed. The NDC does not modify or correct any information as it is delivered to us from our Data Providers. |
string |
None. |
| Debtor1SSN |
The last-4 SSN as recorded in the Trustee’s data for the Debtor 1. Only numeric values allowed, please omit any dashes, commas or other alpha characters. |
string |
None. |
| Debtor2SSN |
The last-4 SSN as recorded in the Trustee’s data for the Debtor 2. Only numeric values allowed, please omit any dashes, commas or other alpha characters. |
string |
None. |
| CustCode |
May be any string up to 50 characters. We do not use the string at this time (it may be a client code internal to your systems) but we may be able to display this on our web site at a future date. |
string |
None. |
Response Information
Response Schema Document
Resource Description
A Success or Failure result. Issue Codes which explain what conditions our matching algorythm encounters. The NDC_Case_ID that was matched if a match was found. Full XML results for Case/Claim/Account Ledger data for the requested case if match is found.
RequestFile2| Name | Description | Type | Additional information |
|---|---|---|---|
| MatcherResults | MatchResults |
None. |
|
| CaseDetails | Case2Details |
None. |
|
| Claims | Collection of Claim2 |
None. |
|
| Ledgers | Collection of Ledger2 |
None. |
Response Formats
application/xml, text/xml
Sample:
<RequestFile2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
<CaseDetails>
<AttorneyFeeInPlan>sample string 26</AttorneyFeeInPlan>
<AttorneyFeeOutsidePlan>sample string 28</AttorneyFeeOutsidePlan>
<AttorneyName>sample string 25</AttorneyName>
<AttorneyPaidToDate>sample string 27</AttorneyPaidToDate>
<BalanceOnHand>sample string 30</BalanceOnHand>
<CaseClosedDT>sample string 48</CaseClosedDT>
<CaseConfirmedDT>sample string 47</CaseConfirmedDT>
<CaseStatus>sample string 29</CaseStatus>
<ClaimMarkTotalClaims>sample string 60</ClaimMarkTotalClaims>
<ClaimMarkTotalOutstandingAMT>sample string 61</ClaimMarkTotalOutstandingAMT>
<ClaimMarkTotalOwedAMT>sample string 59</ClaimMarkTotalOwedAMT>
<Debtor1AddressLine1>sample string 2</Debtor1AddressLine1>
<Debtor1AddressLine2>sample string 3</Debtor1AddressLine2>
<Debtor1Alias>sample string 5</Debtor1Alias>
<Debtor1City>sample string 4</Debtor1City>
<Debtor1DBA>sample string 6</Debtor1DBA>
<Debtor1DirectAMT>sample string 7</Debtor1DirectAMT>
<Debtor1Name>sample string 1</Debtor1Name>
<Debtor1PayrollDedAMT>sample string 8</Debtor1PayrollDedAMT>
<Debtor2AddressLine1>sample string 10</Debtor2AddressLine1>
<Debtor2AddressLine2>sample string 11</Debtor2AddressLine2>
<Debtor2Alias>sample string 13</Debtor2Alias>
<Debtor2City>sample string 12</Debtor2City>
<Debtor2DBA>sample string 14</Debtor2DBA>
<Debtor2DirectAMT>sample string 15</Debtor2DirectAMT>
<Debtor2Name>sample string 9</Debtor2Name>
<Debtor2PayrollDedAMT>sample string 16</Debtor2PayrollDedAMT>
<EstimatedMonthsRemaining>sample string 39</EstimatedMonthsRemaining>
<FilingFeePaidToDate>sample string 41</FilingFeePaidToDate>
<FilingFeePlanAMT>sample string 40</FilingFeePlanAMT>
<First341MeetingDT>sample string 46</First341MeetingDT>
<JudgeName>sample string 24</JudgeName>
<LastDisbursementDT>sample string 33</LastDisbursementDT>
<LastReceiptAMT>sample string 32</LastReceiptAMT>
<LastReceiptDT>sample string 31</LastReceiptDT>
<NoticeFeeAMT>sample string 42</NoticeFeeAMT>
<NoticeFeePaidToDate>sample string 43</NoticeFeePaidToDate>
<PaymentAmount1>sample string 50</PaymentAmount1>
<PaymentAmount2>sample string 53</PaymentAmount2>
<PaymentAmount3>sample string 56</PaymentAmount3>
<PaymentDate1>sample string 52</PaymentDate1>
<PaymentDate2>sample string 55</PaymentDate2>
<PaymentDate3>sample string 58</PaymentDate3>
<PaymentDesc1>sample string 51</PaymentDesc1>
<PaymentDesc2>sample string 54</PaymentDesc2>
<PaymentDesc3>sample string 57</PaymentDesc3>
<PetitionFiledDT>sample string 44</PetitionFiledDT>
<PlanBase>sample string 35</PlanBase>
<PlanFiledDT>sample string 45</PlanFiledDT>
<PortfolioAsOfDT>sample string 49</PortfolioAsOfDT>
<Service_Provider>sample string 62</Service_Provider>
<TotalPaidAllParties>sample string 37</TotalPaidAllParties>
<TotalPaidCreditors>sample string 38</TotalPaidCreditors>
<TotalPaidIntoPlan>sample string 36</TotalPaidIntoPlan>
<TrusteeAsOfDT>sample string 20</TrusteeAsOfDT>
<TrusteeCity>sample string 19</TrusteeCity>
<TrusteeID>sample string 23</TrusteeID>
<TrusteeName>sample string 18</TrusteeName>
<TrusteePK>17</TrusteePK>
<TrusteePaidToDate>sample string 22</TrusteePaidToDate>
<TrusteePercent>sample string 21</TrusteePercent>
<UnsecuredPercent>sample string 34</UnsecuredPercent>
</CaseDetails>
<Claims>
<Claim2>
<AccountNumber>sample string 5</AccountNumber>
<ClaimAMT>sample string 14</ClaimAMT>
<ClaimDescription>sample string 2</ClaimDescription>
<ClaimLevel>sample string 3</ClaimLevel>
<ClaimTypeCode>sample string 34</ClaimTypeCode>
<Claim_Num>sample string 1</Claim_Num>
<ClassTypeCode>sample string 35</ClassTypeCode>
<ClassTypeDescription>sample string 36</ClassTypeDescription>
<CollateralValueAMT>sample string 17</CollateralValueAMT>
<Comments>sample string 4</Comments>
<Continuing>sample string 27</Continuing>
<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>
<InterestDueAMT>sample string 23</InterestDueAMT>
<InterestPaidAMT>sample string 22</InterestPaidAMT>
<InterestRate>sample string 21</InterestRate>
<MaxPayAMT>sample string 29</MaxPayAMT>
<MonthlyPaymentAMT>sample string 16</MonthlyPaymentAMT>
<NDC_Case_ID>sample string 31</NDC_Case_ID>
<NDC_Claim_ID>sample string 32</NDC_Claim_ID>
<NoCheck>sample string 25</NoCheck>
<PrincipalDueAMT>sample string 20</PrincipalDueAMT>
<PrincipalOwedAMT>sample string 19</PrincipalOwedAMT>
<PrincipalPaidToDate>sample string 18</PrincipalPaidToDate>
<Reference_No>sample string 37</Reference_No>
<Reserve>sample string 28</Reserve>
<ScheduleAMT>sample string 15</ScheduleAMT>
<Service_Provider>sample string 30</Service_Provider>
<StopDisbursement>sample string 26</StopDisbursement>
<TrusteePercent>sample string 24</TrusteePercent>
<UCI>sample string 33</UCI>
</Claim2>
<Claim2>
<AccountNumber>sample string 5</AccountNumber>
<ClaimAMT>sample string 14</ClaimAMT>
<ClaimDescription>sample string 2</ClaimDescription>
<ClaimLevel>sample string 3</ClaimLevel>
<ClaimTypeCode>sample string 34</ClaimTypeCode>
<Claim_Num>sample string 1</Claim_Num>
<ClassTypeCode>sample string 35</ClassTypeCode>
<ClassTypeDescription>sample string 36</ClassTypeDescription>
<CollateralValueAMT>sample string 17</CollateralValueAMT>
<Comments>sample string 4</Comments>
<Continuing>sample string 27</Continuing>
<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>
<InterestDueAMT>sample string 23</InterestDueAMT>
<InterestPaidAMT>sample string 22</InterestPaidAMT>
<InterestRate>sample string 21</InterestRate>
<MaxPayAMT>sample string 29</MaxPayAMT>
<MonthlyPaymentAMT>sample string 16</MonthlyPaymentAMT>
<NDC_Case_ID>sample string 31</NDC_Case_ID>
<NDC_Claim_ID>sample string 32</NDC_Claim_ID>
<NoCheck>sample string 25</NoCheck>
<PrincipalDueAMT>sample string 20</PrincipalDueAMT>
<PrincipalOwedAMT>sample string 19</PrincipalOwedAMT>
<PrincipalPaidToDate>sample string 18</PrincipalPaidToDate>
<Reference_No>sample string 37</Reference_No>
<Reserve>sample string 28</Reserve>
<ScheduleAMT>sample string 15</ScheduleAMT>
<Service_Provider>sample string 30</Service_Provider>
<StopDisbursement>sample string 26</StopDisbursement>
<TrusteePercent>sample string 24</TrusteePercent>
<UCI>sample string 33</UCI>
</Claim2>
</Claims>
<Ledgers>
<Ledger2>
<Amount>7</Amount>
<CheckNum>sample string 5</CheckNum>
<ClaimDescription>sample string 9</ClaimDescription>
<ClaimNumber>sample string 3</ClaimNumber>
<ClaimTypeCode>sample string 8</ClaimTypeCode>
<ClassDescription>sample string 11</ClassDescription>
<ClassTypeCode>sample string 10</ClassTypeCode>
<Date>2025-12-21T16:05:46.2233528-06:00</Date>
<Description>sample string 6</Description>
<NDC_Claim_ID>sample string 1</NDC_Claim_ID>
<NameOfParty>sample string 4</NameOfParty>
<TransactionType>sample string 12</TransactionType>
</Ledger2>
<Ledger2>
<Amount>7</Amount>
<CheckNum>sample string 5</CheckNum>
<ClaimDescription>sample string 9</ClaimDescription>
<ClaimNumber>sample string 3</ClaimNumber>
<ClaimTypeCode>sample string 8</ClaimTypeCode>
<ClassDescription>sample string 11</ClassDescription>
<ClassTypeCode>sample string 10</ClassTypeCode>
<Date>2025-12-21T16:05:46.2233528-06:00</Date>
<Description>sample string 6</Description>
<NDC_Claim_ID>sample string 1</NDC_Claim_ID>
<NameOfParty>sample string 4</NameOfParty>
<TransactionType>sample string 12</TransactionType>
</Ledger2>
</Ledgers>
<MatcherResults>
<IssueCode>sample string 2</IssueCode>
<NDC_Case_ID>sample string 3</NDC_Case_ID>
<Result>sample string 1</Result>
</MatcherResults>
</RequestFile2>
application/json, text/json
Sample:
{
"MatcherResults": {
"Result": "sample string 1",
"IssueCode": "sample string 2",
"NDC_Case_ID": "sample string 3"
},
"CaseDetails": {
"Debtor1Name": "sample string 1",
"Debtor1AddressLine1": "sample string 2",
"Debtor1AddressLine2": "sample string 3",
"Debtor1City": "sample string 4",
"Debtor1Alias": "sample string 5",
"Debtor1DBA": "sample string 6",
"Debtor1DirectAMT": "sample string 7",
"Debtor1PayrollDedAMT": "sample string 8",
"Debtor2Name": "sample string 9",
"Debtor2AddressLine1": "sample string 10",
"Debtor2AddressLine2": "sample string 11",
"Debtor2City": "sample string 12",
"Debtor2Alias": "sample string 13",
"Debtor2DBA": "sample string 14",
"Debtor2DirectAMT": "sample string 15",
"Debtor2PayrollDedAMT": "sample string 16",
"TrusteePK": 17,
"TrusteeName": "sample string 18",
"TrusteeCity": "sample string 19",
"TrusteeAsOfDT": "sample string 20",
"TrusteePercent": "sample string 21",
"TrusteePaidToDate": "sample string 22",
"TrusteeID": "sample string 23",
"JudgeName": "sample string 24",
"AttorneyName": "sample string 25",
"AttorneyFeeInPlan": "sample string 26",
"AttorneyPaidToDate": "sample string 27",
"AttorneyFeeOutsidePlan": "sample string 28",
"CaseStatus": "sample string 29",
"BalanceOnHand": "sample string 30",
"LastReceiptDT": "sample string 31",
"LastReceiptAMT": "sample string 32",
"LastDisbursementDT": "sample string 33",
"UnsecuredPercent": "sample string 34",
"PlanBase": "sample string 35",
"TotalPaidIntoPlan": "sample string 36",
"TotalPaidAllParties": "sample string 37",
"TotalPaidCreditors": "sample string 38",
"EstimatedMonthsRemaining": "sample string 39",
"FilingFeePlanAMT": "sample string 40",
"FilingFeePaidToDate": "sample string 41",
"NoticeFeeAMT": "sample string 42",
"NoticeFeePaidToDate": "sample string 43",
"PetitionFiledDT": "sample string 44",
"PlanFiledDT": "sample string 45",
"First341MeetingDT": "sample string 46",
"CaseConfirmedDT": "sample string 47",
"CaseClosedDT": "sample string 48",
"PortfolioAsOfDT": "sample string 49",
"PaymentAmount1": "sample string 50",
"PaymentDesc1": "sample string 51",
"PaymentDate1": "sample string 52",
"PaymentAmount2": "sample string 53",
"PaymentDesc2": "sample string 54",
"PaymentDate2": "sample string 55",
"PaymentAmount3": "sample string 56",
"PaymentDesc3": "sample string 57",
"PaymentDate3": "sample string 58",
"ClaimMarkTotalOwedAMT": "sample string 59",
"ClaimMarkTotalClaims": "sample string 60",
"ClaimMarkTotalOutstandingAMT": "sample string 61",
"Service_Provider": "sample string 62"
},
"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"
},
{
"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"
}
],
"Ledgers": [
{
"NDC_Claim_ID": "sample string 1",
"Date": "2025-12-21T16:05:46.2233528-06:00",
"ClaimNumber": "sample string 3",
"NameOfParty": "sample string 4",
"CheckNum": "sample string 5",
"Description": "sample string 6",
"Amount": 7.0,
"ClaimTypeCode": "sample string 8",
"ClaimDescription": "sample string 9",
"ClassTypeCode": "sample string 10",
"ClassDescription": "sample string 11",
"TransactionType": "sample string 12"
},
{
"NDC_Claim_ID": "sample string 1",
"Date": "2025-12-21T16:05:46.2233528-06:00",
"ClaimNumber": "sample string 3",
"NameOfParty": "sample string 4",
"CheckNum": "sample string 5",
"Description": "sample string 6",
"Amount": 7.0,
"ClaimTypeCode": "sample string 8",
"ClaimDescription": "sample string 9",
"ClassTypeCode": "sample string 10",
"ClassDescription": "sample string 11",
"TransactionType": "sample string 12"
}
]
}