API documentation | API docs for agents | OpenAPI 3.1

rmis-registration-steps

ark.get_rmis_registration_steps

POST variant for fetching RMIS registration-step activity when a JSON body is easier than query parameters.

Availability: Expanded preview
Scopes: carriers:read
ARK permissions: canInviteCarrierExternal
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

rmisCarrierIdstring

min length: 1; max length: 64

dotNumberstring

min length: 1; max length: 32

mcNumberstring

min length: 1; max length: 32

intraStateNumberstring

min length: 1; max length: 64

allActivityForTodayboolean

default: false

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/carriers/rmis-registration-steps' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

RMIS registration steps

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.providerstringrequired

data.filterobjectrequired

data.stepsarray<object>required

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 422: Invalid request
HTTP 502: External provider or worker queue could not be reached