Case Files#

Case Files are documents uploaded to collection cases, such as invoices, contracts, demand letters, and correspondence.

The Case File object#

AttributeTypeDescription
idstringUUID identifier
objectstringAlways "case_file"
casestringCollection Case ID
file_namestringOriginal filename
urlstringDownload URL
document_typeenumoriginal_invoice, debtor_documents, creditor_documents, demand_letter, miscellaneous
descriptionstringOptional description
file_sizeintegerFile size in bytes
mime_typestringMIME type
uploaded_bystringWho uploaded (you or partner)
createdtimestampUpload time
{
  "id": "cf_file_001",
  "object": "case_file",
  "case": "dc_a1b2c3d4",
  "file_name": "invoice-2024-0892.pdf",
  "url": "https://files.casapay.com/cases/dc_a1b2c3d4/cf_file_001",
  "document_type": "original_invoice",
  "description": "Original unpaid invoice INV-2024-0892",
  "file_size": 145000,
  "mime_type": "application/pdf",
  "uploaded_by": "creditor",
  "created": 1706140800
}

Upload a Case File#

POST /v1/collection_cases/:id/files

Content-Type: multipart/form-data

curl https://api.casapay.com/v1/collection_cases/dc_a1b2c3d4/files \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -F "file=@invoice.pdf" \
  -F "document_type=original_invoice" \
  -F "description=Original unpaid invoice"

List Case Files#

GET /v1/collection_cases/:id/files

curl https://api.casapay.com/v1/collection_cases/dc_a1b2c3d4/files \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"