Aller au contenu

Environnement de développement : contenu en cours de rédaction, rien ne pointe vers la production.

Sommaire de la documentation

files

Version 0.1.04 opérations

Documents of the organisation

GET/organisations/{id}/filesSession du tableau de bord

Paramètres

  • idstringpathobligatoire

Réponses

  • 200

    • idstring (uuid)obligatoire
    • typestringobligatoire
      • enum: "business_contract", "business_registration", "patent", "affiliation_contract", "identity_document", "proof_of_address", "logo", "other"
    • originalNamestringobligatoire
    • mimeTypestringobligatoire
    • sizeBytesnumberobligatoire
    • reviewedAtstring (date-time) | nullobligatoire
    • uploadedBystring (uuid) | nullobligatoire
    • createdAtstring (date-time)obligatoire

Exemples de code

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

Exemple : 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}/filesSession du tableau de bord

Paramètres

  • idstringpathobligatoire

Corps de la requête multipart/form-data

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

Réponses

  • 201

    • idstring (uuid)obligatoire
    • typestringobligatoire
      • enum: "business_contract", "business_registration", "patent", "affiliation_contract", "identity_document", "proof_of_address", "logo", "other"
    • originalNamestringobligatoire
    • mimeTypestringobligatoire
    • sizeBytesnumberobligatoire
    • reviewedAtstring (date-time) | nullobligatoire
    • uploadedBystring (uuid) | nullobligatoire
    • createdAtstring (date-time)obligatoire

Exemples de code

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"
}'

Exemple : corps de la requête

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

Exemple : 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}/downloadSession du tableau de bord

Paramètres

  • idstringpathobligatoire
  • fileIdstringpathobligatoire

Réponses

  • 200

    • urlstringobligatoire

      Pre-signed URL, valid 5 minutes

    • expiresAtstring (date-time)obligatoire

Exemples de code

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

Exemple : 200

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

Delete a document not yet reviewed by Konnect

DELETE/organisations/{id}/files/{fileId}Session du tableau de bord

Paramètres

  • idstringpathobligatoire
  • fileIdstringpathobligatoire

Réponses

  • 204

Exemples de code

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