Requires authentication
Endpoint
Query Parameters
| Parameter | Type | Description |
|---|---|---|
type | string | Filter by document type (NATIONAL, LICENSE, PASSPORT, RESIDENCE, OTHER) |
issuedBy | string | Filter by issuing authority |
✨ The Urban Management docs now have a brand-new home! Explore the improved documentation experience
Retrieve list of documents
GET /documents
| Parameter | Type | Description |
|---|---|---|
type | string | Filter by document type (NATIONAL, LICENSE, PASSPORT, RESIDENCE, OTHER) |
issuedBy | string | Filter by issuing authority |
{
"success": true,
"data": [
{
"id": "uuid",
"url": "https://storage.example.com/document.pdf",
"type": "NATIONAL",
"expiryDate": "2025-12-31T00:00:00Z",
"issuedBy": "Ministry of Interior",
"adminId": "admin-uuid",
"userId": null
}
]
}
Was this page helpful?