To send a file via Flixcheck, you need to take three steps:

1. Upload the file

First of all, you need to upload the file without telling what to do with it. In this step, the only goad is to get the content of your file into our storage.

• Method: POST

• URL: https://api.flixcheck.com/user/v7/temp-files

• Headers:

  • Content-Type: multipart/form-data; boundary=<calculated when request is sent>
  • X-Flixcheck-UserId: <Your User ID>
  • X-Flixcheck-ApiKey: <Your API Key>

• Body: form-data, key = file, value = your file

• Response:

  {
      "resource": "eyJqa3...J9uJZR3"
  }
  

  In the response.resource, you’ll get a JWT string that you will need in the next step.

2. Exchange your JWT for a fileId

Now you’ve uploaded your content to our storage, we can check it in to our file management system by create a file entity.

• Method: POST

• URL: https://api.flixcheck.com/user/v7/files

• Query Params:

  • If you want to use this file for a PDF editor later on, add ?action=generateImagesOfPdf to the URL

• Headers:

  • Content-Type: application/json
  • X-Flixcheck-UserId: <Your User ID>
  • X-Flixcheck-ApiKey: <Your API Key>

• Body:

  {
      "jwt": "eyJqa3...J9uJZR3"
  }
  

• Response:

  {
      "resource": {
          "mime": "application/pdf",
          "size": 12032,
          "expires": "2025-07-16T11:40:55.640Z",
          "isThumb": false,
          "publiclyAccessible": false,
          "pdfInfo": {
              "nrOfPages": 1,
              "signed": false,
              "fields": [],
              "imagesGenerationFailed": false
          },
          "created": "2025-07-15T11:40:55.688Z",
          "id": "**68763e4754b3fce174ab6961**",
          "url": "<https://fxc.obs.eu-de.otc.t-systems.com/>...",
          "filename": "testfile.pdf"
      },
      "meta": {
          "isSignedPdf": false
      }
  }
  

  • Copy the resource.id. This is your fileId.
  • Note the expires property? We will delete the file after that date if you won’t use the file in a check or a template. As soon as you use the file, it will be assigned to the check / template and the expires property will be deleted.
  • You can use the file in multiple checks and templates! Just re-use the fileId.
  • After deleting the last check or template associated with the file, the file will be deleted as well. Please note that this might also occur bevor the expiery date.

3. Use the file in a check

We’ll show you how to send a single file within a file information element. You can use uploaded images in the image information and uploaded PDFs in the pdf information element.

• Method: POST