Guides

Boarding Loans

Suggest Edits

High-Level Walkthrough

The following steps can be used to board loans:

  1. End user signifies a loan which is ready for boarding within the UI
  2. Get loan boarding events
  3. Get proposed Loan File for loan and all related information
  4. Board to core
  5. Update loanBoardingIdentifier
  6. Generate portfolio loans
  7. Associate proposed loan with the portfolio loan
  8. Close loan boarding events on all successfully boarded loans

User signifies a loan is ready for boarding

Users can navigate to Administration - Loan Boarding - Select loan - Board loan to core. This will then create a loan boarding event which can be leveraged in conjunction with at timed job to find all loans which should be boarded.

Get loan boarding events

The endpoint GET /v1/events can be leveraged to get all events. The event type loanBoardedEvent can be specified to only get events of that type.

curl -X GET "https://api.sageworks.com/v1/events?eventType=loanBoardedEvent" -H "accept: application/json"

[
  {
    "id": 125464545,
    "eventTime": "2021-08-01",
    "eventType": "loanBoardedEvent",
    "eventContent": {
      "ProposedLoanId": "654321"
    },
    "isComplete": false
  },
  {
    "id": 125464546,
    "eventTime": "2021-08-03",
    "eventType": "loanBoardedEvent",
    "eventContent": {
      "ProposedLoanId": "654321"
    },
    "isComplete": false
  }
]

Update Loan Boarding Identifier on the proposed loan

At this point the institution may update the proposed loan with the the core system unique identifier. That field can be housed in the loanBoardingIdentifier field.

Use Get proposed-loan-file for loan and all related information

The endpoint GET /v1/proposed-loan-file/{proposedLoanId} may be leveraged to then to get the proposed loan as well as the related customer and collateral information.

curl -X GET "https://api.sageworks.com/v1/proposed-loan-file/{proposedLoanId}" -H "accept: application/json" -H "authorization: Bearer {token}"

{
  "proposedLoan": {
    "id": 1884007,
    "loanId": null,
    "loanName": "ProposedLoanFile",
    "customerId": 85477283,
    "loanAmount": 82923,
    "riskRating": 0,
    "paymentAmount": 0,
    "paymentFrequency": "monthly",
    "paymentType": "fixedPayment",
    "loanOfficerId": null,
    "interestRate": 0,
    "callCode": "",
    "collateralCode": "",
    "loanTypeCode": "",
    "productCode": "",
    "purposeCode": "",
    "industryCode": "",
    "adjustableInterestRate": false,
    "loanTerm": 0,
    "dayCountConvention": null,
    "amortizedOver": null,
    "isDeleted": false,
    "status": null,
    "createdDate": "2023-08-29",
    "statusLastUpdatedDate": null,
    "probabilityOfClosing": null,
    "projectedClosingDate": null,
    "totalFees": 0,
    "otherFees": 0,
    "expectedUtilizationRate": 0,
    "originationExpenses": 0,
    "overheadExpenses": 0,
    "upfrontFee": 0,
    "annualFee": 0,
    "unusedCommitmentFee": 0,
    "servicingExpenses": 0,
    "floorRate": 0,
    "indexRateDescription": null,
    "indexRate": 0,
    "spread": 0,
    "ceilingRate": 0,
    "proposedLoanStageId": null,
    "proposedProductsId": null,
    "evaluatedCreditScore": null,
    "bankCodeBranch": "",
    "denialOrWithdrawalReason": null,
    "denialOrWithdrawalReasons": null,
    "loanTypeForDenialOrWithdrawal": null,
    "statusReason": "",
    "firstPaymentDate": null,
    "firstInterestPaymentDate": null,
    "isSubjectToRegO": null,
    "isTakedownLoan": null,
    "isGuidanceLineOfCredit": null,
    "noteDate": null,
    "disbursementDate": null,
    "discountPointsDollarAmount": null,
    "includeNegativeAmortization": null,
    "brokerCompensationPercent": null,
    "lenderCredits": null,
    "introductionRatePeriodInMonths": null,
    "pointsAndFees": null,
    "isPreapprovalRequested": null,
    "isReverseMortgage": null,
    "rateLockDate": null,
    "includeOtherNonAmortizingFeatures": null,
    "ecoaAdverseAction1": null,
    "ecoaAdverseAction2": null,
    "ecoaAdverseAction3": null,
    "hmdaLoanType": null,
    "hmdaLoanPurposeType": null,
    "hmdaPurchaserType": null,
    "hmdaFinalActionTakenType": null,
    "craLoanType": null,
    "craLoanPurposeType": null,
    "hmdaAmortizationType": null,
    "hmdaHoepaStatusType": null,
    "craRevenueCodeType": null,
    "interestOnlyTerm": 0,
    "accountType": null,
    "parentIsProposed": null,
    "parentLoansId": null,
    "lossGivenDefaultRiskRating": "0",
    "probabilityOfDefaultRiskRating": 0,
    "withheldAmount": null,
    "institutionAvailableCredit": null,
    "institutionWithheld": null,
    "participatedAmount": null,
    "userDefinedString1": null,
    "userDefinedString2": null,
    "userDefinedString3": null,
    "userDefinedString4": null,
    "userDefinedString5": null,
    "userDefinedString6": null,
    "userDefinedString7": null,
    "userDefinedString8": null,
    "userDefinedString9": null,
    "userDefinedString10": null,
    "userDefinedString11": null,
    "userDefinedString12": null,
    "userDefinedString13": null,
    "userDefinedString14": null,
    "userDefinedString15": null,
    "userDefinedString16": null,
    "userDefinedString17": null,
    "userDefinedString18": null,
    "userDefinedString19": null,
    "userDefinedString20": null,
    "userDefinedNumber1": null,
    "userDefinedNumber2": null,
    "userDefinedNumber3": null,
    "userDefinedNumber4": null,
    "userDefinedNumber5": null,
    "userDefinedNumber6": null,
    "userDefinedNumber7": null,
    "userDefinedNumber8": null,
    "userDefinedNumber9": null,
    "userDefinedNumber10": null,
    "userDefinedNumber11": null,
    "userDefinedNumber12": null,
    "userDefinedNumber13": null,
    "userDefinedNumber14": null,
    "userDefinedNumber15": null,
    "userDefinedNumber16": null,
    "userDefinedNumber17": null,
    "userDefinedNumber18": null,
    "userDefinedNumber19": null,
    "userDefinedNumber20": null,
    "userDefinedDate1": null,
    "userDefinedDate2": null,
    "userDefinedDate3": null,
    "userDefinedDate4": null,
    "userDefinedDate5": null,
    "userDefinedDate6": null,
    "userDefinedDate7": null,
    "userDefinedDate8": null,
    "userDefinedDate9": null,
    "userDefinedDate10": null,
    "userDefinedFields": null,
    "comments": "",
    "purpose": "",
    "loanBoardingIdentifier": null
  },
  "customers": [
    {
      "customer": {
        "id": 85477283,
        "name": "New, User",
        "dba": null,
        "firstName": "User",
        "middleInitial": "",
        "lastName": "New",
        "nameSuffix": "",
        "userDefinedFields": null,
        "creditScore": 0,
        "secondaryCreditScore": 0,
        "businessType": null,
        "dnbScore": null,
        "namePrefix": "",
        "jobTitle": "Product Manager",
        "addresses": [
          {
            "line1": "123 fake lane",
            "line2": "",
            "city": "Raleigh",
            "state": "NC",
            "postalCode": "27608",
            "country": "US",
            "addressType": "primary"
          }
        ],
        "phoneNumbers": [
          {
            "type": "primary",
            "number": "(123) 456-7890"
          }
        ],
        "type": "person",
        "emailAddress": "[email protected]",
        "industryCode": null,
        "isDeleted": false,
        "uniqueIdentifier": "",
        "taxId": "999-99-9999",
        "branch": "",
        "department": "",
        "website": "",
        "description": null,
        "restricted": false,
        "checkingBalance": 0,
        "savingsBalance": 0,
        "cDsBalance": 0,
        "averageChecking": 0,
        "averageSavings": 0,
        "averageCDs": 0,
        "citizenshipStatus": null,
        "maritalStatus": null,
        "isActiveMiltaryDuty": null,
        "isDependentOfActiveMiltaryDuty": null,
        "civDescription": null,
        "employer": "",
        "numberOfYearsEmployed": 0,
        "ofacDesignation": "Negative",
        "dateOfBirth": null,
        "idDescription": null,
        "idNumber": null,
        "idIssueDate": null,
        "idExpirationDate": null,
        "idIssuingAuthority": null,
        "comments": "",
        "msa": null,
        "stateCode": null,
        "countyCode": null,
        "tractCode": null,
        "longitude": null,
        "latitude": null,
        "medianHouseholdIncome": null,
        "metropolitanDivision": null,
        "metropolitanDivisionCode": null,
        "loanOfficer": null,
        "loanOfficerId": null,
        "loanAdministrator": null,
        "equifaxCreditScore": null,
        "equifaxCreditScoreDate": null,
        "experianCreditScore": null,
        "experianCreditScoreDate": null,
        "transunionCreditScore": null,
        "transunionCreditScoreDate": null,
        "ficoSbssCreditScore": null,
        "ficoSbssCreditScoreDate": null,
        "bankruptcies": null,
        "dateOfLastBankruptcy": null,
        "historical30DayDelinquencies": null,
        "historical60DayDelinquencies": null,
        "historical90DayDelinquencies": null,
        "historicalOtherDelinquencies": null,
        "currentMortgagePastDue": null,
        "currentInstallmentPastDue": null,
        "currentAutoPastDue": null,
        "currentEducationPastDue": null,
        "currentOpenPastDue": null,
        "currentRevolvingPastDue": null,
        "currentOtherPastDue": null,
        "currentTotalPastDue": null,
        "entryMethod": "operatingCompany",
        "professionalLLC": null,
        "yearFounded": 0,
        "businessRegistered": null,
        "farmRegistered": null,
        "stateOfFormation": null,
        "franchiseName": null,
        "franchiseLegalName": null,
        "franchiseStartDate": null,
        "sbaCode": null,
        "cityHQ": null,
        "stateHQ": null,
        "franchiseDataImportDate": null,
        "franchiseDataFinancialPeriod": null,
        "historicalSuccessRate": null,
        "systemSupportAndExpenseCommitment": null,
        "resaleActivityLevel": null,
        "mngmtExperienceStability": null,
        "averageUnitRevenueGrowth": null,
        "prospectScreening": null,
        "unitEconomics": null,
        "franchiseAgreementAssessment": null,
        "franchiseeRelationship": null,
        "projectedUnitSuccess": null,
        "recurringRevenueSelfSufficiency": null,
        "totalFundScore": null,
        "finStatementStrength": null,
        "franchisedUnits": null,
        "minInitial": null,
        "maxInitial": null,
        "avgInitial": null,
        "companyOwnedUnits": null,
        "projectedOpenings": null,
        "compoundAnnualUnitGrowthRate": null,
        "compoundedUnitSuccessRate": null,
        "experianDBT": null,
        "equifaxDBT": null,
        "dbdbt": null,
        "dbPaydex": null,
        "ansoniaCreditRating": null,
        "ansoniaRiskScore": null,
        "creditLogicScore": null,
        "dbViabilityRating": null,
        "lastReportRun": null,
        "bankruptciesCount": null,
        "collectionsCount": null,
        "judgmentsCount": null,
        "chargeOffsCount": null,
        "liensCount": null,
        "nsfChecksCount": null,
        "dataDepthScore": null,
        "underFormation": null,
        "dateBusinessEstablished": null,
        "loanBoardingIdentifier": "71923test"
      },
      "loanRole": {
        "id": 6257891,
        "customerId": 85477283,
        "portfolioLoanId": null,
        "proposedLoanId": 1884007,
        "percentResponsible": 0,
        "roleType": "Primary Borrower",
        "isDeleted": false
      }
    }
  ],
  "collaterals": [
    {
      "id": 45059222,
      "description": "proposed loan file collateral",
      "currentValue": 5000,
      "mostRecentAppraisalValue": 5000,
      "mostRecentAppraisalDate": "2023-08-15",
      "collateralCode": "",
      "collateralType": "Inventory",
      "customerId": 85477283,
      "originalValue": 0,
      "discountRate": 0,
      "isDeleted": false,
      "propertyAddress": null,
      "propertyCity": null,
      "propertyState": null,
      "propertyZip": null,
      "propertyCounty": null,
      "propertyTaxID": null,
      "make": null,
      "vin": null,
      "model": null,
      "year": null,
      "bodyStyle": null,
      "serialNumber": null,
      "manufacturer": null,
      "aircraftNumber": null,
      "vesselName": null,
      "vesselNumber": null,
      "possessoryType": null,
      "accountLOCNumber": null,
      "issuedBy": null,
      "issuer": null,
      "shares": null,
      "cusip": null,
      "heldBy": null,
      "beneficiary": null,
      "letterOfCreditDate": null,
      "govtContractNumber": null,
      "govtContractDate": null,
      "titledType": "titled",
      "floodDeterminationDate": "2023-08-01",
      "specialFloodHazardArea": 1,
      "capitalizationRate": 0.01,
      "isLOMC": null,
      "collateralBreakout": null,
      "cbraAndOPADesignationDate": null,
      "dwelling": null,
      "vesselLength": null,
      "floodZone": null,
      "floodZoneCode": null,
      "floodProgramType": null,
      "isLandImprovements": null,
      "lomcCaseNumber": null,
      "lomcDate": null,
      "nfipMapNumber": null,
      "nfipMapPanelDate": null,
      "nfipCommunityName": null,
      "nfipCommunityNumber": null,
      "nfipPropertyDescription": null,
      "constructionMethod": null,
      "manufacturedHomeType": null,
      "manufacturedHomeLandPropertyInterest": null,
      "totalUnits": null,
      "multiFamilyAffordableUnits": null,
      "occupancyType": null,
      "isForAgriculturalPurpose": null,
      "isOwnerOccupied": null,
      "isSecondHome": null,
      "isProtectedArea": null,
      "stateCode": null,
      "countyCode": null,
      "tractCode": null,
      "latitude": null,
      "longitude": null,
      "metropolitanStatisticalArea": null,
      "medianHouseholdIncome": null,
      "metropolitanDivision": null,
      "metropolitanDivisionCode": null,
      "userDefinedFields": null,
      "dateAppraisalRequested": null,
      "isReadyForAppraisal": null,
      "collateralMetadataType": "proposed",
      "collateralIdentifier": "",
      "legalDescription": null
    }
  ]
}

Board loan and relevant information to core

At this point all the necessary information regarding that loan can be used to board to core.

Generate portfolio loan if necessary

Use POST /v1/portfolio-loans to create one or portfolio loan or POST /v1/portfolio-loans/bulk to post multiple portfolio loans in a single call. The customerId and loanOfficerId will need updated for each loan.

{
  "name": "Loan Name",
  "paymentType": "fixedPayment",
  "paymentAmount": 5523,
  "unamortizedPremium": 1312,
  "paymentFrequency": "monthly",
  "customerId": 85477283,
  "bookBalance": 573000.32,
  "currentBalance": 573000.32,
  "loanNumber": "100041235",
  "dayCountConvention": "c_30_360",
  "callCode": "1a",
  "purposeCode": "110",
  "industryCode": "110210",
  "remainingTermInMonths": 60,
  "productCode": "Real Estate",
  "loanTypeCode": "Real Estate - Owner Occupied",
  "currentAvailableCredit": 0,
  "collateralCode": "Office Building",
  "troubledDebtRestructure": false,
  "interestRate": 0.097,
  "floorRate": 0.03,
  "ceilingRate": 0.25,
  "indexRateDescription": "libor",
  "spread": 0.02,
  "indexRate": 0.02,
  "renewalDate": "2017-12-15",
  "watchList": false,
  "timesPastDue3060": 1,
  "defaultStartDate": "2017-04-18",
  "adjustableInterestRate": true,
  "points": 0,
  "refinance": false,
  "originationDate": "2007-01-31",
  "accruedInterest": 274.23,
  "maturityDate": "2030-12-15",
  "timesPastDue6090": 0,
  "timesPastDue90Plus": 1,
  "originalLoanAmount": 1250000,
  "originalTermInMonths": 60,
  "governmentGuaranteed": false,
  "latestPaymentDate": "2023-08-05",
  "daysCurrentlyPastDue": 15,
  "chargedOffAmount": 418.92,
  "amountPastDue": 615.91,
  "prepaymentPenalty": false,
  "loanOfficerId": 431871,
  "loanToValueRatio": 0.754,
  "netDeferredFeesOrCosts": 1200,
  "totalFees": 500,
  "expectedUtilizationRate": 0.25,
  "upfrontFee": 100,
  "annualFee": 100,
  "unusedCommitmentFee": 100,
  "originationExpenses": 200,
  "overheadExpenses": 200,
  "servicingExpenses": 200,
  "nonAccrual": false,
  "riskRating": 4,
  "isDeleted": false,
  "userDefinedString1": "Commercial",
  "userDefinedString2": "Fixed Rate",
  "userDefinedString3": "",
  "userDefinedString4": "",
  "userDefinedString5": "",
  "userDefinedString6": "",
  "userDefinedString7": "Another User Defined Value",
  "userDefinedString8": "",
  "userDefinedString9": "",
  "userDefinedString10": "",
  "userDefinedString11": "",
  "userDefinedString12": "",
  "userDefinedString13": "",
  "userDefinedString14": "",
  "userDefinedString15": "",
  "userDefinedString16": "",
  "userDefinedString17": "",
  "userDefinedString18": "",
  "userDefinedString19": "",
  "userDefinedString20": "",
  "userDefinedNumber1": 13.77,
  "userDefinedNumber2": 1044,
  "userDefinedNumber3": 0.0045,
  "userDefinedNumber4": 7,
  "userDefinedNumber5": 7,
  "userDefinedNumber6": 7,
  "userDefinedNumber7": 7,
  "userDefinedNumber8": 7,
  "userDefinedNumber9": 7,
  "userDefinedNumber10": 7,
  "userDefinedNumber11": 7,
  "userDefinedNumber12": 7,
  "userDefinedNumber13": 7,
  "userDefinedNumber14": 7,
  "userDefinedNumber15": 7,
  "userDefinedNumber16": 7,
  "userDefinedNumber17": 7,
  "userDefinedNumber18": 7,
  "userDefinedNumber19": 7,
  "userDefinedNumber20": 7,
  "userDefinedDate1": "2023-09-05",
  "userDefinedDate2": "2023-09-04",
  "userDefinedDate3": "2023-09-05",
  "userDefinedDate4": "2023-09-05",
  "userDefinedDate5": "2023-09-05",
  "userDefinedDate6": "2023-09-05",
  "userDefinedDate7": "2023-09-05",
  "userDefinedDate8": "2023-09-05",
  "userDefinedDate9": "2023-09-05",
  "userDefinedDate10": "2023-09-05",
  "isGuidanceLineOfCredit": true
}

{
  "id": 87081656,
  "loanNumber": "100041235",
  "name": "Loan Name",
  "customerId": 85477283,
  "currentBalance": 573000.32,
  "unamortizedPremium": 1312,
  "bookBalance": 573000.32,
  "riskRating": 4,
  "paymentAmount": 5523,
  "paymentFrequency": "monthly",
  "paymentType": "fixedPayment",
  "loanOfficerId": null,
  "interestRate": 0.097,
  "floorRate": 0.03,
  "ceilingRate": 0.25,
  "indexRateDescription": "libor",
  "spread": 0.02,
  "indexRate": 0.02,
  "callCode": "1a",
  "collateralCode": "Office Building",
  "loanTypeCode": "Real Estate - Owner Occupied",
  "productCode": "Real Estate",
  "purposeCode": "110",
  "industryCode": "110210",
  "nonAccrual": false,
  "nonAccrualDate": null,
  "troubledDebtRestructure": false,
  "troubledDebtRestructureDate": null,
  "defaultStartDate": "2017-04-18",
  "adjustableInterestRate": true,
  "timesPastDue3060": 1,
  "timesPastDue6090": 0,
  "timesPastDue90Plus": 1,
  "daysCurrentlyPastDue": 15,
  "chargedOffAmount": 418.92,
  "amountPastDue": 615.91,
  "prepaymentPenalty": false,
  "remainingTermInMonths": 60,
  "dayCountConvention": "c_30_360",
  "amortizedOver": null,
  "currentAvailableCredit": 0,
  "maturityDate": "2030-12-15",
  "netDeferredFeesOrCosts": 1200,
  "totalFees": 500,
  "expectedUtilizationRate": 0.25,
  "upfrontFee": 100,
  "annualFee": 100,
  "unusedCommitmentFee": 100,
  "originationExpenses": 200,
  "overheadExpenses": 200,
  "servicingExpenses": 200,
  "accruedInterest": 274.23,
  "originalLoanAmount": 1250000,
  "originationDate": "2007-01-31",
  "originalTermInMonths": 60,
  "renewalDate": "2017-12-15",
  "governmentGuaranteed": false,
  "governmentGuaranteedPercent": null,
  "governmentGuaranteedBalance": null,
  "watchList": false,
  "points": 0,
  "refinance": false,
  "latestPaymentDate": "2023-08-05",
  "loanToValueRatio": 0.754,
  "isDeleted": false,
  "isGuidanceLineOfCredit": true,
  "bankCodeBranch": "",
  "accountType": "loan",
  "parentLoansId": null,
  "withheldAmount": null,
  "institutionAvailableCredit": null,
  "institutionWithheld": null,
  "userDefinedString1": "Commercial",
  "userDefinedString2": "Fixed Rate",
  "userDefinedString3": "",
  "userDefinedString4": "",
  "userDefinedString5": "",
  "userDefinedString6": "",
  "userDefinedString7": "Another User Defined Value",
  "userDefinedString8": "",
  "userDefinedString9": "",
  "userDefinedString10": "",
  "userDefinedString11": "",
  "userDefinedString12": "",
  "userDefinedString13": "",
  "userDefinedString14": "",
  "userDefinedString15": "",
  "userDefinedString16": "",
  "userDefinedString17": "",
  "userDefinedString18": "",
  "userDefinedString19": "",
  "userDefinedString20": "",
  "userDefinedNumber1": 13.77,
  "userDefinedNumber2": 1044,
  "userDefinedNumber3": 0.0045,
  "userDefinedNumber4": 7,
  "userDefinedNumber5": 7,
  "userDefinedNumber6": 7,
  "userDefinedNumber7": 7,
  "userDefinedNumber8": 7,
  "userDefinedNumber9": 7,
  "userDefinedNumber10": 7,
  "userDefinedNumber11": 7,
  "userDefinedNumber12": 7,
  "userDefinedNumber13": 7,
  "userDefinedNumber14": 7,
  "userDefinedNumber15": 7,
  "userDefinedNumber16": 7,
  "userDefinedNumber17": 7,
  "userDefinedNumber18": 7,
  "userDefinedNumber19": 7,
  "userDefinedNumber20": 7,
  "userDefinedDate1": "2023-09-05",
  "userDefinedDate2": "2023-09-04",
  "userDefinedDate3": "2023-09-05",
  "userDefinedDate4": "2023-09-05",
  "userDefinedDate5": "2023-09-05",
  "userDefinedDate6": "2023-09-05",
  "userDefinedDate7": "2023-09-05",
  "userDefinedDate8": "2023-09-05",
  "userDefinedDate9": "2023-09-05",
  "userDefinedDate10": "2023-09-05",
  "userDefinedFields": null
}

Associate proposed loan with the portfolio loan

POST /v1/proposed-loans/associate may be leveraged to connect the proposed loan with the portfolio loan.

{
  "proposedLoanId": 0,
  "portfolioLoanId": 0,
  "copyLoanInformation": true,
  "moveDocuments": true,
  "moveNarratives": true,
  "copyPolicyExceptions": true,
  "copyCollateral": true,
  "collateralMappings": [
    {
      "proposedCollateralId": 0,
      "existingCollateralId": 0
    }
  ]
}

Close the loan boarding event

Once all actions are complete regarding boarding the loan and all updates are successful, the loan boarding event may now be closed

PATCH /v1/events{id}/complete can be used to complete loan boarding events by id. This will make sure that the event does not appear in further queries for loan boarding events.

Updated about 1 year ago