Intake – Client Docs

Cancel a document request. Sets its status to "archived", closes the client's portal link immediately, and stops all further reminder emails. No email is sent to the client. Use this for dead requests that will never be fulfilled. Only call this when the user explicitly asks to cancel the request.

cancel_request

Mark a document request as complete. The client's portal shows the request as complete and their portal link expires after a grace period. No email is sent. Only call this when the user explicitly asks to complete the request.

complete_request

Create a "clean copy" of a photo upload: a derived scanner-style PDF (perspective-corrected and cleaned to black-and-white). The original file is never modified. Available on paid plans, for JPEG or PNG uploads. Generation is asynchronous — the response shows document_copy_status "processing"; fetch the upload again until it is "ready" (document_copy_url is then set) or "failed".

create_document_copy

Create a new client. Requires at least a name or email address. Returns the created client.

create_client

Create a new deal.

create_deal

Create a new deal from a deal template. This creates the deal with all party roles pre-configured from the template. Parties are created without clients — assign clients afterward using update_party.

create_deal_from_template

Create a new form template with fields in one call. Fields support types: text, textarea, number, date, email, phone, select, radio, checkbox, signature, appointment. Fields with options (select, radio, checkbox) need config.options as a list of strings. Appointment fields let the client pick a time slot; see add_form_field for the config shape. Best practices: - Set required: true for fields the client must fill out. - Use config.validation to enforce format, e.g. "email" or "phone_us". - When the field name implies a type (e.g. "Email Address"), prefer the matching field type (email) and add the corresponding validation.

create_form_template

Create a public page. Attach at least one document type, form template, PDF template, or a fee, otherwise the page shows as unavailable to visitors. Public pages are live-only (not available with test API keys). The page is public as soon as it's created, so only call this when the user explicitly asks to publish it.

create_public_page

Create a new document request for a client. Optionally include checklist items and co-clients (additional recipients who each get their own portal link, e.g. a spouse on a joint filing). The request is created in draft status — use send_request to email it to the recipients. Typical workflow: 1. create_request with checklist items (documents to upload) and any co-clients 2. Attach forms (attach_form_to_request or attach_inline_form) and/or PDFs (attach_pdf_to_request) 3. Show the user the draft. Only when they explicitly ask to send: send_request

create_request

Create a fully-loaded request for a deal party using the deal template's attachments. The party must have a client assigned and the deal must have been created from a template. Automatically attaches form templates, PDF templates, and document checklists defined for the party's role in the template.

create_request_from_template

One-call deal creation: upserts clients, creates a deal from a template, assigns clients to parties, generates requests, and optionally sends them. Returns the full deal with portal URLs. Only set auto_send when the user explicitly asks to send; otherwise the requests stay drafts.

dispatch_deal

Draft one request from a plain-English description of what you need from a client ("send Jane my questionnaire, two years of tax returns, and the fee agreement"). Candidates are matched against your existing document types, form templates and PDF templates; a confident match is reported under `match` and will be reused on accept, everything else is created. Client name/email are extracted when present. Nothing is created until accept_setup_plan is called.

plan_request

Build a workspace proposal from a plain-English description of the business and what it needs from clients. Returns a draft plan: document types clients upload, intake forms with fields, a public start page, and the PDFs the owner must supply (engagement letter, consents). Each item carries a verdict (keep / unsure / drop) and the raw judgment probabilities. Nothing is created until accept_setup_plan is called. Live-only.

setup_workspace

Find a client by external_id+external_source, or by email. If not found, create one. Returns the client and whether it was created or updated.

find_or_create_client

Get one appointment by ID, with its request and client.

get_appointment

Get a single deal by ID, including all parties and their requests.

get_deal

Get a deal template with all party roles and their attachments (form templates, PDF templates, document types). Use this to inspect what a template includes before creating a deal from it.

get_deal_template

Get form responses for a request. Returns all attached forms with their fields and submitted responses (if completed).

get_form_responses

Get a form template with all its field definitions. Use this to inspect a template before attaching it to a request.

get_form_template

Return the audit trail for a completed PDF fill request: per-signature field name, SHA-256 hash, IP address, user agent, and signed-at timestamp. These are the same records that appear on the Certificate of Completion page appended to every signed PDF.

get_pdf_fill_signatures

Get a PDF template with field definitions and editor URL. Use this to inspect a template before attaching it to a request.

get_pdf_template

Get a public page with its attachments, fee, and submission count.

get_public_page

Get a single document request by ID. Includes full detail with items, forms, the portal_url the primary client uses to upload documents, and a recipients array with each co-client's own portal_url.

get_request

List appointments booked through `appointment` form fields, ordered by start time. Filter by a date window, status, client, or request. Times are UTC ISO 8601; `timezone` is the zone the client booked in. Paginate with `after` (the last appointment's id) while `has_more` is true.

list_appointments

List all clients for the authenticated user. Optionally filter by search term (matches name or email).

list_clients

List all deal templates (user-created and system templates). Deal templates define multi-party workflows with pre-configured roles, forms, PDFs, and document checklists for each party.

list_deal_templates

List all deals. Optionally filter by status.

list_deals

List all saved form templates for the authenticated user. Returns template summaries with field counts.

list_form_templates

List the people in this workspace who can be assigned requests and deals. Returns each member's id (mem_…), role, name, and email.

list_members

List all PDF templates for the authenticated user. Returns template summaries with field counts and page info.

list_pdf_templates

List public pages: reusable shareable links (/i/:slug) anyone can open to upload documents, fill forms, sign PDFs, or pay a fee. Each submission creates a client and a sent request. Includes the public URL and submission count for each page.

list_public_pages

List the reminder audit trail for a request. Shows when each reminder was sent, to whom, with what urgency, and which items were pending. recipient_type is client, co_client, professional_overdue, professional_cap_reached, professional_never_viewed (no portal view 3 days after sending), or professional_due_passed (due date went by, reminders stopped).

list_request_reminders

List document requests. Optionally filter by status, client_id, or deal_id. Each request includes a recipients array with any co-clients' portal URLs.

list_requests

List all uploads for a document request.

list_uploads

Re-request a checklist item. Resets status to pending and clears review_status; the review_note is kept, shown to the client on the portal, and emailed to them. Previous uploads are kept for reference but marked superseded and excluded from exports. Use this when a submitted document was rejected and the client needs to resubmit. Only call this when the user explicitly asks to re-request the item.

re_request_item

Send a document request to the client. Changes status from draft to sent. By default sends an email to the client with the portal link. Set skip_email to true to activate the request without sending an email (useful when you want to share the portal link manually, e.g. via text message). Only call this when the user explicitly asks to send this request. Creating or editing a draft is never permission to send: show the draft and ask first.

send_request

Update an existing client's name, email, or phone. Returns the updated client.

update_client

Update the review status and optional note on a checklist item. Only works when the item's status is "received" (i.e., the client has uploaded). Valid review statuses depend on the user's settings (defaults: in_review, approved, rejected). The status and note are shown to the client in their portal, so only set them when the user explicitly asks.

update_item

Update a public page. Attachment id lists, when given, replace that kind entirely; omitted kinds are left unchanged. Set active=false to take the page down. Changes are public immediately, so only call this when the user explicitly asks.

update_public_page

Update a document request's title, description, due date, assignee, or reminder settings. On a sent request, enabling reminders or extending the due date resumes automatic reminder emails to the client, so only change those when the user explicitly asks.

update_request