GET RequestFile2/MatchResults?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. The api returns a Success or Failure results and the IssueCodes that the process encountered.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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.

RequestFileMatchResults2
NameDescriptionTypeAdditional information
MatcherResults

MatchResults

None.

Response Formats

application/xml, text/xml

Sample: 
<RequestFileMatchResults2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NDCapi.Models">
  <MatcherResults>
    <IssueCode>sample string 2</IssueCode>
    <NDC_Case_ID>sample string 3</NDC_Case_ID>
    <Result>sample string 1</Result>
  </MatcherResults>
</RequestFileMatchResults2>

application/json, text/json

Sample: 
{
  "MatcherResults": {
    "Result": "sample string 1",
    "IssueCode": "sample string 2",
    "NDC_Case_ID": "sample string 3"
  }
}