Conditions
What a lender still needs before a deal can close.
List a deal's conditions
What the lender and broker still need, highest priority first. Filter by status for open ones.
path Parameters
idResource id.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
statusFilter by broker-owned status, e.g. outstanding.
List a deal's conditions › 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 a condition to a deal
Adds a condition the same way the deal's Conditions tab does. BrokerPlus also files a task to decide it. The condition records your key's broker as the filer. Use assignee_role and assignee_contact_id to say who owes it. Supports Idempotency-Key.
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 condition to a deal › Request Body
titleWhat has to be satisfied. Required.
descriptionLonger detail.
categoryThe checklist group. Defaults to other.
priorityDefaults to normal.
The date the condition is due, as YYYY-MM-DD.
assignee_roleWho owes the condition. Use broker, borrower, lawyer, credit_assistant, realtor, insurer, or your own value. Send null to clear it.
assignee_contact_idA contact in your brokerage who owes the condition, e.g. the lawyer. Send null to clear it.
Add a condition to a deal › Responses
Success
successAlways true on a successful response.
The requested record.
Email somebody on a deal about conditions
Emails a letter that explains conditions in plain language now, from the broker's connected mailbox, as Request From Participant on the deal's Conditions tab does. A borrower gets a request for what the lender needs. A professional on the deal, for example a realtor or a lawyer, gets an update. BrokerPlus writes the letter and sends it through a draft in the broker's name. The response is 201 with that draft, with status sent. A key with the no_sending limit gets 403. Supports Idempotency-Key.
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.
Email somebody on a deal about conditions › Request Body
condition_idsThe conditions to explain, from GET /v1/deals/{id}/conditions. Each must be on this deal.
contact_idWho gets the letter. The contact must be on the deal (GET /v1/deals/{id}/participants) and must have an email address. A borrower gets a request for what the lender needs. A professional on the deal, for example a realtor or a lawyer, gets an update.
subjectReplaces the subject that BrokerPlus writes.
bodyReplaces the letter that BrokerPlus writes, in plain text. Leave it out to send the letter from the app, which explains each condition in plain language.
Email somebody on a deal about conditions › Responses
Success
successAlways true on a successful response.
The requested record.
Update a condition
Move a condition to a new status, or change its due date. lender_status is not writable: it is the lender's own answer and is refreshed from them, so a value written here would be overwritten and would meanwhile claim the lender accepted something it never saw.
path Parameters
idResource id.
Update a condition › Request Body
statusWhere the condition stands with your team. Setting it to satisfied stamps satisfied_at.
due_dateISO 8601 date the condition is due, or null to clear it.
status_noteThe team's note on where the condition stands. Send null or an empty string to clear it.
assignee_roleWho owes the condition. Use broker, borrower, lawyer, credit_assistant, realtor, insurer, or your own value. Send null to clear it.
assignee_contact_idA contact in your brokerage who owes the condition, e.g. the lawyer. Send null to clear it.
Update a condition › Responses
Success
successAlways true on a successful response.
The requested record.
Satisfy a condition
Marks the condition satisfied and stamps satisfied_at. The task to decide it is completed. Send no body.
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.
Satisfy a condition › Responses
Success
successAlways true on a successful response.
The requested record.
Waive a condition
Marks the condition waived: it no longer blocks the deal, but it was not satisfied. The task to decide it is completed. Send no body.
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.
Waive a condition › Responses
Success
successAlways true on a successful response.
The requested record.
Attach documents to a condition
Attaches documents on the deal to the condition as what answers it, as the attach on the deal's Conditions tab does. The documents go to the lender with the condition. A document that is already attached stays attached once. Nothing is sent and the condition's status does not change: satisfy it with POST /conditions/{id}/satisfy.
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.
Attach documents to a condition › Request Body
document_idsThe documents that answer the condition. Each one has to be on the condition's deal: list them with GET /deals/{id}/documents. A document that is already attached stays attached.
Attach documents to a condition › Responses
Success
successAlways true on a successful response.
The requested record.