Get file information by ID | Invofox

const url = 'https://api.invofox.com/v1/ingest/files/66f580d3bee75c4a542daabb';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "id": "66f580d3bee75c4a542daabb",
  "accountId": "66d721ec7edc0baa3794eec1",
  "environmentId": "66d721f5ee90270bfac654a0",
  "importId": "66d711d737c788ba24e17734",
  "filename": "invoice.pdf",
  "compressed": false,
  "status": "processed",
  "mimeType": "application/pdf",
  "companyId": "66d5dc3afed4f8062c998439",
  "parentFileId": "66f580d3bee75c4a542daabb",
  "documentIds": [
    "66d71d63c9d0d2adc038b076",
    "66d71d63c9d0d2adc038b077"
  ],
  "error": "ERR_UNSUPPORTED_FILE_FORMAT",
  "createdAt": "2024-09-26T10:30:00.000Z",
  "updatedAt": "2024-09-26T10:35:00.000Z",
  "clientData": {
    "userId": "507f1f77bcf86cd799439015",
    "invofoxAccountName": "company-name",
    "invofoxCompanyId": "12345"
  }
}

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.

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

mimeTypestring

MIME type of the file

companyIdstringOptional

Company identifier

parentFileIdstringOptional

Parent file identifier if this file was extracted from another

documentIdslist of stringsOptional

Array of document identifiers extracted from this file

errorstringOptional

Error code if processing failed

createdAtstringOptionalformat: "date-time"

Timestamp when the file was created

updatedAtstringOptionalformat: "date-time"

Timestamp when the file was last updated

clientDataobjectOptional

Client data associated to the file

Errors

404

Not Found Error