API documentation | API docs for agents | OpenAPI 3.1

preview

ark.preview_carrier_invite

Looks up FMCSA carrier details and existing ARK carrier or pending invite conflicts before sending an onboarding invite.

Availability: Expanded preview
Scopes: carriers:read
ARK permissions: canInviteCarrier
Team visibility: Not entity-scoped
Idempotency-Key: Not required
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

None.

Request body

dotNumberstringrequired

min length: 1; max length: 20

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/carrier-invites/preview' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "dotNumber": "<dotNumber>"
}'

Success response

Carrier invite preview

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.fmcsaobjectrequired

data.existingCarrierobject | nullrequired

data.pendingInviteobject | nullrequired

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 404: Resource not found