POST dosconnect/NewRequestedMortgage

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
APIKey	string	None.
MortgageApplicationID	integer	None.
Mortgage	UpdateMortgageModel	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1",
  "MortgageApplicationID": 2,
  "Mortgage": {
    "MIPremiumAmount": 1.0,
    "TotalLoanAmount": 1.0,
    "MortgageTypeDD": 1,
    "RequestMortgageTypeDD": 1,
    "LoanTypeDD": 1,
    "Balance": 1.0,
    "Payment": 1.0,
    "IADDate": "2025-12-15T22:53:20.2303952-05:00",
    "IADValue": 1.0,
    "FirstPaymentDate": "2025-12-15T22:53:20.2303952-05:00",
    "MaturityDate": "2025-12-15T22:53:20.2303952-05:00",
    "LineOfBusinessDD": 1,
    "ClassificationCommercialFlag": true,
    "ClassificationConstructionFlag": true,
    "ClassificationReverseFlag": true,
    "ClassificationSubPrimeFlag": true,
    "ClassificationHELOCFlag": true,
    "MIFlag": true,
    "MIIncludedFlag": true,
    "LOCRepaymentTypeDD": 1,
    "MIPremiumRateOverrideFlag": true,
    "MIPremiumRate": 1.0,
    "InterestRate": 1.0,
    "DiscountRate": 1.0,
    "PremiumRate": 1.0,
    "BuyDownRate": 1.0,
    "NetRate": 1.0,
    "VariableToPrime": "sample string 1",
    "RateTypeDD": 1,
    "TermTypeDD": 1,
    "PaymentFrequencyDD": 1,
    "InterestCompoundTypeDD": 1,
    "TermInMonth": 1,
    "AmortizationInMonth": 1,
    "BlendedAmortFlag": true,
    "InterestOnlyFlag": true,
    "QDInterestRate": 1.0,
    "QDInterestCompoundTypeDD": 1,
    "QDInterestOnlyFlag": true,
    "QDAmortizationInMonth": 1,
    "CashBackPercentage": 1.0,
    "CashBackAmount": 1.0,
    "CashBackOverrideFlag": true
  }
}

application/xml, text/xml

Sample:

<NewRequestedMortgageInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
  <Mortgage>
    <AmortizationInMonth>1</AmortizationInMonth>
    <Balance>1</Balance>
    <BlendedAmortFlag>true</BlendedAmortFlag>
    <BuyDownRate>1</BuyDownRate>
    <CashBackAmount>1</CashBackAmount>
    <CashBackOverrideFlag>true</CashBackOverrideFlag>
    <CashBackPercentage>1</CashBackPercentage>
    <ClassificationCommercialFlag>true</ClassificationCommercialFlag>
    <ClassificationConstructionFlag>true</ClassificationConstructionFlag>
    <ClassificationHELOCFlag>true</ClassificationHELOCFlag>
    <ClassificationReverseFlag>true</ClassificationReverseFlag>
    <ClassificationSubPrimeFlag>true</ClassificationSubPrimeFlag>
    <DiscountRate>1</DiscountRate>
    <FirstPaymentDate>2025-12-15T22:53:20.2303952-05:00</FirstPaymentDate>
    <IADDate>2025-12-15T22:53:20.2303952-05:00</IADDate>
    <IADValue>1</IADValue>
    <InterestCompoundTypeDD>1</InterestCompoundTypeDD>
    <InterestOnlyFlag>true</InterestOnlyFlag>
    <InterestRate>1</InterestRate>
    <LOCRepaymentTypeDD>1</LOCRepaymentTypeDD>
    <LineOfBusinessDD>1</LineOfBusinessDD>
    <LoanTypeDD>1</LoanTypeDD>
    <MIFlag>true</MIFlag>
    <MIIncludedFlag>true</MIIncludedFlag>
    <MIPremiumAmount>1</MIPremiumAmount>
    <MIPremiumRate>1</MIPremiumRate>
    <MIPremiumRateOverrideFlag>true</MIPremiumRateOverrideFlag>
    <MaturityDate>2025-12-15T22:53:20.2303952-05:00</MaturityDate>
    <MortgageTypeDD>1</MortgageTypeDD>
    <NetRate>1</NetRate>
    <Payment>1</Payment>
    <PaymentFrequencyDD>1</PaymentFrequencyDD>
    <PremiumRate>1</PremiumRate>
    <QDAmortizationInMonth>1</QDAmortizationInMonth>
    <QDInterestCompoundTypeDD>1</QDInterestCompoundTypeDD>
    <QDInterestOnlyFlag>true</QDInterestOnlyFlag>
    <QDInterestRate>1</QDInterestRate>
    <RateTypeDD>1</RateTypeDD>
    <RequestMortgageTypeDD>1</RequestMortgageTypeDD>
    <TermInMonth>1</TermInMonth>
    <TermTypeDD>1</TermTypeDD>
    <TotalLoanAmount>1</TotalLoanAmount>
    <VariableToPrime>sample string 1</VariableToPrime>
  </Mortgage>
  <MortgageApplicationID>2</MortgageApplicationID>
</NewRequestedMortgageInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NewRequestedMortgageInput'.

Response Information

Resource Description

NewRequestedMortgageOutput

Name	Description	Type	Additional information
MortgageID		integer	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "MortgageID": 1,
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<NewRequestedMortgageOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <MortgageID>1</MortgageID>
</NewRequestedMortgageOutput>