POST api/Mortgages
Request Information
URI Parameters
None.
Body Parameters
Mortgage| Name | Description | Type | Additional information |
|---|---|---|---|
| AuthorizationID | string |
String length: inclusive between 0 and 20 |
|
| MortgageID | integer |
None. |
|
| ClientID | integer |
None. |
|
| LoanNbr | string |
String length: inclusive between 0 and 20 |
|
| Vendor | string |
String length: inclusive between 0 and 50 |
|
| VendorAddress1 | string |
String length: inclusive between 0 and 50 |
|
| VendorAddress2 | string |
String length: inclusive between 0 and 50 |
|
| VendorCity | string |
String length: inclusive between 0 and 50 |
|
| VendorState | string |
String length: inclusive between 0 and 10 |
|
| VendorZip | string |
String length: inclusive between 0 and 20 |
|
| VendorContact | string |
String length: inclusive between 0 and 50 |
|
| VendorPhone | string |
String length: inclusive between 0 and 25 |
|
| VendorFax | string |
String length: inclusive between 0 and 25 |
|
| VendorMobile | string |
String length: inclusive between 0 and 25 |
|
| FutureIntRate | decimal number |
None. |
|
| FutureIntRateEff | date |
None. |
|
| FuturePIPmt | decimal number |
None. |
|
| FuturePIPmtEff | date |
None. |
|
| FutureEscrowPmt | decimal number |
None. |
|
| FutureEscrowPmtEff | date |
None. |
|
| AssumedBalance | decimal number |
None. |
|
| MtgPmtDueDay | integer |
None. |
|
| MtgBeginDate | date |
None. |
|
| MaturityDate | date |
None. |
|
| LastPmtDate | date |
None. |
|
| NextPmtDate | date |
None. |
|
| InterestRate | decimal number |
None. |
|
| PaidInArrears | string |
String length: inclusive between 0 and 10 |
|
| PIPmt | decimal number |
None. |
|
| EscrowPmt | decimal number |
None. |
|
| PayoffDate | date |
None. |
|
| PayoffReason | string |
String length: inclusive between 0 and 50 |
|
| ReleaseDate | date |
None. |
|
| BuyoutDate | date |
None. |
|
| BuyoutAmt | decimal number |
None. |
|
| MtgAuthSent | date |
None. |
|
| MtgAuthReceived | date |
None. |
|
| InfoRequested | date |
None. |
|
| InfoReceived | date |
None. |
|
| MtgDetail | string |
String length: inclusive between 0 and 25 |
|
| LoanType | string |
String length: inclusive between 0 and 50 |
|
| User1 | string |
String length: inclusive between 0 and 50 |
|
| User2 | string |
String length: inclusive between 0 and 50 |
|
| User3 | string |
String length: inclusive between 0 and 50 |
|
| User4 | string |
String length: inclusive between 0 and 50 |
|
| User5 | decimal number |
None. |
|
| User6 | decimal number |
None. |
|
| User7 | decimal number |
None. |
|
| User8 | date |
None. |
|
| User9 | date |
None. |
|
| User10 | date |
None. |
|
| VendorID | integer |
None. |
|
| VendorContactID | integer |
None. |
|
| ID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"AuthorizationID": "sample string 1",
"MortgageID": 2,
"ClientID": 1,
"LoanNbr": "sample string 3",
"Vendor": "sample string 4",
"VendorAddress1": "sample string 5",
"VendorAddress2": "sample string 6",
"VendorCity": "sample string 7",
"VendorState": "sample string 8",
"VendorZip": "sample string 9",
"VendorContact": "sample string 10",
"VendorPhone": "sample string 11",
"VendorFax": "sample string 12",
"VendorMobile": "sample string 13",
"FutureIntRate": 1.1,
"FutureIntRateEff": "2025-05-09T17:57:54.399309+00:00",
"FuturePIPmt": 1.0,
"FuturePIPmtEff": "2025-05-09T17:57:54.399309+00:00",
"FutureEscrowPmt": 1.0,
"FutureEscrowPmtEff": "2025-05-09T17:57:54.399309+00:00",
"AssumedBalance": 1.0,
"MtgPmtDueDay": 1,
"MtgBeginDate": "2025-05-09T17:57:54.399309+00:00",
"MaturityDate": "2025-05-09T17:57:54.399309+00:00",
"LastPmtDate": "2025-05-09T17:57:54.399309+00:00",
"NextPmtDate": "2025-05-09T17:57:54.399309+00:00",
"InterestRate": 1.1,
"PaidInArrears": "sample string 14",
"PIPmt": 1.0,
"EscrowPmt": 1.0,
"PayoffDate": "2025-05-09T17:57:54.399309+00:00",
"PayoffReason": "sample string 15",
"ReleaseDate": "2025-05-09T17:57:54.399309+00:00",
"BuyoutDate": "2025-05-09T17:57:54.399309+00:00",
"BuyoutAmt": 1.0,
"MtgAuthSent": "2025-05-09T17:57:54.399309+00:00",
"MtgAuthReceived": "2025-05-09T17:57:54.399309+00:00",
"InfoRequested": "2025-05-09T17:57:54.399309+00:00",
"InfoReceived": "2025-05-09T17:57:54.399309+00:00",
"MtgDetail": "sample string 16",
"LoanType": "sample string 17",
"User1": "sample string 18",
"User2": "sample string 19",
"User3": "sample string 20",
"User4": "sample string 21",
"User5": 1.0,
"User6": 1.0,
"User7": 1.0,
"User8": "2025-05-09T17:57:54.399309+00:00",
"User9": "2025-05-09T17:57:54.399309+00:00",
"User10": "2025-05-09T17:57:54.399309+00:00",
"VendorID": 1,
"VendorContactID": 1,
"ID": 22
}
application/xml, text/xml
Sample:
<Mortgage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric"> <AssumedBalance>1</AssumedBalance> <AuthorizationID>sample string 1</AuthorizationID> <BuyoutAmt>1</BuyoutAmt> <BuyoutDate>2025-05-09T17:57:54.399309+00:00</BuyoutDate> <ClientID>1</ClientID> <EscrowPmt>1</EscrowPmt> <FutureEscrowPmt>1</FutureEscrowPmt> <FutureEscrowPmtEff>2025-05-09T17:57:54.399309+00:00</FutureEscrowPmtEff> <FutureIntRate>1.1</FutureIntRate> <FutureIntRateEff>2025-05-09T17:57:54.399309+00:00</FutureIntRateEff> <FuturePIPmt>1</FuturePIPmt> <FuturePIPmtEff>2025-05-09T17:57:54.399309+00:00</FuturePIPmtEff> <ID>22</ID> <InfoReceived>2025-05-09T17:57:54.399309+00:00</InfoReceived> <InfoRequested>2025-05-09T17:57:54.399309+00:00</InfoRequested> <InterestRate>1.1</InterestRate> <LastPmtDate>2025-05-09T17:57:54.399309+00:00</LastPmtDate> <LoanNbr>sample string 3</LoanNbr> <LoanType>sample string 17</LoanType> <MaturityDate>2025-05-09T17:57:54.399309+00:00</MaturityDate> <MortgageID>2</MortgageID> <MtgAuthReceived>2025-05-09T17:57:54.399309+00:00</MtgAuthReceived> <MtgAuthSent>2025-05-09T17:57:54.399309+00:00</MtgAuthSent> <MtgBeginDate>2025-05-09T17:57:54.399309+00:00</MtgBeginDate> <MtgDetail>sample string 16</MtgDetail> <MtgPmtDueDay>1</MtgPmtDueDay> <NextPmtDate>2025-05-09T17:57:54.399309+00:00</NextPmtDate> <PIPmt>1</PIPmt> <PaidInArrears>sample string 14</PaidInArrears> <PayoffDate>2025-05-09T17:57:54.399309+00:00</PayoffDate> <PayoffReason>sample string 15</PayoffReason> <ReleaseDate>2025-05-09T17:57:54.399309+00:00</ReleaseDate> <User1>sample string 18</User1> <User10>2025-05-09T17:57:54.399309+00:00</User10> <User2>sample string 19</User2> <User3>sample string 20</User3> <User4>sample string 21</User4> <User5>1</User5> <User6>1</User6> <User7>1</User7> <User8>2025-05-09T17:57:54.399309+00:00</User8> <User9>2025-05-09T17:57:54.399309+00:00</User9> <Vendor>sample string 4</Vendor> <VendorAddress1>sample string 5</VendorAddress1> <VendorAddress2>sample string 6</VendorAddress2> <VendorCity>sample string 7</VendorCity> <VendorContact>sample string 10</VendorContact> <VendorContactID>1</VendorContactID> <VendorFax>sample string 12</VendorFax> <VendorID>1</VendorID> <VendorMobile>sample string 13</VendorMobile> <VendorPhone>sample string 11</VendorPhone> <VendorState>sample string 8</VendorState> <VendorZip>sample string 9</VendorZip> </Mortgage>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Mortgage| Name | Description | Type | Additional information |
|---|---|---|---|
| AuthorizationID | string |
String length: inclusive between 0 and 20 |
|
| MortgageID | integer |
None. |
|
| ClientID | integer |
None. |
|
| LoanNbr | string |
String length: inclusive between 0 and 20 |
|
| Vendor | string |
String length: inclusive between 0 and 50 |
|
| VendorAddress1 | string |
String length: inclusive between 0 and 50 |
|
| VendorAddress2 | string |
String length: inclusive between 0 and 50 |
|
| VendorCity | string |
String length: inclusive between 0 and 50 |
|
| VendorState | string |
String length: inclusive between 0 and 10 |
|
| VendorZip | string |
String length: inclusive between 0 and 20 |
|
| VendorContact | string |
String length: inclusive between 0 and 50 |
|
| VendorPhone | string |
String length: inclusive between 0 and 25 |
|
| VendorFax | string |
String length: inclusive between 0 and 25 |
|
| VendorMobile | string |
String length: inclusive between 0 and 25 |
|
| FutureIntRate | decimal number |
None. |
|
| FutureIntRateEff | date |
None. |
|
| FuturePIPmt | decimal number |
None. |
|
| FuturePIPmtEff | date |
None. |
|
| FutureEscrowPmt | decimal number |
None. |
|
| FutureEscrowPmtEff | date |
None. |
|
| AssumedBalance | decimal number |
None. |
|
| MtgPmtDueDay | integer |
None. |
|
| MtgBeginDate | date |
None. |
|
| MaturityDate | date |
None. |
|
| LastPmtDate | date |
None. |
|
| NextPmtDate | date |
None. |
|
| InterestRate | decimal number |
None. |
|
| PaidInArrears | string |
String length: inclusive between 0 and 10 |
|
| PIPmt | decimal number |
None. |
|
| EscrowPmt | decimal number |
None. |
|
| PayoffDate | date |
None. |
|
| PayoffReason | string |
String length: inclusive between 0 and 50 |
|
| ReleaseDate | date |
None. |
|
| BuyoutDate | date |
None. |
|
| BuyoutAmt | decimal number |
None. |
|
| MtgAuthSent | date |
None. |
|
| MtgAuthReceived | date |
None. |
|
| InfoRequested | date |
None. |
|
| InfoReceived | date |
None. |
|
| MtgDetail | string |
String length: inclusive between 0 and 25 |
|
| LoanType | string |
String length: inclusive between 0 and 50 |
|
| User1 | string |
String length: inclusive between 0 and 50 |
|
| User2 | string |
String length: inclusive between 0 and 50 |
|
| User3 | string |
String length: inclusive between 0 and 50 |
|
| User4 | string |
String length: inclusive between 0 and 50 |
|
| User5 | decimal number |
None. |
|
| User6 | decimal number |
None. |
|
| User7 | decimal number |
None. |
|
| User8 | date |
None. |
|
| User9 | date |
None. |
|
| User10 | date |
None. |
|
| VendorID | integer |
None. |
|
| VendorContactID | integer |
None. |
|
| ID | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"AuthorizationID": "sample string 1",
"MortgageID": 2,
"ClientID": 1,
"LoanNbr": "sample string 3",
"Vendor": "sample string 4",
"VendorAddress1": "sample string 5",
"VendorAddress2": "sample string 6",
"VendorCity": "sample string 7",
"VendorState": "sample string 8",
"VendorZip": "sample string 9",
"VendorContact": "sample string 10",
"VendorPhone": "sample string 11",
"VendorFax": "sample string 12",
"VendorMobile": "sample string 13",
"FutureIntRate": 1.1,
"FutureIntRateEff": "2025-05-09T17:57:54.4149339+00:00",
"FuturePIPmt": 1.0,
"FuturePIPmtEff": "2025-05-09T17:57:54.4149339+00:00",
"FutureEscrowPmt": 1.0,
"FutureEscrowPmtEff": "2025-05-09T17:57:54.4149339+00:00",
"AssumedBalance": 1.0,
"MtgPmtDueDay": 1,
"MtgBeginDate": "2025-05-09T17:57:54.4149339+00:00",
"MaturityDate": "2025-05-09T17:57:54.4149339+00:00",
"LastPmtDate": "2025-05-09T17:57:54.4149339+00:00",
"NextPmtDate": "2025-05-09T17:57:54.4149339+00:00",
"InterestRate": 1.1,
"PaidInArrears": "sample string 14",
"PIPmt": 1.0,
"EscrowPmt": 1.0,
"PayoffDate": "2025-05-09T17:57:54.4149339+00:00",
"PayoffReason": "sample string 15",
"ReleaseDate": "2025-05-09T17:57:54.4149339+00:00",
"BuyoutDate": "2025-05-09T17:57:54.4149339+00:00",
"BuyoutAmt": 1.0,
"MtgAuthSent": "2025-05-09T17:57:54.4149339+00:00",
"MtgAuthReceived": "2025-05-09T17:57:54.4149339+00:00",
"InfoRequested": "2025-05-09T17:57:54.4149339+00:00",
"InfoReceived": "2025-05-09T17:57:54.4149339+00:00",
"MtgDetail": "sample string 16",
"LoanType": "sample string 17",
"User1": "sample string 18",
"User2": "sample string 19",
"User3": "sample string 20",
"User4": "sample string 21",
"User5": 1.0,
"User6": 1.0,
"User7": 1.0,
"User8": "2025-05-09T17:57:54.4149339+00:00",
"User9": "2025-05-09T17:57:54.4149339+00:00",
"User10": "2025-05-09T17:57:54.4149339+00:00",
"VendorID": 1,
"VendorContactID": 1,
"ID": 22
}
application/xml, text/xml
Sample:
<Mortgage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric"> <AssumedBalance>1</AssumedBalance> <AuthorizationID>sample string 1</AuthorizationID> <BuyoutAmt>1</BuyoutAmt> <BuyoutDate>2025-05-09T17:57:54.4149339+00:00</BuyoutDate> <ClientID>1</ClientID> <EscrowPmt>1</EscrowPmt> <FutureEscrowPmt>1</FutureEscrowPmt> <FutureEscrowPmtEff>2025-05-09T17:57:54.4149339+00:00</FutureEscrowPmtEff> <FutureIntRate>1.1</FutureIntRate> <FutureIntRateEff>2025-05-09T17:57:54.4149339+00:00</FutureIntRateEff> <FuturePIPmt>1</FuturePIPmt> <FuturePIPmtEff>2025-05-09T17:57:54.4149339+00:00</FuturePIPmtEff> <ID>22</ID> <InfoReceived>2025-05-09T17:57:54.4149339+00:00</InfoReceived> <InfoRequested>2025-05-09T17:57:54.4149339+00:00</InfoRequested> <InterestRate>1.1</InterestRate> <LastPmtDate>2025-05-09T17:57:54.4149339+00:00</LastPmtDate> <LoanNbr>sample string 3</LoanNbr> <LoanType>sample string 17</LoanType> <MaturityDate>2025-05-09T17:57:54.4149339+00:00</MaturityDate> <MortgageID>2</MortgageID> <MtgAuthReceived>2025-05-09T17:57:54.4149339+00:00</MtgAuthReceived> <MtgAuthSent>2025-05-09T17:57:54.4149339+00:00</MtgAuthSent> <MtgBeginDate>2025-05-09T17:57:54.4149339+00:00</MtgBeginDate> <MtgDetail>sample string 16</MtgDetail> <MtgPmtDueDay>1</MtgPmtDueDay> <NextPmtDate>2025-05-09T17:57:54.4149339+00:00</NextPmtDate> <PIPmt>1</PIPmt> <PaidInArrears>sample string 14</PaidInArrears> <PayoffDate>2025-05-09T17:57:54.4149339+00:00</PayoffDate> <PayoffReason>sample string 15</PayoffReason> <ReleaseDate>2025-05-09T17:57:54.4149339+00:00</ReleaseDate> <User1>sample string 18</User1> <User10>2025-05-09T17:57:54.4149339+00:00</User10> <User2>sample string 19</User2> <User3>sample string 20</User3> <User4>sample string 21</User4> <User5>1</User5> <User6>1</User6> <User7>1</User7> <User8>2025-05-09T17:57:54.4149339+00:00</User8> <User9>2025-05-09T17:57:54.4149339+00:00</User9> <Vendor>sample string 4</Vendor> <VendorAddress1>sample string 5</VendorAddress1> <VendorAddress2>sample string 6</VendorAddress2> <VendorCity>sample string 7</VendorCity> <VendorContact>sample string 10</VendorContact> <VendorContactID>1</VendorContactID> <VendorFax>sample string 12</VendorFax> <VendorID>1</VendorID> <VendorMobile>sample string 13</VendorMobile> <VendorPhone>sample string 11</VendorPhone> <VendorState>sample string 8</VendorState> <VendorZip>sample string 9</VendorZip> </Mortgage>