Skip to main content
POST
/
partner
/
incorporation
/
{incorporationId}
/
files
Register an incorporation file
curl --request POST \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/files \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "fileId": 456
}'
{
  "file": {
    "fileId": 456,
    "fileName": "passport.pdf",
    "mimeType": "application/pdf",
    "fileSize": 123456
  }
}
Registers a company-scoped Commenda file to the incorporation context and returns that fileId. Use this endpoint before linking files as typed participant documents.
This endpoint does not upload binary content. For new partner-collected files, first create a company document with Create a company document after using Create a document upload URL, then pass the returned file.fileId here.
For the full file handoff from S3 upload URL to participant document, see Upload documents for incorporation. 
{
  "fileId": 456
}
MIME compatibility is checked when the file is linked as a typed participant document, not only when it is registered. Accepted file types are determined by the current requirements DSL for the selected incorporation.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
incorporationId
string
required

Incorporation identifier returned by create or list endpoints.

Body

application/json
​
fileId
integer
required

Existing Commenda file id to register to this incorporation.

Example:

456

Response

File registered successfully

​
file
object
required