Skip to main content
PUT
/
partner
/
incorporation
/
{incorporationId}
/
participants
/
{participantId}
/
documents
/
{documentKind}
Upsert a participant document
curl --request PUT \
  --url https://api.prod.commenda.io/api/v1/partner/incorporation/{incorporationId}/participants/{participantId}/documents/{documentKind} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "fileId": 456
}'
{
  "document": {
    "documentId": "document_123",
    "participantId": "participant_123",
    "fileId": 456,
    "status": "SUBMITTED"
  },
  "incorporationValidation": {
    "isComplete": false,
    "missingRequirements": [
      {
        "code": "PARTICIPANT_DOCUMENT_REQUIRED",
        "path": "participants.participant_123.documents.PASSPORT_SCAN",
        "message": "Participant participant_123 requires a PASSPORT_SCAN document",
        "participantId": "participant_123",
        "displayName": "Jane Founder"
      }
    ],
    "invalidRequirements": [
      {
        "code": "PARTICIPANT_DOCUMENT_REQUIRED",
        "path": "participants.participant_123.documents.PASSPORT_SCAN",
        "message": "Participant participant_123 requires a PASSPORT_SCAN document",
        "participantId": "participant_123",
        "displayName": "Jane Founder"
      }
    ]
  }
}
Assigns a customer-scoped Commenda file to one participant document slot. Use this endpoint after uploading a customer file with the Commenda OS Partner API. Commenda creates or replaces the typed participant document in one transaction without changing the reusable file. There is no separate file registration call. If you are starting from a passport scan, utility bill, or other local file, first follow Upload files for incorporation to upload the file and get a file.fileId. The slot is replacement-based by participantId and documentKind. Calling this endpoint again with a different fileId replaces the file for that participant document. Calling it again with the same fileId is safe. The documentKind path value comes from the incorporation requirements. Current values include PASSPORT_SCAN and UTILITY_BILL. 
{
  "fileId": 456
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
incorporationId
string
required

Incorporation identifier returned by create or list endpoints.

​
participantId
string
required

Incorporation-specific participant identifier returned by register, list, or read endpoints.

​
documentKind
enum<string>
required

Typed document requirement to satisfy for this participant. Type of document linked to an incorporation participant.

Available options:
PASSPORT_SCAN,
UTILITY_BILL

Body

application/json
​
fileId
integer
required

Existing customer-scoped Commenda file id to assign to the participant document slot.

Example:

456

Response

Participant document upserted successfully

​
document
object
required
​
incorporationValidation
object
required