Upload participant document

curl -X POST https://api.caresquareapi.com/api/public/v1/participants/participant_id/documents \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: multipart/form-data" \
     -F file=@"[object Object]" \
     -F document_name='{
  "type": "json"
}' \
     -F document_type='{
  "type": "json"
}' \
     -F portal_access='{
  "type": "json"
}' \
     -F plan_id='{
  "type": "json"
}' \
     -F external_id='{
  "type": "json"
}'

{
  "id": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "participant": "string",
  "document_name": "string",
  "document_type": "string",
  "portal_access": true,
  "plan_id": 1,
  "external_id": "string",
  "file_system_type": "legacy",
  "portal_document_status": "pending",
  "uploaded_by": "string",
  "rejection_reason": "string"
}

Upload one file as a participant document. Send multipart/form-data with the file in the file field (max 20 MB). Allowed extensions: csv, doc, docx, eml, gif, jpeg, jpg, msg, pdf, png, txt, webp, xls, xlsx.

Authentication

AuthorizationBearer

API key issued for your account. Send as Bearer token in the Authorization header.

X-Plan-Manager-Idstring

Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

participant_idstringRequiredformat: "uuid"

Participant UUID

Request

This endpoint expects a multipart form containing a file.

filefileRequired

File to upload

document_namestringOptional

Display name (defaults to the file name)

document_typestringOptional

Document type (defaults to Other)

portal_accessbooleanOptionalDefaults to false

Show the document in the participant portal

plan_idintegerOptional

NDIS plan id to link; must belong to this participant

external_idstringOptional

External system id

Response

Document uploaded

idstring

Document id (bigint as string)

created_atdatetimeOptional

participantstringOptionalformat: "uuid"

document_namestringOptional

document_typestringOptional

portal_accessbooleanOptional

Whether the participant can see it in the portal

plan_idinteger or nullOptional

Linked NDIS plan id

external_idstring or nullOptional

file_system_typeenumOptional

Where the file is stored. Only legacy documents can be downloaded through the API.

Allowed values:

portal_document_statusenum or nullOptional

Set for documents the participant uploaded through the portal (read-only)

Allowed values:

uploaded_bystring or nullOptional

Portal uploader (read-only)

rejection_reasonstring or nullOptional

Why a portal upload was rejected (read-only)

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

413

Content Too Large Error

500

Internal Server Error