mycarrierpackets-api_skill

Overview

This skill provides practical guidance to integrate with the MyCarrierPackets (MCP) API for carrier onboarding, monitoring, document retrieval, and risk assessment. It covers OAuth2 authentication, invitation flows (Intellivite), carrier data retrieval, Assure Advantage monitoring, and polling for completed packets. Use it when building TMS carrier management features or automating carrier compliance workflows.

How this skill works

The skill explains how to authenticate with MCP using the OAuth2 password grant, cache tokens, and make authenticated requests. It describes three invitation methods (API-based, link-based, direct MCP URL), endpoints for retrieving full carrier profiles, contacts, COIs/W9s, and risk assessments, plus polling patterns for completed packets and carrier changes. It also details monitoring operations: add/remove monitored carriers, list monitored carriers, bulk sync, and Assure Advantage risk endpoints.

When to use it

• Integrating carrier onboarding into a TMS or dispatch platform
• Automating Intellivite carrier invitations and tracking responses
• Retrieving COIs, W9s, eAgreements, or full carrier profiles programmatically
• Implementing Assure Advantage continuous carrier monitoring and alerts
• Polling for completed packets or carrier status changes for downstream workflows

Best practices

• Use the OAuth2 password flow with token caching and expiry buffer to avoid frequent logins
• Prefer API-based invitations for tracking; use link-based invitations for TMS-generated emails
• Poll CompletedPackets and CarriersChanges on a 5–15 minute cadence; respect minimum intervals (4 minutes for changes)
• Store MCP credentials in environment variables or a secrets manager, never in source control
• Page large requests (MonitoredCarriers, MonitoredCarrierData) and respect max page sizes to avoid timeouts

Example use cases

• Onboard a carrier automatically: preview carrier, send Intellivite invitation, then poll for completion and fetch COI/W9
• Add a carrier to Assure Advantage monitoring and receive change events to trigger carrier re-validation
• Run a nightly bulk sync of monitored carriers to update local TMS profiles and risk scores
• Implement fraud checks by calling FindAssociatedCarriers on shared phone/email before onboarding
• Expose carrier contacts in your TMS by calling GetCarrierContacts during quote or dispatch flows