Submits Share Documents Form

post

https://api.vcita.biz/client_api/v1/portals/{business_uid}/share_documents_form/submit

Overview

Submits Share Documents Form to the business.

Authentication

Available for Client Tokens only.

Critical Requirement

The matter_uid query parameter must reference a matter with an assigned staff member. Without this, the endpoint returns 500 due to a server-side bug.

Request Format

This endpoint requires multipart/form-data format with actual binary file uploads (not JSON). Documents must be uploaded as form fields with proper content types.

Important: Field Naming Convention

Document fields MUST use explicit numeric indices (e.g., [0], [1]), NOT empty brackets [].

Correct: form_data[fields][documents][0][email protected]
Wrong: form_data[fields][documents][][email protected] (causes 500 error)

This is because the server expects a Hash structure, not an Array.

Captcha

When the business has the captcha_intake_form feature enabled, a valid captcha_token is required.

Example cURL

curl -X POST 'https://api.vcita.biz/client_api/v1/portals/{business_uid}/share_documents_form/submit?matter_uid={matter_uid}' \
  -H 'Authorization: Bearer {token}' \
  -F 'form_data[fields][title]=My Document' \
  -F 'form_data[fields][message]=Please review' \
  -F 'form_data[fields][documents][0][email protected];type=application/pdf'

Responses

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success - Documents submitted successfully.

422Validation Error or Business Blocked. Validation Error: Missing required fields like documents. Business Blocked: When the business is flagged as spammer or user access is blocked, returns 422 with NO explicit error message - only auto_reply_message in the data object.

500Internal Server Error. Occurs when the matter does not have an assigned staff member or when an empty JSON body is sent instead of multipart/form-data.