API reference
API surface
Capability-oriented inventory of platform, Referential, Rules, SIV, and MCP operations.
Discovery
| Surface | Path |
|---|---|
| OpenAPI JSON | /v3/api-docs |
| Swagger UI | /swagger-ui.html |
| MCP Streamable HTTP | /mcp with the mcp profile |
| Actuator | Management port and configured /actuator paths |
Referential families
All paths begin /referential/v1.
| Family | Base path | Main operations |
|---|---|---|
| Carriers | /carriers | register, search, read, correct, activate, suspend, reactivate |
| Beneficiaries | /carriers/{id}/beneficiaries | record and read effective-dated payout details |
| Vehicles | /vehicles | register, search, read, correct, transfer, category, lifecycle, seats |
| Identifiers | /vehicle-identifiers | resolve, read, revoke |
| Permits | /vehicle-permits | read, revoke, expiry worklist/watch, CSV import |
| Categories | /vehicle-categories | declare, search, read, retire, reactivate |
| Topology | /station-areas, /bays, /checkpoints | catalogs, corrections, lifecycle, capabilities |
| Geography | /destinations, /stations | catalogs and lifecycle |
| Coordinations | /coordinations | catalog and effective-dated membership |
| Lines | /lines | catalog, operators, lifecycle, itineraries |
| Schedules | /schedules | revisions, exceptions, stop times, activation, station calls |
| Authorizations | /authorizations | grants, holders, vehicles, lines, eligibility |
| Import staging | /import-staging | batches, statements, conflicts, resolution |
| Eligibility | /checkpoints/{id}/eligibility | master-data vehicle eligibility |
Rules families
GET /rules/v1/rule-domains
GET /rules/v1/rule-domains/{code}/schema
POST /rules/v1/rules
GET /rules/v1/rules
POST /rules/v1/rules/{ruleId}/versions
GET /rules/v1/rules/{ruleId}/versions
GET /rules/v1/rule-versions/{versionId}
PUT /rules/v1/rule-versions/{versionId}
POST /rules/v1/rule-versions/{versionId}/activate
POST /rules/v1/rule-versions/{versionId}/deactivate
GET /rules/v1/rule-versions/{versionId}/transitions
POST /rules/v1/rules/{ruleId}/resolution
POST /rules/v1/rules/{ruleId}/contextual-resolutionSIV families
POST /siv/v1/display-points
GET /siv/v1/display-points
GET /siv/v1/display-points/{id}
PATCH /siv/v1/display-points/{id}
POST /siv/v1/display-points/{id}/retirement
PUT /siv/v1/display-points/{id}/profile
POST /siv/v1/display-profiles
GET /siv/v1/display-profiles
GET /siv/v1/display-profiles/{id}
PATCH /siv/v1/display-profiles/{id}
POST /siv/v1/display-profiles/{id}/retirementPermission model
Permissions follow <module>.<resource>:<action>. Sensitive beneficiary reads
and writes have their own permissions rather than inheriting general carrier
access.
HTTP and MCP operations demand equivalent permissions and invoke the same domain boundary.