Skip to main content
POST
/
file-requests
Create File Request
curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/file-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Contract renewal",
  "description": "We need these files to complete your contract renewal",
  "customerId": "cst_abc123456789",
  "directoryId": "fsd_abc123456789",
  "requestedFiles": [
    {
      "name": "Logo",
      "description": "The logo we should put on your website",
      "required": true,
      "maxFileSize": 10240
    }
  ]
}'
{
  "id": "frq_abc12345678",
  "name": "Contract renewal",
  "description": "We need these files to complete your contract renewal",
  "directoryId": "fsd_abc123456789",
  "customerId": "cst_abc123456789",
  "requestedFiles": [
    {
      "id": "fqf_abc123456789",
      "name": "Logo",
      "description": "The logo we should put on your website",
      "required": true,
      "maxFileSize": 10240,
      "uploadedFileId": "fsf_abc123456789"
    }
  ],
  "completedAt": "2024-04-29T21:00:00+02:00",
  "createdAt": "2024-04-29T21:00:00+02:00",
  "links": {
    "customer": {
      "href": "https://api.mijnklantportaal.nl/v1/customers/cst_abc12345def678",
      "type": "<string>"
    },
    "publicRequest": {
      "href": "<string>",
      "type": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The name of the file request to recognize it in your managing portal

Example:

"Contract renewal"

​
requestedFiles
object[]
required

An array of file request file data of the files you want to receive. You can request upon 10 files per File Request.

​
description
string

An optional description of why you need the file(s). This will be shown to the person uploading the files

Example:

"We need these files to complete your contract renewal"

​
customerId
string

The ID of the customer you want to request the files from. Omit to generate a public link

Example:

"cst_abc123456789"

​
directoryId
string

The ID of the directory where the uploaded file(s) should placed it. Omit to place the file(s) in the root of your file system.

Example:

"fsd_abc123456789"

Response

Returning the created File Request

File Request

​
id
string

ID of the File Share, always starting with frq_.

Example:

"frq_abc12345678"

​
name
string

The name of the file request to recognize it in your managing portal

Example:

"Contract renewal"

​
description
string | null

The description of why you need the file(s). This will be shown to the person uploading the files

Example:

"We need these files to complete your contract renewal"

​
directoryId
string | null

The ID of the directory where the uploaded files should be put it, if set.

Example:

"fsd_abc123456789"

​
customerId
string | null

The ID of the customer you want to request the files from. Will be null when requested via public link

Example:

"cst_abc123456789"

​
requestedFiles
object[]

An array of file request data of the files you want to receive. You can request upon 10 files per File Request.

​
completedAt
string | null

Date and time when the files in the request were provided. Written in ATOM format. null when the files are not provided yet.

Example:

"2024-04-29T21:00:00+02:00"

​
createdAt
string

Date and time when the File Request was created. Written in ATOM format.

Example:

"2024-04-29T21:00:00+02:00"

​
links
object
⌘I