Skip to content
Luminary Luminary Luminary
Get started
API Reference

Documents

List all documents
client.documents.list(DocumentListParams { household_id, limit, offset, type } query?, RequestOptionsoptions?): DocumentList { data, pagination }
get/documents
Upload a new document
client.documents.create(DocumentCreateParams { file, household_id, name, 4 more } body, RequestOptionsoptions?): Document { id, created_at, household_id, 6 more }
post/documents
Delete a document
client.documents.delete(stringid, RequestOptionsoptions?): void
delete/documents/{id}
Get a document by ID
client.documents.retrieve(stringid, RequestOptionsoptions?): Document { id, created_at, household_id, 6 more }
get/documents/{id}
Update a document
client.documents.update(stringid, DocumentUpdateParams { client_profile_id, enable_ai_suggestions, entity_id, 2 more } body, RequestOptionsoptions?): Document { id, created_at, household_id, 6 more }
put/documents/{id}
Get summaries for a document
client.documents.getSummaries(stringid, RequestOptionsoptions?): DocumentGetSummariesResponse { data }
get/documents/{id}/document-summaries
Download document file content
client.documents.download(stringid, RequestOptionsoptions?): Response
get/documents/{id}/download
ModelsExpand 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
client_profile_id?: string | null

Client profile ID if this document is associated with an individual

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

DocumentList { data, pagination }
data: Array<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
client_profile_id?: string | null

Client profile ID if this document is associated with an individual

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

DocumentType = "GRAT_DESIGN_SUMMARY" | "GENERATED_PRESENTATION" | "ASSET_VALUATION" | 40 more

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"