Declaration Acknowledgement Service - API Contract

GET /api/v1/declaration-acknowledgements/api/v1/declaration-acknowledgements

List acknowledgement records with optional filtering

Public

Response Example

{
  "data": [
    {
      "declaration_id": "decl_88A1",
      "driver_id": "drv_0042",
      "acknowledged": true,
      "acknowledged_at": "2026-03-22T14:35:00Z",
      "ip_address": "185.90.12.44",
      "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_0)"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 9
  }
}

GET /api/v1/declaration-acknowledgements/api/v1/declaration-acknowledgements/:declaration_id

Get the acknowledgement record for a specific declaration

Public

Response Example

{
  "declaration_id": "decl_88A1",
  "driver_id": "drv_0042",
  "acknowledged": true,
  "acknowledged_at": "2026-03-22T14:35:00Z",
  "ip_address": "185.90.12.44",
  "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_0)"
}

POST /api/v1/declaration-acknowledgements/api/v1/declaration-acknowledgements

Record a driver's acknowledgement of a declaration

Public

Request Example

{
  "declaration_id": "decl_88A1",
  "driver_id": "drv_0042",
  "timestamp": "2026-03-22T14:35:00Z",
  "ip_address": "185.90.12.44",
  "user_agent": "Mozilla/5.0 (iPhone; CPU iPhone OS 17_0)"
}

Response Example

{
  "declaration_id": "decl_88A1",
  "driver_id": "drv_0042",
  "acknowledged": true,
  "acknowledged_at": "2026-03-22T14:35:00Z",
  "created_at": "2026-03-22T14:35:01Z"
}

PUT /api/v1/declaration-acknowledgements/api/v1/declaration-acknowledgements/:declaration_id

Update acknowledgement metadata (admin correction only)

Public

Request Example

{
  "timestamp": "2026-03-22T14:36:00Z",
  "ip_address": "185.90.12.44"
}

Response Example

{
  "declaration_id": "decl_88A1",
  "driver_id": "drv_0042",
  "acknowledged_at": "2026-03-22T14:36:00Z",
  "updated_at": "2026-03-26T09:00:00Z"
}

DELETE /api/v1/declaration-acknowledgements/api/v1/declaration-acknowledgements/:declaration_id

Void an acknowledgement record (admin only)

Public

Response Example

{
  "declaration_id": "decl_88A1",
  "voided": true,
  "voided_at": "2026-03-26T09:30:00Z"
}

GET /api/v1/declaration-acknowledgements/api/v1/declaration-acknowledgements/:declaration_id/eligibility

Check whether a declaration is eligible to be acknowledged

Public

Response Example

{
  "declaration_id": "decl_88A1",
  "eligible": true,
  "reason": null,
  "expires_at": "2026-04-21T10:00:00Z"
}

GET /api/v1/declaration-acknowledgements/api/v1/declaration-acknowledgements/:declaration_id/is-acknowledged

Quick boolean check whether the declaration has been acknowledged

Public

Response Example

{
  "declaration_id": "decl_88A1",
  "is_acknowledged": true
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}