Retrieve document information

get/api/document-service/v1/documents/{documentId}

Get details about a specific document including file information. Users can only access documents they created.

Path Parameters

  • documentIdstring<uuid>Required
    Unique identifier for the document

200 Response

documentId string required
Unique identifier for the document
documentType string required
Type of the document
documentTypeLabel string required
Human-readable label for the document type
subType string
Subtype of the document
status string required
Current status of the document
Allowed values: awaitingUpload uploaded
metadata dictionary<string, any>
Optional metadata for the document
files array[object] required
File information for document retrieval
id string required
Unique identifier for the file
view string
View or side of the document file
Allowed values: front back full
status string required
Current status of the file upload
Allowed values: awaitingUpload uploaded
fileName string
Original filename of the uploaded file
fileType string
MIME type of the file
fileSize number
Size of the file in bytes
uploadUrl string <uri>
Presigned URL for file upload
downloadUrl string <uri>
Presigned URL for file download
uploadUrlExpiresAt string <date-time>
When the upload URL expires
createdAt string <date-time>required
When the file was created
updatedAt string <date-time>required
When the file was last updated
createdAt string <date-time>required
When the document was created
updatedAt string <date-time>required
When the document was last updated

400 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details

401 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details

403 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details

404 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details

500 Response

code string required
Error code
message string required
Error message
details dictionary<string, any>
Additional error details