HEhellosunset
Documents

List documents

List all documents for a case.

get/cases/{case_id}/documents

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination.

per_pageinteger

Number of items per page.

type'death_certificate' | 'probate_document' | 'bank_document' | 'credit_report' | 'birth_certificate' | 'deceased_id' | 'executor_id' | 'property_report' | 'will' | 'trust_documents' | 'other'
status'uploaded' | 'skipped' | 'pending' | 'rejected'

Response

List of documents.

Example response

{
  "data": [
    {
      "id": "01K5XB07CJ5T22HRYE78AN7DEF",
      "type": "death_certificate",
      "file_name": "death_cert_scan.pdf",
      "file_size_bytes": 245000,
      "mime_type": "application/pdf",
      "status": "uploaded"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total_count": 142,
    "total_pages": 6,
    "next_cursor": "eyJpZCI6IjAxSzVXRjA2TUo2VDk5SFJZRTQ4QU43WE04In0=",
    "has_more": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.