Guides

Loan Search

Use the API to find one or many loans from a given search criteria

Suggest Edits

Searching for loans in an NLS database is quite simple using the API. We will be using the API endpoint, POST /loans/search to find our loan to display on a customer or agent facing web portal.

The search is done by passing a JSON payload through the API request, loanSearchParam parameter. The value of a JSON attribute is used as the search criteria. Below is entire the JSON payload that can be used in the API request for searching: 

{
  "Portfolio_Code_Id": "",
  "Acctrefno": "",
  "Loan_Number": "",
  "Cifno": "",
  "Cifnumber": "",
  "Loan_Group_No": "",
  "Investor": {
    "Cifnumber": ""
  },
  "Shortname": "",
  "Name": "",
  "Loan_Class1_No": "",
  "Loan_Class2_No": "",
  "Risk_Rating_No": "",
  "Entity": "",
  "Tin": "",
  "Tin_Hash": "",
  "Status_Code_No": "",
  "Status_Codes": {
    "HasNone": false,
    "ApplyOrOperator": false,
    "SelectionsToInclude": [],
    "SelectionsToExclude": []
  },
  "Loan_Officer_No": "",
  "Collection_Officer_No": "",
  "Input_Date": "",
  "Open_Date": "",
  "Curr_Date": "",
  "Curr_Maturity_Date": "",
  "Payoff_Date": "",
  "Closed_Date": "",
  "Last_Activity_Date": "",
  "Interest_Accrued_Thru_Date": "",
  "Interest_Paid_Thru_Date": "",
  "Principal_Paid_Thru_Date": "",
  "Next_Statement1_Date": "",
  "Next_Accrual_Cutoff": "",
  "Loan_Type": "",
  "Interest_Method": "",
  "Current_Interest_Rate": "",
  "Term": "",
  "Term_Due": "",
  "Term_Char": "",
  "SAC_Expiration_Date": "",
  "SAC_Ineligible_Date": "",
  "Credit_Line_Limit": "",
  "Current_Note_Amount": "",
  "Current_Perdiem": "",
  "Current_Servicing_Balance": "",
  "Current_Principal_Balance": "",
  "Current_Interest_Balance": "",
  "Current_Def_Interest_Balance": "",
  "Current_Fees_Balance": "",
  "Current_Late_Charge_Balance": "",
  "Current_Udf1_Balance": "",
  "Current_Udf2_Balance": "",
  "Current_Udf3_Balance": "",
  "Current_Udf4_Balance": "",
  "Current_Udf5_Balance": "",
  "Current_Udf6_Balance": "",
  "Current_Udf7_Balance": "",
  "Current_Udf8_Balance": "",
  "Current_Udf9_Balance": "",
  "Current_Udf10_Balance": "",
  "Current_Payoff_Balance": "",
  "Current_Suspense": "",
  "Current_Impound_Balance": "",
  "Current_Ol1_Balance": "",
  "Current_Ol2_Balance": "",
  "Current_Ol3_Balance": "",
  "Balloon_Payment_Amount": "",
  "Balloon_Payment_Date": "",
  "Next_Principal_Due_Amount": "",
  "Next_Principal_Payment_Date": "",
  "Next_Interest_Due_Amount": "",
  "Next_Interest_Payment_Date": "",
  "Next_Payment_Total_Amount": "",
  "Last_Payment_Amount": "",
  "Last_Payment_Date": "",
  "Total_Past_Due_Balance": "",
  "Days_Past_Due": "",
  "Total_Current_Due_Balance": "",
  "InterestOnlyPeriod": false,
  "ParentOfShadowLoan": false,
  "Participant": {
    "Participantrefno": "",
    "Participant_Number": "",
    "Shortname": "",
    "Loan_Group_No": ""
  },
  "Cif_Loan_Relationship": {
    "Cifno": "",
    "Cifnumber": "",
    "Relationship_Code_Id": ""
  },
  "Transaction_History": {
    "Transaction_Date": "",
    "Effective_Date": "",
    "Gl_Date": "",
    "Transaction_Code": "",
    "Transaction_Amount": "",
    "User_Reference": "",
    "Payment_Method_No": "",
    "Payment_Method_Reference": "",
    "Userdef01": "",
    "Userdef02": "",
    "Userdef03": "",
    "Userdef04": "",
    "Userdef05": ""
  },
  "Payment_History": {
    "Date_Due": "",
    "Date_Paid": "",
    "Gl_Date": "",
    "Payment_Amount": "",
    "User_Reference": "",
    "Payment_Method_No": "",
    "Payment_Method_Reference": "",
    "Userdef01": "",
    "Userdef02": "",
    "Userdef03": "",
    "Userdef04": "",
    "Userdef05": "",
    "SearchPayoffsOnly": false,
    "SearchPaymentsOnly": false
  },
  "Promise_To_Pay": {
    "Promise_Date": "",
    "Promise_Kept_Date": "",
    "Promise_Amount": "",
    "SearchBrokenPromisesOnly": false,
    "SearchSoftBrokenPromisesOnly": false,
    "Promise_Broken_Date": "",
    "Promise_Softbroken_Date": ""
  },
  "Next_Impound_Analysis_Date": "",
  "Branch_Cifno": "",
  "BranchDivisionID": "",
  "Dealer_Cifno": "",
  "Master_Acctrefno": "",
  "Pool_Acctrefno": ""
}**`POST` `/loans/search`**

📘

Quick Tip

You don't have to pass all of the attributes. You can formulate a JSON payment with only attributes you wish to use for your search criteria.

Search Examples

{
 "Loan_Number": "Sampleloan1",
}

{
 "Portfolio_Code_Id": "01",
}

{
 "Loan_Number": "%",
}

Postman Example

If you imported the Swagger into Postman, [POST /loans/search] will already be configured for you. For this example we will be using Postman to search for Loan Number NortridgeLoan1. The JSON payload will be entered in the body request tab. This is how the Postman request will look like:

Request Header

Content-Type needs to be set to application/json

Request Body

JSON script will go here. Set the request type to Raw and format to JSON.

🚧

Auth Token

Make sure to authorize with a token before sending the request.
[Check out how to get an access token] (https://apidocs.nortridge.com/docs/get-access-token)

🚧

Don't Forget to Authenticate!

Make sure to authorize with a token before sending the request.
[Check out how to get an access token] (https://apidocs.nortridge.com/docs/get-access-token)

📘

Control your output

You can also customize how the loan data is returned with Query Parameters. Check out POST /loans/search for more details.

Click on Send when you are ready to execute this endpoint.

The API will return with a status 200 if the request is valid. totalCount is the number of loans found. Since we are looking for a single loan, we expect a totalCount 1.

The returned loan will also include all basic loan attributes in JSON format. Here is an example output for 1 loan. 

{
    "status": {
        "code": 200,
        "message": "Success"
    },
    "payload": {
        "totalCount": 1,
        "count": 1,
        "data": [
            {
                "Acctrefno": 10634,
                "Loan_Type": 0,
                "Portfolio_Code_Id": 0,
                "Loan_Number": "NORTRIDGELOAN1",
                "Cifno": 2,
                "Loan_Group_No": 1,
                "Shortname": "HARPER LEE",
                "Name": "Lee Harper ",
                "Loan_Class1_No": 0,
                "Loan_Class2_No": 0,
                "Risk_Rating_No": 0,
                "Entity": "INDIVIDUAL",
                "Branch_Cifno": null,
                "Status_Code_No": 0,
                "Loan_Officer_No": 0,
                "Collection_Officer_No": 0,
                "Dealer_Cifno": null,
                "Master_Acctrefno": 0,
                "Pool_Acctrefno": 0,
                "Shadow_Loan_Exists": false,
                "Curr_Maturity_Date": "2022-12-05T00:00:00",
                "Interest_Accrued_Thru_Date": "2021-12-04T00:00:00",
                "Current_Note_Amount": 10000.00,
                "Current_Payoff_Balance": 10000.0000000000,
                "Days_Past_Due": 0,
                "Closed_Date": null
            }
        ]
    }
}

Updated 5 months ago