Industry Content

Overview

  1. Get new loan applications by polling endpoint GET /v1/loan-application-proposed-loan-mappings
  2. Get proposed Loan and customer data to understand customer NAICS code using GET /v/proposed-loans/{id} and GET /v1/customers/{id}
  3. POST in industry data PDF into Documents using POST /v1/document-folders, POST /v1/documents and POST /v1/document-associations

Get new loan applications

Get new loan applications by polling endpoint GET /v1/loan-application-proposed-loan-mappings

curl -X GET "https://api.sageworks.com/v1/loan-application-proposed-loan-mappings" -H "accept: application/json" -H "authorization: Bearer [token]"
{ "items": [ { "id": 0, "loanApplicationId": 0, "proposedLoanId": 0, "applicationTemplateId": 0 } ] }

Get proposed loan and customer data

Get proposed loan and customer data to understand customer NAICS code using GET /v/proposed-loans/{id} and GET /v1/customers/{id}.

curl -X GET "https://api.sageworks.com/v1/proposed-loans/[id]?includeUserDefinedFields=false" -H "accept: application/json" -H "authorization: Bearer [token]"
{ "id": 1280549, "loanId": null, "loanName": "L1", "customerId": 85296182, "loanAmount": 10000, "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": "2021-10-22", "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": false, "isGuidanceLineOfCredit": false, "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": null, "accountType": null, "parentIsProposed": null, "parentLoansId": null, "lossGivenDefaultRiskRating": "0", "probabilityOfDefaultRiskRating": 0, "withheldAmount": null, "userDefinedString1": "", "userDefinedString2": "", "userDefinedString3": "", "userDefinedString4": "", "userDefinedString5": "", "userDefinedString6": "", "userDefinedString7": "", "userDefinedString8": "", "userDefinedString9": "", "userDefinedString10": "", "userDefinedString11": "", "userDefinedString12": "", "userDefinedString13": "", "userDefinedString14": "", "userDefinedString15": "", "userDefinedString16": "", "userDefinedString17": "", "userDefinedString18": "", "userDefinedString19": "", "userDefinedString20": "", "userDefinedNumber1": 0, "userDefinedNumber2": 0, "userDefinedNumber3": 0, "userDefinedNumber4": 0, "userDefinedNumber5": 0, "userDefinedNumber6": 0, "userDefinedNumber7": 0, "userDefinedNumber8": 0, "userDefinedNumber9": 0, "userDefinedNumber10": 0, "userDefinedNumber11": 0, "userDefinedNumber12": 0, "userDefinedNumber13": 0, "userDefinedNumber14": 0, "userDefinedNumber15": 0, "userDefinedNumber16": 0, "userDefinedNumber17": 0, "userDefinedNumber18": 0, "userDefinedNumber19": 0, "userDefinedNumber20": 0, "userDefinedDate1": null, "userDefinedDate2": null, "userDefinedDate3": null, "userDefinedDate4": null, "userDefinedDate5": null, "userDefinedDate6": null, "userDefinedDate7": null, "userDefinedDate8": null, "userDefinedDate9": null, "userDefinedDate10": null, "userDefinedFields": null, "comments": "", "purpose": "" }
curl -X GET "https://api.sageworks.com/v1/customers/[id]?includeUserDefinedFields=false" -H "accept: application/json" -H "authorization: Bearer [token]"
{ "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": "aaron.sutara@abrigo.com", "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 }

Create a new folder

Use POST /v1/document-folders to create a new folder to post documents.

{ "name": "My Financial Document Folder", "type": "customer", "isDeleted": false, "parentDocumentFolderId": 123 }
{ "id": 86475, "type": "customer", "name": "My Financial Document Folder", "parentDocumentFolderId": 69527, "isDeleted": false }

Post the document

Use POST /v1/documents to post the document into Sageworks. Note: documentContent must be in base64 format.

{ "associationCustomerId": 85477283, "document": { "description": "Test File", "documentDated": "2017-12-31", "documentFolderId": 69526, "uniqueIdentifier": "Test Document 123", "name": "Test File", "fileName": "TestFileName.txt" }, "documentContent": { "content": "Z2FyYmFnZSBmYWtl" } }
{ "id": 26278763, "customerId": 85477283, "documentFolderId": 69526, "uniqueIdentifier": "Test Document 123", "name": "Test File", "customerFacingName": null, "fileName": "TestFileName.txt", "sizeInBytes": 12, "isImage": false, "isDeleted": false, "documentDated": "2017-12-31", "description": "Test File", "dateUploaded": "2023-06-15" }

Post document associations

Use POST /v1/document-associations to associate the document with other objects in Sageworks.

{ "id": 50929059, "documentId": 26865232, "objectType": "PortfolioLoan", "objectId": 57649024 }
{ "id": 50929059, "documentId": 26865232, "objectType": "PortfolioLoan", "objectId": 57649024 }

Did this page help you?