Skip to content
Get started

API Reference

Libraries

npm install withluminary
pip install withluminary
go get -u 'github.com/withluminary/go-sdk@v0.6.0'

API Overview

Document Summaries

List all document summaries
GET/document-summaries
Get a document summary by ID
GET/document-summaries/{id}
Update a document summary
PUT/document-summaries/{id}
Download document summary as PDF
GET/document-summaries/{id}/download

Documents

List all documents
GET/documents
Upload a new document
POST/documents
Delete a document
DELETE/documents/{id}
Get a document by ID
GET/documents/{id}
Update a document
PUT/documents/{id}
Get summaries for a document
GET/documents/{id}/document-summaries
Download document file content
GET/documents/{id}/download

Entities

List all entities
GET/entities
Delete an entity
DELETE/entities/{id}
Get an entity by ID
GET/entities/{id}

EntitiesValuation

Get the current valuation for an entity
GET/entities/{id}/valuation
Create a new valuation for an entity
POST/entities/{id}/valuation

Households

List all households
GET/households
Create a new household
POST/households
Delete a household
DELETE/households/{id}
Get a household by ID
GET/households/{id}
Update a household
PUT/households/{id}
List all documents in a household
GET/households/{id}/documents
List all entities in a household
GET/households/{id}/entities
List all individuals in a household
GET/households/{id}/individuals

Individuals

Delete an individual
DELETE/individuals/{id}
Get an individual by ID
GET/individuals/{id}
Update an individual
PUT/individuals/{id}

Users

Get a user by ID
GET/users/{id}