Intakes

The one link a broker shares with anybody who wants to start an application. It is not tied to a client and it does not expire. The url is null until the link has been enabled once.

Enabling the link for the first time creates its url. Disabling it stops new intakes but keeps the url, so a link already printed somewhere works again when you enable it.

One row per client application, newest first. updated_since pages on when each last changed, so a daily job can ask for what moved. Asking by contact_id answers an intake the contact is a co-applicant on as well as one in their own name.

Creates an intake for one client, with or without a deal. delivery of link returns the client's link and sends nothing. delivery of email creates the intake and emails each applicant their link now, from the broker's connected mailbox. It answers 412 EMAIL_NOT_CONNECTED if the broker has no mailbox connected. A key with the no_sending limit cannot use email, and neither can a key whose brokerage's automation policy does not allow messages to clients to be asked for this way (403 POLICY_BLOCKED). A client who already has an open intake answers 409 DUPLICATE_INTAKE.

A single intake by id, with each applicant's progress.

Every question each applicant is asked, grouped by section, with the answer as it stands now. Answers save as the client types, so an intake that is not submitted yet shows what the client has filled in so far, the same as the broker sees in BrokerPlus. Check each applicant's submitted_at to know if the answers are final. The SIN is never returned.

Accepts what the client sent, the same as Approve on the intake in BrokerPlus. BrokerPlus builds the submission package and locks the answers. The client gets no message. The intake must be submitted or needs_changes.

Reopens the answers you name in changes, and refuses the files you name in uploads, now. BrokerPlus emails the client a link to fix them, with your message and a comment on each answer or file, the same as a change request sent on the intake in BrokerPlus. A refused file is replaced when the client sends a new one. The intake moves to needs_changes, and the response is the intake. The client must have submitted the intake first. A key with the no_sending limit cannot use this endpoint.

Every item on the client's portal other than a question: each document, form to sign, consent, identity check and down payment source, in the order the client sees them. Each item lists the applicants it is for, with what each one did about it and the files they sent. The questions and their answers are on GET /intakes/{id}/answers. For only what the client still owes on a deal, use GET /deals/{id}/document-requests.

One item by its key, with each applicant's state and files.

Puts one applicant's item in a tray on the broker's document board, as a drag on the board does. Send stage verified to accept it. Use it for an item with no file, for example a document the broker already has. To move a file the client sent, use POST /intakes/{id}/uploads/{uploadId}/stage. Nothing goes to the client.

Every file the client sent through their portal, newest first. A file the client replaced is not listed. A file becomes a deal document only when the broker verifies it.

The file's metadata plus a signed download URL valid for five minutes. Follow it, do not store it.

Moves the file to a tray on the broker's document board, as a drag on the board does. Send stage verified to accept it: BrokerPlus reads it and copies it to the deal's documents, and document_id then names the copy. Nothing goes to the client. To refuse a file and ask the client for a new one, use POST /intakes/{id}/request-changes with uploads.

The flags BrokerPlus's checks raised on a client's intake, the most serious first. A flag with audience never_disclose is for the broker only: never pass it on to the client.

The broker's Override: the flag stops standing against the file, with the reason kept on it and in the audit log. Nothing goes to the client.

The broker's choices on the stated income card: the dates the calculation counts, the bank statements and accounts left out, and the income the client declared. accounts lists every bank account on the client's statements. An intake the broker never changed reads with no dates and nothing left out.

Sets the dates, the statements and accounts left out, or the declared income, as the stated income card does. A field you leave out keeps its value. BrokerPlus then works the income out again, which takes a moment. Nothing goes to the client.

Every transaction BrokerPlus read off the client's bank statements, newest first, with what it was read as and the broker's change, if any. This is the transactions list on the stated income card. An account number is only ever its last 4 digits.

Takes transactions out of the income calculation, puts them back, or changes their category, as the stated income card does for the rows the broker selects. A field you leave out keeps each transaction's own value. BrokerPlus then works the income out again and settles any flag about a transaction taken out. Nothing goes to the client.

The transaction counts again as BrokerPlus read it, and the response is the transaction as it now reads. BrokerPlus then works the income out again. Nothing goes to the client.

The notes brokers wrote on the items and files of a client's intake, newest first, replies included. Nobody outside the brokerage sees them.

Puts a note on one file (upload_id) or one item (item_key) of the intake, or replies to a note (parent_id). A teammate mentioned in the note is told, as in BrokerPlus. The client never sees it. A note cannot be changed or deleted afterwards, in BrokerPlus or here.

One note that a broker wrote on an item or file of a client's intake, or a reply to one. Nobody outside the brokerage sees it.

Every answer and file the broker asked the client to fix on this intake, newest first. To ask for a new one, use POST /intakes/{id}/request-changes.

Removes it, as the broker does in the request panel. Nothing goes to the client.

Changes what the broker told the client about it. Nothing is sent: the client sees the new words the next time they open their link.

Marks it resolved, as the broker does in the request panel. Nothing goes to the client.

Puts a resolved change back to open. Nothing goes to the client.

Issues a link for one client on this intake. BrokerPlus keeps only a fingerprint of a link, so a link already sent cannot be read back: this issues another one, and every link issued for the same intake keeps working until it expires. Pass contact_id for a co-applicant.