Skip to main content

Get Document By ID API

Overview​

Fetches single document metadata record by ID.

  • Endpoint: /api/documents/get-by-id
  • Method: POST

Request Body Schema​

FieldTypeRequiredDescription
idUUID StringYesUnique Document ID

Request Body Example​

{
  "id": "d1234567-89ab-cdef-0123-456789abcdef"
}

Response Example (200 OK)​

{
  "success": true,
  "data": {
    "id": "d1234567-89ab-cdef-0123-456789abcdef",
    "name": "Company Registration Certificate.pdf",
    "path": "documents/companies/c1234567/2026-09-07/uuid_cert.pdf",
    "mimeType": "application/pdf",
    "size": 1048576,
    "companyId": "c1234567-89ab-cdef-0123-456789abcdef",
    "uploadById": null,
    "active": true,
    "createdAt": "2026-09-07T16:30:00.000Z",
    "url": "http://localhost:4000/media/documents/companies/c1234567/2026-09-07/uuid_cert.pdf"
  },
  "message": "Document details retrieved successfully"
}