Sign in

v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Document Collections

Get uploaded file details

The endpoint returns details about a specific uploaded file, including its processing status and any recognized documents.

get/v1/documents/collections/{collection_id}/upload/{uploaded_file_id}/

Response

file_idstring required
filenamestring required
mime_type'application/pdf' | 'image/jpeg' | 'image/png' | 'image/tiff' | 'image/webp' | 'image/x-ms-bmp' | 'image/heic' | 'image/heif' required
status'pending' | 'validating' | 'validated' | 'invalid' | 'duplicate' | 'processing' | 'successful' | 'failed' required
file_urlstring uri required
user_idstring nullable

Truv user ID associated with this file

external_user_idstring nullable

External system user ID associated with this file

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "file_id": "f1234567890abcdef1234567890abcde",
  "filename": "merged_paystubs.pdf",
  "mime_type": "application/pdf",
  "validations": {
    "is_viable_size": true,
    "is_supported_type": true,
    "is_accessible": true,
    "is_valid": true,
    "is_readable": true,
    "is_unique": true
  },
  "status": "successful",
  "file_url": "https://example.com/files/file123xyz789.pdf",
  "user_id": "a1b2c3d4e5f6478899aabbccddeeff00",
  "external_user_id": "ext_user_789",
  "created_at": "2025-11-11T10:00:00Z",
  "updated_at": "2025-11-11T10:05:00Z"
}