{
    "document": {
        "title": "CheckPoint API Integration Export",
        "product": "EXSPEEDITE CheckPoint",
        "purpose": "Everything needed to build a server-to-server TMS connector into CheckPoint.",
        "generated_at": "2026-07-28T07:42:49+00:00",
        "docs_url": "https://exspeeditecheckpoint.com/developers.php",
        "markdown_export_url": "https://exspeeditecheckpoint.com/developers.php?export=markdown",
        "json_export_url": "https://exspeeditecheckpoint.com/developers.php?export=json",
        "version": "2026-07-09"
    },
    "base_url": "https://exspeeditecheckpoint.com",
    "authentication": {
        "initialize": {
            "type": "bearer_token",
            "header": "Authorization: Bearer {CHECKPOINT_TENANT_API_TOKEN}",
            "content_type": "application/json",
            "token_source": "Company Profile \u2192 API Tokens (per company workspace)",
            "server_side_only": true,
            "notes": "Never embed the bearer token in browser JavaScript or client-facing TMS pages. TMS backend adds the token before POST."
        },
        "shipper_visibility": {
            "type": "hmac_sha256",
            "headers": [
                "X-Shipper-UUID",
                "X-Timestamp",
                "X-Signature"
            ],
            "timestamp_window_seconds": 300,
            "signing_key": "SHA256(one_time_shipper_api_secret)",
            "canonical_string": "METHOD\\nPATH\\nCANONICAL_QUERY\\nX_TIMESTAMP\\nSHA256_HEX(BODY)"
        },
        "tms_live_map_launch": {
            "type": "hmac_sha256_query",
            "endpoint": "/v1/auth/tms-launch.php",
            "replay_window_seconds": 120,
            "signing_key": "SHA256(raw_launch_secret)",
            "secret_source": "Company Profile \u2192 API client \u2192 Generate TMS Launch Secret"
        },
        "driver_mobile": {
            "type": "load_tracking_token",
            "source": "tracking_url query parameter from initialize response"
        }
    },
    "endpoints": [
        {
            "id": "initialize",
            "method": "POST",
            "path": "/v1/tracking/initialize.php",
            "url": "https://exspeeditecheckpoint.com/v1/tracking/initialize.php",
            "auth": "bearer_token",
            "audience": "TMS server-to-server",
            "description": "Create or reinitialize one active load, ordered stops, driver workflow, and tracking links."
        },
        {
            "id": "shipper_active_shipments",
            "method": "GET",
            "path": "/api/v1/shipper/active-shipments.php",
            "url": "https://exspeeditecheckpoint.com/api/v1/shipper/active-shipments.php",
            "compat_path": "/v1/shipper/active-shipments.php",
            "auth": "shipper_hmac",
            "audience": "Enterprise shipper systems",
            "description": "Poll active shipments across carriers. No driver PII."
        },
        {
            "id": "carrier_assign_driver",
            "method": "POST",
            "path": "/v1/carrier/assign-driver.php",
            "url": "https://exspeeditecheckpoint.com/v1/carrier/assign-driver.php",
            "auth": "assignment_token",
            "audience": "Carrier private assignment page",
            "description": "Completes private_link driver assignment after initialize."
        },
        {
            "id": "load_info",
            "method": "POST",
            "path": "/v1/tracking/load-info.php",
            "url": "https://exspeeditecheckpoint.com/v1/tracking/load-info.php",
            "auth": "load_tracking_token",
            "audience": "Driver mobile app"
        },
        {
            "id": "milestone_ping",
            "method": "POST",
            "path": "/v1/tracking/ping.php",
            "url": "https://exspeeditecheckpoint.com/v1/tracking/ping.php",
            "auth": "load_tracking_token",
            "audience": "Driver web check-in"
        },
        {
            "id": "background_ping",
            "method": "POST",
            "path": "/v1/tracking/background-ping.php",
            "url": "https://exspeeditecheckpoint.com/v1/tracking/background-ping.php",
            "auth": "load_tracking_token",
            "audience": "Driver app continuous GPS add-on"
        },
        {
            "id": "pod_upload",
            "method": "POST",
            "path": "/v1/tracking/pod-upload.php",
            "url": "https://exspeeditecheckpoint.com/v1/tracking/pod-upload.php",
            "auth": "load_tracking_token",
            "audience": "Driver POD capture"
        },
        {
            "id": "tms_live_map_launch",
            "method": "GET",
            "path": "/v1/auth/tms-launch.php",
            "url": "https://exspeeditecheckpoint.com/v1/auth/tms-launch.php",
            "auth": "tms_launch_hmac",
            "audience": "EXSPEEDITE TMS dispatcher deep link to Live Map"
        }
    ],
    "quickstart": [
        "Generate bearer token for the correct CheckPoint company workspace.",
        "Store token server-side only.",
        "Build one JSON load payload with ordered stops.",
        "Choose direct_driver when TMS has driver phone; private_link when carrier enters phone privately.",
        "POST to /v1/tracking/initialize.php with Authorization bearer header.",
        "Store tracking_url or assignment_url from HTTP 200 response.",
        "On tractor change, POST initialize again with same load_number (reinitialized).",
        "Configure asset GPS in CheckPoint admin separately \u2014 never send ELD API keys in initialize."
    ],
    "initialize": {
        "required_fields": [
            {
                "field": "load_number",
                "type": "string",
                "notes": "Unique while active for tenant."
            },
            {
                "field": "carrier_name",
                "type": "string",
                "notes": "Carrier shown to dispatchers."
            },
            {
                "field": "stops",
                "type": "array",
                "notes": "Non-empty ordered stop objects. At least one milestone_type delivery required."
            }
        ],
        "conditional_fields": [
            {
                "field": "driver_name",
                "type": "string",
                "when": "direct_driver"
            },
            {
                "field": "driver_phone",
                "type": "string",
                "when": "direct_driver",
                "format": "E.164 e.g. +13125550119"
            },
            {
                "field": "carrier_contact_email",
                "type": "string",
                "when": "private_link",
                "recommended": true
            }
        ],
        "recommended_optional_fields": [
            "tms_vehicle_id",
            "power_unit",
            "tracking_mode",
            "reference_numbers",
            "shipper_reference",
            "global_shipper_uuid",
            "correlation_id",
            "commodity_description",
            "notification_emails",
            "email_notifications",
            "user1",
            "user2",
            "user3",
            "user4",
            "user5",
            "user6",
            "user7",
            "user8",
            "user9",
            "user10"
        ],
        "field_aliases": {
            "tms_vehicle_id": [
                "vehicle_id",
                "tractor_id",
                "truck_id"
            ],
            "power_unit": [
                "power_unit_number",
                "tractor_number",
                "truck_number"
            ]
        },
        "driver_assignment_modes": {
            "direct_driver": "TMS has driver phone; CheckPoint sends tracking SMS immediately.",
            "private_link": "Carrier enters driver phone on token-gated page; returns assignment_url."
        },
        "tracking_modes": {
            "ping": {
                "default": true,
                "description": "Web link milestone check-in only. No driver app required."
            },
            "continuous": {
                "default": false,
                "description": "Optional add-on; native driver app background GPS between milestones."
            }
        },
        "stop_required_fields": [
            {
                "field": "stop_sequence",
                "type": "integer",
                "notes": "1-based order."
            },
            {
                "field": "milestone_type",
                "type": "string",
                "allowed": [
                    "pickup",
                    "transit",
                    "delivery"
                ]
            },
            {
                "field": "location_name",
                "type": "string"
            },
            {
                "field": "city",
                "type": "string"
            },
            {
                "field": "state",
                "type": "string"
            }
        ],
        "stop_optional_fields": [
            "address1",
            "zip",
            "scheduled_at",
            "time_window_start",
            "time_window_end",
            "appointment_type",
            "load_unload_type",
            "facility_hours",
            "dock_instructions",
            "access_rules",
            "driver_instructions"
        ],
        "success_response_fields": [
            "success",
            "status",
            "load_number",
            "tracking_mode",
            "correlation_id",
            "tracking_session_id",
            "tracking_url",
            "assignment_url",
            "sms_sent",
            "email_sent",
            "driver_assignment_status",
            "reinitialized"
        ],
        "status_values": {
            "initialized": "First POST for load_number.",
            "reinitialized": "Repeat POST for same active load_number; equipment/stops refreshed; same tracking_session_id."
        }
    },
    "asset_gps": {
        "tms_fields_on_initialize": [
            "tms_vehicle_id",
            "power_unit"
        ],
        "admin_setup": "Settings \u2192 GPS Integrations (not TMS code). ELD API keys never in initialize payload.",
        "supported_providers_v1": [
            "samsara",
            "motive"
        ],
        "planned_providers": [
            "peoplenet"
        ],
        "admin_pages": [
            "/gps-integrations.php",
            "/gps-live-map-setup.php",
            "/company-profile.php"
        ],
        "handoff_doc": "https://exspeeditecheckpoint.com/docs/expedite_motive_gps_tms_handoff.md"
    },
    "exspeedite_adapter": {
        "inbound": "POST /v1/tracking/initialize.php with bearer token.",
        "outbound_callbacks": {
            "separate_from_customer_webhooks": true,
            "admin_page": "/expedite-callback-settings.php",
            "delivery": "HTTPS POST JSON + Authorization Bearer to EXSPEEDITE TMS receiver URL",
            "event_catalog": {
                "assignment_created": "Private assignment link created",
                "assignment_completed": "Carrier completed driver assignment",
                "tracking_started": "Active tracking session started",
                "tracking_failed": "Tracking could not start or continue",
                "status_update": "General visibility status update",
                "eta_updated": "ETA updated",
                "geofence_arrival": "Geofence or stop proximity arrival",
                "missed_update": "Expected ping or GPS update missing",
                "visibility_health_issue": "Visibility health degraded or failed",
                "pod_uploaded": "Proof of delivery document available",
                "photo_uploaded": "Photo proof uploaded",
                "document_uploaded": "Document uploaded",
                "picked_up": "Pickup milestone reached (driver departed shipper)",
                "delivered": "Delivery milestone reached",
                "exception_alert": "Operations exception alert",
                "accepted": "Assignment accepted",
                "rejected": "Assignment rejected"
            }
        },
        "reinitialize": "Send initialize again with updated tms_vehicle_id or power_unit while load is active."
    },
    "errors": {
        "shape": {
            "success": false,
            "error_code": "STABLE_CODE",
            "message": "Human-readable message",
            "correlation_id": "Optional on Phase 3+ responses",
            "errors": "Optional field-level array",
            "details": "Optional structured hints"
        },
        "initialize": [
            {
                "http": 401,
                "error_code": "INVALID_BEARER_TOKEN",
                "fix": "Verify company workspace bearer token."
            },
            {
                "http": 400,
                "error_code": "MISSING_MANDATORY_FIELDS",
                "fix": "Send load_number, carrier_name, stops; direct_driver needs driver_name and driver_phone."
            },
            {
                "http": 400,
                "error_code": "MISSING_DELIVERY_STOP",
                "fix": "Include at least one stop with milestone_type delivery."
            },
            {
                "http": 400,
                "error_code": "INVALID_DRIVER_PHONE",
                "fix": "Normalize phone to E.164 before POST."
            },
            {
                "http": 400,
                "error_code": "INVALID_STOPS_PAYLOAD",
                "fix": "stops must be a non-empty JSON array."
            },
            {
                "http": 400,
                "error_code": "INVALID_STOP_SEQUENCE",
                "fix": "Use 1-based integer stop_sequence."
            },
            {
                "http": 400,
                "error_code": "INVALID_STOP_MILESTONE_TYPE",
                "fix": "Use pickup, transit, or delivery on milestone_type."
            },
            {
                "http": 400,
                "error_code": "MISSING_STOP_LOCATION_NAME",
                "fix": "Every stop needs location_name."
            },
            {
                "http": 400,
                "error_code": "MISSING_STOP_CITY_STATE",
                "fix": "Every stop needs city and state."
            },
            {
                "http": 400,
                "error_code": "CONTINUOUS_TRACKING_DISABLED",
                "fix": "Enable add-on or use ping mode."
            },
            {
                "http": 400,
                "error_code": "INVALID_BACKGROUND_INTERVAL",
                "fix": "Use 10-900 seconds or omit."
            },
            {
                "http": 500,
                "error_code": "SERVER_ERROR",
                "fix": "Retry with backoff; contact support with correlation_id."
            }
        ],
        "shipper_hmac": [
            {
                "http": 401,
                "error_code": "MISSING_HMAC_HEADERS"
            },
            {
                "http": 401,
                "error_code": "INVALID_SHIPPER_UUID"
            },
            {
                "http": 401,
                "error_code": "EXPIRED_HMAC_TIMESTAMP"
            },
            {
                "http": 401,
                "error_code": "SHIPPER_NOT_ACTIVE"
            },
            {
                "http": 403,
                "error_code": "INVALID_HMAC_SIGNATURE"
            },
            {
                "http": 403,
                "error_code": "HMAC_SIGNATURE_MISMATCH"
            }
        ]
    },
    "examples": {
        "direct_driver_minimal": {
            "load_number": "TMS-104482",
            "carrier_name": "Blue River Transport",
            "driver_assignment_mode": "direct_driver",
            "driver_name": "Maria Santos",
            "driver_phone": "+13125550119",
            "stops": [
                {
                    "stop_sequence": 1,
                    "milestone_type": "pickup",
                    "location_name": "Chicago DC",
                    "city": "Chicago",
                    "state": "IL"
                },
                {
                    "stop_sequence": 2,
                    "milestone_type": "delivery",
                    "location_name": "Dallas Retail Pool",
                    "city": "Dallas",
                    "state": "TX"
                }
            ]
        },
        "private_link": {
            "load_number": "TMS-104483",
            "carrier_name": "Blue River Transport",
            "driver_assignment_mode": "private_link",
            "carrier_contact_email": "dispatch@carrier.example",
            "stops": [
                {
                    "stop_sequence": 1,
                    "milestone_type": "pickup",
                    "location_name": "Chicago DC",
                    "city": "Chicago",
                    "state": "IL"
                },
                {
                    "stop_sequence": 2,
                    "milestone_type": "transit",
                    "location_name": "Memphis Crossdock",
                    "city": "Memphis",
                    "state": "TN"
                },
                {
                    "stop_sequence": 3,
                    "milestone_type": "delivery",
                    "location_name": "Dallas Retail Pool",
                    "city": "Dallas",
                    "state": "TX"
                }
            ]
        },
        "asset_gps_carrier": {
            "load_number": "TMS-20260703-44102",
            "carrier_name": "Example Carrier LLC",
            "driver_assignment_mode": "direct_driver",
            "driver_name": "Alex Rivera",
            "driver_phone": "+13125550119",
            "tms_vehicle_id": "1042",
            "power_unit": "1042",
            "tracking_mode": "ping",
            "stops": [
                {
                    "stop_sequence": 1,
                    "milestone_type": "pickup",
                    "location_name": "Chicago DC",
                    "city": "Chicago",
                    "state": "IL"
                },
                {
                    "stop_sequence": 2,
                    "milestone_type": "delivery",
                    "location_name": "Indianapolis Hub",
                    "city": "Indianapolis",
                    "state": "IN"
                }
            ]
        },
        "success_direct_driver": {
            "success": true,
            "status": "initialized",
            "load_number": "TMS-104482",
            "tracking_mode": "ping",
            "tracking_session_id": "trk_\u2026",
            "correlation_id": "\u2026",
            "tracking_url": "https://exspeeditecheckpoint.com/tracking/start.php?token=\u2026&milestone=pickup&stop=1",
            "sms_sent": true,
            "driver_assignment_status": "assigned"
        },
        "success_private_link": {
            "success": true,
            "status": "initialized",
            "load_number": "TMS-104483",
            "assignment_url": "https://exspeeditecheckpoint.com/carrier/assign.php?token=\u2026",
            "sms_sent": false,
            "driver_assignment_status": "pending_assignment"
        },
        "validation_error": {
            "success": false,
            "error_code": "INVALID_STOP_MILESTONE_TYPE",
            "message": "Stop 2 milestone_type must be pickup, transit, or delivery.",
            "correlation_id": "\u2026",
            "details": {
                "stop_sequence": 2,
                "field": "milestone_type",
                "allowed": [
                    "pickup",
                    "transit",
                    "delivery"
                ]
            }
        }
    },
    "curl_initialize": "curl -X POST \"https://exspeeditecheckpoint.com/v1/tracking/initialize.php\" -H \"Authorization: Bearer YOUR_CHECKPOINT_TOKEN\" -H \"Content-Type: application/json\" -d @load.json",
    "related_docs": {
        "developers_page": "https://exspeeditecheckpoint.com/developers.php",
        "markdown_export": "https://exspeeditecheckpoint.com/developers.php?export=markdown",
        "gps_handoff": "https://exspeeditecheckpoint.com/docs/expedite_motive_gps_tms_handoff.md",
        "tms_live_map_launch": "https://exspeeditecheckpoint.com/docs/expedite_tms_live_map_launch_spec.md",
        "gps_framework": "https://exspeeditecheckpoint.com/docs/checkpoint_gps_provider_framework.md",
        "schema": "https://exspeeditecheckpoint.com/dev/checkpoint_schema.html"
    }
}