Skip to main content
PATCH
/
cases
/
{case_id}
/
documents
/
{document_id}
Update document metadata
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/documents/{document_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "data": {
    "id": "01K5XB07CJ5T22HRYE78AN7DEF",
    "type": "death_certificate",
    "file_name": "death_cert_scan.pdf",
    "file_size_bytes": 245000,
    "mime_type": "application/pdf",
    "status": "uploaded",
    "uploaded_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

​
document_id
string
required

Document identifier.

Body

application/json
​
type
enum<string>
Available options:
death_certificate,
probate_document,
bank_document,
credit_report,
birth_certificate,
deceased_id,
executor_id,
property_report,
will,
trust_documents,
other
​
status
enum<string>
Available options:
uploaded,
skipped,
pending,
rejected

Response

Document updated.

​
data
object