Skip to main content
GET
/
v1
/
documents
/
collections
/
{collection_id}
/
upload
/
{uploaded_file_id}
Get uploaded file details
curl --request GET \
  --url https://prod.truv.com/v1/documents/collections/{collection_id}/upload/{uploaded_file_id}/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
{
  "file_id": "f1234567890abcdef1234567890abcde",
  "filename": "merged_paystubs.pdf",
  "mime_type": "application/pdf",
  "status": "successful",
  "file_url": "https://example.com/files/file123xyz789.pdf",
  "created_at": "2025-11-11T10:00:00Z",
  "updated_at": "2025-11-11T10:05:00Z",
  "validations": {
    "is_viable_size": true,
    "is_supported_type": true,
    "is_accessible": true,
    "is_valid": true,
    "is_readable": true,
    "is_unique": true
  },
  "user_id": "a1b2c3d4e5f6478899aabbccddeeff00",
  "external_user_id": "ext_user_789"
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Path Parameters

​
collection_id
string
required

Collection ID

​
uploaded_file_id
string
required

Uploaded File ID

Response

​
file_id
string
required
Example:

"f1234567890abcdef1234567890abcde"

​
filename
string
required
Example:

"merged_paystubs.pdf"

​
mime_type
enum<string>
required
Available options:
application/pdf,
image/jpeg,
image/png,
image/tiff,
image/webp,
image/x-ms-bmp,
image/heic,
image/heif
Example:

"application/pdf"

​
status
enum<string>
required
Available options:
pending,
validating,
validated,
invalid,
duplicate,
processing,
successful,
failed
Example:

"successful"

​
file_url
string<uri>
required
Example:

"https://example.com/files/file123xyz789.pdf"

​
created_at
string<date-time>
required
Example:

"2025-11-11T10:00:00Z"

​
updated_at
string<date-time>
required
Example:

"2025-11-11T10:05:00Z"

​
validations
File validations · object
Example:
{
  "is_viable_size": true,
  "is_supported_type": true,
  "is_accessible": true,
  "is_valid": true,
  "is_readable": true,
  "is_unique": true
}
​
user_id
string | null

Truv user ID associated with this file

Example:

"a1b2c3d4e5f6478899aabbccddeeff00"

​
external_user_id
string | null

External system user ID associated with this file

Example:

"ext_user_789"