Skip to content

Development environment: content is being written, nothing points to production.

Documentation contents

files

Version 0.1.04 operations

Documents of the organisation

GET/organisations/{id}/filesDashboard session

Parameters

  • idstringpathrequired

Responses

  • 200

    • idstring (uuid)required
    • typestringrequired
      • enum: "business_contract", "business_registration", "patent", "affiliation_contract", "identity_document", "proof_of_address", "logo", "other"
    • originalNamestringrequired
    • mimeTypestringrequired
    • sizeBytesnumberrequired
    • reviewedAtstring (date-time) | nullrequired
    • uploadedBystring (uuid) | nullrequired
    • createdAtstring (date-time)required

Code samples

curl -X GET "$KONNECT_API_URL/organisations/id/files" \
  -H "Cookie: konnect_session=$KONNECT_SESSION"

Example: 200

[
  {
    "id": "id",
    "type": "business_contract",
    "originalName": "originalName",
    "mimeType": "mimeType",
    "sizeBytes": 1,
    "reviewedAt": "2026-10-01T09:30:00.000Z",
    "uploadedBy": "uploadedBy",
    "createdAt": "2026-10-01T09:30:00.000Z"
  }
]

Upload a document (PDF, PNG or JPEG, 10 MB at most)

POST/organisations/{id}/filesDashboard session

Parameters

  • idstringpathrequired

Request body multipart/form-data

  • typestringrequired
    • enum: "business_contract", "business_registration", "patent", "affiliation_contract", "identity_document", "proof_of_address", "logo", "other"
  • filestring (binary)required

Responses

  • 201

    • idstring (uuid)required
    • typestringrequired
      • enum: "business_contract", "business_registration", "patent", "affiliation_contract", "identity_document", "proof_of_address", "logo", "other"
    • originalNamestringrequired
    • mimeTypestringrequired
    • sizeBytesnumberrequired
    • reviewedAtstring (date-time) | nullrequired
    • uploadedBystring (uuid) | nullrequired
    • createdAtstring (date-time)required

Code samples

curl -X POST "$KONNECT_API_URL/organisations/id/files" \
  -H "Cookie: konnect_session=$KONNECT_SESSION" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "business_contract",
  "file": "file"
}'

Example: request body

{
  "type": "business_contract",
  "file": "file"
}

Example: 201

{
  "id": "id",
  "type": "business_contract",
  "originalName": "originalName",
  "mimeType": "mimeType",
  "sizeBytes": 1,
  "reviewedAt": "2026-10-01T09:30:00.000Z",
  "uploadedBy": "uploadedBy",
  "createdAt": "2026-10-01T09:30:00.000Z"
}

Pre-signed download URL, valid 5 minutes

GET/organisations/{id}/files/{fileId}/downloadDashboard session

Parameters

  • idstringpathrequired
  • fileIdstringpathrequired

Responses

  • 200

    • urlstringrequired

      Pre-signed URL, valid 5 minutes

    • expiresAtstring (date-time)required

Code samples

curl -X GET "$KONNECT_API_URL/organisations/id/files/fileId/download" \
  -H "Cookie: konnect_session=$KONNECT_SESSION"

Example: 200

{
  "url": "url",
  "expiresAt": "2026-10-01T09:30:00.000Z"
}

Delete a document not yet reviewed by Konnect

DELETE/organisations/{id}/files/{fileId}Dashboard session

Parameters

  • idstringpathrequired
  • fileIdstringpathrequired

Responses

  • 204

Code samples

curl -X DELETE "$KONNECT_API_URL/organisations/id/files/fileId" \
  -H "Cookie: konnect_session=$KONNECT_SESSION"