Skip to main content
Incorporation documents are built from reusable Commenda OS company files. The upload and company-document creation endpoints live in the Commenda OS Partner API because files can be reused outside incorporation for KYC, entity records, registrations, and future document-review workflows. The Incorporation API only registers those files to an incorporation and links them to participants as typed documents.

Flow

  1. Create a company document upload URL with Create a document upload URL.
  2. Upload bytes directly to upload.signedUrl with HTTP PUT.
  3. Create a company document with Create a company document, passing upload.hostedUrl as fileUrl.
  4. Register the returned file.fileId to the incorporation with Register an incorporation file.
  5. Link the registered fileId to a participant with Link a participant document.

Endpoint map

StepEndpointAPI surfaceOutput
Create upload targetPOST /partner/commenda-os/companies/{companyId}/documents/upload-urlCommenda OS Partner APIupload.signedUrl, upload.hostedUrl
Create company file recordPOST /partner/commenda-os/companies/{companyId}/documentsCommenda OS Partner APIfile.fileId
Register file to incorporationPOST /partner/incorporation/{incorporationId}/filesPartner Incorporation APIRegistered fileId
Link typed participant documentPOST /partner/incorporation/{incorporationId}/documentsPartner Incorporation APIdocument.documentId

Important handoffs

  • Use upload.signedUrl only for the direct S3 PUT.
  • Use upload.hostedUrl as fileUrl when creating the company document.
  • Do not store upload.signedGetUrl as the document reference. It is short-lived and only useful for immediate preview/debugging.
  • Use file.fileId when registering and linking incorporation documents.
  • The current requirements DSL determines which participant roles need documents, which documentKind values are valid, and which file types are accepted.