Skip to content
Luminary Luminary Luminary
Get started
API Reference

Documents

List all documents
documents.list(DocumentListParams**kwargs) -> DocumentList
get/documents
Upload a new document
documents.create(DocumentCreateParams**kwargs) -> Document
post/documents
Delete a document
documents.delete(strid)
delete/documents/{id}
Get a document by ID
documents.retrieve(strid) -> Document
get/documents/{id}
Update a document
documents.update(strid, DocumentUpdateParams**kwargs) -> Document
put/documents/{id}
Get summaries for a document
documents.get_summaries(strid) -> DocumentGetSummariesResponse
get/documents/{id}/document-summaries
Download document file content
documents.download(strid) -> BinaryResponseContent
get/documents/{id}/download
ModelsExpand Collapse
class Document: …
id: str

Unique identifier with document_ prefix

created_at: datetime

Timestamp when the document was created

formatdate-time
household_id: str

Household ID this document belongs to

name: str

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: datetime

Timestamp when the document was last updated

formatdate-time
client_profile_id: Optional[str]

Client profile ID if this document is associated with an individual

enable_ai_suggestions: Optional[bool]

Whether this document should be used for AI suggestions

entity_id: Optional[str]

Entity ID if this document is owned by an entity

class DocumentList: …
data: List[Document]
id: str

Unique identifier with document_ prefix

created_at: datetime

Timestamp when the document was created

formatdate-time
household_id: str

Household ID this document belongs to

name: str

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: datetime

Timestamp when the document was last updated

formatdate-time
client_profile_id: Optional[str]

Client profile ID if this document is associated with an individual

enable_ai_suggestions: Optional[bool]

Whether this document should be used for AI suggestions

entity_id: Optional[str]

Entity ID if this document is owned by an entity

DocumentType = Literal["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"