> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crewpass.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# CrewPass Partner API

> Read the crew across your fleet — vessels, profiles, documents, and compliance — and get notified when things change.

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

<CardGroup cols={2}>
  <Card title="List your vessels" href="/guides/vessels">
    Every vessel on your CrewPass account.
  </Card>

  <Card title="See your crew" href="/guides/crew">
    Everyone on your vessels, with verification and background-check status.
  </Card>

  <Card title="Read a crew profile" href="/guides/profiles">
    Contact details, experience, photo, and (with consent) identity fields.
  </Card>

  <Card title="Documents & downloads" href="/guides/documents">
    List certificates with issuer + verification status, and download the files.
  </Card>

  <Card title="Check compliance" href="/guides/compliance">
    Is a crew member fully certified for their role? STCW, medical, and more.
  </Card>

  <Card title="Get webhooks" href="/webhooks">
    Be notified when a document, compliance, status, or profile changes.
  </Card>
</CardGroup>

New here? Start with the [Quickstart](/quickstart) — credentials to your first
crew read in about 15 minutes.

<h2 id="access">
  How access works
</h2>

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](/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

| Environment   | Base URL                             |
| ------------- | ------------------------------------ |
| Production    | `https://partners.crewpass.co.uk`    |
| Dev / sandbox | `https://devpartners.crewpass.co.uk` |

Everything lives under `/api/v2/`.

## For AI coding agents

These docs are built to be fed to coding agents (Claude, Cursor, GPT):
[`/llms.txt`](/llms.txt) is a manifest of every page, [`/llms-full.txt`](/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`](/api-reference/openapi.json).