HoundDog API v2
HoundDog's API lets your systems create and read the parties you track, upload certificates, read compliance status and the reasons behind it, manage requirements, manage projects, and receive signed webhooks when something changes.
- Base URL:
https://app.hounddog.com/api/v2/ - Format: JSON requests and responses; multipart only for file uploads
- Machine-readable contract: the OpenAPI 3 document (its source is
docs/api/openapi.v2.json) - Interactive reference: Browse in Swagger UI
Conventions
- Authentication: an account API key in the
Api-Keyheader, scopesreadandread_write - Pagination and collections: the collection envelope,
per_pagecaps, incremental reads - Errors: one error shape with a request id you can quote to support
- Rate limits: the per-key request budget
- Webhooks: signed change notifications, payload and verification
- Migrating from v1: every v1 endpoint and its v2 equivalent
- Idempotency: safe retries of
POSTrequests withIdempotency-Key
Endpoint reference
| Page | Covers |
|---|---|
| Parties | Parties, their filters, create and update, the party actions, contacts, a party's events, and the reachouts in progress for each party |
| Certificates | Certificates, the parsed coverage data, uploads (direct and in the request), invalidate and restore, download |
| Approval overrides | Marking a party compliant without a certificate |
| Compliance requests | The requests and reminder cadence behind each party's status |
| Insurance requirements | Requirements and their coverages, and the coverage types (GET /coverage_types) |
| Projects | Projects, attaching parties, the project lifecycle |
| Custom fields | The account's custom field definitions: list, create, change, archive and restore |
| Compliance profiles | Multi-factor compliance bundles |
| Documents | General files kept on a party |
| Events | The event log, its filters and the event types |
| Webhook subscriptions | Managing subscriptions, test deliveries, secret rotation, the delivery log |
| Account and users | Account settings and dashboard users |
| W-9s | W-9 requests, uploads, downloads and tax ID exposure |
| Document signing | Signing templates (read) and signing requests |
| Requirement statuses | Per-requirement status rows |
Changes to the API are recorded in the Changelog.
Naming
The API uses one noun for the parties you track, whatever your dashboard calls them: parties in paths (/parties) and party_id in payloads, never vendor_id. The dashboard's label is available on the account resource as party_name so your UI can match ours.