> ## Documentation Index > Fetch the complete documentation index at: https://docs.digitalseaservice.com/llms.txt > Use this file to discover all available pages before exploring further. # Provision a crew member into a sponsored seat > Auto-provision the account+vessel and grant Premium in one call (JIT). ## OpenAPI ````yaml /api-reference/openapi.json post /v1/partners/sponsorships openapi: 3.1.0 info: title: DSS Public API description: >- Public OAuth 2.0 API for Digital Sea Service. See https://docs.digitalseaservice.com for the developer guide. version: 1.0.0 contact: name: DSS Developer Support email: admin@digitalseaservice.com url: https://docs.digitalseaservice.com license: name: Proprietary termsOfService: https://digitalseaservice.com/terms servers: - url: https://api.digitalseaservice.com description: Production - url: https://api.dev.digitalseaservice.com description: Sandbox (dev) security: [] paths: /v1/partners/sponsorships: post: tags: - partners summary: Provision a crew member into a sponsored seat description: Auto-provision the account+vessel and grant Premium in one call (JIT). operationId: create_sponsorship_v1_partners_sponsorships_post parameters: - name: Idempotency-Key in: header required: false schema: anyOf: - type: string - type: 'null' title: Idempotency-Key - name: authorization in: header required: false schema: anyOf: - type: string - type: 'null' title: Authorization requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSponsorshipRequest' responses: '200': description: Idempotent replay — an open seat already existed for this email. content: application/json: schema: $ref: '#/components/schemas/CreateSponsorshipResponse' '201': description: A new sponsored member was provisioned and granted Premium. '401': description: >- `invalid_token` — bearer token missing, malformed, expired, or revoked. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '403': description: '`insufficient_scope` — the token lacks the required scope.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '422': description: >- `invalid_request` — request validation failed; see the `errors` array. content: application/problem+json: schema: $ref: '#/components/schemas/ValidationProblemDetails' '429': description: '`rate_limit_exceeded` — per-client request budget exhausted.' content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' '500': description: >- `internal_error` — an unexpected error occurred; reference `instance`. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' security: - oauth2: - profile:read - bearerAuth: [] components: schemas: CreateSponsorshipRequest: properties: email: type: string minLength: 3 title: Email description: Crew member's email (normalised). first_name: type: string maxLength: 100 minLength: 1 title: First Name description: Crew member's first name. last_name: type: string maxLength: 100 minLength: 1 title: Last Name description: Crew member's last name. position: type: string minLength: 1 title: Position description: Crew rank/role for the account. vessel_imo: type: string pattern: ^\d{7}$ title: Vessel Imo description: 7-digit IMO of the vessel to track. phone: anyOf: - type: string - type: 'null' title: Phone description: Crew member's phone (E.164). vessel_name: anyOf: - type: string - type: 'null' title: Vessel Name description: Vessel display name (optional). join_date: anyOf: - type: string format: date-time - type: 'null' title: Join Date description: Crew join date on the vessel. external_ref: anyOf: - type: string - type: 'null' title: External Ref description: Partner's own opaque reference. type: object required: - email - first_name - last_name - position - vessel_imo title: CreateSponsorshipRequest description: >- Auto-provision one crew member into a sponsored Premium seat (JIT). All of ``email``, ``first_name``, ``last_name``, ``position`` and a 7-digit ``vessel_imo`` are required — the dashboard needs them to create the account, vessel and tracking in one step. There is no invite/claim round-trip. example: email: jane@example.com external_ref: ywc-beta-0042 first_name: Jane join_date: '2026-07-01T00:00:00Z' last_name: Doe phone: '+447700900123' position: Chief Stewardess vessel_imo: '9074729' vessel_name: MY Example CreateSponsorshipResponse: properties: sponsorship_id: type: string title: Sponsorship Id status: type: string title: Status user_id: anyOf: - type: string - type: 'null' title: User Id description: >- The member's DSS user id — the same id delivered in the ``data.user_id`` of ``user.sea_time.updated`` webhooks. Persist it to correlate future webhooks to your own member record. Null until the seat is active (e.g. an invited-but-unclaimed seat). vessel_resolved: type: boolean title: Vessel Resolved description: False when the IMO did not match a vessel (soft failure). default: false claim_url: anyOf: - type: string - type: 'null' title: Claim Url description: Always null for JIT — there is no claim link. expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At description: Per-user sponsored term end (activated_at + term_months). type: object required: - sponsorship_id - status title: CreateSponsorshipResponse description: The provisioned seat — returned 201 on create, 200 on idempotent replay. example: expires_at: '2027-07-24T09:00:00Z' sponsorship_id: 665f00000000000000000042 status: active user_id: aQ0mtT8kRgVv7C3o1p2q3r4s5t6u vessel_resolved: true ProblemDetails: type: object description: >- RFC 7807 Problem Details. Returned with the `application/problem+json` content type on every resource (`/v1/*`) error. properties: type: type: string format: uri description: Stable URL identifying the error type; resolves to its docs page. title: type: string description: Short, human-readable summary of the error type. status: type: integer description: HTTP status code. detail: type: string description: Explanation specific to this occurrence. instance: type: string description: Request correlation id; matches the `X-Request-Id` header. required: - type - title - status - detail - instance ValidationProblemDetails: description: Problem Details for a 422, carrying a per-field `errors` array. allOf: - $ref: '#/components/schemas/ProblemDetails' - type: object properties: errors: type: array description: One entry per field that failed validation. items: type: object additionalProperties: true securitySchemes: oauth2: type: oauth2 description: >- OAuth 2.0 Authorization Code flow with PKCE. See the integration guide at docs.digitalseaservice.com for the full step-by-step. flows: authorizationCode: authorizationUrl: https://api.digitalseaservice.com/oauth/authorize tokenUrl: https://api.digitalseaservice.com/oauth/token refreshUrl: https://api.digitalseaservice.com/oauth/token scopes: profile:read: Read the crew member's name, role, country, and photo URL. seatime:read: Read aggregate sea-time totals and the 12-month trend. vessels:read: Read the crew member's vessel history. bearerAuth: type: http scheme: bearer bearerFormat: Opaque ````