Update a document

client.Documents.Update(ctx, id, body) (*Document, error)

put/documents/{id}

Update document metadata only

ParametersExpand Collapse

id string

body DocumentUpdateParams

EnableAISuggestions param.Field[bool]optional

Whether this document should be used for AI suggestions

EntityID param.Field[string]optional

Entity ID if this document is owned by an entity

IndividualID param.Field[string]optional

Individual ID if associated with an individual

Name param.Field[string]optional

Display name of the document

minLength1

Type param.Field[DocumentType]optional

Type of document

ReturnsExpand Collapse

type Document struct{…}

ID string

Unique identifier with document_ prefix

CreatedAt Time

Timestamp when the document was created

formatdate-time

HouseholdID string

Household ID this document belongs to

Name string

Display name of the document

Type DocumentType

Type of document

Accepts one of the following:

const DocumentTypeGratDesignSummary DocumentType = "GRAT_DESIGN_SUMMARY"

const DocumentTypeGeneratedPresentation DocumentType = "GENERATED_PRESENTATION"

const DocumentTypeAssetValuation DocumentType = "ASSET_VALUATION"

const DocumentTypeSignedTrustDocument DocumentType = "SIGNED_TRUST_DOCUMENT"

const DocumentTypeTrustAmendment DocumentType = "TRUST_AMENDMENT"

const DocumentTypeTransferConfirmation DocumentType = "TRANSFER_CONFIRMATION"

const DocumentTypeExistingRemainderTrustDocument DocumentType = "EXISTING_REMAINDER_TRUST_DOCUMENT"

const DocumentTypeBalanceSheet DocumentType = "BALANCE_SHEET"

const DocumentTypeWill DocumentType = "WILL"

const DocumentTypeWillCodicil DocumentType = "WILL_CODICIL"

const DocumentTypePowerOfAttorney DocumentType = "POWER_OF_ATTORNEY"

const DocumentTypeAssignmentOfInterest DocumentType = "ASSIGNMENT_OF_INTEREST"

const DocumentTypeAssignmentOfTangibleProperty DocumentType = "ASSIGNMENT_OF_TANGIBLE_PROPERTY"

const DocumentTypeLoanNoteAgreement DocumentType = "LOAN_NOTE_AGREEMENT"

const DocumentTypeArticlesOfIncorporation DocumentType = "ARTICLES_OF_INCORPORATION"

const DocumentTypeOperatingAgreement DocumentType = "OPERATING_AGREEMENT"

const DocumentTypePartnershipAgreement DocumentType = "PARTNERSHIP_AGREEMENT"

const DocumentTypeAccountDocumentationStatement DocumentType = "ACCOUNT_DOCUMENTATION_STATEMENT"

const DocumentTypeTaxIDConfirmation DocumentType = "TAX_ID_CONFIRMATION"

const DocumentTypeGiftTaxReturn DocumentType = "GIFT_TAX_RETURN"

const DocumentTypeIncomeTaxReturn DocumentType = "INCOME_TAX_RETURN"

const DocumentTypeTaxReceipt DocumentType = "TAX_RECEIPT"

const DocumentTypeTaxFiling DocumentType = "TAX_FILING"

const DocumentTypeCorporateBylaws DocumentType = "CORPORATE_BYLAWS"

const DocumentTypeLlcAgreement DocumentType = "LLC_AGREEMENT"

const DocumentTypeLlcAgreementAmendment DocumentType = "LLC_AGREEMENT_AMENDMENT"

const DocumentTypeOperatingAgreementAmendment DocumentType = "OPERATING_AGREEMENT_AMENDMENT"

const DocumentTypePartnershipAgreementAmendment DocumentType = "PARTNERSHIP_AGREEMENT_AMENDMENT"

const DocumentTypeShareholdersAgreement DocumentType = "SHAREHOLDERS_AGREEMENT"

const DocumentTypeStateBusinessFiling DocumentType = "STATE_BUSINESS_FILING"

const DocumentTypeLoggedContribution DocumentType = "LOGGED_CONTRIBUTION"

const DocumentTypeLoggedDistribution DocumentType = "LOGGED_DISTRIBUTION"

const DocumentTypeInsurancePolicy DocumentType = "INSURANCE_POLICY"

const DocumentTypeCrummeyLetter DocumentType = "CRUMMEY_LETTER"

const DocumentTypeInsurancePremiumPayment DocumentType = "INSURANCE_PREMIUM_PAYMENT"

const DocumentTypeBeneficialOwnershipInformationReport DocumentType = "BENEFICIAL_OWNERSHIP_INFORMATION_REPORT"

const DocumentTypeFincenFiling DocumentType = "FINCEN_FILING"

const DocumentTypeHealthcareProxy DocumentType = "HEALTHCARE_PROXY"

const DocumentTypeLivingWill DocumentType = "LIVING_WILL"

const DocumentTypeDriversLicense DocumentType = "DRIVERS_LICENSE"

const DocumentTypePassport DocumentType = "PASSPORT"

const DocumentTypeDeed DocumentType = "DEED"

const DocumentTypeOther DocumentType = "OTHER"

UpdatedAt Time

Timestamp when the document was last updated

formatdate-time

EnableAISuggestions booloptional

Whether this document should be used for AI suggestions

EntityID stringoptional

Entity ID if this document is owned by an entity

IndividualID stringoptional

Individual ID if this document is associated with an individual

Update a document

package main

import (
  "context"
  "fmt"

  "github.com/withluminary/go-sdk"
  "github.com/withluminary/go-sdk/option"
)

func main() {
  client := withluminary.NewClient(
    option.WithClientID("My Client ID"),
    option.WithClientSecret("My Client Secret"),
  )
  document, err := client.Documents.Update(
    context.TODO(),
    "id",
    withluminary.DocumentUpdateParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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",
  "enable_ai_suggestions": true,
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "individual_id": "client_profile_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",
  "enable_ai_suggestions": true,
  "entity_id": "entity_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "individual_id": "client_profile_01ARZ3NDEKTSV4RRFFQ69G5FAV"
}