List Driver Documents

View as Markdown
# List Driver Documents Fetches the complete list of all KYC documents uploaded by the authenticated driver, including file URLs, entered numbers, and administrative verification statuses. --- ### Endpoint Overview - **Method:** `GET` - **Route:** `/api/v1/driver/documents` - **Authentication:** `Bearer Token (Driver JWT)` - **Content-Type:** `N/A` --- ### Request Headers | Header | Type | Required | Description | | --- | --- | --- | --- | | `Authorization` | `string` | **Yes** | Format: `Bearer` | --- ### Request Body Schema _None (GET request)_ --- ### Response Body Schema (`200 OK`) | Top-Level Key | Data Type | Description | | --- | --- | --- | | `documents` | `array` | Array of all document records submitted by the driver | #### `Document Item Fields` | Field | Data Type | Nullable | Allowed Values / Constraints | Description | | --- | --- | --- | --- | --- | | `id` | `string` | No | Prefixed with `ddoc_` | Unique document ID | | `driverId` | `string` | No | Prefixed with `drv_` | Driver ID | | `document_type` | `enum` | No | `"DRIVING_LICENCE""AADHAAR""PAN""VEHICLE_RC""VEHICLE_MODEL_NUMBER""PERMIT""INSURANCE""FITNESS_CERTIFICATE"` | Document category | | `front_image_url` | `string` | Yes | Valid URL | Hosted front side image URL | | `back_image_url` | `string` | Yes | Valid URL | Hosted back side image URL | | `document_number` | `string` | Yes | String | Document identifier number | | `name_on_doc` | `string` | Yes | String | Name printed on document | | `date_of_birth` | `string` | Yes | ISO 8601 Timestamp | Date of birth | | `fuel_type` | `enum` | Yes | `"PETROL"`, `"DIESEL"`, `"CNG"`, `"ELECTRIC"`, `null` | Vehicle fuel type (for RC) | | `vehicle_model_number` | `string` | Yes | String | Model number | | `verification_status` | `enum` | No | `"PENDING""APPROVED""REJECTED"` | Admin approval state | | `rejection_reason` | `string` | Yes | String | Reason if status is `REJECTED` | | `verified_at` | `string` | Yes | ISO 8601 Timestamp | When admin reviewed the document | | `verified_by` | `string` | Yes | Admin ID | Admin who reviewed the document | | `created_at` | `string` | No | ISO 8601 Timestamp | Initial submission timestamp | | `updated_at` | `string` | No | ISO 8601 Timestamp | Last update timestamp | --- ### `Response Examples` #### ``1. `200 OK` — Multiple Documents Returned`` ``` json { "documents": [ { "id": "ddoc_9a8b7c6d5e", "driverId": "drv_8a7b6c5d4e", "document_type": "DRIVING_LICENCE", "front_image_url": "https://storage.example.com/docs/dl_front.jpg", "back_image_url": "https://storage.example.com/docs/dl_back.jpg", "document_number": "KA0120200012345", "name_on_doc": null, "date_of_birth": "1992-05-15T00:00:00.000Z", "fuel_type": null, "vehicle_model_number": null, "verification_status": "APPROVED", "rejection_reason": null, "verified_at": "2026-09-21T06:00:00.000Z", "verified_by": "adm_super123", "created_at": "2026-09-21T05:30:00.000Z", "updated_at": "2026-09-21T06:00:00.000Z" }, { "id": "ddoc_1b2c3d4e5f", "driverId": "drv_8a7b6c5d4e", "document_type": "PAN", "front_image_url": "https://storage.example.com/docs/pan_front.jpg", "back_image_url": null, "document_number": "ABCDE1234F", "name_on_doc": "Ravi Kumar", "date_of_birth": null, "fuel_type": null, "vehicle_model_number": null, "verification_status": "PENDING", "rejection_reason": null, "verified_at": null, "verified_by": null, "created_at": "2026-09-21T05:35:00.000Z", "updated_at": "2026-09-21T05:35:00.000Z" } ] } ``` #### ``2. `200 OK` — No Documents Submitted Yet`` ``` json { "documents": [] } ``` #### ``3. `401 Unauthorized` — Missing / Expired Token / Revoked Session`` ``` json { "error": "Unauthorized", "message": "Invalid or expired driver access token." } ``` #### ``4. `403 Forbidden` — Account Blocked / Deactivated`` ``` json { "error": "Forbidden", "message": "Driver account is blocked or deactivated." } ``` #### `` 5. `500 Internal Server Error` `` ``` json { "error": "Failed to fetch documents" } ``` --- ### `Status Codes Reference` | HTTP Status Code | Condition | | --- | --- | | **`200 OK`** | List of documents returned successfully (can be empty array). | | **`401 Unauthorized`** | Missing, invalid, expired token or session revoked. | | **`403 Forbidden`** | Driver account is deactivated or blocked. | | **`500 Internal Server Error`** | Server or database query error. |

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.