Ingest ReferenceFiles

Get file information by ID

Retrieves file information if the user belongs to the same environment

Authentication

x-api-keystring

API key authentication for programmatic access. Used by server-to-server integrations and API clients.

OR
x-access-tokenstring

Access token authentication for web users. Used by browser-based applications and authenticated user sessions.

Path parameters

fileIdstringRequired
The ID of the file

Response

File information retrieved successfully
idstring
Unique identifier of the file
accountIdstring
Account identifier
environmentIdstring
Environment identifier
importIdstring
Import identifier
filenamestring
Name of the file
compressedboolean
Indicates if the file is compressed
statusenum
Current processing status of the file
Allowed values:
mimeTypestring
MIME type of the file
companyIdstring or null
Company identifier
parentFileIdstring or null
Parent file identifier if this file was extracted from another
documentIdslist of strings or null
Array of document identifiers extracted from this file
errorstring or null
Error code if processing failed
createdAtstring or nullformat: "date-time"
Timestamp when the file was created
updatedAtstring or nullformat: "date-time"
Timestamp when the file was last updated
clientDataobject or null
Client data associated to the file

Errors