Skip to content
Luminary Luminary Luminary
Get started
API Reference
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

Create a new document with file content

ParametersExpand Collapse
body: DocumentCreateParams { file, household_id, name, 4 more }
file: Uploadable

The document file to upload

formatbinary
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"
client_profile_id?: string

Client profile ID if associated with an individual

enable_ai_suggestions?: boolean

Whether this document should be used for AI suggestions

entity_id?: string

Entity ID if this document is owned by an entity

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

Upload a new document
import Luminary from 'withluminary';

const client = new Luminary();

const document = await client.documents.create({
  file: fs.createReadStream('path/to/file'),
  household_id: 'household_01ARZ3NDEKTSV4RRFFQ69G5FAV',
  name: 'Trust Agreement.pdf',
  type: 'GRAT_DESIGN_SUMMARY',
});

console.log(document.id);
{
  "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",
  "client_profile_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "enable_ai_suggestions": true,
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV"
}
Returns Examples
{
  "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",
  "client_profile_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "enable_ai_suggestions": true,
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV"
}