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
| Method | Endpoint | Auth | Description |
|---|---|---|---|
| POST | /register | Public | Register new company |
| POST | /login | Public | Login |
| POST | /validate-vat | Public | Validate Greek VAT number |
| POST | /credentials | Protected | Store GSIS credentials |
| PUT | /credentials | Protected | Update GSIS credentials |
| DELETE | /credentials | Protected | Remove credentials & data |
| POST | /sync | Protected | Trigger manual sync |
| GET | /vessels | Protected | List synced vessels |
| GET | /ports | Protected | List synced ports |
| GET | /charterers | Protected | List synced charterers |
| GET | /authorities | Protected | List port authorities (184) |
| GET | /doy | Protected | List Greek tax offices (125) |
| GET | /usage-types | Protected | List vessel usage types |
| GET | /execution-subtypes | Protected | List charter execution subtypes |
| GET | /fuel-burdens | Protected | List fuel burden options |
| GET | /additional-expenses | Protected | List additional expenses options |
| GET | /empty-run-movements | Protected | List empty run movement types |
| GET | /form-options | Protected | List all form options (flat, legacy) |
| GET | /status | Protected | Connection status & credits |
| POST | /bulk-charter-party/create | 1 Credit | Create bulk process (step 1) |
| POST | /bulk-charter-party/upload | Protected | Upload charter parties JSON (step 2) |
| POST | /bulk-charter-party/finish | Protected | Finalize process (step 3) |
| GET | /bulk-charter-party/export | Protected | Get charter parties export |
| GET | /bulk-charter-party/pdf | Protected | Download charter party PDF |
| POST | /bulk-charter-party/cancel | Protected | Cancel a charter party |
| POST | /bulk-charter-party/cancel-all | Protected | Cancel process + all children |
| GET | /requests | Protected | List request log (last 100) |
| GET | /requests/{id} | Protected | Get request details |
| DELETE | /account | Protected | Delete account & all data |
| POST | /accept-disclaimer | Protected | Accept terms & disclaimer |
X-API-Key header. Your API key is available in the developer portal.Public Endpoints
https://api.server/api/register
Public
Register a new company (Greek only)
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
| Field | Type | Required | Description |
|---|---|---|---|
| vat_number | string | Yes | Greek VAT number (ΑΦΜ) — 9 digits, validated against GSIS |
| company_name | string | Yes | Company display name |
| string | Yes | Login email (must be unique) | |
| password | string | Yes | Account 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
| Field | Type | Description |
|---|---|---|
| success | boolean | Operation result |
| company_id | string (UUID) | Unique company identifier |
| api_key | string | SHA-256 API key for authenticating protected endpoints |
| credits | int | Starting credits (25) |
Error Responses
| Status | When |
|---|---|
| 400 | Missing required fields or invalid/deactivated VAT number |
| 409 | Email already registered |
| 429 | Rate limit: max 10 registrations per IP per hour |
| 500 | Registration failed |
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
| Field | Type | Required | Description |
|---|---|---|---|
| string | Yes | Registered email | |
| password | string | Yes | Account 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
| Field | Type | Description |
|---|---|---|
| success | boolean | Operation result |
| company_id | string (UUID) | Unique company identifier |
| company_name | string | Company display name |
| api_key | string | SHA-256 API key |
| credits | int | Current credit balance |
Error Responses
| Status | When |
|---|---|
| 400 | Missing email or password |
| 401 | Invalid credentials |
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
| Field | Type | Required | Description |
|---|---|---|---|
| vat_number | string | Yes | Greek 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
| Status | When |
|---|---|
| 400 | Missing vat_number |
Protected Endpoints
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"}'
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| username | string | Yes | GSIS/TaxisNet username (usually VAT number) |
| password | string | Yes | GSIS/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
| Field | Type | Description |
|---|---|---|
| success | boolean | Operation result |
| message | string | Status message |
| sync.success | boolean | Whether the automatic sync succeeded |
| sync.authenticated | boolean | Whether GSIS authentication succeeded |
| sync.ports_synced | int | Number of ports synced |
| sync.vessels_synced | int | Number of vessels synced |
| sync.form_options_synced | int | Number of form options synced |
Error Responses
| Status | When |
|---|---|
| 400 | Missing username or password |
| 500 | Failed to store credentials |
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
| Field | Type | Required | Description |
|---|---|---|---|
| username | string | Yes | New GSIS/TaxisNet username |
| password | string | Yes | New 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
| Status | When |
|---|---|
| 400 | Missing username or password |
| 404 | No credentials found (use POST first) |
| 500 | Failed to update credentials |
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"
}
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"
Response — 200 OK
{
"success": true,
"ports_synced": 302,
"vessels_synced": 0,
"form_options_synced": 326
}
Response Fields
| Field | Type | Description |
|---|---|---|
| success | boolean | Whether the sync succeeded |
| ports_synced | int | Number of ports synced |
| vessels_synced | int | Number of vessels synced |
| form_options_synced | int | Number of form options synced (authorities, DOY, fixed selects) |
Error Responses
| Status | When |
|---|---|
| 400 | No GSIS credentials stored |
| 401 | GSIS authentication failed |
| 429 | Rate limit exceeded |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Stable UUID — use in charter party submissions |
| data[].ministry_id | string | Internal eCharterParty ID |
| data[].description | string | Display text from eCharterParty |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Stable UUID — use as start_port_uuid / end_port_uuid |
| data[].ministry_id | string | Internal eCharterParty ID |
| data[].description | string | Port name |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Stable UUID |
| data[].ministry_id | string | Internal eCharterParty ID |
| data[].description | string | Charterer name |
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"
authority_uuid when submitting a charter party.Response — 200 OK
{
"data": [
{
"uuid": "a10e8400-e29b-41d4-a716-446655440001",
"ministry_id": "60",
"description": "Κ.Λ. ΑΛΕΞΑΝΔΡΟΥΠΟΛΗΣ"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Stable UUID — use as authority_uuid in charter party submission |
| data[].ministry_id | string | Internal eCharterParty authority ID |
| data[].description | string | Authority display name |
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"
doy_uuid when submitting a charter party.Response — 200 OK
{
"data": [
{
"uuid": "b20e8400-e29b-41d4-a716-446655440002",
"ministry_id": "1",
"description": "Δ.Ο.Υ. Α' ΑΘΗΝΩΝ"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Stable UUID — use as doy_uuid in charter party submission |
| data[].ministry_id | string | Internal eCharterParty DOY ID |
| data[].description | string | DOY display name |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Use as usage_type_uuid in charter party submission |
| data[].ministry_id | string | Option value (exploitation, self_use, empty_run) |
| data[].description | string | Human-readable label |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Use as execution_subtype_uuid in charter party submission |
| data[].ministry_id | string | Option value (ba, bb) |
| data[].description | string | Human-readable label |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Use as fuel_burden_uuid in charter party submission |
| data[].ministry_id | string | Option value (charterer, owner) |
| data[].description | string | Human-readable label |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Use as additional_expenses_on_owner_uuid in charter party submission |
| data[].ministry_id | string | Option value (unknown, true, false) |
| data[].description | string | Human-readable label |
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
| Field | Type | Description |
|---|---|---|
| data[].uuid | string (UUID) | Use as empty_run_movement_uuid in charter party submission |
| data[].ministry_id | string | Option value (CHANGE_BERTH, MOORING_TRIAL, etc.) |
| data[].description | string | Human-readable label |
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
| Field | Type | Description |
|---|---|---|
| connected | boolean | Whether GSIS authentication is active |
| status | string | Connected / No Connection / No credentials / Pending |
| credits | int | Remaining credits for charter party submissions |
| last_sync_at | string | Timestamp of last successful sync |
| disclaimer_accepted | boolean | Whether the terms have been accepted |
| company | object | Company legal details from GSIS |
Bulk Charter Parties
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"}'
process_slug needed for the next steps. Each successful creation consumes 1 credit.Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| string | Yes | Submitter email | |
| authority_uuid | string (UUID) | No | UUID 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
| Status | When |
|---|---|
| 400 | No credentials stored or invalid authority_uuid |
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"
multipart/form-data.Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| process_slug | string | Yes | Process slug from step 1 |
| file | file (JSON) | Yes | JSON array of charter party objects |
Response — 200 OK
{
"success": true,
"process_slug": "mG8WjlP6"
}
Error Responses
| Status | When |
|---|---|
| 400 | Missing process_slug or no file uploaded |
| 422 | Invalid JSON (must be an array) |
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"}'
app_code, detail page, and protocol number. After finishing, use the export endpoint to retrieve them.Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| process_slug | string | Yes | Process slug from step 1 |
Response — 200 OK
{
"success": true,
"process_slug": "mG8WjlP6"
}
Error Responses
| Status | When |
|---|---|
| 400 | Missing process_slug |
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"
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
| Field | Type | Description |
|---|---|---|
| charter_parties[].app_code | string | Charter party code (use for PDF download & cancel) |
| charter_parties[].app_link | string | Relative URL to charter party detail page |
| charter_parties[].app_status_code | string | SUBMIT, CANCEL, etc. |
| charter_parties[].app_protocol | string | Protocol number (e.g. "81230 / 2026") |
| charter_parties[].charterparty_id | string | Internal charter party ID |
| charter_parties[].is_ready | boolean | Whether all requirements are met |
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"
charter-party-all-template for exploitation, empty-run-template for empty runs). Returns binary PDF data with Content-Type: application/pdf.Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| app_code | string (query) | Yes | Charter party code (from export endpoint) |
Response — 200 OK
Content-Type: application/pdf Content-Disposition: attachment; filename="3GnZwjnG.pdf" Content-Length: 61093
Error Responses
| Status | When |
|---|---|
| 400 | Missing app_code |
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"}'
Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| app_code | string | Yes | Charter party code (from export endpoint) |
Response — 200 OK
{
"success": true,
"app_code": "3GnZwjnG"
}
Error Responses
| Status | When |
|---|---|
| 400 | Missing app_code |
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"}'
app_code, then cancels the parent process itself.Request Fields
| Field | Type | Required | Description |
|---|---|---|---|
| process_slug | string | Yes | Process slug from step 1 |
Response — 200 OK
{
"success": true,
"process_slug": "mG8WjlP6",
"cancelled": ["3GnZwjnG", "EygYxJWG"],
"cancelled_count": 2,
"failed": [],
"failed_count": 0
}
Response Fields
| Field | Type | Description |
|---|---|---|
| cancelled | string[] | List of successfully cancelled app_codes |
| cancelled_count | int | Number of charter parties cancelled |
| failed | object[] | Failed cancellations with app_code and error |
| failed_count | int | Number of failed cancellations |
Error Responses
| Status | When |
|---|---|
| 400 | Missing process_slug |
Request Log
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
| Field | Type | Description |
|---|---|---|
| data[].id | string (UUID) | Request log entry ID |
| data[].type | string | charter_party |
| data[].status | string | pending / completed / failed |
| data[].credits_remaining | int | Credits remaining after this request |
| data[].created_at | string | When the request was created |
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
| Field | Type | Description |
|---|---|---|
| data.id | string (UUID) | Request log entry ID |
| data.company_id | string (UUID) | Company that made the request |
| data.type | string | charter_party |
| data.payload | object | Original request body (parsed JSON) |
| data.ministry_response | string | Raw response from eCharterParty |
| data.status | string | pending / completed / failed |
| data.process_id | string | Process ID from the ministry |
| data.errors | array / null | Parsed error messages (if any) |
| data.credits_remaining | int | Credits remaining after this request |
| data.created_at | string | When the request was created |
Error Responses
| Status | When |
|---|---|
| 404 | Request not found or does not belong to this company |
Account
https://api.server/api/account
Delete account and all data
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
| Field | Type | Required | Description |
|---|---|---|---|
| password | string | Yes | Your account password to confirm deletion |
Response — 200 OK
{
"success": true,
"message": "Account and all associated data deleted"
}
Error Responses
| Status | When |
|---|---|
| 400 | Password is required |
| 401 | Invalid password |
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"
}