Blazelock
File Scans

Get a file scan by external reference ID

Retrieve a file scan by the client-provided external reference ID instead of the Blazelock file scan ID. The external reference ID is resolved within the authenticated API integration. Depending on the scan progress and outcome, the response can return a processing, completed, or failed state.

GET/file-scans/external-reference/{external_reference_id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key generated in the Blazelock Dashboard. Send it as Authorization: Bearer <api-key>.

In: header

Path Parameters

external_reference_id*never

Header Parameters

Content-Language?string

Two-letter ISO language code used for localized human-readable response messages. Supported values:

  • en = English
  • de = German
Value in"en" | "de"

Response Body

application/json

{
  "id": "019583d8-b2e4-7b8d-9d1f-6f4cb3d0b6f1",
  "external_reference_id": "invoice-4711",
  "status": "processing",
  "execution_mode": "async",
  "file_name": "invoice.pdf",
  "file_size": 245761,
  "submitted_at": "2026-03-09T12:34:56.000Z"
}