--- schema_version: "1" id: f05f216ae380d6a28c166096f654be6b809f207d4eeab6cfdb1f500092c3a5ab title: Mortgage Loan collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/industries-integrations/financial_services/references/generated-api-specs/mortgage_loan.md canonical_url: https://developer.salesforce.com/docs/industries/fsc/references/mortgage_loan source_site: developer.salesforce.com content_type: documentation content_hash: 305e1449522f4bf5eb9e26d975ef7fa01d748227a2cc136e577f0cd4899c9ee2 products: - Agentforce Financial Services - Industries Integrations --- Mortgage Loan # Mortgage Loan Use the Mortgage Loan API to purchase the property and calculate the principal, interest repayments, and other activities related to mortgage loan product fulfillment. **Version:** v1 Protocols: HTTPS. ## /MortgageLoan The mortgage loan account details. ## /MortgageLoan/{mortgageLoanId} The mortgage loan account ID details. ## /MortgageLoan/{mortgageLoanId}/Interest Specifies the interest details of the specific mortgage loan account. ## Operations ### POST Check the eligibility of MortgageLoan for Payment Deferral `POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility` Check the eligibility of MortgageLoan for Payment Deferral #### Parameters * `mortgageLoanId` (path, string, required) The unique ID of the mortgage loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) The unique tracking ID of the request. Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) The unique reference ID of the flow from the source system of the request. Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `object`. * `eligibilityVerificationDate` (_date-only_, required) Date on which the deferral eligibility is evaluated. Example: `2026-06-10`. * `deferralReason` (_string_, required) Reason provided by the customer for requesting payment deferral, such as medical emergency, financial issues, and so on. Example: `financial_hardship`. #### Responses * **200** Retrieved the eligibility of Payment Deferral Media type: `application/json`. Schema: `object`. * `requestId` (_string_, required) Unique ID for the eligibility request. Example: `12334455`. * `eligibleForModification` (_boolean_, required) Indicates whether the account is eligible for payment deferral (`true`) or not (`false`). Example: `true`. * `modifiedPaymentDetails` (_object_, required) Payment modification details if deferral is applied. * `deferredPaymentsCount` (_number_, required) Example: `3`. * `nextDueDateAfterDeferral` (_date-only_, required) Example: `2026-06-15`. * `interestAccruedDuringDeferral` (_number (double)_, required) Example: `200.50`. * `deferralEligibilityExpiryDate` (_date-only_, required) Date until which the deferral eligibility remains valid. Example: `2026-06-01`. * `eligibilityVerificationDate` (_date-only_) Date on which the deferral eligibility was evaluated. Example: `2026-06-18`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** The server couldn't find any valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Authorization failed. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: The access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Resource not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "406" errorMessage: The requested resource cannot generate acceptable content according to the Accept headers sent in the request. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "415" errorMessage: The server denied the request because it was not in a format supported by the target resource. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **429** The server exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server denied the request due to exceeding rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Payment Deferral enrollment for MortgageLoan `POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Enrollment` Enroll MortgageLoan for Payment Deferral #### Parameters * `mortgageLoanId` (path, string, required) The unique ID of the mortgage loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) The unique tracking ID of the request. Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) The unique reference ID of the flow from the source system of the request. Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `object`. * `updatedPaymentDetails` (_object_, required) Details of the updated payment terms to be applied after deferral. * `deferredPaymentsCount` (_number_, required) Example: `3`. * `nextDueDateAfterDeferral` (_date-only_, required) Example: `2026-06-15`. * `interestAccruedDuringDeferral` (_number (double)_, required) Example: `200.50`. * `confirmationDate` (_date-only_, required) Date on which the customer confirms the deferral enrollment. Example: `2026-06-18`. * `requiresUpfrontPayment` (_boolean_) Indicates whether an upfront payment is required to proceed with the deferral (`true`) or not (`false`). Example: `false`. #### Responses * **200** Payment Deferral enrollment created successfully Media type: `application/json`. Schema: `object`. * `requestId` (_string_, required) Unique identifier for the deferral enrollment request. Example: `12334455`. * `status` (_string_, required) Current status of the deferral enrollment, such as success or failed. Example: `Success`. * `nextDueDateAfterDeferral` (_date-only_, required) Next payment due date after applying the deferral. Example: `2026-06-15`. * `deferredPaymentsCount` (_number_, required) Number of payments that have been deferred. Example: `3`. * `interestAccruedDuringDeferral` (_number (double)_, required) Total interest amount that's accumulated during the deferral period. Example: `200.50`. * `confirmationDate` (_date-only_, required) Date on which the customer confirmed the deferral. Example: `2026-06-18`. * `requiresUpfrontPayment` (_boolean_) Indicates whether an upfront payment was required as part of the deferral. Example: `false`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** The server couldn't find any valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Authorization failed. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: The access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Resource not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 415 response._ * **429** The server exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server denied the request due to exceeding rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Check the eligibility of MortgageLoan for Due Date Change `POST /MortgageLoan/{mortgageLoanId}/DueDateChange/Eligibility` Check the eligibility of MortgageLoan for Due Date Change #### Parameters * `mortgageLoanId` (path, string, required) The unique ID of the mortgage loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) The unique tracking ID of the request. Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) The unique reference ID of the flow from the source system of the request. Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `object`. * `paymentFrequency` (_string_, required) Frequency of payments for the account, such as monthly or bi-weekly. Allowed values: `Monthly`. Example: `Monthly`. * `requestedRecurringDueDay` (_number_, required) Preferred day of the cycle or month for future payment due dates. Minimum: 1. Maximum: 28. Example: `2`. #### Responses * **200** Retrieved the eligibility of Due Date Change Media type: `application/json`. Schema: `object`. * `requestId` (_string_, required) Unique identifier for the eligibility request. Example: `12334455`. * `eligibleForModification` (_boolean_, required) Indicates whether the due date change is allowed (`true`) or not (`false`). Example: `true`. * `paymentFrequency` (_string_, required) Frequency of payments for the account, such as monthly or bi-weekly. Allowed values: `Monthly`. Example: `Monthly`. * `requestedRecurringDueDay` (_number_, required) Preferred day of the cycle or month for future payment due dates. Minimum: 1. Maximum: 28. Example: `2`. * `currentDueDate` (_date-only_, required) Existing payment due date before any modification. Example: `2026-06-15`. * `eligibilityCriteriaMet` (_array of any_) Indicates whether all required eligibility conditions are satisfied (`true`) or not (`false`). _Example_ ``` - "No past due payments" - "Mortgage loan balance under $10,000" ``` * `modifiedPaymentDetails` (_object_, required) Proposed updated payment schedule reflecting the requested due date change. * `paymentAmount` (_number (double)_, required) Example: `250.75`. * `remainingBalance` (_number (double)_, required) Example: `5000.00`. * `interestAccrued` (_number (double)_, required) Example: `35.25`. * `nextPaymentDueDate` (_date-only_, required) Example: `2026-06-15`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** The server couldn't find any valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Authorization failed. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: The access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Resource not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 415 response._ * **429** The server exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server denied the request due to exceeding rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### POST Due Date Change confirmation for MortgageLoan `POST /MortgageLoan/{mortgageLoanId}/DueDateChange/Confirmation` Confirm MortgageLoan for Due Date Change #### Parameters * `mortgageLoanId` (path, string, required) The unique ID of the mortgage loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) The unique tracking ID of the request. Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) The unique reference ID of the flow from the source system of the request. Example: `006E0077774TquXIAS`. #### Request body Media type: `application/json`. Schema: `object`. * `paymentFrequency` (_string_, required) Finalized payment frequency to be applied, such as monthly or bi-weekly. Allowed values: `Monthly`. Example: `Monthly`. * `requestedRecurringDueDay` (_number_, required) Recurring due day for payments. Example: `3`. * `confirmation` (_boolean_, required) Indicates whether the customer accepted the due date change terms (`true`) or not (`false`). Example: `true`. * `confirmationTimestamp` (_datetime_, required) Date and time when the customer provided their confirmation. Example: `2026-06-10T09:53:06.851858Z`. * `modifiedPaymentDetails` (_object_, required) Details of the final payment schedule to be applied after customer confirmation. * `paymentAmount` (_number (double)_, required) Example: `2000.05`. * `remainingBalance` (_number (double)_, required) Example: `20000`. * `interestAccrued` (_number (double)_, required) Example: `20.05`. * `nextPaymentDueDate` (_date-only_, required) Example: `2026-06-01`. #### Responses * **200** Due Date Change confirmed successfully Media type: `application/json`. Schema: `object`. * `requestId` (_string_, required) Unique ID for the due date change confirmation request. Example: `12334455`. * `confirmationStatus` (_string_, required) Status of the due date change request. Example: `Confirmed`. * `paymentFrequency` (_string_, required) Payment frequency that's applied after confirmation. Allowed values: `Monthly`. Example: `Monthly`. * `requestedRecurringDueDay` (_number_, required) Recurring due day that's applied. Example: `3`. * `modifiedPaymentDetails` (_object_, required) Finalized payment schedule after applying the due date change. * `paymentAmount` (_number (double)_, required) Example: `2000.05`. * `remainingBalance` (_number (double)_, required) Example: `20000`. * `interestAccrued` (_number (double)_, required) Example: `20.05`. * `nextPaymentDueDate` (_date-only_, required) Example: `2026-06-01`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** The server couldn't find any valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Authorization failed. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: The access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Resource not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 415 response._ * **429** The server exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server denied the request due to exceeding rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ### GET Retrieve mortgage interest details `GET /MortgageLoan/{mortgageLoanId}/Interest/Retrieve` Use this resource to retrieve the interest details of the mortgage loan account. #### Parameters * `mortgageLoanId` (path, string, required) The unique ID of the mortgage loan account. Example: `01axx000003MLytAAG`. * `requestId` (query, string) The unique tracking ID of the request. Example: `006E0000004TquXIAS`. * `flowRefId` (query, string) The unique reference ID of the flow from the source system of the request. Example: `006E0077774TquXIAS`. * `taxYear` (query, string, required) The tax year of the mortgage interest. Example: `2023`. #### Responses * **200** The retrieved details of mortgage interest. Media type: `application/json`. Schema: `GetMortgageInterestResponse`. * **400** The server couldn’t process the request due to a client error. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "400" errorMessage: Invalid request message. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **401** The server couldn't find any valid credentials to access the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "401" errorMessage: Authorization failed. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **403** The server denied access to the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "403" errorMessage: The access to the requested resource was denied. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **404** The server couldn’t find the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "404" errorMessage: Resource not found. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **405** The request method isn't supported for the requested resource. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "405" errorMessage: The target resource does not support the requested method. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **406** The target resource didn't have a current representation that was acceptable to the user agent. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 406 response._ * **415** The Accept header specified an unsupported media type. Media type: `application/json`. Schema: `ErrorResponse`. _Example: same as POST /MortgageLoan/{mortgageLoanId}/PaymentDeferral/Eligibility 415 response._ * **429** The server exceeded the API request rate limit. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "429" errorMessage: The server denied the request due to exceeding rate limits. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` * **500** An internal error occurred while processing the API request. Media type: `application/json`. Schema: `ErrorResponse`. _Example_ ``` errorCode: "500" errorMessage: The server was unable to process the request due to an internal error. transactionId: dd960082-abbf-47c2-8c65-f18eeb35848b timeStamp: 2019-09-30T15:27:49.274Z ``` ## Schemas ### ErrorResponse Represents a standard message body to be returned with the error responses. * `errorCode` (_string_, required) Specifies the short code to identify the error. Example: `INVALID_PARAMETER`. * `errorMessage` (_string_, required) Specifies the verbose, human-readable error message. Example: `The value you entered is out of bounds`. * `transactionId` (_string_, required) Specifies the request identifier. Example: `dd960082-abbf-47c2-8c65-f18eeb35848b`. * `timeStamp` (_datetime_, required) Specifies the event date and time. Example: `2019-09-23T11:46:44.256-05:00`. ### GetMortgageInterestResponse The response to GetMortgageInterest request. * `TaxYear` (_string_) The tax year of the mortgage interest. Example: `2023`. * `CurrencyCode` (_string_) The currency code for the mortgage interest. Example: `USD`. * `AccountName` (_object_) The account name for the mortgage interest. * `Name` (_string_) The name of the account. Example: `test`. * `InterestAmount` (_array of AmountValueType_) Specifies the interest amount. Minimum items: 1. * `AccountBalance` (_object_) Specifies the account balance for the mortgage interest. * `BalanceAmount` (_object_) Specifies the balance amount for the mortgage interest. Includes all fields of `AmountValueType`. * `PointsPaidOnPurchase` (_string_) Specifies the points paid on purchase of principal residence. Example: `test`. * `AccountDate` (_array of AccountDatesType_) Specifies the mortgage account date. Minimum items: 1. * `InsurancePremium` (_string_) Specifies the mortgage insurance premium. Example: `11`. * `MortgageAddress` (_object_) Specifies the address or description of property securing mortgage. * `IsMortgageAddressOfPropertySameAsBorrower` (_string_) Specifies the address of property securing mortgage is the same as Borrower address. Example: `false`. * `Address` (_object_) The address of property securing mortgage. Includes all fields of `ADDRESS`. * `NumberOfPropertiesPurchased` (_string_) Specifies the number of properties securing the mortgage. Example: `2`. * `OtherInformation` (_string_) Specifies the other information. Example: `This is a test message.`. * `BorrowerReference` (_object_) Specifies the borrower reference. Includes all fields of `UserInformationType`. * `LenderReference` (_object_) Specifies the lender reference. Includes all fields of `UserInformationType`. _Example_ ``` { "TaxYear": "2023", "CurrencyCode": "USD", "AccountName": { "Name": "test" }, "InterestAmount": [ { "AmountValue": { "Value": "100" }, "AmountType": "MortgageInterestReceived" }, { "AmountValue": { "Value": "100" }, "AmountType": "MortgageInterestRefund" } ], "AccountBalance": { "BalanceAmount": { "AmountValue": { "Value": "45" }, "AmountType": "OutstandingPrincipal" }, "PointsPaidOnPurchase": "1" }, "AccountDate": [ { "DateTimeContent": "2024-04-02T12:00:00", "TimeZoneCode": "UTC", "DaylightSavingIndicator": "true", "AccountDateType": "MortgageOriginationDate" }, { "DateTimeContent": "2024-04-02T12:00:00", "TimeZoneCode": "UTC", "DaylightSavingIndicator": "true", "AccountDateType": "MortgageAcquisitionDate" } ], "InsurancePremium": "11", "MortgageAddress": { "IsMortgageAddressOfPropertySameAsBorrower": "false", "Address": { "AddressType": "Mailing Address", "AddressLine1": "415 Mission St", "AddressLine2": "Floor 61", "City": "San Francisco", "State": "CA", "PostalCode": "94105", "Country": "USA" } }, "NumberOfPropertiesPurchased": "2", "OtherInformation": "This is a test message.", "BorrowerReference": { "Tin": "111", "FirstName": "John", "LastName": "Carter", "Phone": "0000000000", "Address": { "AddressType": "Mailing Address", "AddressLine1": "415 Mission St", "AddressLine2": "Floor 61", "City": "San Francisco", "State": "CA", "PostalCode": "94105", "Country": "USA" } }, "LenderReference": { "Tin": "111", "FirstName": "John", "LastName": "Carter", "Phone": "0000000000", "Address": { "AddressType": "Mailing Address", "AddressLine1": "415 Mission St", "AddressLine2": "Floor 61", "City": "San Francisco", "State": "CA", "PostalCode": "94105", "Country": "USA" } } } ``` ### AmountValueType Specifies the mortgage interest amount value type. * `AmountValue` (_object_) Number of monetary units specified in a currency, where the unit of currency is explicit and compliant with ISO 4217. * `Value` (_string_) The value for the amount. Example: `100`. * `AmountType` (_string_) Specifies the mortgage interest amount type.. like MortgageInterestReceived, MortgageInterestRefund, and OutstandingPrincipal. Example: `MortgageInterestReceived`. ### AccountDatesType Specifies the mortgage account date type. * `DateTimeContent` (_string_) The date time content for the mortgage interest. Example: `2024-04-02T12:00:00`. * `TimeZoneCode` (_string_) The time zone code for the mortgage interest. Example: `UTC`. * `DaylightSavingIndicator` (_string_) The day light saving indicator for the mortgage interest. Example: `true`. * `AccountDateType` (_string_) The account date type for the mortgage interest.. like MortgageOriginationDate, and MortgageAcquisitionDate. Example: `MortgageOriginationDate`. ### ADDRESS Specifies the address details. * `AddressType` (_string_) The type of address. For example, Home. Example: `Mailing Address`. * `AddressLine1` (_string_, required) The address line 1 of the user's address. Example: `415 Mission St`. * `AddressLine2` (_string_) The address line 2 of the user's address. Example: `Floor 61`. * `City` (_string_, required) The city name of the user's address. Example: `San Francisco`. * `State` (_string_, required) Specifes the state of the user's address. Example: `CA`. * `PostalCode` (_string_, required) Specifes the postal code of the user's address. Example: `94105`. * `Country` (_string_, required) The country of the user's address. Example: `USA`. ### UserInformationType Specifies the user type. * `Tin` (_string_) Specifies the tin information. Example: `111`. * `FirstName` (_string_) Specifies the first name. Example: `John`. * `LastName` (_string_) Specifies the last name. Example: `Carter`. * `Phone` (_string_) Specifies the phone. Example: `0000000000`. * `Address` (_object_) Specifies the address. Includes all fields of `ADDRESS`.