API Reference

Overview

Browse the three API-key operations and webhook integration guides.

Public API surface

The public reference contains only the three inquiry operations authenticated with X-Api-Key.

POST/api/v1/customer/inquiries

Create an inquiry from a published template.

GET/api/v1/customer/inquiries/{inquiryId}

Read current inquiry status, metadata, and optional identity.

GET/api/v1/customer/inquiries/{inquiryId}/documents

Retrieve document URLs for APPROVED or NEEDS_REVIEW.

Test requests

Every endpoint page includes synchronized examples for cURL, JavaScript, Python, PHP, Go, Java, and Ruby. Enter your environment values once to update all examples or send a browser request.

Webhook reference

Webhooks are inbound callbacks rather than additional API-key operations. Use these guides to build and test your receiver.

Webhooks overview

Understand delivery and receiver requirements.

Event catalog

Review supported inquiry events and payloads.

Signatures and testing

Generate and verify signed sample deliveries.

Delivery operations

Handle failures, duplicates, and manual resend.

Verification screens

Open an inquiry