Skip to main content
HoundDog API Documentation

Documents

General files kept on a party that are not insurance certificates (contracts, licenses, anything else). Every route needs documents enabled on the account (enable_documents); otherwise 403 feature_disabled. Documents of your individuals are not served.

Operation Scope
GET /documents read
GET /documents/:id read
GET /parties/:id/documents read
POST /documents read_write
DELETE /documents/:id read_write

The document entity

{
  "id": 610,
  "party_id": 191537,
  "name": "Contractor license",
  "external_id": null,
  "file_url": "https://...",
  "created_at": "2026-09-12T11:00:00Z"
}

file_url is a short-lived link to the file (two days), never null. Fetch it when you need the bytes; do not store it.

GET /documents, GET /documents/:id, GET /parties/:id/documents

All of the account's documents, one document, and one party's documents (collections in the envelope).

POST /documents

multipart/form-data with file (required), name (required) and party_id (required). Event: Document Uploaded. Response 201. A party_id outside your account is 422 naming party_id. So is the id of one of your individuals.

DELETE /documents/:id

Deletes the document. Event: Document Deleted. Response 204.