Skip to main content
POST
Crew compliance snapshot (scope: crew:compliance:read)

Authorizations

Authorization
string
header
required

Partner API key (cpk_live_* / cpk_test_*) as a Bearer token.

Headers

authorization
string | null
X-Partner-API-Key
string | null

Path Parameters

crew_unique_id
string
required

Query Parameters

vessel_id
string | null

Body

application/json

POST /employers/me/crew/{id}/compliance-checks request body.

Currently empty: the endpoint returns the crew member's current compliance projection as-is. Point-in-time (as_of) and required-cert filtering are intentionally not exposed yet — honouring them would mean re-deriving compliance here, which is forbidden (CLAUDE.md). They will return when the underlying snapshot supports them.

Response

Successful Response

Compliance for a crew member on a vessel, as a unified requirement matrix.

Each requirements[] row is one role requirement carrying its own status and the satisfied_by document(s). Verdicts come from the dashboard compliance engine (single source of truth); this service only reshapes them and never re-derives compliance. compliance_source says whether the live engine or the crewCompliance fallback produced the result. summary always reconciles with requirements.

crew_unique_id
string
required
as_of
string<date-time>
required
overall_status
string
required
compliance_source
string
required
vessel_id
string | null
position_name
string | null
summary
ComplianceSummary · object

Requirement counts. Always reconciles: the parts sum to total and total equals the number of rows in requirements.

requirements
RequirementRow · object[]