Skip to content
Luminary Luminary Luminary
Get started
API Reference
Documents

List all documents

client.documents.list(DocumentListParams { after, before, household_id, 2 more } query?, RequestOptionsoptions?): CursorPagination<Document { id, created_at, household_id, 6 more } >
get/documents

Retrieve a paginated list of documents using cursor-based pagination

ParametersExpand Collapse
query: DocumentListParams { after, before, household_id, 2 more }
after?: string

Cursor for forward pagination. Returns items after this cursor.

before?: string

Cursor for backward pagination. Returns items before this cursor.

household_id?: string

Filter documents by household ID

limit?: number

Maximum number of items to return

maximum1000
minimum1
type?: DocumentType

Filter by document type

Accepts one of the following:
"GRAT_DESIGN_SUMMARY"
"GENERATED_PRESENTATION"
"ASSET_VALUATION"
"SIGNED_TRUST_DOCUMENT"
"TRUST_AMENDMENT"
"TRANSFER_CONFIRMATION"
"EXISTING_REMAINDER_TRUST_DOCUMENT"
"BALANCE_SHEET"
"WILL"
"WILL_CODICIL"
"POWER_OF_ATTORNEY"
"ASSIGNMENT_OF_INTEREST"
"ASSIGNMENT_OF_TANGIBLE_PROPERTY"
"LOAN_NOTE_AGREEMENT"
"ARTICLES_OF_INCORPORATION"
"OPERATING_AGREEMENT"
"PARTNERSHIP_AGREEMENT"
"ACCOUNT_DOCUMENTATION_STATEMENT"
"TAX_ID_CONFIRMATION"
"GIFT_TAX_RETURN"
"INCOME_TAX_RETURN"
"TAX_RECEIPT"
"TAX_FILING"
"CORPORATE_BYLAWS"
"LLC_AGREEMENT"
"LLC_AGREEMENT_AMENDMENT"
"OPERATING_AGREEMENT_AMENDMENT"
"PARTNERSHIP_AGREEMENT_AMENDMENT"
"SHAREHOLDERS_AGREEMENT"
"STATE_BUSINESS_FILING"
"LOGGED_CONTRIBUTION"
"LOGGED_DISTRIBUTION"
"INSURANCE_POLICY"
"CRUMMEY_LETTER"
"INSURANCE_PREMIUM_PAYMENT"
"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"
"FINCEN_FILING"
"HEALTHCARE_PROXY"
"LIVING_WILL"
"DRIVERS_LICENSE"
"PASSPORT"
"DEED"
"OTHER"
ReturnsExpand Collapse
Document { id, created_at, household_id, 6 more }
id: string

Unique identifier with document_ prefix

created_at: string

Timestamp when the document was created

formatdate-time
household_id: string

Household ID this document belongs to

name: string

Display name of the document

type: DocumentType

Type of document

Accepts one of the following:
"GRAT_DESIGN_SUMMARY"
"GENERATED_PRESENTATION"
"ASSET_VALUATION"
"SIGNED_TRUST_DOCUMENT"
"TRUST_AMENDMENT"
"TRANSFER_CONFIRMATION"
"EXISTING_REMAINDER_TRUST_DOCUMENT"
"BALANCE_SHEET"
"WILL"
"WILL_CODICIL"
"POWER_OF_ATTORNEY"
"ASSIGNMENT_OF_INTEREST"
"ASSIGNMENT_OF_TANGIBLE_PROPERTY"
"LOAN_NOTE_AGREEMENT"
"ARTICLES_OF_INCORPORATION"
"OPERATING_AGREEMENT"
"PARTNERSHIP_AGREEMENT"
"ACCOUNT_DOCUMENTATION_STATEMENT"
"TAX_ID_CONFIRMATION"
"GIFT_TAX_RETURN"
"INCOME_TAX_RETURN"
"TAX_RECEIPT"
"TAX_FILING"
"CORPORATE_BYLAWS"
"LLC_AGREEMENT"
"LLC_AGREEMENT_AMENDMENT"
"OPERATING_AGREEMENT_AMENDMENT"
"PARTNERSHIP_AGREEMENT_AMENDMENT"
"SHAREHOLDERS_AGREEMENT"
"STATE_BUSINESS_FILING"
"LOGGED_CONTRIBUTION"
"LOGGED_DISTRIBUTION"
"INSURANCE_POLICY"
"CRUMMEY_LETTER"
"INSURANCE_PREMIUM_PAYMENT"
"BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"
"FINCEN_FILING"
"HEALTHCARE_PROXY"
"LIVING_WILL"
"DRIVERS_LICENSE"
"PASSPORT"
"DEED"
"OTHER"
updated_at: string

Timestamp when the document was last updated

formatdate-time
enable_ai_suggestions?: boolean

Whether this document should be used for AI suggestions

entity_id?: string | null

Entity ID if this document is owned by an entity

individual_id?: string | null

Individual ID if this document is associated with an individual

List all documents
import Luminary from 'withluminary';

const client = new Luminary();

// Automatically fetches more pages as needed.
for await (const document of client.documents.list()) {
  console.log(document.id);
}
{
  "data": [
    {
      "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "name": "Trust Agreement.pdf",
      "type": "GRAT_DESIGN_SUMMARY",
      "updated_at": "2024-01-20T14:45:00Z",
      "enable_ai_suggestions": true,
      "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}
Returns Examples
{
  "data": [
    {
      "id": "document_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "created_at": "2024-01-15T09:30:00Z",
      "household_id": "household_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "name": "Trust Agreement.pdf",
      "type": "GRAT_DESIGN_SUMMARY",
      "updated_at": "2024-01-20T14:45:00Z",
      "enable_ai_suggestions": true,
      "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  ],
  "page_info": {
    "has_next_page": true,
    "has_previous_page": false,
    "end_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9",
    "start_cursor": "eyJpZCI6ImhvdXNlaG9sZF8wMUFSWjNOREVLVFNWNFJSRkZRNjlHNUZBViJ9"
  },
  "total_count": 100
}