List Documents
Retrieve a complete list of all verification documents associated with your account. This endpoint returns every document you have uploaded, including their current verification status, expiration dates, and whether they meet the agency's requirements.
Document verification is a critical part of the Daakey car sharing experience. Before you can book a vehicle, you must upload and have verified certain documents (typically a driver's license). This endpoint helps you track which documents you've submitted, which ones have been approved, and which might need attention.
The response includes metadata about which documents are required versus optional for your agency. Required documents must be verified before you can make bookings, while optional documents may provide additional benefits or faster checkout experiences.
Endpoint
INFO
GET /api/v1/client/documents
Headers
| Header | Value | Required |
|---|---|---|
Accept | application/json | Yes |
Authorization | Bearer {token} | Yes |
X-Agency-Signature | {signature} | Yes |
Example Request
curl -X GET https://api.daakey.com/api/v1/client/documents \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-H "X-Agency-Signature: {signature}"Response
Success (200)
{
"success": true,
"message": "Documents retrieved",
"data": [
{
"id": 1,
"type": "driver_license_front",
"url": "https://api.daakey.com/storage/documents/1/dl-front.jpg",
"status": "verified",
"verified_at": "2024-01-10T00:00:00Z",
"expires_at": "2025-12-31",
"uploaded_at": "2024-01-05T00:00:00Z"
},
{
"id": 2,
"type": "driver_license_back",
"url": "https://api.daakey.com/storage/documents/1/dl-back.jpg",
"status": "verified",
"verified_at": "2024-01-10T00:00:00Z",
"expires_at": "2025-12-31",
"uploaded_at": "2024-01-05T00:00:00Z"
},
{
"id": 3,
"type": "id_card",
"url": "https://api.daakey.com/storage/documents/1/id.jpg",
"status": "pending",
"verified_at": null,
"expires_at": null,
"uploaded_at": "2024-01-15T00:00:00Z"
}
],
"meta": {
"agency_id": 123,
"agency_code": "AGENCY123",
"required_documents": ["driver_license_front", "driver_license_back"],
"optional_documents": ["id_card", "passport"]
},
"request_id": "uuid",
"timestamp": "2024-01-01T00:00:00.000Z"
}Document Types
| Type | Description |
|---|---|
driver_license_front | Front of driver's license |
driver_license_back | Back of driver's license |
id_card | National ID card |
passport | Passport photo page |
Document Status
| Status | Description |
|---|---|
pending | Awaiting verification |
verified | Document verified |
rejected | Document rejected |
expired | Document has expired |