DutyClaims Docs
Portal role: broker

Brokers and broker operators

This guide is for customs brokers and broker-ops users who need a plain-language walkthrough of registration, activation, client acquisition, client drill-down pages, commercial tracking, and managed broker API credentials.

Main workspace /broker/dashboard8 screenshot-backed walkthroughs

At a glance

Use the broker workspace to register the brokerage, work the client queue, invite importers, and manage commissions, payouts, and API keys.

Journey Map

Register the brokerage and wait for active status before expecting portal access

Broker access has its own lifecycle. Registration creates the brokerage record, but the full partner workspace does not become operational until the broker record is active.

/broker/register/broker/dashboard
  1. Complete Broker Registration with firm, contact, and license information.
  2. If the dashboard shows a pending or manual-review message, read the lifecycle copy there instead of assuming the portal is broken.
  3. Expect the active broker workspace only after the broker record clears review.
  • Broker approval is its own lifecycle, separate from importer onboarding.
  • Registration creates the brokerage record; activation unlocks clients, invites, payouts, and API credentials.
Broker Registration is the entry point for a new brokerage. The downstream broker portal depends on this approval path clearing first.

Use the broker dashboard as the working client queue

The main broker workspace is a live operating queue, not a static profile page. It combines client search, quick invite actions, workflow tasks, and one-importer drill-down pages.

/broker/dashboard/broker/clients/[importerId]
  1. Start on the dashboard to review enrolled client count, aggregate estimated refund value, quick-invite actions, and the broker workflow rail.
  2. Use client views, search, and claim-status filters to work the current book of business without leaving the workspace.
  3. Open a client detail page when you need claim-level context for one importer relationship, including status, value, and document follow-up.
  • The dashboard is both an operations queue and a relationship-management surface.
  • Client detail pages are where one importer relationship stops being abstract.
The broker dashboard is the partner workbench: client filters, quick invites, workflow tasks, and live book-of-business visibility all sit in one place.
Client detail shows one importer relationship in context so the broker can inspect claim state and next actions without guessing from the aggregate queue.

Invite importers one at a time or seed the queue by CSV

DutyClaims supports two broker acquisition motions: tracked invites for high-touch outreach and CSV upload for roster-based onboarding.

/broker/invites/broker/upload
  1. Use Client Invites for high-touch outreach, activation tracking, and resend logic tied to named importer contacts.
  2. Use Upload when you already have a roster and want to seed multiple clients with one CSV.
  3. Move between these surfaces depending on whether the motion is curated outreach or book-of-business migration.
  • Invites are best for tracked outreach.
  • CSV upload is best for roster onboarding.
Client Invites is the broker-side outreach surface for one-at-a-time invitation workflows and activation tracking.
Upload handles CSV-driven book-of-business onboarding when the broker already has a client roster.

Track commissions, payouts, and API credentials from the same broker workspace

The broker portal is both an operational workspace and a commercial workspace. Earnings, payout posture, and managed API credentials stay inside the same signed-in area.

/broker/dashboard/earnings/broker/dashboard/payouts/broker/dashboard/api-keys
  1. Open Earnings for commission history, current tier, and referral conversion posture.
  2. Open Payouts to review what is ready to pay, what has already been disbursed, and what remains tied to claim state.
  3. Open API Keys when the brokerage needs managed credentials for a diligence or partner integration.
  • The broker portal is a commercial workspace, not just a client list.
  • API keys are broker-facing credentials, not a reason to invent a separate human role.
Earnings keeps commission performance and referral conversion visible without forcing the brokerage into a separate finance portal.
Payouts is the broker-side view into settlement readiness and historical disbursement activity.
API Keys is where the brokerage can create, rotate, and revoke managed credentials for partner integrations.