FLEETS.GR

e-Charter Agreement API Documentation

Use the API to integrate charter party management directly into your systems. All endpoints accept and return application/json.

Base URL

https://api.server/api

Quick Reference

MethodEndpointAuthDescription
POST/registerPublicRegister new company
POST/loginPublicLogin
POST/validate-vatPublicValidate Greek VAT number
POST/credentialsProtectedStore GSIS credentials
PUT/credentialsProtectedUpdate GSIS credentials
DELETE/credentialsProtectedRemove credentials & data
POST/syncProtectedTrigger manual sync
GET/vesselsProtectedList synced vessels
GET/portsProtectedList synced ports
GET/charterersProtectedList synced charterers
GET/authoritiesProtectedList port authorities (184)
GET/doyProtectedList Greek tax offices (125)
GET/usage-typesProtectedList vessel usage types
GET/execution-subtypesProtectedList charter execution subtypes
GET/fuel-burdensProtectedList fuel burden options
GET/additional-expensesProtectedList additional expenses options
GET/empty-run-movementsProtectedList empty run movement types
GET/form-optionsProtectedList all form options (flat, legacy)
GET/statusProtectedConnection status & credits
POST/bulk-charter-party/create1 CreditCreate bulk process (step 1)
POST/bulk-charter-party/uploadProtectedUpload charter parties JSON (step 2)
POST/bulk-charter-party/finishProtectedFinalize process (step 3)
GET/bulk-charter-party/exportProtectedGet charter parties export
GET/bulk-charter-party/pdfProtectedDownload charter party PDF
POST/bulk-charter-party/cancelProtectedCancel a charter party
POST/bulk-charter-party/cancel-allProtectedCancel process + all children
GET/requestsProtectedList request log (last 100)
GET/requests/{id}ProtectedGet request details
DELETE/accountProtectedDelete account & all data
POST/accept-disclaimerProtectedAccept terms & disclaimer
Authentication
Protected endpoints require an X-API-Key header. Your API key is available in the developer portal.

Public Endpoints

POST https://api.server/api/register Public

Register a new company (Greek only)

Only Greek companies can register. The vat_number is validated against the GSIS tax registry in real-time. Company legal info is fetched automatically.

cURL

curl -X POST https://api.server/api/register \
  -H "Content-Type: application/json" \
  -d '{"vat_number":"094281265","company_name":"My Maritime Co.","email":"admin@acme.gr","password":"securePassword123"}'

Request Fields

FieldTypeRequiredDescription
vat_numberstringYesGreek VAT number (ΑΦΜ) — 9 digits, validated against GSIS
company_namestringYesCompany display name
emailstringYesLogin email (must be unique)
passwordstringYesAccount password (min 6 characters)

Request

{
  "vat_number": "094281265",
  "company_name": "Acme Maritime S.A.",
  "email": "admin@acme.gr",
  "password": "securePassword123"
}

Response — 201 Created

{
  "success": true,
  "company_id": "550e8400-e29b-41d4-a716-446655440000",
  "api_key": "a1b2c3d4e5f6...64char_sha256_hex",
  "credits": 25
}

Response Fields

FieldTypeDescription
successbooleanOperation result
company_idstring (UUID)Unique company identifier
api_keystringSHA-256 API key for authenticating protected endpoints
creditsintStarting credits (25)

Error Responses

StatusWhen
400Missing required fields or invalid/deactivated VAT number
409Email already registered
429Rate limit: max 10 registrations per IP per hour
500Registration failed
POST https://api.server/api/login Public

Login to get your API key

cURL

curl -X POST https://api.server/api/login \
  -H "Content-Type: application/json" \
  -d '{"email":"admin@acme.gr","password":"securePassword123"}'

Request Fields

FieldTypeRequiredDescription
emailstringYesRegistered email
passwordstringYesAccount password

Response — 200 OK

{
  "success": true,
  "company_id": "550e8400-e29b-41d4-a716-446655440000",
  "company_name": "Acme Maritime S.A.",
  "api_key": "a1b2c3d4e5f6...64char_sha256_hex",
  "credits": 25
}

Response Fields

FieldTypeDescription
successbooleanOperation result
company_idstring (UUID)Unique company identifier
company_namestringCompany display name
api_keystringSHA-256 API key
creditsintCurrent credit balance

Error Responses

StatusWhen
400Missing email or password
401Invalid credentials
POST https://api.server/api/validate-vat Public

Validate a Greek VAT number

cURL

curl -X POST https://api.server/api/validate-vat \
  -H "Content-Type: application/json" \
  -d '{"vat_number":"094281265"}'

Request Fields

FieldTypeRequiredDescription
vat_numberstringYesGreek VAT number (ΑΦΜ) — 9 digits

Response — 200 OK — Valid

{
  "success": true,
  "vat_number": "094281265",
  "business_name": "ACME MARITIME S.A.",
  "commercial_title": "ACME",
  "legal_status": "ΑΕ",
  "doy": "3012",
  "doy_description": "ΦΑΕ ΑΘΗΝΩΝ",
  "address": "ΠΑΝΕΠΙΣΤΗΜΙΟΥ",
  "address_no": "15",
  "zip_code": "10679",
  "area": "ΑΘΗΝΑ",
  "deactivation": "N"
}

Error Responses

StatusWhen
400Missing vat_number

Protected Endpoints

POST https://api.server/api/credentials

Store Ministry (GSIS/TaxisNet) credentials

cURL

curl -X POST https://api.server/api/credentials \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"username":"123456789","password":"taxisnet_password"}'
Triggers an automatic first sync upon success. Uses GSIS/TaxisNet username and password for OIDC authentication with eCharterParty.

Request Fields

FieldTypeRequiredDescription
usernamestringYesGSIS/TaxisNet username (usually VAT number)
passwordstringYesGSIS/TaxisNet password

Response — 200 OK

{
  "success": true,
  "message": "Credentials stored",
  "sync": {
    "success": true,
    "authenticated": true,
    "ports_synced": 302,
    "vessels_synced": 0,
    "form_options_synced": 326
  }
}

Response Fields

FieldTypeDescription
successbooleanOperation result
messagestringStatus message
sync.successbooleanWhether the automatic sync succeeded
sync.authenticatedbooleanWhether GSIS authentication succeeded
sync.ports_syncedintNumber of ports synced
sync.vessels_syncedintNumber of vessels synced
sync.form_options_syncedintNumber of form options synced

Error Responses

StatusWhen
400Missing username or password
500Failed to store credentials
PUT https://api.server/api/credentials

Update Ministry credentials

cURL

curl -X PUT https://api.server/api/credentials \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"username":"123456789","password":"new_taxisnet_password"}'

Request Fields

FieldTypeRequiredDescription
usernamestringYesNew GSIS/TaxisNet username
passwordstringYesNew GSIS/TaxisNet password

Response — 200 OK

{
  "success": true,
  "message": "Credentials updated",
  "sync": {
    "success": true,
    "authenticated": true,
    "ports_synced": 302,
    "vessels_synced": 0,
    "form_options_synced": 326
  }
}

Error Responses

StatusWhen
400Missing username or password
404No credentials found (use POST first)
500Failed to update credentials
DELETE https://api.server/api/credentials

Remove Ministry credentials & synced data

cURL

curl -X DELETE https://api.server/api/credentials \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "success": true,
  "message": "Credentials and synced data removed"
}
POST https://api.server/api/sync

Trigger manual data sync

cURL

curl -X POST https://api.server/api/sync \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
Re-authenticates with GSIS OIDC and re-syncs ports, vessels, authorities, DOY, and form options from the eCharterParty platform.

Response — 200 OK

{
  "success": true,
  "ports_synced": 302,
  "vessels_synced": 0,
  "form_options_synced": 326
}

Response Fields

FieldTypeDescription
successbooleanWhether the sync succeeded
ports_syncedintNumber of ports synced
vessels_syncedintNumber of vessels synced
form_options_syncedintNumber of form options synced (authorities, DOY, fixed selects)

Error Responses

StatusWhen
400No GSIS credentials stored
401GSIS authentication failed
429Rate limit exceeded
GET https://api.server/api/vessels

List synced vessels

cURL

curl -X GET https://api.server/api/vessels \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    {
      "uuid": "660e8400-e29b-41d4-a716-446655440001",
      "ministry_id": "123",
      "description": "MV Aegean Star"
    }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Stable UUID — use in charter party submissions
data[].ministry_idstringInternal eCharterParty ID
data[].descriptionstringDisplay text from eCharterParty
GET https://api.server/api/ports

List synced ports

cURL

curl -X GET https://api.server/api/ports \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    {
      "uuid": "880e8400-e29b-41d4-a716-446655440001",
      "ministry_id": "1",
      "description": "Πειραιάς (Piraeus)"
    }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Stable UUID — use as start_port_uuid / end_port_uuid
data[].ministry_idstringInternal eCharterParty ID
data[].descriptionstringPort name
GET https://api.server/api/charterers

List synced charterers

cURL

curl -X GET https://api.server/api/charterers \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    {
      "uuid": "990e8400-e29b-41d4-a716-446655440001",
      "ministry_id": "45",
      "description": "Charterer S.A."
    }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Stable UUID
data[].ministry_idstringInternal eCharterParty ID
data[].descriptionstringCharterer name
GET https://api.server/api/authorities

List port authorities (184 items)

cURL

curl -X GET https://api.server/api/authorities \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
Port authorities and coast guard offices. Loaded via Select2 autocomplete from the eCharterParty form. Use authority_uuid when submitting a charter party.

Response — 200 OK

{
  "data": [
    {
      "uuid": "a10e8400-e29b-41d4-a716-446655440001",
      "ministry_id": "60",
      "description": "Κ.Λ. ΑΛΕΞΑΝΔΡΟΥΠΟΛΗΣ"
    }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Stable UUID — use as authority_uuid in charter party submission
data[].ministry_idstringInternal eCharterParty authority ID
data[].descriptionstringAuthority display name
GET https://api.server/api/doy

List Greek tax offices / Δ.Ο.Υ. (125 items)

cURL

curl -X GET https://api.server/api/doy \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
Greek tax offices (ΔΟΥ). Loaded via Select2 autocomplete from the eCharterParty form. Use doy_uuid when submitting a charter party.

Response — 200 OK

{
  "data": [
    {
      "uuid": "b20e8400-e29b-41d4-a716-446655440002",
      "ministry_id": "1",
      "description": "Δ.Ο.Υ. Α' ΑΘΗΝΩΝ"
    }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Stable UUID — use as doy_uuid in charter party submission
data[].ministry_idstringInternal eCharterParty DOY ID
data[].descriptionstringDOY display name
GET https://api.server/api/usage-types

List vessel usage types

cURL

curl -X GET https://api.server/api/usage-types \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    { "uuid": "c30e8400-...", "ministry_id": "exploitation", "description": "Εκμετάλλευση..." },
    { "uuid": "c30e8401-...", "ministry_id": "self_use", "description": "Ιδιοχρησιμοποίηση..." }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Use as usage_type_uuid in charter party submission
data[].ministry_idstringOption value (exploitation, self_use, empty_run)
data[].descriptionstringHuman-readable label
GET https://api.server/api/execution-subtypes

List charter execution subtypes

cURL

curl -X GET https://api.server/api/execution-subtypes \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    { "uuid": "d40e8400-...", "ministry_id": "ba", "description": "..." },
    { "uuid": "d40e8401-...", "ministry_id": "bb", "description": "..." }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Use as execution_subtype_uuid in charter party submission
data[].ministry_idstringOption value (ba, bb)
data[].descriptionstringHuman-readable label
GET https://api.server/api/fuel-burdens

List fuel burden options

cURL

curl -X GET https://api.server/api/fuel-burdens \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    { "uuid": "e50e8400-...", "ministry_id": "charterer", "description": "Ναυλώτης" },
    { "uuid": "e50e8401-...", "ministry_id": "owner", "description": "Εκναυλωτής" }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Use as fuel_burden_uuid in charter party submission
data[].ministry_idstringOption value (charterer, owner)
data[].descriptionstringHuman-readable label
GET https://api.server/api/additional-expenses

List additional expenses options

cURL

curl -X GET https://api.server/api/additional-expenses \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    { "uuid": "f60e8400-...", "ministry_id": "unknown", "description": "..." },
    { "uuid": "f60e8401-...", "ministry_id": "true", "description": "..." },
    { "uuid": "f60e8402-...", "ministry_id": "false", "description": "..." }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Use as additional_expenses_on_owner_uuid in charter party submission
data[].ministry_idstringOption value (unknown, true, false)
data[].descriptionstringHuman-readable label
GET https://api.server/api/empty-run-movements

List empty run movement types

cURL

curl -X GET https://api.server/api/empty-run-movements \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    { "uuid": "170e8400-...", "ministry_id": "CHANGE_BERTH", "description": "..." },
    { "uuid": "170e8401-...", "ministry_id": "MOORING_TRIAL", "description": "..." }
  ]
}

Response Fields

FieldTypeDescription
data[].uuidstring (UUID)Use as empty_run_movement_uuid in charter party submission
data[].ministry_idstringOption value (CHANGE_BERTH, MOORING_TRIAL, etc.)
data[].descriptionstringHuman-readable label
GET https://api.server/api/status

Connection status & credits

cURL

curl -X GET https://api.server/api/status \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "connected": true,
  "status": "Connected",
  "credits": 25,
  "last_sync_at": "2026-06-16 14:30:00",
  "disclaimer_accepted": true,
  "disclaimer_accepted_at": "2026-06-16 12:00:00",
  "company": {
    "company_name": "Acme Maritime S.A.",
    "vat_number": "094281265",
    "business_name": "ACME MARITIME S.A.",
    "commercial_title": "ACME",
    "legal_status": "ΑΕ",
    "full_address": "ΠΑΝΕΠΙΣΤΗΜΙΟΥ 15, 10679 ΑΘΗΝΑ"
  }
}

Response Fields

FieldTypeDescription
connectedbooleanWhether GSIS authentication is active
statusstringConnected / No Connection / No credentials / Pending
creditsintRemaining credits for charter party submissions
last_sync_atstringTimestamp of last successful sync
disclaimer_acceptedbooleanWhether the terms have been accepted
companyobjectCompany legal details from GSIS

Bulk Charter Parties

The bulk flow allows creating multiple charter parties from a single JSON file upload. See the JSON schema documentation for the file format.
POST https://api.server/api/bulk-charter-party/create 1 Credit

Create a bulk-charter-party process (step 1)

cURL

curl -X POST https://api.server/api/bulk-charter-party/create \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"email":"admin@company.gr"}'
Creates a new bulk process on eCharterParty. The representative identity fields are pre-filled by the platform based on the company profile. Returns a process_slug needed for the next steps. Each successful creation consumes 1 credit.

Request Fields

FieldTypeRequiredDescription
emailstringYesSubmitter email
authority_uuidstring (UUID)NoUUID of authority (from /authorities). If omitted, the first available is used.

Response — 200 OK

{
  "success": true,
  "process_slug": "mG8WjlP6",
  "process_url": "https://echarterparty.yna.gov.gr/procs/detail/mG8WjlP6/"
}

Error Responses

StatusWhen
400No credentials stored or invalid authority_uuid
POST https://api.server/api/bulk-charter-party/upload

Upload charter parties JSON file (step 2)

cURL (multipart upload)

curl -X POST https://api.server/api/bulk-charter-party/upload \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "process_slug=mG8WjlP6" \
  -F "file=@charter_parties.json"
Uploads a JSON array of charter parties to the process created in step 1. The file must conform to the charter parties schema. Send as multipart/form-data.

Request Fields

FieldTypeRequiredDescription
process_slugstringYesProcess slug from step 1
filefile (JSON)YesJSON array of charter party objects

Response — 200 OK

{
  "success": true,
  "process_slug": "mG8WjlP6"
}

Error Responses

StatusWhen
400Missing process_slug or no file uploaded
422Invalid JSON (must be an array)
POST https://api.server/api/bulk-charter-party/finish

Finalize process / Ολοκλήρωση (step 3)

cURL

curl -X POST https://api.server/api/bulk-charter-party/finish \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"process_slug":"mG8WjlP6"}'
Finalizes the bulk process, creating individual charter party sub-processes. Each gets its own app_code, detail page, and protocol number. After finishing, use the export endpoint to retrieve them.

Request Fields

FieldTypeRequiredDescription
process_slugstringYesProcess slug from step 1

Response — 200 OK

{
  "success": true,
  "process_slug": "mG8WjlP6"
}

Error Responses

StatusWhen
400Missing process_slug
GET https://api.server/api/bulk-charter-party/export

Get charter parties export

cURL

curl -H "X-API-Key: YOUR_API_KEY" \
  "https://api.server/api/bulk-charter-party/export?process_slug=mG8WjlP6"
Returns the charter parties created by a finished bulk process. Each entry includes the app_code (needed for PDF download and cancel), app_link, protocol number, and readiness flags. Only available after step 3 (finish).

Response — 200 OK

{
  "success": true,
  "process_slug": "mG8WjlP6",
  "charter_parties": [
    {
      "client_id": "14jAh4dO3lsCZR4UYnI2R7aPsgmA",
      "app_id": "163696",
      "app_link": "/procs/detail/3GnZwjnG/",
      "app_status_code": "SUBMIT",
      "app_protocol": "81230 / 2026",
      "app_code": "3GnZwjnG",
      "charterparty_id": "59621",
      "needs_departure_permit": true,
      "has_departure_permit": false,
      "needs_crew_info": true,
      "has_crew_info": true,
      "is_ready": false
    }
  ]
}

Response Fields

FieldTypeDescription
charter_parties[].app_codestringCharter party code (use for PDF download & cancel)
charter_parties[].app_linkstringRelative URL to charter party detail page
charter_parties[].app_status_codestringSUBMIT, CANCEL, etc.
charter_parties[].app_protocolstringProtocol number (e.g. "81230 / 2026")
charter_parties[].charterparty_idstringInternal charter party ID
charter_parties[].is_readybooleanWhether all requirements are met
GET https://api.server/api/bulk-charter-party/pdf

Download charter party PDF

cURL

curl -H "X-API-Key: YOUR_API_KEY" \
  -o charter_party.pdf \
  "https://api.server/api/bulk-charter-party/pdf?app_code=3GnZwjnG"
Downloads the PDF document for a specific charter party. The template type is detected automatically from the detail page (e.g. charter-party-all-template for exploitation, empty-run-template for empty runs). Returns binary PDF data with Content-Type: application/pdf.

Request Fields

FieldTypeRequiredDescription
app_codestring (query)YesCharter party code (from export endpoint)

Response — 200 OK

Content-Type: application/pdf
Content-Disposition: attachment; filename="3GnZwjnG.pdf"
Content-Length: 61093

Error Responses

StatusWhen
400Missing app_code
POST https://api.server/api/bulk-charter-party/cancel

Cancel a charter party

cURL

curl -X POST https://api.server/api/bulk-charter-party/cancel \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"app_code":"3GnZwjnG"}'
Cancels an individual charter party sub-process. This is a two-step operation (confirmation page + POST with CSRF) handled automatically by the API.

Request Fields

FieldTypeRequiredDescription
app_codestringYesCharter party code (from export endpoint)

Response — 200 OK

{
  "success": true,
  "app_code": "3GnZwjnG"
}

Error Responses

StatusWhen
400Missing app_code
POST https://api.server/api/bulk-charter-party/cancel-all

Cancel process and all charter parties

cURL

curl -X POST https://api.server/api/bulk-charter-party/cancel-all \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"process_slug":"mG8WjlP6"}'
Cancels the parent bulk process and all individual charter party sub-processes in one call. Fetches the export to find all children, cancels each by app_code, then cancels the parent process itself.

Request Fields

FieldTypeRequiredDescription
process_slugstringYesProcess slug from step 1

Response — 200 OK

{
  "success": true,
  "process_slug": "mG8WjlP6",
  "cancelled": ["3GnZwjnG", "EygYxJWG"],
  "cancelled_count": 2,
  "failed": [],
  "failed_count": 0
}

Response Fields

FieldTypeDescription
cancelledstring[]List of successfully cancelled app_codes
cancelled_countintNumber of charter parties cancelled
failedobject[]Failed cancellations with app_code and error
failed_countintNumber of failed cancellations

Error Responses

StatusWhen
400Missing process_slug

Request Log

GET https://api.server/api/requests

List request log (last 100)

cURL

curl -X GET https://api.server/api/requests \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": [
    {
      "id": "aa0e8400-e29b-41d4-a716-446655440099",
      "type": "charter_party",
      "status": "completed",
      "credits_remaining": 24,
      "created_at": "2026-06-16 14:35:00"
    }
  ]
}

Response Fields

FieldTypeDescription
data[].idstring (UUID)Request log entry ID
data[].typestringcharter_party
data[].statusstringpending / completed / failed
data[].credits_remainingintCredits remaining after this request
data[].created_atstringWhen the request was created
GET https://api.server/api/requests/{id}

Get request details

cURL

curl -X GET https://api.server/api/requests/aa0e8400-e29b-41d4-a716-446655440099 \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "data": {
    "id": "aa0e8400-e29b-41d4-a716-446655440099",
    "company_id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "charter_party",
    "payload": { "authority": "...", "freight": "50000" },
    "ministry_response": "...raw eCharterParty response...",
    "status": "completed",
    "process_id": "proc_12345",
    "errors": null,
    "credits_remaining": 24,
    "created_at": "2026-06-16 14:35:00"
  }
}

Response Fields

FieldTypeDescription
data.idstring (UUID)Request log entry ID
data.company_idstring (UUID)Company that made the request
data.typestringcharter_party
data.payloadobjectOriginal request body (parsed JSON)
data.ministry_responsestringRaw response from eCharterParty
data.statusstringpending / completed / failed
data.process_idstringProcess ID from the ministry
data.errorsarray / nullParsed error messages (if any)
data.credits_remainingintCredits remaining after this request
data.created_atstringWhen the request was created

Error Responses

StatusWhen
404Request not found or does not belong to this company

Account

DELETE https://api.server/api/account

Delete account and all data

Permanently deletes your company account, credentials, fleet data, and request history. This action is irreversible.

cURL

curl -X DELETE https://api.server/api/account \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{"password":"your_password"}'

Request Fields

FieldTypeRequiredDescription
passwordstringYesYour account password to confirm deletion

Response — 200 OK

{
  "success": true,
  "message": "Account and all associated data deleted"
}

Error Responses

StatusWhen
400Password is required
401Invalid password
POST https://api.server/api/accept-disclaimer

Accept terms & disclaimer

cURL

curl -X POST https://api.server/api/accept-disclaimer \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

Response — 200 OK

{
  "success": true,
  "disclaimer_accepted_at": "2026-06-16 12:00:00"
}