book-scan

Sweep a book you send (nothing stored)

Runs the opportunity sweep over up to 250 household documents (25 on a sandbox key), storing none of them. Any key works. Every household is validated before any is scanned; an advisorRef containing "@" is rejected. Expense labels are stripped.

post/api/v1/book-scan

Request

  • Base URL: https://worthune.com
  • URL: https://worthune.com/api/v1/book-scan
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Request body

Response

The queue, per-advisor rollups, skips and notes.

okunknown required
householdsScannedinteger required
householdsTruncatedinteger required

Households beyond the cap that were NOT scanned — never silent.

strategiesRunstring[] required
notesstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.