Skip to main content

Courier Network APIs

The Courier Network APIs manage the backbone of Skeep's delivery workforce. These APIs handle courier onboarding, profiling, and real-time operations.

Partner Only

Most of these APIs are restricted to internal administrative tools and the official Skeep Rider applications.

Courier Management

1. Courier Onboarding

POST /couriers/onboard Initiates the onboarding process for a new rider. This creates a pending courier profile.

2. Document Verification

POST /couriers/{id}/documents Upload and verify required KYC documents (ID, License, Vehicle Insurance).

3. Availability Status

PATCH /couriers/{id}/status Toggle courier status between online and offline. This determines if a courier is eligible for job assignments.

Courier Operations

1. Job Assignment

POST /dispatch/assign Assigns a specific courier to a delivery order. Can be automated via dispatch logic or manual via admin dashboard.

2. Location Tracking

PUT /couriers/{id}/location Internal endpoint for the Rider app to send high-frequency GPS updates.

3. Performance Metrics

GET /couriers/{id}/metrics Fetches data on delivery success rate, average completion time, and customer ratings.