Skip to main content
POST
/
partner
/
incorporation
/
{incorporationId}
/
documents
Link a participant document
curl --request POST \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/documents \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "participantId": "participant_123",
  "documentKind": "passport_scan",
  "fileId": 456
}
'
{
  "document": {
    "documentId": "document_123",
    "participantId": "participant_123",
    "documentKind": "passport_scan",
    "fileId": 456,
    "status": "submitted"
  }
}
Links a registered incorporation file to a participant as a typed document. Files are the low-level storage object. Documents are the typed incorporation requirement being satisfied for a participant. The fileId must first be registered to this incorporation with POST /partner/incorporation/{incorporationId}/files. If you are starting from a passport scan, utility bill, or other local file, first follow Upload documents for incorporation to get a registered incorporation fileId. Linking is replacement-based per participant and document kind. If you call this endpoint again with the same participantId and documentKind, Commenda updates that participant document to point at the new fileId. 
{
  "participantId": "participant_123",
  "documentKind": "passport_scan",
  "fileId": 456
}
The current requirements DSL determines which documentKind values are required for each participant and which MIME types are accepted. If a registered file has an unsupported MIME type or the document kind is not valid for the participant, this endpoint returns a validation error.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
incorporationId
string
required

Incorporation identifier returned by create or list endpoints.

Body

application/json
​
participantId
string
required

Participant this document belongs to.

Example:

"participant_123"

​
documentKind
enum<string>
required

Type of document linked to an incorporation participant.

Available options:
passport_scan,
utility_bill
​
fileId
integer
required

File id previously registered to this incorporation.

Example:

456

Response

Participant document linked successfully

​
document
object
required