Mortgage
The mortgage record on a deal: loan terms, the property, the applicants and their financials.
Retrieve a deal's mortgage application
The mortgage record itself: amount, term, amortization, rates and payment, with the figures BrokerPlus calculates from it: the total loan amount, the insurance premium, and the gross debt service, total debt service and loan-to-value ratios. Rates and ratios on this object are PERCENT (5.25 means 5.25%), not decimal fractions. Every lender-coded field arrives as a code plus a readable label.
path Parameters
idResource id.
Retrieve a deal's mortgage application › Responses
Success
successAlways true on a successful response.
The requested record.
Update a deal's mortgage application
Changes the loan amount, rate, rate type, term, amortization, first payment date or financing condition date. Send only the fields to change. Rates are PERCENT (5.25 means 5.25%). If the deal has no application yet, this creates one.
path Parameters
idResource id.
Update a deal's mortgage application › Request Body
loan_amountPrincipal, in dollars. Send null to clear.
net_rateContract rate as a PERCENT, e.g. 5.25 means 5.25%. Not a fraction. Send null to clear.
rate_typeRate type, as the numeric code that rate_type returns on read. Send null to clear.
term_monthsTerm length in months, e.g. 60 for a 5-year term. Send null to clear.
amortization_monthsAmortization in months, e.g. 300 for 25 years. Send null to clear.
purchase_pricePurchase price or estimated value, in dollars. Send null to clear.
payment_amountScheduled payment, in dollars. Send null to clear.
payment_frequencyPayment frequency, as the numeric code that payment_frequency returns on read. Send null to clear.
payment_acceleratedWhether payments are accelerated. Use true with payment_frequency 26 for accelerated bi-weekly or 52 for accelerated weekly. False means regular payments. Send null to clear.
mortgage_insurerMortgage insurer, as the numeric code that mortgage_insurer returns on read. Send null to clear.
When the term ends. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
When the first payment is due. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
When interest adjusts, before the first payment. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
When the mortgage funds or funded. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
When the financing condition on the purchase comes off. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
labelThe broker's own name for this scenario. Send null to clear.
loan_typeLoan type, as the numeric code that loan_type returns on read. Send null to clear.
charge_typeCharge type, as the numeric code that charge_type returns on read. Send null to clear.
repayment_typeRepayment type, as the numeric code that repayment_type returns on read. Send null to clear.
requested_paymentThe payment the borrower asked for, in dollars. Send null to clear.
down_payment_overrideThe down payment the broker states, in dollars. Send null to clear.
legal_and_closing_costsLegal and closing costs the broker was quoted, in dollars. Send null to clear.
type_of_buyerType of buyer, as the numeric code that type_of_buyer returns on read. Send null to clear.
loan_purpose_additionalMore detail on the loan purpose. Send null to clear.
mortgage_classificationMortgage classification, as the numeric code that mortgage_classification returns on read. Send null to clear.
rate_compound_frequencyRate compounding frequency, as the numeric code that rate_compound_frequency returns on read. Send null to clear.
lender_classificationLender classification, as the numeric code that lender_classification returns on read. Send null to clear.
early_payout_typeEarly payout type, as the numeric code that early_payout_type returns on read. Send null to clear.
capitalize_payout_penaltytrue to add the outgoing lender's payout penalty to the new mortgage, false when the borrower pays it at closing. Send null to clear.
purchase_stagenot_started, looking, offer_made, or offer_accepted. Send null to clear.
purchase_timelineWhen the borrower expects to buy. Send null to clear.
improvement_descriptionWhat the improvements are. Send null to clear.
security_deposit_amountDeposit paid on the purchase, in dollars. Send null to clear.
Update a deal's mortgage application › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a deal's subject property
The property being mortgaged: address components, structure, occupancy and carrying costs. The address is returned as parts rather than one line, because that is what the lender submission carries.
path Parameters
idResource id.
Retrieve a deal's subject property › Responses
Success
successAlways true on a successful response.
The requested record.
Update a deal's subject property address
Changes the address of the property being mortgaged. Send only the parts to change. Street type, street direction and province take the numeric code that the read returns. If the deal has no property yet, this creates one.
path Parameters
idResource id.
Update a deal's subject property address › Request Body
unit_numberUnit or suite. Send null to clear.
street_numberStreet number. Send null to clear.
street_nameStreet name, without the type or direction. Send null to clear.
street_typeStreet type, as the numeric code that street_type returns on read. Send null to clear.
street_directionStreet direction, as the numeric code that street_direction returns on read. Send null to clear.
cityCity or town. Send null to clear.
Province, as the numeric code that province returns on read, or as the two-letter code, e.g. ON. Send null to clear.
postal_codePostal code. Send null to clear.
occupancy_typeWho lives in the property. One of the occupancy_type values on read. Send null to clear.
occupancy_purposeOccupancy purpose, as the numeric code that occupancy_purpose returns on read. Send null to clear.
property_description_typeProperty description, as the numeric code that property_description_type returns on read. Send null to clear.
property_usage_typeProperty usage, as the numeric code that property_usage_type returns on read. Send null to clear.
zoning_typeZoning, as the numeric code that zoning_type returns on read. Send null to clear.
construction_typeConstruction type, as the numeric code that construction_type returns on read. Send null to clear.
heating_typeHeating type, as the numeric code that heating_type returns on read. Send null to clear.
parking_typeParking type, as the numeric code that parking_type returns on read. Send null to clear.
water_supply_typeWater supply, as the numeric code that water_supply_type returns on read. Send null to clear.
water_waste_typeWaste water, as the numeric code that water_waste_type returns on read. Send null to clear.
property_sizeLiving area, in property_size_units. Send null to clear.
property_size_unitsProperty size units, as the numeric code that property_size_units returns on read. Send null to clear.
lot_sizeLot area, in lot_size_units. Send null to clear.
lot_size_unitsLot size units, as the numeric code that lot_size_units returns on read. Send null to clear.
environmental_hazardtrue when the property has an environmental hazard. Send null to clear.
new_propertytrue when the property is new. Send null to clear.
mls_listedtrue when the property is listed on MLS. Send null to clear.
rental_offset_pctThe share of rent that counts, as a PERCENT from 0 to 100. Send null to clear.
rental_calc_typeRental calculation method, as the numeric code that rental_calc_type returns on read. Send null to clear.
condo_fee_tds_pctThe share of the condo fee that counts, as a PERCENT from 0 to 100. Send null to clear.
condo_fees_include_heatingtrue when the condo fee already covers heat.
include_expenses_in_tdsfalse leaves property tax, heat and the condo fee out of the housing cost.
annual_tax_estimatedtrue when the property tax figure is an estimate. Send null to clear.
tax_yearThe year the tax figure is for. Send null to clear.
taxes_paid_byTaxes paid by, as the numeric code that taxes_paid_by returns on read. Send null to clear.
original_purchase_priceWhat the borrower paid for the property, in dollars. Send null to clear.
When the borrower bought the property. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
monthly_hydro_costsMonthly hydro cost, in dollars. Send null to clear.
monthly_insurance_costsMonthly insurance cost, in dollars. Send null to clear.
monthly_management_costsMonthly property management cost, in dollars. Send null to clear.
monthly_repairs_costsMonthly repairs cost, in dollars. Send null to clear.
monthly_interest_costsMonthly interest cost, in dollars. Send null to clear.
monthly_other_costsOther monthly operating costs, in dollars. Send null to clear.
monthly_fees_offsetMonthly condo fee left out of the ratios, in dollars. Send null to clear.
legal_descriptionThe legal description of the land. Send null to clear.
legal_pinThe land registry's PIN. Send null to clear.
Update a deal's subject property address › Responses
Success
successAlways true on a successful response.
The requested record.
List a deal's credit notes
The broker's own notes on the credit of the people on the deal, one per person, most recently changed first. This is what the broker wrote, not a credit report: no credit score or bureau data is returned.
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
List a deal's credit notes › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Write a credit note
Writes the broker's note on the credit of a person on the deal, as the credit panel on the deal does. The first write creates the note. A score the broker entered in BrokerPlus is kept as it is.
path Parameters
idResource id.
contactIdResource id.
Write a credit note › Request Body
bodyThe broker's note on the person's credit, up to 4000 characters. Send null or an empty string to clear it.
Write a credit note › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a deal's creditor life insurance
The deal's creditor life insurance: whether the broker offered it, what the client said, and where the application is with the insurer. Returns 404 until the broker records an outcome or sends an application.
path Parameters
idResource id.
Retrieve a deal's creditor life insurance › Responses
Success
successAlways true on a successful response.
The requested record.
Record the life insurance outcome
Records where the conversation about creditor life insurance landed with the client, as the deal's insurance panel does. A new outcome replaces the one before. Nothing is sent: when the client accepts, the broker sends the application in BrokerPlus, with the client's consent.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Record the life insurance outcome › Request Body
outcomeWhere the conversation with the client landed. accepted records that the client wants it: the broker sends the application in BrokerPlus.
noteThe broker's note, e.g. why the client waived it.
Record the life insurance outcome › Responses
Success
successAlways true on a successful response.
The requested record.
List a deal's applicants
Everyone on the application: the primary applicant, co-applicants and guarantors, each with their employment history and any income that does not come from a job. Read a person's name and contact details from the contact_id. Social insurance numbers are never returned.
path Parameters
idResource id.
List a deal's applicants › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Add an applicant to the application
Gives a borrower on the deal their application detail. The contact must already be on the deal as a borrower: add them first with POST /deals/{id}/participants. If the deal has no application yet, this creates one.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add an applicant to the application › Request Body
contact_idThe contact to add to the application. The contact must already be on the deal as a borrower. Put them on the deal first with POST /deals/{id}/participants.
roleprimary, co_applicant, or guarantor. On create, the default comes from the participant role.
middle_nameMiddle name. Send null to clear.
honorificHonorific, as the numeric code that honorific returns on read. Send null to clear.
suffixName suffix, as the numeric code that suffix returns on read. Send null to clear.
sexSex, as the numeric code that sex returns on read. Send null to clear.
correspondence_languageCorrespondence language, as the numeric code that correspondence_language returns on read. Send null to clear.
marital_statusMarital status, as the numeric code that marital_status returns on read. Send null to clear.
number_of_dependentsNumber of dependents. Send null to clear.
resident_typeResidency status, as the numeric code that resident_type returns on read. Send null to clear.
relationship_to_primaryRelationship to the primary applicant, as the numeric code that relationship_to_primary returns on read. Send null to clear.
Add an applicant to the application › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a deal's financial position
What the applicants own, what they owe, and where the down payment comes from. A liability with from_credit_bureau set to true came from a credit report, which carries its own redistribution obligations. Account numbers are never returned.
path Parameters
idResource id.
Retrieve a deal's financial position › Responses
Success
successAlways true on a successful response.
The requested record.
List changes to a deal's loan terms
One row for each change to one of nine loan terms on the deal's application, oldest first. Each row gives the old and new value, when the change was made, and who made it. A change made through an API key names the broker who owns the key.
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List changes to a deal's loan terms › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Retrieve one applicant
One applicant on the deal's application, with their employment, their other income, their addresses and their phone numbers. Social insurance numbers are never returned.
path Parameters
idResource id.
applicantIdResource id.
Retrieve one applicant › Responses
Success
successAlways true on a successful response.
The requested record.
Remove an applicant from the application
Deletes the applicant's application detail: their employment, their income, and their share of any asset or debt. The contact stays on the deal. To take them off the deal too, use DELETE /deals/{id}/participants/{contactId} after this.
path Parameters
idResource id.
applicantIdResource id.
Remove an applicant from the application › Responses
Success
successAlways true on a successful response.
The requested record.
Update an applicant
Changes the applicant's role, marital status, dependents, residency, or relationship to the primary applicant. Send only the fields to change. Coded fields take the numeric code that the read returns.
path Parameters
idResource id.
applicantIdResource id.
Update an applicant › Request Body
roleprimary, co_applicant, or guarantor. On create, the default comes from the participant role.
middle_nameMiddle name. Send null to clear.
honorificHonorific, as the numeric code that honorific returns on read. Send null to clear.
suffixName suffix, as the numeric code that suffix returns on read. Send null to clear.
sexSex, as the numeric code that sex returns on read. Send null to clear.
correspondence_languageCorrespondence language, as the numeric code that correspondence_language returns on read. Send null to clear.
marital_statusMarital status, as the numeric code that marital_status returns on read. Send null to clear.
number_of_dependentsNumber of dependents. Send null to clear.
resident_typeResidency status, as the numeric code that resident_type returns on read. Send null to clear.
relationship_to_primaryRelationship to the primary applicant, as the numeric code that relationship_to_primary returns on read. Send null to clear.
Update an applicant › Responses
Success
successAlways true on a successful response.
The requested record.
Add a job to an applicant
Adds one employment record, with its income lines. The gross debt service and total debt service ratios on the application include the new income on the next read.
path Parameters
idResource id.
applicantIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add a job to an applicant › Request Body
employer_nameName of the employer. Send null to clear.
job_titleJob title. Send null to clear.
currenttrue when this is a current job. The default on create is true.
statusEmployment status, as the numeric code that status returns on read. Send null to clear.
typeEmployment type, as the numeric code that type returns on read. Send null to clear. The temporary codes 3, 4 and 6 are no longer used: 3 is saved as 1, 4 as 2, and 6 as 5.
industryIndustry, as the numeric code that industry returns on read. Send null to clear.
occupationOccupation, as the numeric code that occupation returns on read. Send null to clear.
cityEmployer city or town. Send null to clear.
Employer province, as the numeric code that province returns on read, or as the two-letter code, e.g. ON. Send null to clear.
Date the applicant started this job. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
Date the applicant left this job. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
Date the applicant started in this industry. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
industry_variestrue when the applicant works across industries. Leave industry empty then.
business_typeBusiness type, as the numeric code that business_type returns on read. Send null to clear.
employer_unit_numberEmployer unit or suite. Send null to clear.
employer_street_numberEmployer street number. Send null to clear.
employer_street_nameEmployer street name. Send null to clear.
employer_street_typeEmployer street type, as the numeric code that employer_street_type returns on read. Send null to clear.
employer_street_directionEmployer street direction, as the numeric code that employer_street_direction returns on read. Send null to clear.
employer_postal_codeEmployer postal code. Send null to clear.
employer_phone_area_codeEmployer phone area code. Send null to clear.
employer_phone_numberEmployer phone number, without the area code. Send null to clear.
employer_phone_extensionEmployer phone extension. Send null to clear.
The complete list of income lines for this job. A line with an id changes that line, a line without one is added, and a line you leave out is removed. Leave the field out to keep the lines as they are.
Add a job to an applicant › Responses
Success
successAlways true on a successful response.
The requested record.
Remove a job
Deletes one employment record and its income lines.
path Parameters
idResource id.
applicantIdResource id.
employmentIdResource id.
Remove a job › Responses
Success
successAlways true on a successful response.
The requested record.
Update a job
Changes one employment record. Send only the fields to change. When you send incomes, it is the complete list for this job: lines you leave out are removed. A status with no employer, such as retired, clears the employer fields.
path Parameters
idResource id.
applicantIdResource id.
employmentIdResource id.
Update a job › Request Body
employer_nameName of the employer. Send null to clear.
job_titleJob title. Send null to clear.
currenttrue when this is a current job. The default on create is true.
statusEmployment status, as the numeric code that status returns on read. Send null to clear.
typeEmployment type, as the numeric code that type returns on read. Send null to clear. The temporary codes 3, 4 and 6 are no longer used: 3 is saved as 1, 4 as 2, and 6 as 5.
industryIndustry, as the numeric code that industry returns on read. Send null to clear.
occupationOccupation, as the numeric code that occupation returns on read. Send null to clear.
cityEmployer city or town. Send null to clear.
Employer province, as the numeric code that province returns on read, or as the two-letter code, e.g. ON. Send null to clear.
Date the applicant started this job. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
Date the applicant left this job. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
Date the applicant started in this industry. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
industry_variestrue when the applicant works across industries. Leave industry empty then.
business_typeBusiness type, as the numeric code that business_type returns on read. Send null to clear.
employer_unit_numberEmployer unit or suite. Send null to clear.
employer_street_numberEmployer street number. Send null to clear.
employer_street_nameEmployer street name. Send null to clear.
employer_street_typeEmployer street type, as the numeric code that employer_street_type returns on read. Send null to clear.
employer_street_directionEmployer street direction, as the numeric code that employer_street_direction returns on read. Send null to clear.
employer_postal_codeEmployer postal code. Send null to clear.
employer_phone_area_codeEmployer phone area code. Send null to clear.
employer_phone_numberEmployer phone number, without the area code. Send null to clear.
employer_phone_extensionEmployer phone extension. Send null to clear.
The complete list of income lines for this job. A line with an id changes that line, a line without one is added, and a line you leave out is removed. Leave the field out to keep the lines as they are.
Update a job › Responses
Success
successAlways true on a successful response.
The requested record.
Add other income to an applicant
Adds one income line that does not come from a job, for example a pension or child support.
path Parameters
idResource id.
applicantIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add other income to an applicant › Request Body
income_typeKind of income, as the numeric code that income_type returns on read.
payment_frequencyHow often it is received, as the numeric code that payment_frequency returns on read.
amountAmount received each period, in dollars. Not annualized.
detailsFree-text detail. Send null to clear.
Add other income to an applicant › Responses
Success
successAlways true on a successful response.
The requested record.
Update other income
Changes one income line. Send only the fields to change.
path Parameters
idResource id.
applicantIdResource id.
incomeSourceIdResource id.
Update other income › Request Body
income_typeKind of income, as the numeric code that income_type returns on read.
payment_frequencyHow often it is received, as the numeric code that payment_frequency returns on read.
amountAmount received each period, in dollars. Not annualized.
detailsFree-text detail. Send null to clear.
Update other income › Responses
Success
successAlways true on a successful response.
The requested record.
Add an address to an applicant
Adds one address: where the applicant lives now (current), a home they lived in before (previous), or a mailing address (correspondence). Lenders ask for about three years of address history, so add each earlier home as its own previous address with its dates.
path Parameters
idResource id.
applicantIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add an address to an applicant › Request Body
typecurrent, previous or correspondence. The default on create is current. Add each earlier home as its own previous address.
occupancy_typeHow the applicant lives there. One of the occupancy_type values on read. Send null to clear.
unit_numberUnit or suite. Send null to clear.
street_numberStreet number. Send null to clear.
street_nameStreet name. Send null to clear.
street_typeStreet type, as the numeric code that street_type returns on read. Send null to clear.
street_directionStreet direction, as the numeric code that street_direction returns on read. Send null to clear.
cityCity or town. Send null to clear.
Province, as the numeric code that province returns on read, or as the two-letter code, e.g. ON. Send null to clear.
postal_codePostal code. Send null to clear.
countryCountry, as the numeric code that country returns on read. The default on create is Canada.
When the applicant started living at this address. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
When the applicant stopped living at this address. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
current_property_intended_actionWhat happens to this home after the new mortgage, as the numeric code that current_property_intended_action returns on read. Send null to clear.
annual_heating_amountYearly heating cost of this home, in dollars. Send null to clear.
annual_tax_amountYearly property tax on this home, in dollars. Send null to clear.
annual_gross_rental_incomeYearly rent the applicant collects on this home, in dollars. Send null to clear.
rental_offset_pctThe share of rent that counts, as a PERCENT from 0 to 100. Send null to clear.
rental_calc_typeRental calculation method, as the numeric code that rental_calc_type returns on read. Send null to clear.
monthly_rent_paidRent the applicant pays each month, in dollars. Send null to clear.
tenancy_typeTenancy type, as the numeric code that tenancy_type returns on read. Send null to clear.
Add an address to an applicant › Responses
Success
successAlways true on a successful response.
The requested record.
Remove an address
Deletes one address from the applicant.
path Parameters
idResource id.
applicantIdResource id.
addressIdResource id.
Remove an address › Responses
Success
successAlways true on a successful response.
The requested record.
Update an address
Changes one address. Send only the fields to change. Coded fields take the numeric code that the read returns.
path Parameters
idResource id.
applicantIdResource id.
addressIdResource id.
Update an address › Request Body
typecurrent, previous or correspondence. The default on create is current. Add each earlier home as its own previous address.
occupancy_typeHow the applicant lives there. One of the occupancy_type values on read. Send null to clear.
unit_numberUnit or suite. Send null to clear.
street_numberStreet number. Send null to clear.
street_nameStreet name. Send null to clear.
street_typeStreet type, as the numeric code that street_type returns on read. Send null to clear.
street_directionStreet direction, as the numeric code that street_direction returns on read. Send null to clear.
cityCity or town. Send null to clear.
Province, as the numeric code that province returns on read, or as the two-letter code, e.g. ON. Send null to clear.
postal_codePostal code. Send null to clear.
countryCountry, as the numeric code that country returns on read. The default on create is Canada.
When the applicant started living at this address. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
When the applicant stopped living at this address. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
current_property_intended_actionWhat happens to this home after the new mortgage, as the numeric code that current_property_intended_action returns on read. Send null to clear.
annual_heating_amountYearly heating cost of this home, in dollars. Send null to clear.
annual_tax_amountYearly property tax on this home, in dollars. Send null to clear.
annual_gross_rental_incomeYearly rent the applicant collects on this home, in dollars. Send null to clear.
rental_offset_pctThe share of rent that counts, as a PERCENT from 0 to 100. Send null to clear.
rental_calc_typeRental calculation method, as the numeric code that rental_calc_type returns on read. Send null to clear.
monthly_rent_paidRent the applicant pays each month, in dollars. Send null to clear.
tenancy_typeTenancy type, as the numeric code that tenancy_type returns on read. Send null to clear.
Update an address › Responses
Success
successAlways true on a successful response.
The requested record.
Add a phone number to an applicant
Adds one phone number to the applicant's application detail. This is the number the lender sees. It does not change the contact's own phone numbers.
path Parameters
idResource id.
applicantIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add a phone number to an applicant › Request Body
usageWhat the number is for, as the numeric code that usage returns on read.
numberPhone number, without the area code.
preferredtrue when this is the number the applicant prefers. The default on create is false.
country_codeCountry calling code. Send null to clear.
area_codeArea code. Send null to clear.
extensionExtension. Send null to clear.
Add a phone number to an applicant › Responses
Success
successAlways true on a successful response.
The requested record.
Remove a phone number
Deletes one phone number from the applicant.
path Parameters
idResource id.
applicantIdResource id.
phoneIdResource id.
Remove a phone number › Responses
Success
successAlways true on a successful response.
The requested record.
Update a phone number
Changes one phone number. Send only the fields to change.
path Parameters
idResource id.
applicantIdResource id.
phoneIdResource id.
Update a phone number › Request Body
usageWhat the number is for, as the numeric code that usage returns on read.
preferredtrue when this is the number the applicant prefers. The default on create is false.
country_codeCountry calling code. Send null to clear.
area_codeArea code. Send null to clear.
numberPhone number, without the area code.
extensionExtension. Send null to clear.
Update a phone number › Responses
Success
successAlways true on a successful response.
The requested record.
Add an asset
Adds one asset that is not a property, for example savings or a vehicle. To add a property the applicants own, use POST /deals/{id}/other-properties.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add an asset › Request Body
valueValue of the asset, in dollars.
contact_idThe applicant who holds the row, as a contact id. Ignored when owner_contact_ids is sent.
owner_contact_idsEvery applicant who holds the row, as contact ids. A contact that is not an applicant on this deal is ignored. Leave it out to keep the owners as they are.
asset_typeKind of asset, as the numeric code that asset_type returns on read. Send null to clear.
descriptionFree-text detail, 50 characters maximum. Send null to clear.
available_as_collateraltrue when the asset can secure the loan.
applied_to_down_paymentHow much of this asset goes into the down payment, in dollars. Send null to clear.
Add an asset › Responses
Success
successAlways true on a successful response.
The requested record.
Update an asset
Changes one asset. Send only the fields to change.
path Parameters
idResource id.
assetIdResource id.
Update an asset › Request Body
contact_idThe applicant who holds the row, as a contact id. Ignored when owner_contact_ids is sent.
owner_contact_idsEvery applicant who holds the row, as contact ids. A contact that is not an applicant on this deal is ignored. Leave it out to keep the owners as they are.
asset_typeKind of asset, as the numeric code that asset_type returns on read. Send null to clear.
descriptionFree-text detail, 50 characters maximum. Send null to clear.
valueValue of the asset, in dollars.
available_as_collateraltrue when the asset can secure the loan.
applied_to_down_paymentHow much of this asset goes into the down payment, in dollars. Send null to clear.
Update an asset › Responses
Success
successAlways true on a successful response.
The requested record.
Add a debt
Adds one debt the applicants state. Debts from a credit report arrive only from a credit pull. The total debt service ratio includes the new debt on the next read.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add a debt › Request Body
contact_idThe applicant who holds the row, as a contact id. Ignored when owner_contact_ids is sent.
owner_contact_idsEvery applicant who holds the row, as contact ids. A contact that is not an applicant on this deal is ignored. Leave it out to keep the owners as they are.
liability_typeKind of debt, as the numeric code that liability_type returns on read. Send null to clear.
lender_nameWho the debt is owed to. Send null to clear.
pay_offtrue when the broker plans to pay the debt out at closing.
outstanding_balanceBalance owing, in dollars. Send null to clear.
monthly_repaymentRequired monthly payment, in dollars. Send null to clear.
credit_limitCredit limit, in dollars. Send null to clear.
net_rateRate on the debt as a PERCENT, e.g. 5.25 means 5.25%. Not a fraction. Send null to clear.
When the debt matures. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
descriptionFree-text detail. Send null to clear.
original_loan_amountThe amount first borrowed, in dollars. Send null to clear.
When the debt was taken out. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
charge_typeCharge type, as the numeric code that charge_type returns on read. Send null to clear.
repayment_typeRepayment type, as the numeric code that repayment_type returns on read. Send null to clear.
redemption_statusRedemption status, as the numeric code that redemption_status returns on read. Send null to clear.
rate_typeRate type, as the numeric code that rate_type returns on read. Send null to clear.
payoff_typePayout plan, as the numeric code that payoff_type returns on read. Send null to clear.
debt_typeHow BrokerPlus groups the debt for a debt consolidation analysis. A debt with no debt_type is left out of the analysis. Send null to clear.
Add a debt › Responses
Success
successAlways true on a successful response.
The requested record.
Remove a debt
Deletes one debt. A debt with from_credit_bureau set to true cannot be deleted through the API.
path Parameters
idResource id.
liabilityIdResource id.
Remove a debt › Responses
Success
successAlways true on a successful response.
The requested record.
Update a debt
Changes one debt. Send only the fields to change. A debt with from_credit_bureau set to true cannot be changed through the API.
path Parameters
idResource id.
liabilityIdResource id.
Update a debt › Request Body
contact_idThe applicant who holds the row, as a contact id. Ignored when owner_contact_ids is sent.
owner_contact_idsEvery applicant who holds the row, as contact ids. A contact that is not an applicant on this deal is ignored. Leave it out to keep the owners as they are.
liability_typeKind of debt, as the numeric code that liability_type returns on read. Send null to clear.
lender_nameWho the debt is owed to. Send null to clear.
pay_offtrue when the broker plans to pay the debt out at closing.
outstanding_balanceBalance owing, in dollars. Send null to clear.
monthly_repaymentRequired monthly payment, in dollars. Send null to clear.
credit_limitCredit limit, in dollars. Send null to clear.
net_rateRate on the debt as a PERCENT, e.g. 5.25 means 5.25%. Not a fraction. Send null to clear.
When the debt matures. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
descriptionFree-text detail. Send null to clear.
original_loan_amountThe amount first borrowed, in dollars. Send null to clear.
When the debt was taken out. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
charge_typeCharge type, as the numeric code that charge_type returns on read. Send null to clear.
repayment_typeRepayment type, as the numeric code that repayment_type returns on read. Send null to clear.
redemption_statusRedemption status, as the numeric code that redemption_status returns on read. Send null to clear.
rate_typeRate type, as the numeric code that rate_type returns on read. Send null to clear.
payoff_typePayout plan, as the numeric code that payoff_type returns on read. Send null to clear.
debt_typeHow BrokerPlus groups the debt for a debt consolidation analysis. A debt with no debt_type is left out of the analysis. Send null to clear.
Update a debt › Responses
Success
successAlways true on a successful response.
The requested record.
List the other properties the applicants own
Every property the applicants own other than the one being mortgaged, with its value, its mortgage, and its rent. Rates are PERCENT (5.49 means 5.49%).
path Parameters
idResource id.
List the other properties the applicants own › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Add another property
Adds one property the applicants own other than the one being mortgaged. property_use is required. The ratios on the application include the property's costs on the next read.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Add another property › Request Body
property_useWhat the property is used for, e.g. rental.
contact_idThe applicant who holds the row, as a contact id. Ignored when owner_contact_ids is sent.
owner_contact_idsEvery applicant who holds the row, as contact ids. A contact that is not an applicant on this deal is ignored. Leave it out to keep the owners as they are.
street_numberStreet number. Send null to clear.
street_nameStreet name. Send null to clear.
unitUnit or suite. Send null to clear.
cityCity or town. Send null to clear.
Province, as the two-letter code that province returns on read, e.g. ON, or as the numeric province code. Send null to clear.
postal_codePostal code. Send null to clear.
valueValue the broker states, in dollars. Send null to clear.
original_priceWhat the applicant paid, in dollars. Send null to clear.
When the applicant bought it. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
annual_property_taxAnnual property tax, in dollars. Send null to clear.
monthly_condo_feesMonthly condo fees, in dollars. Send null to clear.
monthly_heating_amountMonthly heating cost, in dollars. Send null to clear.
still_mortgagedtrue when a mortgage is still on the property.
mortgage_balanceBalance owing on the mortgage, in dollars. Send null to clear.
interest_rateRate on the mortgage as a PERCENT, e.g. 5.25 means 5.25%. Not a fraction. Send null to clear.
monthly_paymentMonthly mortgage payment, in dollars. Send null to clear.
mortgage_lenderWho holds the mortgage. Send null to clear.
When the mortgage term ends. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
payoffHow the mortgage is paid out at closing, as the numeric code that payoff returns on read. Send null to clear.
include_in_tdstrue when the property's costs count in the total debt service ratio.
monthly_rental_incomeMonthly rent, in dollars. Send null to clear.
rental_offset_pctThe share of rent that counts, as a PERCENT from 0 to 100. Send null to clear.
street_typeStreet type, as the numeric code that street_type returns on read. Send null to clear.
street_directionStreet direction, as the numeric code that street_direction returns on read. Send null to clear.
condo_fees_include_heatingtrue when the condo fee already covers heat.
condo_fee_tds_pctThe share of the condo fee that counts, as a PERCENT from 0 to 100. Send null to clear.
mortgage_rate_typeRate type of the mortgage, as the numeric code that mortgage_rate_type returns on read. Send null to clear.
mortgage_payment_frequencyMortgage payment frequency, as the numeric code that mortgage_payment_frequency returns on read. Send null to clear.
rental_calc_typeRental calculation method, as the numeric code that rental_calc_type returns on read. Send null to clear.
monthly_hydro_costsMonthly hydro cost, in dollars. Send null to clear.
monthly_insurance_costsMonthly insurance cost, in dollars. Send null to clear.
monthly_management_costsMonthly property management cost, in dollars. Send null to clear.
monthly_repairs_costsMonthly repairs cost, in dollars. Send null to clear.
monthly_interest_costsMonthly interest cost, in dollars. Send null to clear.
monthly_other_costsOther monthly operating costs, in dollars. Send null to clear.
monthly_fees_offsetMonthly condo fee left out of the ratios, in dollars. Send null to clear.
Add another property › Responses
Success
successAlways true on a successful response.
The requested record.
Update another property
Changes one property. Send only the fields to change. A change to payoff also changes the paired mortgage debt, when the property has one.
path Parameters
idResource id.
propertyIdResource id.
Update another property › Request Body
contact_idThe applicant who holds the row, as a contact id. Ignored when owner_contact_ids is sent.
owner_contact_idsEvery applicant who holds the row, as contact ids. A contact that is not an applicant on this deal is ignored. Leave it out to keep the owners as they are.
property_useWhat the property is used for, e.g. rental.
street_numberStreet number. Send null to clear.
street_nameStreet name. Send null to clear.
unitUnit or suite. Send null to clear.
cityCity or town. Send null to clear.
Province, as the two-letter code that province returns on read, e.g. ON, or as the numeric province code. Send null to clear.
postal_codePostal code. Send null to clear.
valueValue the broker states, in dollars. Send null to clear.
original_priceWhat the applicant paid, in dollars. Send null to clear.
When the applicant bought it. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
annual_property_taxAnnual property tax, in dollars. Send null to clear.
monthly_condo_feesMonthly condo fees, in dollars. Send null to clear.
monthly_heating_amountMonthly heating cost, in dollars. Send null to clear.
still_mortgagedtrue when a mortgage is still on the property.
mortgage_balanceBalance owing on the mortgage, in dollars. Send null to clear.
interest_rateRate on the mortgage as a PERCENT, e.g. 5.25 means 5.25%. Not a fraction. Send null to clear.
monthly_paymentMonthly mortgage payment, in dollars. Send null to clear.
mortgage_lenderWho holds the mortgage. Send null to clear.
When the mortgage term ends. Accepts YYYY-MM-DD or an ISO 8601 timestamp. Send null to clear.
payoffHow the mortgage is paid out at closing, as the numeric code that payoff returns on read. Send null to clear.
include_in_tdstrue when the property's costs count in the total debt service ratio.
monthly_rental_incomeMonthly rent, in dollars. Send null to clear.
rental_offset_pctThe share of rent that counts, as a PERCENT from 0 to 100. Send null to clear.
street_typeStreet type, as the numeric code that street_type returns on read. Send null to clear.
street_directionStreet direction, as the numeric code that street_direction returns on read. Send null to clear.
condo_fees_include_heatingtrue when the condo fee already covers heat.
condo_fee_tds_pctThe share of the condo fee that counts, as a PERCENT from 0 to 100. Send null to clear.
mortgage_rate_typeRate type of the mortgage, as the numeric code that mortgage_rate_type returns on read. Send null to clear.
mortgage_payment_frequencyMortgage payment frequency, as the numeric code that mortgage_payment_frequency returns on read. Send null to clear.
rental_calc_typeRental calculation method, as the numeric code that rental_calc_type returns on read. Send null to clear.
monthly_hydro_costsMonthly hydro cost, in dollars. Send null to clear.
monthly_insurance_costsMonthly insurance cost, in dollars. Send null to clear.
monthly_management_costsMonthly property management cost, in dollars. Send null to clear.
monthly_repairs_costsMonthly repairs cost, in dollars. Send null to clear.
monthly_interest_costsMonthly interest cost, in dollars. Send null to clear.
monthly_other_costsOther monthly operating costs, in dollars. Send null to clear.
monthly_fees_offsetMonthly condo fee left out of the ratios, in dollars. Send null to clear.
Update another property › Responses
Success
successAlways true on a successful response.
The requested record.
Get the valuation history of another property
Every valuation BrokerPlus holds for one other property, newest first, and how the estimate changed over the last year. change_12mo.change_pct is a PERCENT (4.5 means 4.5%).
path Parameters
idResource id.
propertyIdResource id.
Get the valuation history of another property › Responses
Success
successAlways true on a successful response.
The requested record.
Get the value history of the deal's property
Every valuation BrokerPlus holds for the property the deal's mortgage is on, newest first. This is the home value trend on the client's equity report. BrokerPlus adds a valuation each month while the client gets reports. The value the opportunity shows can differ when the broker set their own in property_value.
path Parameters
idResource id.
Get the value history of the deal's property › Responses
Success
successAlways true on a successful response.
The requested record.
Ask for a new valuation of another property
Asks the valuation service for a new estimate of one other property, the same as the refresh button in BrokerPlus. The valuation runs in the background, so the response is 202. Read the valuation history again in a minute to see the new value. The property must have a street address.
path Parameters
idResource id.
propertyIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Ask for a new valuation of another property › Responses
Success
successAlways true on a successful response.
The requested record.
List debt consolidation analyses
The debt consolidation analyses run on a deal, newest first. The first one is the deal's current analysis. An analysis never changes: run a new one to update it. Every rate is a PERCENT (4.59 means 4.59%).
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List debt consolidation analyses › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Run a debt consolidation analysis
Compares paying out the client's debts with a refinance, a home equity line of credit, or a reverse mortgage, the same as the Debts tab in BrokerPlus. The analysis reads every debt on the deal that has a debt_type, the other properties, and the value and balance on the deal's opportunity. Send a rate to replace the default for that option. BrokerPlus sends nothing to the client.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Run a debt consolidation analysis › Request Body
new_mortgage_rate_pctThe rate on the new mortgage for a refinance, as a PERCENT from 0.01 to 25. 4.59 means 4.59%. Leave it out to use the default.
heloc_rate_pctThe rate on a home equity line of credit, as a PERCENT from 0.01 to 25. 4.59 means 4.59%. Leave it out to use the default.
reverse_mortgage_rate_pctThe rate on a reverse mortgage, as a PERCENT from 0.01 to 25. 4.59 means 4.59%. Leave it out to use the default.
rental_heloc_rate_pctThe rate on a line of credit against a rental property, as a PERCENT from 0.01 to 25. 4.59 means 4.59%. Leave it out to use the default.
Run a debt consolidation analysis › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a debt consolidation analysis
One debt consolidation analysis: the client's position now, each option BrokerPlus compared, and the one it recommends. Every rate is a PERCENT.
path Parameters
idResource id.
analysisIdResource id.
Retrieve a debt consolidation analysis › Responses
Success
successAlways true on a successful response.
The requested record.
List a deal's lender commitments
The terms BrokerPlus read from the lender's commitment PDF, newest first, with the broker's corrections applied and the cost of borrowing worked out from them. Only a reviewed commitment goes on the cost of borrowing disclosure. Rates are PERCENT (5.24 means 5.24%).
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List a deal's lender commitments › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Read the terms of a lender commitment
Reads the terms from the commitment PDF. With no body, BrokerPlus reads the PDF the lender sent with its latest decision. For a lender that sends none, upload the commitment as a document and send its id in document_id. Reading the same PDF again replaces its terms and clears the review. The terms are not on a disclosure until the broker reviews them. Nothing is sent.
path Parameters
idResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Read the terms of a lender commitment › Request Body optional
document_idA document on the deal that is a mortgage commitment. Leave it out to read the PDF the lender sent with its decision.
Read the terms of a lender commitment › Responses
Success
successAlways true on a successful response.
The requested record.
Retrieve a lender commitment
One commitment on the deal, with its terms and the cost of borrowing.
path Parameters
idResource id.
commitmentIdResource id.
Retrieve a lender commitment › Responses
Success
successAlways true on a successful response.
The requested record.
Review a lender commitment
Marks the terms as reviewed by the broker, with any corrections in edits. A reviewed commitment is what the cost of borrowing disclosure prints, so review only terms the broker checked against the PDF. Corrections replace those of an earlier review. Nothing is sent.
path Parameters
idResource id.
commitmentIdResource id.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Review a lender commitment › Request Body optional
Your corrections to what was read. They replace the corrections of an earlier review. Leave it out to accept the terms as read.
Review a lender commitment › Responses
Success
successAlways true on a successful response.
The requested record.