Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.city.atlas.krd/llms.txt

Use this file to discover all available pages before exploring further.

Requires authentication

​
Endpoint

GET /documents

​
Query Parameters

ParameterTypeDescription
typestringFilter by document type (NATIONAL, LICENSE, PASSPORT, RESIDENCE, OTHER)
issuedBystringFilter by issuing authority

​
Response

{
  "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
    }
  ]
}