CrewPass Partner API

The CrewPass Partner API gives a management company a secure, read-only window onto the crew across its fleet: the vessels on your account, the people on those vessels, their documents and compliance, and a real-time feed of changes. It is a front door onto data that already lives in CrewPass — not a second database — so what you read here always matches what your CrewPass dashboard shows.

​

What you can do

New here? Start with the Quickstart — credentials to your first crew read in about 15 minutes.

​

How access works

Every call has to pass three checks before it returns data:

1. You are who you say you are. Each read authenticates with your API key as a Bearer token over TLS; reads are not signed (see Authentication).
2. You’re allowed to see this kind of data. Your CrewPass plan decides which capabilities you have — listing crew, reading documents, reading compliance, and so on.
3. The crew member has agreed, and they’re on your fleet. A crew member consents to share their data with you when they accept a place on one of your vessels. Someone outside your fleet comes back as 404 (never 403) — so you can’t probe for people who exist elsewhere in CrewPass. Sensitive identity fields (date of birth, passport, address) need an extra, explicit consent.

Your fleet is simply the vessels on your CrewPass employer account — the same list as your dashboard. There’s nothing to set up or attach.

​

Base URLs

Everything lives under /api/v2/.

​

Not in this version

This release is read-only plus webhooks. Onboarding crew, writing vessel placements, and ordering background checks through the API are coming in a later version. Background-check status is readable today; the verification provider behind it is never named.

​

For AI coding agents

These docs are built to be fed to coding agents (Claude, Cursor, GPT): /llms.txt is a manifest of every page, /llms-full.txt is the whole site as one file, every page also resolves as .md, and the OpenAPI contract is served raw at openapi.json.