How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Luminary Households API

The Households API from Luminary — 5 operation(s) for households.

Luminary Households API is one of 6 APIs that Luminary publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Households. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{subdomain}.withluminary.com/api/public/v1.

8 operations 5 paths 18 schemas 1 DELETE5 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://lum.withluminary.com/api/public/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Luminary Households API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2Profiles) using the authorizationCode and clientCredentials flows. By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Households 8
GET
/households
List all households
listHouseholds 4 params → 200default
POST
/households
Create a new household
createHousehold body → 201default
DELETE
/households/{id}
Delete a household
deleteHousehold 1 param → 204default
GET
/households/{id}
Get a household by ID
getHousehold 1 param → 200default
PUT
/households/{id}
Update a household
updateHousehold 1 param body → 200default
GET
/households/{id}/documents
List all documents in a household
listHouseholdDocuments 5 params → 200default
GET
/households/{id}/entities
List all entities in a household
listHouseholdEntities 5 params → 200default
GET
/households/{id}/individuals
List all individuals in a household
listHouseholdIndividuals 5 params → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Individual (24 properties), CreatePrimaryIndividualRequest (16 properties), Document (9 properties), Entity (9 properties). Each schema is shown below with its type and property counts.

PageInfo
object
4 properties 2 required
EntityStage
string
Lifecycle stage of the entity
CreateHouseholdRequest
object
4 properties 1 required
InEstateStatus
string
Whether the entity is in or out of the estate
Individual
object
24 properties 11 required
DocumentType
string
Type of document
FieldError
object
2 properties 2 required
EntityList
object
3 properties 3 required
Household
object
8 properties 4 required
EntityKind
string
Type of entity - determines the specific subtype and applicable fields
UpdateHouseholdRequest
object
3 properties
DocumentList
object
3 properties 3 required
HouseholdList
object
3 properties 3 required
IndividualList
object
3 properties 3 required
CreatePrimaryIndividualRequest
object
16 properties 3 required
Entity
object
9 properties 8 required
Error
object
3 properties 2 required
Document
object
9 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

luminary-households-api-openapi.yml Raw ↑

Other APIs Luminary publishes across the network.

Luminary Documents API
Luminary Entities API
Luminary Individuals API
Luminary Users API
Luminary Valuations API
Where this information came from

This is an independent, third-party profile of Luminary Households API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.