Skip to main content
POST
Check a crew member's compliance

Authorizations

Authorization
string
header
required

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

Headers

X-Partner-API-Key
string | null

Your API key, as an alternative to the Authorization: Bearer header.

Path Parameters

crew_unique_id
string
required

Query Parameters

vessel_id
string | null

Body

application/json

No fields yet: send an empty JSON object ({}).

Response

Successful Response

A crew member's compliance with the requirements of their role.

overall_status is compliant, at_risk, non_compliant or no_role. compliance_source is live_evaluator when the result was worked out for this request, or crewCompliance_fallback when CrewPass returned its most recent stored result instead. summary counts the rows in 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

How many requirements are in each status. The counts add up to total, which equals the number of rows in requirements.

requirements
RequirementRow · object[]