Property

APIDescription
GET api/Property/Get?preApprovalID={preApprovalID}

Returns property information

GET api/Property/GetTypes

Returns list of property types

PUT api/Property/Save?preApprovalID={preApprovalID}

creates or updates property information

DELETE api/Property/Delete?preApprovalID={preApprovalID}

Deletes property information. Used when User sets off check box 'I have selected property'.

Borrower

Borrower and Co-Borrower management methods

APIDescription
GET api/Borrower/Get

Returns info about Borrower, which is signed in

PUT api/Borrower/Save

Saves Borrower's entity. Use to create new or update existing

DELETE api/Borrower/DeleteCoBorrower?coBorrowerID={coBorrowerID}&preApprovalID={preApprovalID}

Delete co-borrower only. Used when managing list of Co-Borrowers

PUT api/Borrower/JoinCoBorrower?preApprovalID={preApprovalID}

Joins co-borrower to the loan and send invitation with token valid for 3 days

GET api/Borrower/GetCoborrowerList?preApprovalID={preApprovalID}

Returns list of co-borrowers

POST api/Borrower/SetCoBorrowers?haveBorrowers={haveBorrowers}&ignoreCoBorrowers={ignoreCoBorrowers}&preApprovalID={preApprovalID}

Used to set information about list of co-borrowers

GET api/Borrower/AreCoBorrowersIgnored?preApprovalID={preApprovalID}

Returns information about co-borrowers: ignore them or not

POST api/Borrower/SendInvitation?coBorrowerID={coBorrowerID}&email={email}&preApprovalID={preApprovalID}

Used to resend invitation to the coborrower

GET api/Borrower/IsEmailUnique?eMail={eMail}

Checks borrower's email for uniqueness

GET api/Borrower/IsPersonalIDUnique?personalID={personalID}

Checks borrower's personal ID for uniqueness

GET api/Borrower/IsPersonalIDValid?personalID={personalID}&Residence={Residence}

Validates borrower's personal ID

GET api/Borrower/IsPersonalDocumentNumberUnique?personalDocumentType={personalDocumentType}&personalDocumentNumber={personalDocumentNumber}

Checks borrower's personal document number for uniqueness

GET api/Borrower/IspersonalDocumentNumberValid?personalDocumentType={personalDocumentType}&personalDocumentNumber={personalDocumentNumber}&Residence={Residence}

Validates borrower's personal document number according to country rules

GET api/Borrower/IsPhoneNoUnique?phoneNoCountryCode={phoneNoCountryCode}&phoneNo={phoneNo}

Checks borrower's phone for uniqueness

Document

Controller to work with Documents. Documents are prepared by Lendstream backend systems

APIDescription
GET api/Document/Get?documentID={documentID}&preApprovalID={preApprovalID}

Returns stream of pdf file if found. Should be used within separate window

GET api/Document/GetDocuments?preApprovalID={preApprovalID}

Returns list of documents created for Borrower when PreApproval is granted

POST api/Document/SendByEmail?documentID={documentID}&preApprovalID={preApprovalID}

Initiates sending specified document by email.

Config

Returns settings for the application and methods for the dropdowns

APIDescription
GET api/Config/Get

Returns system setting and defaults

GET api/Config/GetCountries

Returns list of countries

GET api/Config/GetCountry?countryCode={countryCode}

Returns country by code

GET api/Config/GetLoanPurposes?loanTypeID={loanTypeID}

Returns list of Loan Purposes for Applications

GET api/Config/GetLoanTypes

Returns list of Loan Types for Applications

GET api/Config/GetPropertyTypes?loanTypeID={loanTypeID}

Returns list of Property Types for Property

GET api/Config/GetMaritalStatuses

Returns list of Marital Statuses for Borrowers and Coborrowes

GET api/Config/GetEducationBackgrounds

Returns list of Education Backgrounds for Borrowers and Coborrowers

GET api/Config/GetCoBorrowerRelationTypes

Returns list of Relation Type of CoBorrower to Borrower

GET api/Config/GetPersonalDocumentTypes

Returns list of Personal Document Types for Borrower registration

Lead

Method for Light Leads (contact forms)

APIDescription
POST api/Lead/Add

Create Lead within LMIS

Signing

APIDescription
GET api/Signing/GetMethods

Returns list of signing methods

POST api/Signing/Initiate?providerID={providerID}&preapprovalID={preapprovalID}

Should be called when user press on specific bank button

Agreement

Controller to work with consents. The configuration of Consents is handled in Lendstream.io

APIDescription
POST api/Agreement/Accept?preApprovalID={preApprovalID}

Sets marker when user press accept site rules or similar

GET api/Agreement/GetList?preApprovalID={preApprovalID}

Returns list of Aceepted of Agreements and rules

GET api/Agreement/GetConsentList?preApprovalID={preApprovalID}&pageIDs={pageIDs}

Returns list of Consents

User

User account related actions

APIDescription
GET api/User/Login?userName={userName}&password={password}

Authenticates user and returns token with expiry.

GET api/User/Get

Returns User entity

PUT api/User/Save

Saves User Entity

DELETE api/User/Delete

Deletes User account. Used when User selects 'Delete me from your site'. After deletion user session and token is also destoryed

GET api/User/IsUnique?userName={userName}

Used to check user name uniquiness. Use it when it is entering

POST api/User/ForgotPassword?eMail={eMail}

Used to generate and send password. Returns 'Not found' if there is no such email and active use account

POST api/User/ConfirmEmail?urlSent={urlSent}&emailToken={emailToken}

Confirms user's email after User press link within email http://meyerweb.com/eric/tools/dencoder/

POST api/User/ConfirmInvitation?urlSent={urlSent}&emailToken={emailToken}

Confirms Invitation sent for coborrowers if it is valid. To get detailed information about Invitation, use GetCoborrowerInvitationStatus

GET api/User/GetCoborrowerInvitationStatus?emailToken={emailToken}

Returns detailed information about Coborrower Invitation

POST api/User/ConfirmReferralInvitation?emailToken={emailToken}

Confirms Referral Invitation sent by Developer

POST api/User/DenyInvitation?urlSent={urlSent}&emailToken={emailToken}

Denies Invitation for coborrowers

POST api/User/ResendEmail?eMail={eMail}

Resends email confirmation letter for user account

POST api/User/ResendPhoneNoValidationCode?countryCode={countryCode}&phoneNo={phoneNo}&language={language}

Resends security code to phone to validate

GET api/User/ValidatePhoneNoCode?countryCode={countryCode}&phoneNo={phoneNo}&securityCode={securityCode}

Used to validate phone no. Use it when it is entered or changed

POST api/User/ChangePassword?password={password}&passwordConfirmation={passwordConfirmation}

Changes password for user

POST api/User/ResendEmailValidationCode?eMail={eMail}&languageCode={languageCode}

Resends security code to email

POST api/User/ResendPasswordChangeCode?eMail={eMail}&languageCode={languageCode}

Resends security code to for password change

POST api/User/ConfirmPasswordChange?eMail={eMail}&password={password}&securityCode={securityCode}

Changes password for the user if email and security code matches

GET api/User/ValidateEmailCode?eMail={eMail}&securityCode={securityCode}

Used to validate email with security code. Use it when it is entered or changed

Monitoring

Controller for monitoring purposes. no Authorization is required.

APIDescription
GET api/Monitoring/IsAlive

Used for monitoring purposes

Developer

Methods for RealEstate Developer and Broker referrals Application

APIDescription
GET api/Developer/Login?userName={userName}&password={password}

Login for Developer's. Use this to get Token for Developer's workplace

GET api/Developer/GetDeveloper

Returns filled in Developer information

GET api/Developer/GetReferral?referralID={referralID}

Returns filled in Referral Entity

GET api/Developer/GetReferralList?fromDate={fromDate}&throughDate={throughDate}

Returns list of Referral Entities

GET api/Developer/GetPipelineReport?fromDate={fromDate}&throughDate={throughDate}

Returns Pipeline report

GET api/Developer/GetPropertyList

Returns list of Properties of Developer/Broker

POST api/Developer/SendInvitation?referralID={referralID}

Resends invitation to potential borrower

PUT api/Developer/Save

Save referral's invitation

POST api/Developer/AcceptTOC

Marks that Developed Accepted TOC

MIncomes

Methods for Monthly income, Liabilities and Dependants (kids)

APIDescription
GET api/MIncomes/Get?preApprovalID={preApprovalID}

Returns monthly incomes and liabilities of Borrower which signed in

GET api/MIncomes/GetVerified?borrowerID={borrowerID}&preApprovalID={preApprovalID}

Returns info about verified incomes and expenses

PUT api/MIncomes/Save?preApprovalID={preApprovalID}

Creates or updates Monthly Incomes and Liabilities

Status

Methods for getting Pre-Approval status, describes steps proceeded and data entered by User

APIDescription
GET api/Status/Get?preApprovalID={preApprovalID}

Returns Status of whole project/pre-approval. Ready for initiation = 0, InProgress=1, Declined=2, NotEnoughInformation=3, SentForManualReview=4, Deleted = 5, PreApprovalOptionsExist = 9, Approved = 10, Not initiated = -1

BankReport

APIDescription
GET api/BankReport/GetBankReports?bankID={bankID}&preapprovalID={preapprovalID}

Returns list of bank reports

DELETE api/BankReport/Delete?bankReportID={bankReportID}

Deletes specified Bank Report information.

POST api/BankReport/Initiate?bankID={bankID}&preapprovalID={preapprovalID}

Should be called when user press on specific bank button

GET api/BankReport/UpdateStatus?bankID={bankID}&eventType={eventType}&preapprovalID={preapprovalID}

Updates status for particular bank based on user acctions. initiated by JavaScript handler (Instantor) Implemented as GET on purpose not to mess up information within API

POST api/BankReport/UpdateKontomatikSuccess?bankID={bankID}&sessionId={sessionId}&sessionIdSignature={sessionIdSignature}&preapprovalID={preapprovalID}

Updates status for particular bank based on user acctions. initiated by JavaScript handler (Kontomatik) Implemented as POST on purpose not to mess up information within API

Calculator

Methods for Calculators used on Customer Web Sites

APIDescription
GET api/Calculator/GetDTI?mincome={mincome}&liabilities={liabilities}

Returns calculated DTI information

GET api/Calculator/GetMonthlyPayment?propertyPrice={propertyPrice}&downpayment={downpayment}&interestRate={interestRate}&term={term}&insurancePMTPercent={insurancePMTPercent}&propertyTaxPercent={propertyTaxPercent}

Returns calculated Monthly Payment information

GET api/Calculator/GetPropertyPrice?mincome={mincome}&liabilities={liabilities}&downpayment={downpayment}&interestRate={interestRate}&term={term}&MAXDti={MAXDti}

Returns calculated Maximum Property Price information

PreApproval

Pre-Approval management and submission methods

APIDescription
POST api/PreApproval/Add

Creates PreApproval object. User must be logged in. Returns ID of PreApproval object to be used for other calls

GET api/PreApproval/GetCurrent

Returns Current PreApproval object ID.

GET api/PreApproval/GetPage?preApprovalID={preApprovalID}

Returns name of page to show for PreApproval ID. Possible values: show_new_preapproval, show_user_profile, show_bank_list, show_income, show_coborrower, show_inprogress, show_not_enough_information, show_initiation, show_manual_review, show_bud_options, show_approval, show_preapproval_list

GET api/PreApproval/Get?preApprovalID={preApprovalID}

Returns Approval object, if it is ready, use GetStatus function to check that

POST api/PreApproval/Initiate?preApprovalID={preApprovalID}

Initiate PreApproval. When initiated, use /api/status/get to check is approval finished already

GET api/PreApproval/GetList

Returns List of Pre-Approvals

GET api/PreApproval/GetOptionList?preApprovalID={preApprovalID}

Returns List of Options for Pre-Approval

DELETE api/PreApproval/Delete?preApprovalID={preApprovalID}

Marks PreApproval as Deleted. used by Users to hide not needed pre-approval from list. Status is set to '5'

POST api/PreApproval/Decline?preApprovalID={preApprovalID}&comment={comment}

Used to decline pre-approval by user. Comment should be provided

POST api/PreApproval/RecalcOptions?preApprovalID={preApprovalID}&recalcType={recalcType}&recalcDirection={recalcDirection}

Recalculates options for pre-Approval

GET api/PreApproval/GetBankAccounts?preApprovalID={preApprovalID}

Returns list of bank accounts to for user, to select one for the final disbursement

PUT api/PreApproval/SetBankAccount?preApprovalID={preApprovalID}

Set Bank Account to the Preapproval to be used for disbursement

POST api/PreApproval/ApplyOption?preApprovalOptionID={preApprovalOptionID}

Applies selected option for customer

Authenticate

Authentication based on API key and password. Information about Token should be added to the header

APIDescription
GET api/Authenticate/PartnerLogin?apiKey={apiKey}&apiPassword={apiPassword}

Authenticates partner and returns token with expiry.

GET api/Authenticate/UserLogin?username={username}&password={password}

Authenticates user and returns token with expiry.

GET api/Authenticate/DeveloperLogin?userName={userName}&password={password}

Login for Developer's. Use this to get Token for Developer's workplace

PUT api/Authenticate/SaveCookie

Saves Cookie with related data

POST api/Authenticate/SaveReferralSourceCode?rfsc={rfsc}

Saves Referral source code to any type of Session

Application

Application to Pre-Approval information

APIDescription
GET api/Application/Get?preApprovalID={preApprovalID}

Returns Application object

GET api/Application/GetView?preApprovalID={preApprovalID}

Based on statues, returns Application/pre-approval data

PUT api/Application/Save?preApprovalID={preApprovalID}

Saves Application entity, used for create and update